Refactor + docs (#59)

Author: pascalbaljet

app/app/Http/Controllers/TableController.php

@@ -19,6 +19,20 @@ public function custom()
         ]);
     }
 
+    public function noPerPage()
+    {
+        $users = User::query()->orderBy('name')->paginate(10);
+
+        SpladeTable::defaultPerPageOptions([10]);
+
+        return view('table.users', [
+            'users' => SpladeTable::for($users)
+                ->column('name')
+                ->column('email')
+                ->column('actions'),
+        ]);
+    }
+
     public function rowLink()
     {
         $users = User::query()->orderBy('name')->paginate(10);

app/routes/web.php

@@ -171,6 +171,7 @@
     Route::prefix('table')->group(function () {
         $table = new UserTableView;
 
+        Route::get('/noPerPage', [TableController::class, 'noPerPage'])->name('table.noPerPage');
         Route::get('/custom', [TableController::class, 'custom'])->name('table.custom');
         Route::get('/rowLink', [TableController::class, 'rowLink'])->name('table.rowLink');
 

app/tests/Browser/Table/PaginationTest.php

@@ -8,13 +8,6 @@
 
 class PaginationTest extends DuskTestCase
 {
-    public function fullUrls()
-    {
-        return [
-            ['/table/users/eloquent'],
-        ];
-    }
-
     public function simpleUrls()
     {
         return [
@@ -23,18 +16,17 @@ public function simpleUrls()
         ];
     }
 
-    /**
-     * @test
-     * @dataProvider fullUrls
-     */
-    public function it_generates_a_paginator_with_links($url)
+    /** @test */
+    public function it_generates_a_paginator_with_links()
     {
-        $this->browse(function (Browser $browser) use ($url) {
+        $this->browse(function (Browser $browser) {
             $users = User::query()
                 ->select(['id', 'name'])
                 ->orderBy('name')
                 ->get();
 
+            $url = '/table/users/eloquent';
+
             $browser
                 ->visit($url)
                 ->resize(1920, 1080)
@@ -86,6 +78,22 @@ public function it_generates_a_paginator_with_links($url)
         });
     }
 
+    /** @test */
+    public function it_disabled_the_per_page_selection_on_less_than_two_options()
+    {
+        $this->browse(function (Browser $browser) {
+            $users = User::query()
+                ->select(['id', 'name'])
+                ->orderBy('name')
+                ->get();
+
+            $browser->visit('/table/noPerPage')
+                ->resize(1920, 1080)
+                ->assertSeeIn('tr:first-child td:nth-child(1)', $users->get(0)->name)
+                ->assertMissing('select[name="per_page"]');
+        });
+    }
+
     /**
      * @test
      * @dataProvider simpleUrls

resources/views/table/pagination.blade.php

@@ -10,7 +10,7 @@
             </Link>
         @endif
 
-        @include('splade::table.per-page-selector')
+        @includeWhen($hasPerPageOptions ?? true, 'splade::table.per-page-selector')
 
         @if ($paginator->hasMorePages())
             <Link dusk="pagination-simple-next" href="{{ $paginator->nextPageUrl() }}" class="relative inline-flex items-center px-4 py-2 ml-3 text-xs sm:text-sm font-medium text-gray-700 bg-white border border-gray-300 leading-5 rounded-md hover:text-gray-500 focus:outline-none focus:ring ring-gray-300 focus:border-blue-300 active:bg-gray-100 active:text-gray-700 transition ease-in-out duration-150">
@@ -25,9 +25,9 @@
 
     <div class="hidden md:flex-1 md:flex md:items-center md:justify-between">
         <div class="flex items-center">
-            @include('splade::table.per-page-selector')
+            @includeWhen($hasPerPageOptions ?? true, 'splade::table.per-page-selector')
 
-            <div class="hidden lg:block ml-3">
+            <div class="hidden lg:block @if($hasPerPageOptions ?? true) ml-3 @endif">
                 <p class="text-xs sm:text-sm text-gray-700 leading-5">
                     @if ($paginator->firstItem())
                         <span class="font-medium">{{ $paginator->firstItem() }}</span>

resources/views/table/simple-pagination.blade.php

@@ -10,7 +10,7 @@
         </Link>
     @endif
 
-    @include('splade::table.per-page-selector')
+    @includeWhen($hasPerPageOptions ?? true, 'splade::table.per-page-selector')
 
     {{-- Next Page Link --}}
     @if ($paginator->hasMorePages())

resources/views/table/table.blade.php

@@ -30,7 +30,7 @@
             </x-splade-component>
 
             @if($isPaginated())
-                {{ $table->resource->links($paginationView, ['table' => $table]) }}
+                {{ $table->resource->links($paginationView, ['table' => $table, 'hasPerPageOptions' => $hasPerPageOptions()]) }}
             @endif
         </div>
     </template>

src/Commands/PublishFormStylesheetsCommand.php

@@ -11,6 +11,12 @@ class PublishFormStylesheetsCommand extends Command
 
     public $description = 'Publish the stylesheets for Choices.js and Flatpickr';
 
+    /**
+     * Publishes the stylesheets for the Choices.js and
+     * Flatpickr integrations into the app's resources/css folder.
+     *
+     * @return int
+     */
     public function handle(): int
     {
         (new Filesystem)->ensureDirectoryExists(resource_path('css'));

src/Commands/SpladeInstallCommand.php

@@ -14,6 +14,13 @@ class SpladeInstallCommand extends Command
 
     public $description = 'Install the Splade components and resources';
 
+    /**
+     * Installs the Splade Route Middleware, the Exception Handler, the
+     * required NPM packages and copies all boilerplate files into
+     * the application.
+     *
+     * @return int
+     */
     public function handle(): int
     {
         $this->installRouteMiddleware();
@@ -84,6 +91,11 @@ public static function eol(): string
         return windows_os() ? "\n" : PHP_EOL;
     }
 
+    /**
+     * Adds the SSR build step to the 'build' command.
+     *
+     * @return void
+     */
     protected function updateNodeScript()
     {
         if (!file_exists(base_path('package.json'))) {
@@ -99,7 +111,7 @@ protected function updateNodeScript()
     }
 
     /**
-     * Update the "package.json" file.
+     * Updates the "package.json" file.
      *
      * @param  callable  $callback
      * @param  bool  $dev

src/Commands/SsrTestCommand.php

@@ -13,6 +13,11 @@ class SsrTestCommand extends Command
 
     public $description = 'Test the SSR server';
 
+    /**
+     * Sends a request to the SSR servers and verifies that it rendered correctly.
+     *
+     * @return int
+     */
     public function handle(): int
     {
         $this->info('Testing SSR server: ' . config('splade.ssr.server'));

src/Components/Modal.php

@@ -25,7 +25,7 @@ public function render()
     {
         return $this->splade->isModalRequest()
             ? view(
-                $this->splade->modalType() === SpladeCore::MODAL_TYPE_MODAL ? 'splade::modal' : 'splade::slideover',
+                $this->splade->getModalType() === SpladeCore::MODAL_TYPE_MODAL ? 'splade::modal' : 'splade::slideover',
                 [
                     'closeButton' => $this->closeButton,
                     'modalKey'    => $this->splade->getModalKey(),