Filters tests and refactoring.

- Api-router path can be defined in config.
- Simplify RouteCollection class.
- Tests for RouteCollection class.
- PHPUnit support.

Author: asvae

.gitignore

@@ -1,2 +1,4 @@
 /.idea/
-/node_modules/
+/node_modules/
+/vendor/
+/composer.lock

composer.json

@@ -12,6 +12,15 @@
     "require": {
         "php": ">=5.4.0"
     },
+    "require-dev": {
+        "laravel/framework": "5.2.*",
+        "phpunit/phpunit": "~4.0"
+    },
+    "autoload-dev": {
+        "classmap": [
+            "tests/TestCase.php"
+        ]
+    },
     "autoload": {
         "psr-4": {
             "Asvae\\ApiTester\\": "src/"

config/api-tester.php

@@ -26,47 +26,65 @@
 
     'middleware' => ['web'],
 
-
     /*
     |--------------------------------------------------------------------------
-    | Middleware
+    | Route repository
     |--------------------------------------------------------------------------
     |
-    | Define list of middleware(s), that should be used for api-tester.
-    | CRSF token will be handled automatically.
+    | Specify class for RouteRepository.
     |
     */
+
     'repository' => \Asvae\ApiTester\DefaultRouteRepository::class,
 
     /*
     |--------------------------------------------------------------------------
-    | Matching pattern
+    | Default route
     |--------------------------------------------------------------------------
-    | Represent only routes that matching given pattern.
-    |
-    | Example:
     |
-    | 'match' => [
-    |     [
-    |         'path' => '#api/v(1|2|3)/.*#',
-    |         'name' => '#.*#',
-              'method' => '#(GET|POST|PUT|PATCH|DELETE)#'
-    |      ]
-    ]  ]
+    | Define the route for api router.
+    | http://your-site.com/[route]
     |
     */
-    'match'      => [
 
-    ],
+    'route' => 'api-tester',
 
     /*
     |--------------------------------------------------------------------------
-    | Except pattern
+    | Filter routes
     |--------------------------------------------------------------------------
-    | Except routes that matching given pattern.
+    | All your routes will be filtered via given patterns. Both include and
+    | exclude are always applied. You can also use regex when needed.
+    |
+    | ## Examples
+    |
+    | ### Include all
+    | 'include' => [[]]
+    |
+    | ### Include some routes
+    | 'include' => [
+    |      'api/users',
+    |      'api/sales',
+    |      // ...
+    |  ]
+    |
+    | ### Include advanced
+    | 'include' => [
+    |      [
+    |         'path' => 'api/v(1|2|3)/.*',
+    |         'name' => '.*',
+    |         'method' => '(GET|POST|PUT|PATCH|DELETE)'
+    |      ],
+    |      // ...
+    |  ]
+    |
+    | ### Include all except 'users'
+    | 'include' => [[]],
+    | 'exclude' => ['api/users'],
     |
     */
-    'except'     => [
 
-    ],
+    'include' => [[]],
+
+    'exclude' => [],
 ];

phpunit.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/DefaultRouteRepository.php

@@ -5,11 +5,6 @@
 use Asvae\ApiTester\Contracts\RouteRepositoryInterface;
 use Illuminate\Routing\Router;
 
-/**
- * Class DefaultRouteRepository
- *
- * @package \Asvae\ApiTester
- */
 class DefaultRouteRepository implements RouteRepositoryInterface
 {
 

src/Http/Controllers/ApiTesterController.php

@@ -23,8 +23,8 @@ public function index()
     public function routes(RouteRepositoryInterface $repository)
     {
         $data = $repository->get(
-            config('api-tester.match'),
-            config('api-tester.except')
+            config('api-tester.include'),
+            config('api-tester.exclude')
         );
 
         return response()->json(compact('data'));

src/Http/routes.php

@@ -1,6 +1,6 @@
 <?php
 
-Route::get('api-tester', 'ApiTesterController@index');
+Route::get(config('api-tester.route'), 'ApiTesterController@index');
 Route::post('_api-tester/routes', 'ApiTesterController@routes');
 Route::get('_api-tester/assets/{file}', 'AssetsController@index');
 Route::get('_api-tester/test-routes/{type}', 'ApiTesterController@testRoutes');

src/RouteCollection.php

@@ -12,51 +12,70 @@
 class RouteCollection extends Collection
 {
     /**
-     * Return collection of routes that matched pattern
+     * Include routes that match patterns.
      *
-     * @param array $matches
+     * @param array <array|string> $patterns
      *
      * @return static
      */
-    public function filterMatch(array $matches = [])
+    public function filterMatch(array $patterns = [])
     {
-        if (!empty($matches)) {
-            return $this->filter(function ($route, $key) use ($matches) {
-                $isMatched = true;
-
-                foreach ($matches as $match) {
-
-                    foreach ($route as $index => $value) {
-                        if (!array_key_exists($index, $match)) {
-                            continue;
-                        }
+        // String pattern is assumed to be path.
+        foreach ($patterns as $key => $pattern) {
+            if (is_string($pattern)) {
+                $patterns[$key] = ['path' => $pattern];
+            }
+        }
 
-                        if (!preg_match($match[$index], $value)) {
-                            $isMatched = false;
-                        }
-                    }
+        return $this->filter(function ($route) use ($patterns) {
+            // If any of patterns matches the route passes.
+            foreach ($patterns as $pattern) {
+                if ($this->isRouteMatchesPattern($route, $pattern)) {
+                    return true;
                 }
+            }
 
-                return $isMatched;
-            });
-        }
-
-        return $this;
+            // If all patterns don't match - route is filtered out.
+            return false;
+        });
     }
 
+
     /**
-     * Return collection of routes except matched pattern
+     * Exclude routes that match patterns.
      *
-     * @param array $exceptions
+     * @param array <array|string> $patterns
      *
      * @return static
      */
-    public function filterExcept(array $exceptions = [])
+    public function filterExcept(array $patterns = [])
+    {
+        if (empty($patterns)) {
+            return $this;
+        }
+
+        $toExclude = $this->filterMatch($patterns)->keys()->toArray();
+
+        return $this->except($toExclude);
+    }
+
+    /**
+     * @param array $route
+     * @param array $pattern
+     * @return bool
+     */
+    private function isRouteMatchesPattern(array $route, array $pattern)
     {
-        if (!empty($exceptions)) {
-            return $this->except($this->filterMatch($exceptions)->keys()->toArray());
+        foreach ($route as $key => $value) {
+            if (! array_key_exists($key, $pattern)) {
+                continue;
+            }
+
+            $regex = '~'.$pattern[$key].'~';
+
+            return ! ! preg_match($regex, $value);
         }
 
-        return $this;
+        return true;
     }
 }

src/ServiceProvider.php

@@ -2,23 +2,25 @@
 
 namespace Asvae\ApiTester;
 
+use Asvae\ApiTester\Contracts\RouteRepositoryInterface;
 use Asvae\ApiTester\Providers\RouteServiceProvider;
 
-
 class ServiceProvider extends \Illuminate\Support\ServiceProvider
 {
     public function register()
     {
         $this->app->register(RouteServiceProvider::class);
-        $this->mergeConfigFrom(__DIR__ . '/../config/api-tester.php', 'api-tester');
+        $this->mergeConfigFrom(__DIR__.'/../config/api-tester.php',
+            'api-tester');
 
-        $this->app->bind(\Asvae\ApiTester\Contracts\RouteRepositoryInterface::class, config('api-tester.repository'));
+        $this->app->bind(RouteRepositoryInterface::class,
+            config('api-tester.repository'));
     }
 
     public function boot()
     {
         $this->publishes([
-            __DIR__ . '/config/api-tester.php' => config_path('api-tester.php'),
+            __DIR__.'/config/api-tester.php' => config_path('api-tester.php'),
         ], 'config');
     }
 }