Merge pull request #92 from yajra/patch

fix: editor stub with generics

Author: yajra

composer.json

@@ -25,9 +25,9 @@
     },
     "require-dev": {
         "larastan/larastan": "^3.1",
-        "laravel/pint": "^1.21",
-        "orchestra/testbench": "^10.0",
-        "rector/rector": "^2.0.9"
+        "laravel/pint": "^1.21.2",
+        "orchestra/testbench": "^10.1",
+        "rector/rector": "^2.0.10"
     },
     "autoload": {
         "psr-4": {

phpstan.neon.dist

@@ -15,7 +15,6 @@ parameters:
         -   identifier: binaryOp.invalid
         -   identifier: offsetAccess.nonOffsetAccessible
         -   identifier: return.type
-        -   identifier: method.nonObject
         -   identifier: assign.propertyType
 
     excludePaths:

src/DataTablesEditor.php

@@ -223,7 +223,11 @@ protected function getBuilder(): Builder
      */
     protected function resolveModel(): Model
     {
-        if (! $this->model instanceof Model) {
+        if (is_null($this->model)) {
+            throw new DataTablesEditorException('Model not set.');
+        }
+
+        if (is_string($this->model)) {
             $this->model = new $this->model;
         }
 
@@ -233,9 +237,7 @@ protected function resolveModel(): Model
     }
 
     /**
-     * Set model unguard state.
-     *
-     * @return $this
+     * Set model unguarded state.
      */
     public function unguard(bool $state = true): static
     {

src/Generators/stubs/editor.stub

@@ -9,6 +9,9 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Validation\Rule;
 use Yajra\DataTables\DataTablesEditor;
 
+/**
+ * @extends DataTablesEditor<ModelName>
+ */
 class DummyClass extends DataTablesEditor
 {
     protected $model = ModelName::class;

tests/Feature/DataTablesEditorCreateTest.php

@@ -24,11 +24,37 @@ public function it_can_process_create_request()
 
         $data = $response->json()['data'][0];
         $this->assertArrayHasKey('id', $data);
+        $this->assertEquals(1, $data['DT_RowId']);
         $this->assertEquals(1, $data['id']);
         $this->assertEquals('Taylor', $data['name']);
         $this->assertEquals('taylor@laravel.com', $data['email']);
     }
 
+    #[Test]
+    public function it_does_not_process_not_fillable_columns()
+    {
+        $response = $this->postJson('users', [
+            'action' => 'create',
+            'data' => [
+                0 => [
+                    'name' => 'Taylor',
+                    'email' => 'taylor@laravel.com',
+                    'role' => 'admin',
+                ],
+            ],
+        ]);
+
+        $this->assertDatabaseHas('users', ['id' => 1]);
+
+        $data = $response->json()['data'][0];
+        $this->assertArrayHasKey('id', $data);
+        $this->assertEquals(1, $data['DT_RowId']);
+        $this->assertEquals(1, $data['id']);
+        $this->assertEquals('Taylor', $data['name']);
+        $this->assertEquals('taylor@laravel.com', $data['email']);
+        $this->assertNotContains('role', $data);
+    }
+
     #[Test]
     public function it_allows_created_callback_and_returns_the_modified_model()
     {
@@ -77,4 +103,29 @@ public function it_can_validate_invalid_inputs()
         $this->assertEquals('name', $errors[1]['name']);
         $this->assertEquals('The name field is required.', $errors[1]['status']);
     }
+
+    #[Test]
+    public function it_can_set_the_model_to_unguarded_state(): void
+    {
+        $response = $this->postJson('users-unguarded', [
+            'action' => 'create',
+            'data' => [
+                0 => [
+                    'name' => 'Taylor',
+                    'email' => 'taylor@laravel.com',
+                    'role' => 'admin',
+                ],
+            ],
+        ]);
+
+        $this->assertDatabaseHas('users', ['id' => 1]);
+
+        $data = $response->json()['data'][0];
+        $this->assertArrayHasKey('id', $data);
+        $this->assertEquals(1, $data['DT_RowId']);
+        $this->assertEquals(1, $data['id']);
+        $this->assertEquals('Taylor', $data['name']);
+        $this->assertEquals('taylor@laravel.com', $data['email']);
+        $this->assertEquals('admin', $data['role']);
+    }
 }

tests/Models/Post.php

@@ -3,12 +3,13 @@
 namespace Yajra\DataTables\Tests\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
 class Post extends Model
 {
     protected $guarded = [];
 
-    public function user()
+    public function user(): BelongsToMany
     {
         return $this->belongsToMany(User::class);
     }

tests/Models/User.php

@@ -3,12 +3,17 @@
 namespace Yajra\DataTables\Tests\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 
 class User extends Model
 {
-    protected $guarded = [];
+    protected $fillable = [
+        'name',
+        'email',
+        'password',
+    ];
 
-    public function posts()
+    public function posts(): HasMany
     {
         return $this->hasMany(Post::class);
     }

tests/TestCase.php

@@ -31,13 +31,15 @@ protected function migrateDatabase(): void
             $table->string('name');
             $table->string('email');
             $table->string('password')->nullable();
+            $table->string('role')->nullable();
             $table->timestamps();
         });
     }
 
     protected function defineRoutes($router): void
     {
         $router->post('users', fn (UsersDataTableEditor $editor, Request $request) => $editor->process($request));
+        $router->post('users-unguarded', fn (UsersDataTableEditor $editor, Request $request) => $editor->unguard()->process($request));
 
         $router->post(
             'usersWithEvents',