Merge pull request #26 from ytake/feature-ignore-annotations

Feature ignore annotations

Author: ytake

src/AnnotationManager.php

@@ -18,6 +18,7 @@
 namespace Ytake\LaravelAspect;
 
 use Illuminate\Support\Manager;
+use Doctrine\Common\Annotations\AnnotationReader;
 
 /**
  * Class AnnotationManager
@@ -39,6 +40,7 @@ public function getDefaultDriver()
      */
     protected function createArrayDriver()
     {
+        $this->ignoredAnnotations($this->app['config']->get('ytake-laravel-aop.annotation.ignores', []));
         return new ArrayReader();
     }
 
@@ -47,6 +49,7 @@ protected function createArrayDriver()
      */
     protected function createFileDriver()
     {
+        $this->ignoredAnnotations($this->app['config']->get('ytake-laravel-aop.annotation.ignores', []));
         return new FileReader($this->getConfigure('file'));
     }
 
@@ -60,4 +63,15 @@ protected function getConfigure($driver)
 
         return $annotationConfigure[$driver];
     }
+
+    /**
+     * Add a new annotation to the globally ignored annotation names with regard to exception handling.
+     * @param array $ignores
+     */
+    private function ignoredAnnotations(array $ignores = [])
+    {
+        foreach ($ignores as $ignore) {
+            AnnotationReader::addGlobalIgnoredName($ignore);
+        }
+    }
 }

src/Modules/AspectModule.php

@@ -36,10 +36,10 @@ abstract class AspectModule
     /** @var CompilerInterface */
     protected $compiler;
 
-    /** @var array  */
+    /** @var array */
     protected static $pointcuts = [];
 
-    /** @var array  */
+    /** @var array */
     protected static $resolve = [];
 
     /** @var array */
@@ -55,6 +55,7 @@ public function __construct(Application $app)
 
     /**
      * attach pointcut
+     *
      * @return void
      */
     public function attach()

src/config/ytake-laravel-aop.php

@@ -57,5 +57,20 @@
                 'debug' => env('ASPECT_ANNOTATION_DEBUG', false),
             ],
         ],
+
+        'ignores' => [
+            // global Ignored Annotations
+            'Hears',
+            'Get',
+            'Post',
+            'Put',
+            'Patch',
+            'Options',
+            'Delete',
+            'Any',
+            'Middleware',
+            'Resource',
+            'Controller'
+        ],
     ],
 ];

tests/IgnoreAnnotationTest.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * Class IgnoreAnnotationTest
+ */
+class IgnoreAnnotationTest extends AspectTestCase
+{
+    /** @var \Ytake\LaravelAspect\AspectManager $manager */
+    protected $manager;
+
+    protected function setUp()
+    {
+        parent::setUp();
+        $this->manager = new \Ytake\LaravelAspect\AspectManager($this->app);
+        $this->resolveManager();
+    }
+
+    public function testGenerateCacheNameRemoveNullKey()
+    {
+        /** @var \__Test\AnnotationStub $class */
+        $class = $this->app->make(\__Test\AnnotationStub::class);
+        $this->assertNull($class->testing());
+    }
+
+
+    /**
+     *
+     */
+    protected function resolveManager()
+    {
+        /** @var \Ytake\LaravelAspect\RayAspectKernel $aspect */
+        $aspect = $this->manager->driver('ray');
+        $aspect->register(\__Test\LogExceptionsModule::class);
+        $aspect->dispatch();
+    }
+}

tests/config/ytake-laravel-aop.php

@@ -42,5 +42,10 @@
                 'debug' => true,
             ],
         ],
+        'ignores' => [
+            // global Ignored Annotations
+            'Get',
+            'Resource'
+        ],
     ],
 ];

tests/src/AnnotationStub.php

@@ -0,0 +1,25 @@
+<?php
+
+
+namespace __Test;
+
+use Ytake\LaravelAspect\Annotation\LogExceptions;
+
+/**
+ * Class AnnotationStub
+ * for tests
+ * @Resource
+ */
+class AnnotationStub
+{
+    /**
+     * @LogExceptions
+     * @Get
+     * @param null $id
+     * @return null
+     */
+    public function testing($id = null)
+    {
+        return $id;
+    }
+}

tests/src/LogExceptionsModule.php

@@ -11,5 +11,6 @@ class LogExceptionsModule extends Loggable
      */
     protected $classes = [
         \__Test\AspectLogExceptions::class,
+        \__Test\AnnotationStub::class
     ];
 }