Merge pull request #114 from Gustavinho/feature/use-a-model-class-in-the-data-views

feat: Use a model class as initial data

Author: Gustavinho

README.md

@@ -75,7 +75,7 @@ php artisan make:table-view UsersTableView
 ```
 With this artisan command a UsersTableView.php file will be created inside the `app/Http/Livewire` directory.
 
-The basic usage needs a data repository (Eloquent query), headers and rows, you can customize the items to be shown, and the headers and data for each row like this example
+The basic usage needs a model class, headers and rows, you can customize the items to be shown, and the headers and data for each row like this example
 ```php
 <?php
 
@@ -87,10 +87,7 @@ use App\User;
 
 class UsersTableView extends TableView
 {
-    public function repository(): Builder
-    {
-        return User::query();
-    }
+    protected $model = User::class;
 
     public function headers(): array
     {
@@ -128,7 +125,7 @@ You could also use the `@livewire` blade directive.
 
 At this point, you would be able to see a table with some data, the table view doesn't have any styled container or title as the image example, you can render the table view inside any container you want.
 
-In the example above the view is using the User model created by default in every Laravel project, feel free to use any model you have, the method `row` is receiving a sinlge model object and you can use any property or public method you have difined inside your model.
+In the example above the view is using the User model created by default in every Laravel project, feel free to use any model you want, the method `row` is receiving a sinlge model object and you can use any property or public method you have difined inside your model.
 
 This is the basic usage of the table view, but you can customize it with more features.
 
@@ -183,7 +180,7 @@ Here's the plan for what's coming:
 ### From 2.2 to 2.3
 - Clear your cached views `php artisan view:clear` since some of the internal components changed.
 - Update components
-- Update the renderIf() function in your action classes as follows: 
+- Update the renderIf() function in your action classes as follows:
   ```php
   <?php
 
@@ -200,3 +197,4 @@ Here's the plan for what's coming:
       }
   }
   ```
+- **(Optional)**, if your `repository` methods are returning the query object without any query applied like `User::query()`, you can define a `protected $model = User::class;` instead, this is the default behavior now, the `repository` method is still working so you don't need to change anything if you don't want to.

doc/grid-view.md

@@ -31,17 +31,33 @@ With this artisan command a `ExampleGridView.php` file will be created inside `a
 
 ## Defining initial data
 
-Return an `Eloquent` query with the initial data to be displayed on the grid view, it is important to return the query, not the data collection.
+The GridView class needs a model class to get the initial data to be displayed on the table, you can define it in the `$model` property.
 
 ```php
 use App\User;
 
+protected $model = User::class;
+```
+
+If you need an specific query as initial data you can define a `repository` method  returning an `Eloquent` query with the initial data to be displayed on the grid view, it is important to return the query, not the data collection.
+
+```php
+use App\User;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * Sets a initial query with the data to fill the table
+ *
+ * @return Builder Eloquent query
+ */
 public function repository(): Builder
 {
     return User::query();
 }
 ```
 
+If you define this method, the `$model` property is not needed anymore.
+
 ## Defining card data
 
 You have to define a public function returning an array with the data that will be displayed on each card, this array has to include `photo`, `title`, `subtitle` and the `description`.

doc/list-view.md

@@ -31,16 +31,31 @@ With this artisan command an `ExampleListView.php` file will be created inside t
 
 ## Defining initial data
 
-You should return an `Eloquent` query with the initial data to be displayed on the list view, it is important to return the query, not the data collection.
+The ListView class needs a model class to get the initial data to be displayed on the table, you can define it in the `$model` property.
 
 ```php
 use App\User;
 
+protected $model = User::class;
+```
+
+If you need an specific query as initial data you can define a `repository` method  returning an `Eloquent` query with the initial data to be displayed on the list view, it is important to return the query, not the data collection.
+
+```php
+use App\User;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * Sets a initial query with the data to fill the table
+ *
+ * @return Builder Eloquent query
+ */
 public function repository(): Builder
 {
     return User::query();
 }
 ```
+If you define this method, the `$model` property is not needed anymore.
 
 ## Defining data for each list item
 

doc/table-view.md

@@ -44,17 +44,33 @@ php artisan make:table-view UsersTableView
 With this artisan command a `UsersTableView.php` file will be created inside `app/Http/Livewire` directory, with this class you can customize the behavior of the table view.
 
 ## Defining initial data
-Return an `Eloquent` query with the initial data to be displayed on the table, it is important to return the query, not the data collection.
+The TableView class needs a model class to get the initial data to be displayed on the table, you can define it in the `$model` property.
 
 ```php
 use App\User;
 
+protected $model = User::class;
+```
+
+If you need an specific query as initial data you can define a `repository` method  returning an `Eloquent` query with the initial data to be displayed on the table, it is important to return the query, not the data collection.
+
+```php
+use App\User;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * Sets a initial query with the data to fill the table
+ *
+ * @return Builder Eloquent query
+ */
 public function repository(): Builder
 {
     return User::query();
 }
 ```
 
+If you define this method, the `$model` property is not needed anymore.
+
 ## Headers
 Return an array with all the headers you need
 

src/Views/DataView.php

@@ -93,7 +93,11 @@ protected function getRenderData()
      */
     public function getItems(Searchable $searchable, Filterable $filterable, Sortable $sortable)
     {
-        $query = $this->repository();
+        if (method_exists($this, 'repository')) {
+            $query = $this->repository();
+        } else {
+            $query = $this->model::query();
+        }
 
         $query = $searchable->searchItems($query, $this->searchBy, $this->search);
 

stubs/grid-view.stub

@@ -8,14 +8,9 @@ use Illuminate\Database\Eloquent\Builder;
 class DummyClass extends GridView
 {
     /**
-     * Sets a initial query with the data to fill the grid view
-     *
-     * @return Builder Eloquent query
+     * Sets a model class to get the initial data
      */
-    public function repository(): Builder
-    {
-        // return User::query();
-    }
+    protected $model = User::class;
 
     /**
      * Sets the data to every card on the view

stubs/list-view.stub

@@ -8,14 +8,9 @@ use Illuminate\Database\Eloquent\Builder;
 class DummyClass extends ListView
 {
     /**
-     * Sets a initial query with the data to fill the table
-     *
-     * @return Builder Eloquent query
+     * Sets a model class to get the initial data
      */
-    public function repository(): Builder
-    {
-        // return User::query();
-    }
+    protected $model = User::class;
 
     /**
      * Sets the properties to every list item component

stubs/table-view.stub

@@ -3,19 +3,13 @@
 namespace DummyNamespace;
 
 use LaravelViews\Views\TableView;
-use Illuminate\Database\Eloquent\Builder;
 
 class DummyClass extends TableView
 {
     /**
-     * Sets a initial query with the data to fill the table
-     *
-     * @return Builder Eloquent query
+     * Sets a model class to get the initial data
      */
-    public function repository(): Builder
-    {
-        // return User::query();
-    }
+    protected $model = User::class;
 
     /**
      * Sets the headers of the table as you want to be displayed

tests/Feature/TableViewTest.php

@@ -6,6 +6,7 @@
 use LaravelViews\Test\Mock\MockTableView;
 use LaravelViews\Test\TestCase;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use LaravelViews\Test\Mock\MockTableViewWithModelClass;
 use Livewire\Livewire;
 
 class TableViewTest extends TestCase
@@ -30,4 +31,12 @@ public function testSeeAllDataOnTheTable()
         Livewire::test(MockTableView::class)
             ->assertSeeUsers($users);
     }
+
+    public function testSeeAllDataSettingAModelClass()
+    {
+        $users = factory(UserTest::class, 7)->create();
+
+        Livewire::test(MockTableViewWithModelClass::class)
+            ->assertSeeUsers($users);
+    }
 }

tests/Mock/MockTableViewWithModelClass.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace LaravelViews\Test\Mock;
+
+use LaravelViews\Test\Database\UserTest;
+use LaravelViews\Views\TableView;
+use Illuminate\Database\Eloquent\Builder;
+
+class MockTableViewWithModelClass extends TableView
+{
+    protected $model = UserTest::class;
+
+    public function headers()
+    {
+        return [
+            'name',
+            'email'
+        ];
+    }
+
+    public function row(UserTest $user)
+    {
+        return [
+            $user->name,
+            $user->email
+        ];
+    }
+}