Merge pull request #62 from rakutentech/feature/ui

Fixes #3
rakutentech · Mar 29, 2022 · adfc957 · adfc957
2 parents eb12f27 + 5cedb5d
commit adfc957
Show file tree

Hide file tree

Showing 10 changed files with 251 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -138,4 +138,5 @@ Fixing lints
 - v1.15 Adds Filter and fall back to regexp upon Exception
 - v1.17 Donot restrict to FormRequest
 - v1.18 Fix where prism had fixed height. Allow text area resize.
+- v1.18 Updated UI and pushed unit tests
 
diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php
@@ -100,6 +100,26 @@
         </nav>
       <div id="app" v-cloak class="w-full flex lg:pt-10">
          <aside class="text-sm ml-1.5 text-grey-darkest break-all bg-gray-200 pl-2 h-screen sticky top-1 overflow-auto">
+            <section class="pt-5 pl-2 pr-2 pb-5 border mb-10 rounded bg-white shadow">
+                <div class="font-sans">
+                    <h2 class="text-sm break-normal text-black break-normal font-sans pb-1 pt-1 text-black">
+                        Filter
+                    </h2>
+                    <p class="text-xs pb-2 font-medium text-gray-500">Hide non matching</code></p>
+                    <input type="text" v-model="filterTerm" @input="filterDocs" class="w-full p-2 border-2 border-gray-300 rounded" placeholder="/api/search">
+                </div>
+            </section>
+            <section class="pt-5 pl-2 pr-2 pb-5 border mb-10 rounded bg-white shadow">
+                <div class="font-sans">
+                    <h2 class="text-sm break-normal text-black break-normal font-sans pb-1 pt-1 text-black">
+                        Edit Request Headers
+                    </h2>
+                    <p class="text-xs pb-2 font-medium text-gray-500">Default headers sent on every request. Format <code>Key:Value</code></p>
+                    <prism-editor
+                        class="my-prism-editor"
+                        style="max-width:100%;min-height:100px;background:#2d2d2d;color: #ccc;resize:both" v-model="requestHeaders" :highlight="highlighter" line-numbers></prism-editor>
+                </div>
+            </section>
             <h1 class="font-medium mx-3 mt-3" style="width: max-content;min-width:350px;">Routes List</h1>
             <hr class="border-b border-gray-300">
             <table class="table-fixed text-sm mt-5" style="width: max-content">
@@ -153,36 +173,6 @@ class="inline-flex text-xs"
         </aside>
          <br><br>
          <div class="ml-6 mr-6 pl-2 w-2/3 p-2" style="width: 100%">
-            <h1 class="pl-2 pr-2 break-normal text-black break-normal font-sans text-black font-medium">
-                Search・Sort settings
-            </h1>
-            <hr class="border-b border-gray-300">
-            <br>
-            <section class="pt-5 pl-2 pr-2 pb-5 border mb-10 rounded bg-white shadow">
-                <div class="font-sans">
-                    <h2 class="text-sm break-normal text-black break-normal font-sans pb-1 pt-1 text-black">
-                        Filter
-                    </h2>
-                    <p class="text-xs pb-2 font-medium text-gray-500">Hide non matching</code></p>
-                    <input type="text" v-model="filterTerm" @input="filterDocs" class="w-full p-2 border-2 border-gray-300 rounded" placeholder="/api/search">
-                </div>
-            </section>
-            <h1 class="pl-2 pr-2 break-normal text-black break-normal font-sans text-black font-medium">
-                Request Settings (editable)
-            </h1>
-            <hr class="border-b border-gray-300">
-            <br>
-            <section class="pt-5 pl-2 pr-2 pb-5 border mb-10 rounded bg-white shadow">
-                <div class="font-sans">
-                    <h2 class="text-sm break-normal text-black break-normal font-sans pb-1 pt-1 text-black">
-                        Append Request Headers
-                    </h2>
-                    <p class="text-xs pb-2 font-medium text-gray-500">Default headers sent on every request. Format <code>Key:Value</code></p>
-                    <prism-editor
-                        class="my-prism-editor"
-                        style="min-height:100px;background:#2d2d2d;color: #ccc;resize:both" v-model="requestHeaders" :highlight="highlighter" line-numbers></prism-editor>
-                </div>
-            </section>
             <h1 class="pl-2 pr-2 break-normal text-black break-normal font-sans text-black font-medium">
                 Routes List
             </h1>

diff --git a/src/LaravelRequestDocs.php b/src/LaravelRequestDocs.php
@@ -86,10 +86,15 @@ public function getControllersInfo(): array
                     }
                 }
 
+                $middlewares = [];
+                if (!empty($route->action['middleware'])) {
+                    $middlewares = !is_array($route->action['middleware']) ? [$route->action['middleware']] : $route->action['middleware'];
+                }
+
                 $controllersInfo[] = [
                     'uri'                   => $route->uri,
                     'methods'               => $route->methods,
-                    'middlewares'           => !is_array($route->action['middleware']) ? [$route->action['middleware']] : $route->action['middleware'],
+                    'middlewares'           => $middlewares,
                     'controller'            => $controllerName,
                     'controller_full_path'  => $controllerFullPath,
                     'method'                => $method,

diff --git a/tests/LRDTest.php b/tests/LRDTest.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests;
+use Route;
+
+class LRDTest extends TestCase
+{
+    public function testDocsCount()
+    {
+        $docs = $this->lrd->getDocs();
+        $routes = collect(Route::getRoutes());
+
+        $this->assertSame($routes->count(), count($docs));
+    }
+
+    public function testDocsCanFetchAllMethods()
+    {
+        $docs = $this->lrd->getDocs();
+        $methods = [];
+        foreach ($docs as $doc) {
+            $methods = array_merge($methods, $doc['methods']);
+        }
+        $methods = array_unique($methods);
+        sort($methods);
+        $this->assertSame(['DELETE', 'GET', 'HEAD', 'POST', 'PUT'], $methods);
+    }
+
+    public function testDocsCanFetchInfo()
+    {
+        $docs = $this->lrd->getDocs();
+        foreach ($docs as $doc) {
+            $this->assertNotEmpty($doc['rules']);
+            $this->assertNotEmpty($doc['methods']);
+            // $this->assertNotEmpty($doc['middlewares']); //todo: add middlewares to test
+            $this->assertNotEmpty($doc['controller']);
+            $this->assertNotEmpty($doc['controller_full_path']);
+            $this->assertNotEmpty($doc['method']);
+            $this->assertNotEmpty($doc['httpMethod']);
+            $this->assertNotEmpty($doc['rules']);
+        }
+    }
+}
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -2,15 +2,20 @@
 
 namespace Rakutentech\LaravelRequestDocs\Tests;
 
-use Illuminate\Database\Eloquent\Factories\Factory;
 use Orchestra\Testbench\TestCase as Orchestra;
 use Rakutentech\LaravelRequestDocs\LaravelRequestDocsServiceProvider;
+use Rakutentech\LaravelRequestDocs\LaravelRequestDocs;
+use Illuminate\Support\Facades\Route;
+use Rakutentech\LaravelRequestDocs\Tests\TestControllers;
 
 class TestCase extends Orchestra
 {
+    protected LaravelRequestDocs $lrd;
     public function setUp(): void
     {
         parent::setUp();
+        $this->lrd = new LaravelRequestDocs();
+        $this->registerRoutes();
     }
 
     protected function getPackageProviders($app)
@@ -24,4 +29,12 @@ public function getEnvironmentSetUp($app)
     {
         config()->set('database.default', 'testing');
     }
+
+    public function registerRoutes() {
+        Route::get('/', [TestControllers\WelcomeController::class, 'index']);
+        Route::get('welcome', [TestControllers\WelcomeController::class, 'index']);
+        Route::post('welcome', [TestControllers\WelcomeController::class, 'store']);
+        Route::put('welcome', [TestControllers\WelcomeController::class, 'edit']);
+        Route::delete('welcome', [TestControllers\WelcomeController::class, 'destroy']);
+    }
 }
diff --git a/tests/TestControllers/WelcomeController.php b/tests/TestControllers/WelcomeController.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestControllers;
+
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeIndexRequest;
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeEditRequest;
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeStoreRequest;
+use Rakutentech\LaravelRequestDocs\Tests\TestRequests\WelcomeDeleteRequest;
+
+class WelcomeController
+{
+    public function index(WelcomeIndexRequest $request)
+    {
+        return 1;
+    }
+
+    public function edit(WelcomeEditRequest $request)
+    {
+        return 1;
+    }
+
+    public function store(WelcomeStoreRequest $request)
+    {
+        return 1;
+    }
+
+    public function destroy(WelcomeDeleteRequest $request)
+    {
+        return 1;
+    }
+}
diff --git a/tests/TestRequests/WelcomeDeleteRequest.php b/tests/TestRequests/WelcomeDeleteRequest.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeDeleteRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    protected function prepareForValidation()
+    {
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'message_param' => 'nullable|string',
+        ];
+    }
+}
diff --git a/tests/TestRequests/WelcomeEditRequest.php b/tests/TestRequests/WelcomeEditRequest.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeEditRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    protected function prepareForValidation()
+    {
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'message_param' => 'nullable|string',
+        ];
+    }
+}
diff --git a/tests/TestRequests/WelcomeIndexRequest.php b/tests/TestRequests/WelcomeIndexRequest.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeIndexRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    protected function prepareForValidation()
+    {
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'page'            => 'nullable|integer|min:1',
+            'per_page'        => 'nullable|integer|min:1|max:100',
+        ];
+    }
+}
diff --git a/tests/TestRequests/WelcomeStoreRequest.php b/tests/TestRequests/WelcomeStoreRequest.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Rakutentech\LaravelRequestDocs\Tests\TestRequests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WelcomeStoreRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    protected function prepareForValidation()
+    {
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'message_param' => 'nullable|string',
+        ];
+    }
+}