Merge pull request #3 from kirschbaum-development/dev

0.1 release

Author: dvanscott

CHANGELOG.md

@@ -2,6 +2,6 @@
 
 All notable changes to `laravel-route-file-macro` will be documented in this file.
 
-## 1.0.0 - 2019-04-23
+## 1.0.0 - 2019-07-25
 
 - Initial release

composer.json

@@ -5,6 +5,7 @@
     "keywords": [
         "kirschbaum-development",
         "laravel",
+        "laravel-route",
         "laravel-route-file-macro"
     ],
     "homepage": "https://github.com/kirschbaum-development/laravel-route-file-macro",

readme.md

@@ -19,24 +19,29 @@ composer require kirschbaum-development/laravel-route-file-macro
 
 ## Usage
 
+### Single Item
+
+`Route::file` accepts a single file path or `SplFileInfo` object and cannot be used with multiple paths or file objects.
+
 ```php
 Route::file(base_path('routes/admin/users.php'));
+
+$files = File::files(__DIR__.'/routes');
+Route::files($files[0]);
 ```
 
-### Array Usage
+### Multiple Items
+
+`Route::files` accepts an array of file paths or an array of `SplFileInfo` objects and cannot be used with a single path or file object.
 
 ```php
-Route::file([
+Route::files([
     base_path('routes/admin/posts.php'),
     base_path('routes/admin/users.php')
 ]);
-```
 
-### `SplFileInfo` Usage
-
-```php
 $files = File::files(__DIR__.'/routes');
-Route::file($files);
+Route::files($files);
 ```
 
 ## Changelog

src/RouteFileMacroServiceProvider.php

@@ -2,25 +2,18 @@
 
 namespace KirschbaumDevelopment\RouteFileMacro;
 
-use SplFileInfo;
-
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 
 class RouteFileMacroServiceProvider extends ServiceProvider
 {
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
     public function register()
     {
-        $this->registerRouteFileMacro();
-    }
-
-    protected function registerRouteFileMacro()
-    {
-        Route::macro('file', function ($file) {
-            collect(Arr::wrap($file))->each(function ($file) {
-                $path = ($file instanceof SplFileInfo) ? $file->getRealPath() : $file;
-                Route::group([], $path);
-            });
-        });
+        Route::mixin(new RouteMacros);
     }
 }

src/RouteMacros.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace KirschbaumDevelopment\RouteFileMacro;
+
+use SplFileInfo;
+use Illuminate\Support\Facades\Route;
+
+class RouteMacros
+{
+    /**
+     * Load routes from a file.
+     *
+     * @return \Closure
+     */
+    public function file()
+    {
+        return function ($file) {
+            $this->generateRouteGroupForFile($file);
+        };
+    }
+
+    /**
+     * Load routes from multiple files.
+     *
+     * @return \Closure
+     */
+    public function files()
+    {
+        return function ($files) {
+            collect($files)->each(function ($file) {
+                $this->generateRouteGroupForFile($file);
+            });
+        };
+    }
+
+    /**
+     * Generate the route group for a the passed file.
+     *
+     * @return \Closure
+     */
+    protected function generateRouteGroupForFile()
+    {
+        return function ($file) {
+            $path = ($file instanceof SplFileInfo) ? $file->getRealPath() : $file;
+
+            Route::group([], $path);
+        };
+    }
+}

tests/RouteFileMacroTest.php

@@ -5,36 +5,45 @@
 use Orchestra\Testbench\TestCase;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Route;
+use KirschbaumDevelopment\RouteFileMacro\RouteFileMacroServiceProvider;
 
 class RouteFileMacroTest extends TestCase
 {
-    protected function getPackageProviders($app)
+    /** @test */
+    public function hasTheRouteFileMacros()
     {
-        return ['KirschbaumDevelopment\RouteFileMacro\RouteFileMacroServiceProvider'];
+        $this->assertTrue(Route::hasMacro('file'));
+        $this->assertTrue(Route::hasMacro('files'));
     }
 
-    /** @test */
-    public function it_provides_route_file_macro()
+    /** @test **/
+    public function loadsRoutesFromSingleFilePath()
     {
-        $this->assertTrue(Route::hasMacro('file'));
+        Route::file(__DIR__ . '/routes/test-route-1.php');
+
+        $this->refreshNamedRoutes();
+
+        $this->assertTrue(Route::has('test-route-1'));
     }
 
     /** @test **/
-    public function it_loads_a_route_from_a_file_path()
+    public function loadsRoutesFromSingleFileInfoObject()
     {
-        Route::file(__DIR__.'/routes/test-route-1.php');
+        $file = File::files(__DIR__ . '/routes');
+
+        Route::file($file[0]);
 
         $this->refreshNamedRoutes();
 
         $this->assertTrue(Route::has('test-route-1'));
     }
 
     /** @test **/
-    public function it_loads_multiple_routes_from_an_array_of_file_paths()
+    public function loadsRoutesFromMultipleFilePaths()
     {
-        Route::file([
-            __DIR__.'/routes/test-route-1.php',
-            __DIR__.'/routes/test-route-2.php',
+        Route::files([
+            __DIR__ . '/routes/test-route-1.php',
+            __DIR__ . '/routes/test-route-2.php',
         ]);
 
         $this->refreshNamedRoutes();
@@ -44,18 +53,35 @@ public function it_loads_multiple_routes_from_an_array_of_file_paths()
     }
 
     /** @test **/
-    public function it_loads_route_files_from_a_file_object()
+    public function loadsRoutesFromMultipleFileInfoObjects()
     {
-        $files = File::files(__DIR__.'/routes');
+        $files = File::files(__DIR__ . '/routes');
 
-        Route::file($files);
+        Route::files($files);
 
         $this->refreshNamedRoutes();
 
         $this->assertTrue(Route::has('test-route-1'));
         $this->assertTrue(Route::has('test-route-2'));
     }
 
+    /**
+     * Get package providers.
+     *
+     * @param  \Illuminate\Foundation\Application  $app
+     *
+     * @return array
+     */
+    protected function getPackageProviders($app)
+    {
+        return [RouteFileMacroServiceProvider::class];
+    }
+
+    /**
+     * Refresh the named routes.
+     *
+     * @return void
+     */
     protected function refreshNamedRoutes()
     {
         app('router')->getRoutes()->refreshNameLookups();