Merge pull request #34 from andrey-helldar/coverage

Andrey Helldar · web-flow · commit 76a78d4969d0 · 2020-12-22T13:44:24.000+03:00
Coverage
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -31,7 +31,7 @@ jobs:
             -   name: Execute tests
                 run: |
                     mkdir -p build/logs
-                    vendor/bin/phpunit --coverage-clover=coverage.clover
+                    vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
 
             -   name: Export
                 run: |
diff --git a/composer.json b/composer.json
@@ -21,7 +21,7 @@
     "require": {
         "php": "^7.2|^8.0",
         "ext-json": "*",
-        "andrey-helldar/laravel-routes-core": "^1.8.2",
+        "andrey-helldar/laravel-routes-core": "^1.9",
         "andrey-helldar/support": "^1.22",
         "illuminate/contracts": "^5.0|^6.0|^7.0|^8.0",
         "illuminate/http": "^5.0|^6.0|^7.0|^8.0",
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,16 +1,32 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="phpunit.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnError="false"
-         stopOnFailure="false"
-         verbose="true"
+<phpunit
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        bootstrap="phpunit.php"
+        colors="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        processIsolation="false"
+        stopOnError="false"
+        stopOnFailure="false"
+        verbose="true"
 >
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+        <exclude>
+            <file>src/ServiceProvider.php</file>
+        </exclude>
+        <report>
+            <clover outputFile="build/logs/clover.xml"/>
+            <html outputDirectory="build/logs/coverage"/>
+            <text outputFile="build/logs/coverage.txt"/>
+        </report>
+    </coverage>
     <php>
         <env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
         <env name="APP_ENV" value="testing"/>
@@ -21,17 +37,4 @@
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-            <exclude>
-                <file>src/ServiceProvider.php</file>
-            </exclude>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-        <log type="coverage-text" target="build/logs/coverage.txt"/>
-        <log type="coverage-html" target="build/logs/coverage"/>
-    </logging>
 </phpunit>
diff --git a/src/Facades/Cache.php b/src/Facades/Cache.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace PrettyRoutes\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use PrettyRoutes\Support\Cache as Support;
+
+/**
+ * @method static \PrettyRoutes\Support\Cache when($value);
+ * @method static bool routeClear();
+ */
+final class Cache extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return Support::class;
+    }
+}
diff --git a/src/Http/PrettyRoutesController.php b/src/Http/PrettyRoutesController.php
@@ -3,8 +3,11 @@
 namespace PrettyRoutes\Http;
 
 use Helldar\LaravelRoutesCore\Support\Routes;
+use Illuminate\Contracts\View\View;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Routing\Controller as BaseController;
-use Illuminate\Support\Facades\Artisan;
+use PrettyRoutes\Facades\Cache;
+use PrettyRoutes\Support\Config;
 
 class PrettyRoutesController extends BaseController
 {
@@ -13,7 +16,7 @@ class PrettyRoutesController extends BaseController
      *
      * @return \Illuminate\Contracts\View\View
      */
-    public function show()
+    public function show(): View
     {
         return view('pretty-routes::layout');
     }
@@ -22,37 +25,33 @@ public function show()
      * Getting a list of routes.
      *
      * @param  \Helldar\LaravelRoutesCore\Support\Routes  $routes
+     * @param  \PrettyRoutes\Support\Config  $config
      *
      * @return \Illuminate\Http\JsonResponse
      */
-    public function routes(Routes $routes)
+    public function routes(Routes $routes, Config $config): JsonResponse
     {
-        $content = $routes
-            ->setApiMiddlewares((array) config('pretty-routes.api_middleware'))
-            ->setWebMiddlewares((array) config('pretty-routes.web_middleware'))
-            ->setHideMethods(config('pretty-routes.hide_methods', []))
-            ->setHideMatching(config('pretty-routes.hide_matching', []))
-            ->setDomainForce(config('pretty-routes.domain_force', false))
-            ->setUrl(config('app.url'))
-            ->setNamespace(config('modules.namespace'))
-            ->get();
+        $routes->setFromConfig($config);
 
-        return response()->json($content);
+        return response()->json(
+            $routes->get()
+        );
     }
 
     /**
      * Clearing cached routes.
      *
      * @return \Illuminate\Http\JsonResponse
      */
-    public function clear()
+    public function clear(): JsonResponse
     {
-        if (config('app.env') !== 'production' && (bool) config('app.debug') === true) {
-            Artisan::call('route:clear');
-
-            return response()->json('ok');
-        }
+        return Cache::when($this->allow())->routeClear()
+            ? response()->json('ok')
+            : response()->json('disabled', 400);
+    }
 
-        return response()->json('disabled', 400);
+    protected function allow(): bool
+    {
+        return config('app.env') !== 'production' && (bool) config('app.debug') === true;
     }
 }
diff --git a/src/Support/Cache.php b/src/Support/Cache.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace PrettyRoutes\Support;
+
+use Illuminate\Support\Facades\Artisan;
+
+final class Cache
+{
+    protected $when = true;
+
+    public function when($value): self
+    {
+        $this->when = (bool) $value;
+
+        return $this;
+    }
+
+    public function routeClear(): bool
+    {
+        return $this->when && $this->clear('route:clear');
+    }
+
+    protected function clear(string $command): bool
+    {
+        Artisan::call($command);
+
+        return true;
+    }
+}
diff --git a/src/Support/Config.php b/src/Support/Config.php
@@ -0,0 +1,49 @@
+<?php
+
+namespace PrettyRoutes\Support;
+
+use Helldar\LaravelRoutesCore\Contracts\Config as ConfigContract;
+use Illuminate\Support\Facades\Config as Conf;
+
+final class Config implements ConfigContract
+{
+    public function getApiMiddleware(): array
+    {
+        return (array) $this->get('api_middleware');
+    }
+
+    public function getWebMiddleware(): array
+    {
+        return (array) $this->get('web_middleware');
+    }
+
+    public function getHideMethods(): array
+    {
+        return $this->get('hide_methods', []);
+    }
+
+    public function getHideMatching(): array
+    {
+        return $this->get('hide_matching', []);
+    }
+
+    public function getDomainForce(): bool
+    {
+        return (bool) $this->get('domain_force');
+    }
+
+    public function getUrl(): string
+    {
+        return Conf::get('app.url');
+    }
+
+    public function getNamespace(): ?string
+    {
+        return Conf::get('modules.namespace');
+    }
+
+    protected function get(string $key, $default = null)
+    {
+        return Conf::get('pretty-routes.' . $key, $default);
+    }
+}
