Merge branch 'develop'

rappasoft · rappasoft · commit b6e4961afe1d · 2020-08-10T12:06:02.000-04:00
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,37 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->notPath('bootstrap/*')
+    ->notPath('storage/*')
+    ->notPath('resources/view/mail/*')
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => true,
+        'trailing_comma_in_multiline_array' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ]
+    ])
+    ->setFinder($finder);
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,10 +4,31 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
-## [0.1.6] - 2020-06-15
+### Added
+
+- Add pagination reset for perPage updates
+- Add second parameter to view method for the name of the model variable available in the view.
+- Allow publishing of views
+- Make docblocks work with psalm
+- Added searching method either debounce or lazy
+- Allow dot notation for customer attributes
+- Added loading message to table body if $loadingIndicator is true
+- Add clear button option to search box
 
 ### Changed
 
+- Updated Livewire to 1.3
+- $disableSearchOnLoading default to false
+- Trim the search term when processing
+- Added language to publishable translation file
+
+### Removed
+
+- Existing loading subview for tbody message
+
+## [0.1.6] - 2020-06-15
+
+### Changed
 - Add second parameter to view method for the name of the model variable available in the view.
 
 ## [0.1.5] - 2020-05-26
diff --git a/README.md b/README.md
@@ -160,11 +160,12 @@ You can override any of these in your table component:
 | Property | Default | Usage |
 | -------- | ------- | ----- |
 | $searchEnabled | true | Whether or not searching is enabled |
+| $searchUpdateMethod | debounce | debounce or lazy |
 | $searchDebounce | 350 | Amount of time in ms to wait to send the search query and refresh the table |
-| $disableSearchOnLoading | true | Whether or not to disable the search bar when it is searching/loading new data | 
+| $disableSearchOnLoading | false | Whether or not to disable the search bar when it is searching/loading new data | 
 | $search | *none* | The initial search string |
-| $searchLabel | Search... | The placeholder for the search box |
-| $noResultsMessage | There are no results to display for this query. | The message to display when there are no results |
+| $clearSearchButton | false | Adds a clear button to the search input |
+| $clearSearchButtonClass | btn btn-outline-dark | The class applied to the clear button |
 
 #### Sorting
 
@@ -181,21 +182,18 @@ You can override any of these in your table component:
 | $perPageEnabled | true | Displays per page |
 | $perPageOptions | [10, 25, 50] | The options to limit the amount of results per page |
 | $perPage | 25 | Amount of items to show per page |
-| $perPageLabel | Per Page | The label for the per page filter |
 
 #### Loading
 
 | Property | Default | Usage |
 | -------- | ------- | ----- |
 | $loadingIndicator | false | Whether or not to show a loading indicator when searching |
-| $loadingMessage | Loading... | The loading message that gets displayed |
 
 #### Offline
 
 | Property | Default | Usage |
 | -------- | ------- | ----- |
 | $offlineIndicator | true | Whether or not to display an offline message when there is no connection |
-| $offlineMessage | You are not currently connected to the internet. | The message to display when offline | 
 
 #### Checkboxes
 
diff --git a/composer.json b/composer.json
@@ -20,9 +20,11 @@
     ],
     "require": {
         "php": "^7.2.5",
-        "livewire/livewire": "^1.0"
+        "livewire/livewire": "^1.3"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.16",
+        "orchestra/testbench": "^5.0",
         "phpunit/phpunit": "^8.0|^9.0"
     },
     "autoload": {
@@ -37,7 +39,8 @@
     },
     "scripts": {
         "test": "vendor/bin/phpunit",
-        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
+        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
     },
     "config": {
         "sort-packages": true
diff --git a/resources/lang/en/strings.php b/resources/lang/en/strings.php
@@ -0,0 +1,11 @@
+<?php
+
+return [
+    'clear' => 'Clear',
+    'loading' => 'Loading...',
+    'no_results' => 'There are no results to display for this query.',
+    'offline' => 'You are not currently connected to the internet.',
+    'per_page' => 'Per Page',
+    'results' => 'Showing :first to :last out of :total results',
+    'search' => 'Search...',
+];
diff --git a/resources/views/includes/_body.blade.php b/resources/views/includes/_body.blade.php
@@ -1,6 +1,14 @@
-<tbody>
+@if ($loadingIndicator)
+    <tbody wire:loading>
+        <tr><td colspan="{{ collect($columns)->count() }}">@lang('laravel-livewire-tables::strings.loading')</td></tr>
+    </tbody>
+
+    <tbody wire:loading.remove>
+@else
+    <tbody>
+@endif
     @if($models->isEmpty())
-        <tr><td colspan="{{ collect($columns)->count() }}">{{ $noResultsMessage }}</td></tr>
+        <tr><td colspan="{{ collect($columns)->count() }}">@lang('laravel-livewire-tables::strings.no_results')</td></tr>
     @else
         @foreach($models as $model)
             <tr
@@ -41,19 +49,19 @@ class="{{ $this->setTableDataClass($column->attribute, Arr::get($model->toArray(
                         @else
                             @if ($column->isHtml())
                                 @if ($column->isCustomAttribute())
-                                    {{ new \Illuminate\Support\HtmlString($model->{$column->attribute}) }}
+                                    {{ new \Illuminate\Support\HtmlString(data_get($model, $column->attribute)) }}
                                 @else
                                     {{ new \Illuminate\Support\HtmlString(Arr::get($model->toArray(), $column->attribute)) }}
                                 @endif
                             @elseif ($column->isUnescaped())
                                 @if ($column->isCustomAttribute())
-                                    {!! $model->{$column->attribute} !!}
+                                    {!! data_get($model, $column->attribute) !!}
                                 @else
                                     {!! Arr::get($model->toArray(), $column->attribute) !!}
                                 @endif
                             @else
                                 @if ($column->isCustomAttribute())
-                                    {{ $model->{$column->attribute} }}
+                                    {{ data_get($model, $column->attribute) }}
                                 @else
                                     {{ Arr::get($model->toArray(), $column->attribute) }}
                                 @endif
diff --git a/resources/views/includes/_loading.blade.php b/resources/views/includes/_loading.blade.php
diff --git a/resources/views/includes/_offline.blade.php b/resources/views/includes/_offline.blade.php
@@ -2,7 +2,7 @@
     <div class="row">
         <div class="col-12">
             <div wire:offline class="alert alert-danger">
-                <i class="fa fa-info-circle"></i> {{ $offlineMessage }}
+                <i class="fa fa-info-circle"></i> @lang('laravel-livewire-tables::strings.offline')
             </div>
         </div>
     </div>
diff --git a/resources/views/includes/_options.blade.php b/resources/views/includes/_options.blade.php
@@ -2,7 +2,7 @@
     <div class="row mb-4">
         @if ($paginationEnabled && $perPageEnabled)
             <div class="col form-inline">
-                {{ $perPageLabel }}: &nbsp;
+                @lang('laravel-livewire-tables::strings.per_page'): &nbsp;
 
                 <select wire:model="perPage" class="form-control">
                     @if (is_array($perPageOptions))
@@ -20,13 +20,23 @@
 
         @if ($searchEnabled)
             <div class="col">
-                <input
-                    @if (is_numeric($searchDebounce)) wire:model.debounce.{{ $searchDebounce }}ms="search" @endif
-                    @if ($disableSearchOnLoading) wire:loading.attr="disabled" @endif
-                    class="form-control"
-                    type="text"
-                    placeholder="{{ $searchLabel }}"
-                />
+                @if ($clearSearchButton)
+                    <div class="input-group">
+                @endif
+                    <input
+                        @if (is_numeric($searchDebounce) && $searchUpdateMethod === 'debounce') wire:model.debounce.{{ $searchDebounce }}ms="search" @endif
+                        @if ($searchUpdateMethod === 'lazy') wire:model.lazy="search" @endif
+                        @if ($disableSearchOnLoading) wire:loading.attr="disabled" @endif
+                        class="form-control"
+                        type="text"
+                        placeholder="{{ __('laravel-livewire-tables::strings.search') }}"
+                    />
+                @if ($clearSearchButton)
+                        <div class="input-group-append">
+                            <button class="{{ $clearSearchButtonClass }}" type="button" wire:click="clearSearch">@lang('laravel-livewire-tables::strings.clear')</button>
+                        </div>
+                    </div>
+                @endif
             </div>
         @endif
     </div>
diff --git a/resources/views/includes/_pagination.blade.php b/resources/views/includes/_pagination.blade.php
@@ -5,7 +5,11 @@
         </div>
 
         <div class="col text-right text-muted">
-            {{ __('Showing :first to :last out of :total results', ['first' => $models->count() ? $models->firstItem() : 0, 'last' => $models->count() ? $models->lastItem() : 0, 'total' => $models->total()]) }}
+            @lang('laravel-livewire-tables::strings.results', [
+                'first' => $models->count() ? $models->firstItem() : 0,
+                'last' => $models->count() ? $models->lastItem() : 0,
+                'total' => $models->total()
+            ])
         </div>
     </div>
 @endif
diff --git a/resources/views/table-component.blade.php b/resources/views/table-component.blade.php
@@ -7,7 +7,6 @@
 @endif
     @include('laravel-livewire-tables::includes._offline')
     @include('laravel-livewire-tables::includes._options')
-    @include('laravel-livewire-tables::includes._loading')
 
     @if (is_string($responsive))
         <div class="{{ $responsive }}">
diff --git a/src/LivewireTablesServiceProvider.php b/src/LivewireTablesServiceProvider.php
@@ -15,5 +15,15 @@ class LivewireTablesServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->loadViewsFrom(__DIR__.'/../resources/views', 'laravel-livewire-tables');
+
+        $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'laravel-livewire-tables');
+
+        $this->publishes([
+            __DIR__.'/../resources/views' => resource_path('views/vendor/laravel-livewire-tables'),
+        ]);
+
+        $this->publishes([
+            __DIR__.'/../resources/lang' => resource_path('lang/vendor/laravel-livewire-tables'),
+        ]);
     }
 }
diff --git a/src/TableComponent.php b/src/TableComponent.php
@@ -49,38 +49,12 @@ abstract class TableComponent extends Component
     public $refresh = false;
 
     /**
-     * Use constructor instead of mount so that the child classes have access to a mount method that they can accept parameters in.
-     *
-     * TableComponent constructor.
-     *
-     * @param $id
-     */
-    public function __construct($id)
-    {
-        parent::__construct($id);
-
-        $this->setTranslationStrings();
-    }
-
-    /**
-     * Sets the initial translations of these items.
-     */
-    public function setTranslationStrings()
-    {
-        $this->loadingMessage = __('Loading...');
-        $this->offlineMessage = __('You are not currently connected to the internet.');
-        $this->noResultsMessage = __('There are no results to display for this query.');
-        $this->perPageLabel = __('Per Page');
-        $this->searchLabel = __('Search...');
-    }
-
-    /**
-     * @return mixed
+     * @return \Illuminate\Database\Eloquent\Builder
      */
     abstract public function query(): Builder;
 
     /**
-     * @return mixed
+     * @return array
      */
     abstract public function columns(): array;
 
@@ -115,15 +89,15 @@ public function models(): Builder
                 foreach ($this->columns() as $column) {
                     if ($column->searchable) {
                         if (is_callable($column->searchCallback)) {
-                            $builder = app()->call($column->searchCallback, ['builder' => $builder, 'term' => $this->search]);
+                            $builder = app()->call($column->searchCallback, ['builder' => $builder, 'term' => trim($this->search)]);
                         } elseif (Str::contains($column->attribute, '.')) {
                             $relationship = $this->relationship($column->attribute);
 
                             $builder->orWhereHas($relationship->name, function (Builder $builder) use ($relationship) {
-                                $builder->where($relationship->attribute, 'like', '%'.$this->search.'%');
+                                $builder->where($relationship->attribute, 'like', '%'.trim($this->search).'%');
                             });
                         } else {
-                            $builder->orWhere($builder->getModel()->getTable().'.'.$column->attribute, 'like', '%'.$this->search.'%');
+                            $builder->orWhere($builder->getModel()->getTable().'.'.$column->attribute, 'like', '%'.trim($this->search).'%');
                         }
                     }
                 }
diff --git a/src/Traits/Checkboxes.php b/src/Traits/Checkboxes.php
@@ -7,10 +7,6 @@
  */
 trait Checkboxes
 {
-    /**
-     * Checboxes.
-     */
-
     /**
      * Whether or not checkboxes are enabled.
      *
@@ -46,7 +42,10 @@ trait Checkboxes
      */
     public $checkboxValues = [];
 
-    public function updatedCheckboxAll()
+    /**
+     * Adds all the id's to the checkbox array.
+     */
+    public function updatedCheckboxAll(): void
     {
         $this->checkboxValues = [];
 
@@ -57,7 +56,10 @@ public function updatedCheckboxAll()
         }
     }
 
-    public function updatedCheckboxValues()
+    /**
+     * Toggles the checkbox that selects/deselects all of the checkboxes.
+     */
+    public function updatedCheckboxValues(): void
     {
         $this->checkboxAll = false;
     }
diff --git a/src/Traits/Loading.php b/src/Traits/Loading.php
@@ -16,12 +16,12 @@ trait Loading
      *
      * @var bool
      */
-    public $loadingIndicator = false;
+    public $loadingIndicator = true;
 
     /**
-     * The loading message that gets displayed.
+     * Whether or not to disable the search bar when it is searching/loading new data.
      *
-     * @var string
+     * @var bool
      */
-    public $loadingMessage;
+    public $disableSearchOnLoading = false;
 }
diff --git a/src/Traits/Offline.php b/src/Traits/Offline.php
@@ -17,11 +17,4 @@ trait Offline
      * @var bool
      */
     public $offlineIndicator = true;
-
-    /**
-     * The message to display when offline.
-     *
-     * @var string
-     */
-    public $offlineMessage;
 }
diff --git a/src/Traits/Pagination.php b/src/Traits/Pagination.php
diff --git a/src/Traits/Search.php b/src/Traits/Search.php
diff --git a/src/Traits/Yajra.php b/src/Traits/Yajra.php
diff --git a/src/Views/Button.php b/src/Views/Button.php
diff --git a/src/Views/Column.php b/src/Views/Column.php
diff --git a/src/Views/Link.php b/src/Views/Link.php
