Merge pull request #4 from LaraChimp/master

Improvements

README.md

@@ -67,7 +67,7 @@ The config file ```pine-annotations.php``` has two sections ```autoload_files```
 
 ```php
 'autoload_files' => [
-    // 
+    app_path('Annotations/FooAnnotation.php'),
 ],
 ```
 
@@ -78,15 +78,29 @@ can include as many files as you need.
 
 ```php
 'autoload_namespaces' => [
-    'App\Annotations' => app_path('Annotations'),
+    'App\Annotations',
 ],
 ```
 
-This array contains the namespaces and paths of your annotations classes. This is useful if you want to register all annotations classes 
+This array contains the namespaces of your annotations classes. This is useful if you want to register all annotations classes 
 of a whole namespace in a single go. 
 
-> It is imperative that you register either one of those arrays 
-> when creating your annotations classes.
+#### Using the Reader to manually add entries to the Registry.
+
+Alternatively you may use the methods ```addFilesToRegistry()``` and ```addNamespacesToRegistry()``` to perform manual entries of
+files and namespaces to the annotation registry. 
+
+```php
+// Adding files manually to the Registry.
+AnnotationsReader::addFilesToRegistry($filesPaths);
+```
+
+```php
+// Adding namespaces manually to the Registry.
+AnnotationsReader::addNamespacesToRegistry($namespaces);
+```
+
+> It is imperative that you register your annotations classes in one way or the other with the Reader.
 > Otherwise AnnotationsReader won't be able to parse them. 
 
 ### The AnnotationsReader

composer.json

@@ -32,7 +32,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "0.1.x-dev"
+            "dev-master": "0.2.x-dev"
         },
         "laravel": {
             "providers": [

config/pine-annotations.php

@@ -14,7 +14,7 @@
     */
 
     'autoload_files' => [
-        // app_path('Annotations/FooAnnotation.php')
+        app_path('Annotations/FooAnnotation.php'),
     ],
 
     /*
@@ -29,6 +29,6 @@
     */
 
     'autoload_namespaces' => [
-        // 'App\Annotations' => app_path('Annotations'),
+        'App\Annotations',
     ],
 ];

src/Concerns/NamespaceToPathConvertable.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace LaraChimp\PineAnnotations\Concerns;
+
+use Illuminate\Console\DetectsApplicationNamespace;
+
+trait NamespaceToPathConvertable
+{
+    use DetectsApplicationNamespace;
+
+    /**
+     * Convert the given namespace to a file path.
+     *
+     * @param string $namespace
+     * @param string $base
+     *
+     * @return string
+     */
+    public function getPathFromNamespace($namespace, $base = null)
+    {
+        $appNamespace = $this->getAppNamespace();
+
+        // Remove the app namespace from the namespace if it is there
+        if (substr($namespace, 0, strlen($appNamespace)) == $appNamespace) {
+            $namespace = substr($namespace, strlen($appNamespace));
+        }
+        $path = str_replace('\\', '/', trim($namespace, ' \\'));
+
+        // trim and return the path
+        return ($base ?: app_path()).'/'.$path;
+    }
+}

src/PineAnnotationsServiceProvider.php

@@ -2,12 +2,10 @@
 
 namespace LaraChimp\PineAnnotations;
 
-use Symfony\Component\Finder\Finder;
 use Doctrine\Common\Annotations\Reader;
 use Illuminate\Support\ServiceProvider;
 use Doctrine\Common\Annotations\CachedReader;
 use Doctrine\Common\Annotations\AnnotationReader;
-use Doctrine\Common\Annotations\AnnotationRegistry;
 use LaraChimp\PineAnnotations\Support\Reader\AnnotationsReader;
 use LaraChimp\PineAnnotations\Doctrine\Cache\LaravelCacheDriver;
 
@@ -23,6 +21,8 @@ public function boot()
         $this->publishes([
             __DIR__.'/../config/pine-annotations.php' => config_path('pine-annotations.php'),
         ]);
+
+        $this->addAnnotationsToRegistry();
     }
 
     /**
@@ -42,9 +42,6 @@ public function register()
 
         // Register commands.
         $this->registerCommands();
-
-        // Register annotations Registry.
-        $this->registerAnnotationsRegistry();
     }
 
     /**
@@ -96,35 +93,19 @@ protected function registerCommands()
     }
 
     /**
-     * Register autoload files and namespaces used
-     * to load annotations from.
+     * Add files and namespaces to the annotations registry.
      *
      * @return void
      */
-    protected function registerAnnotationsRegistry()
+    protected function addAnnotationsToRegistry()
     {
+        // Creates annotation Reader.
+        $reader = $this->app->make(AnnotationsReader::class);
+
         // Register files autoload.
-        collect(config('pine-annotations.autoload_files'))->each(function ($filePath) {
-            $this->registerFileAnnotation($filePath);
-        });
+        $reader->addFilesToRegistry(config('pine-annotations.autoload_files'));
 
         // Register namespaces autoload.
-        collect(config('pine-annotations.autoload_namespaces'))->each(function ($dirs) {
-            foreach (Finder::create()->files()->name('*.php')->in($dirs) as $file) {
-                $this->registerFileAnnotation($file->getRealPath());
-            }
-        });
-    }
-
-    /**
-     * Registers a file in th Annotation registry.
-     *
-     * @param string $filePath
-     *
-     * @return void
-     */
-    protected function registerFileAnnotation($filePath)
-    {
-        AnnotationRegistry::registerFile($filePath);
+        $reader->addNamespacesToRegistry(config('pine-annotations.autoload_namespaces'));
     }
 }

src/Support/Reader/AnnotationsReader.php

@@ -7,10 +7,15 @@
 use ReflectionProperty;
 use Illuminate\Support\Str;
 use InvalidArgumentException;
+use Symfony\Component\Finder\Finder;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Common\Annotations\AnnotationRegistry;
+use LaraChimp\PineAnnotations\Concerns\NamespaceToPathConvertable;
 
 class AnnotationsReader
 {
+    use NamespaceToPathConvertable;
+
     /**
      * The Reader instance.
      *
@@ -112,6 +117,48 @@ public function read($argument)
         return $this->readAllAnnotationsFor($reflection);
     }
 
+    /**
+     * Adds files containing annotations to the registry.
+     *
+     * @param array|string $filePaths
+     *
+     * @return self
+     */
+    public function addFilesToRegistry($filePaths)
+    {
+        collect((array) $filePaths)->each(function ($filePath) {
+            if (file_exists($filePath)) {
+                AnnotationRegistry::registerFile($filePath);
+            }
+        });
+
+        return $this;
+    }
+
+    /**
+     * Adds namespaces containing annotations to the registry.
+     *
+     * @param array|string $namespaces
+     *
+     * @return $this
+     */
+    public function addNamespacesToRegistry($namespaces)
+    {
+        collect((array) $namespaces)->each(function ($namespace) {
+            // Get path from namespace.
+            $path = $this->getPathFromNamespace($namespace);
+
+            if (file_exists($path)) {
+                // Register each annotations file found in the namespace.
+                foreach (Finder::create()->files()->name('*.php')->in($path) as $file) {
+                    $this->addFilesToRegistry($file->getRealPath());
+                }
+            }
+        });
+
+        return $this;
+    }
+
     /**
      * Reads all the annotations for the given target.
      *