Merge pull request #8 from WatheqAlshowaiter/feat/exclude-model-default-attributes

Feat/exclude model default attributes

Author: WatheqAlshowaiter

.github/workflows/fix-php-code-style-issues.yml

@@ -4,6 +4,7 @@ on:
   push:
     paths:
       - "**.php"
+  pull_request:
   workflow_dispatch:
 
 permissions:

.github/workflows/tests-for-databases.yml

@@ -9,6 +9,7 @@ on:
       - "phpunit.xml.dist"
       - "composer.json"
       - "composer.lock"
+    pull_request:
   workflow_dispatch:
 
 jobs:

.github/workflows/tests-for-laravel-versions.yml

@@ -9,6 +9,7 @@ on:
       - "phpunit.xml.dist"
       - "composer.json"
       - "composer.lock"
+  pull_request:
   workflow_dispatch:
 
 jobs:

src/RequiredFields.php

@@ -11,9 +11,10 @@ trait RequiredFields
     /**
      * Get only required fields for the model that
      * need to be added while creating a new record in the database.
-     * So, we ignore auto_increment, primary keys, nullable and default fields.
+     * So, we ignore auto_increment, primary keys, nullable
+     * and default fields (either from database or application).
      *
-     * @return array
+     * @return array<string>
      */
     public static function getRequiredFields(
         $withNullables = false,
@@ -28,6 +29,8 @@ public static function getRequiredFields(
             );
         }
 
+        $modelDefaultAttributes = self::getModelDefaultAttributes();
+
         $primaryIndex = collect(Schema::getIndexes((new self)->getTable()))
             ->filter(function ($index) {
                 return $index['primary'];
@@ -50,6 +53,9 @@ public static function getRequiredFields(
                     $column['default'] != null && ! $withDefaults ||
                     (in_array($column['name'], $primaryIndex));
             })
+            ->reject(function ($column) use ($modelDefaultAttributes, $withDefaults) {
+                return in_array($column['name'], $modelDefaultAttributes) && ! $withDefaults;
+            })
             ->pluck('name')
             ->when($withPrimaryKey, function ($collection) use ($primaryIndex) {
                 return $collection->prepend(...$primaryIndex);
@@ -105,6 +111,7 @@ protected static function getRequiredFieldsForSqlite(
         $withPrimaryKey = false
     ) {
         $table = self::getTableFromThisModel();
+        $modelDefaultAttributes = self::getModelDefaultAttributes();
 
         $queryResult = DB::select(/** @lang SQLite */ "PRAGMA table_info($table)");
 
@@ -117,8 +124,12 @@ protected static function getRequiredFieldsForSqlite(
                     || $column['dflt_value'] != null && ! $withDefaults
                     || ! $column['notnull'] && ! $withNullables;
             })
+            ->reject(function ($column) use ($modelDefaultAttributes, $withDefaults) {
+                return in_array($column['name'], $modelDefaultAttributes) && ! $withDefaults;
+            })
             ->pluck('name')
             ->toArray();
+
     }
 
     protected static function getRequiredFieldsForMysqlAndMariaDb(
@@ -127,6 +138,7 @@ protected static function getRequiredFieldsForMysqlAndMariaDb(
         $withPrimaryKey = false
     ) {
         $table = self::getTableFromThisModel();
+        $modelDefaultAttributes = self::getModelDefaultAttributes();
 
         $queryResult = DB::select(
             /** @lang SQLite */ "
@@ -162,6 +174,9 @@ protected static function getRequiredFieldsForMysqlAndMariaDb(
                     || $column['default'] != null && ! $withDefaults
                     || $column['nullable'] && ! $withNullables;
             })
+            ->reject(function ($column) use ($modelDefaultAttributes, $withDefaults) {
+                return in_array($column['name'], $modelDefaultAttributes) && ! $withDefaults;
+            })
             ->pluck('name')
             ->toArray();
     }
@@ -172,6 +187,7 @@ protected static function getRequiredFieldsForPostgres(
         $withPrimaryKey = false
     ) {
         $table = self::getTableFromThisModel();
+        $modelDefaultAttributes = self::getModelDefaultAttributes();
 
         $primaryIndex = DB::select(/** @lang PostgreSQL */ "
             SELECT
@@ -234,6 +250,9 @@ protected static function getRequiredFieldsForPostgres(
                     ($column['nullable'] == 'YES' && ! $withNullables) ||
                     (in_array($column['name'], $primaryIndex));
             })
+            ->reject(function ($column) use ($modelDefaultAttributes, $withDefaults) {
+                return in_array($column['name'], $modelDefaultAttributes) && ! $withDefaults;
+            })
             ->pluck('name')
             ->when($withPrimaryKey, function ($collection) use ($primaryIndex) {
                 return $collection->prepend(...$primaryIndex);
@@ -248,6 +267,7 @@ protected static function getRequiredFieldsForSqlServer(
         $withPrimaryKey = false
     ) {
         $table = self::getTableFromThisModel();
+        $modelDefaultAttributes = self::getModelDefaultAttributes();
 
         $primaryIndex = DB::select(/** @lang TSQL */ '
             SELECT
@@ -295,6 +315,9 @@ protected static function getRequiredFieldsForSqlServer(
                     || $column['nullable'] && ! $withNullables
                     || (in_array($column['name'], $primaryIndex) && ! $withPrimaryKey);
             })
+            ->reject(function ($column) use ($modelDefaultAttributes, $withDefaults) {
+                return in_array($column['name'], $modelDefaultAttributes) && ! $withDefaults;
+            })
             ->pluck('name')
             ->toArray();
     }
@@ -309,6 +332,14 @@ protected static function getTableFromThisModel()
         return str_replace('.', '__', $table);
     }
 
+    /**
+     * @return array<string>
+     */
+    protected static function getModelDefaultAttributes()
+    {
+        return array_keys((new self)->getAttributes());
+    }
+
     public static function getRequiredFieldsWithNullables()
     {
         return self::getRequiredFields($withNullables = true, $withDefaults = false, $withPrimaryKey = false);

tests/Models/Brother.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace WatheqAlshowaiter\ModelRequiredFields\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use WatheqAlshowaiter\ModelRequiredFields\RequiredFields;
+
+class Brother extends Model
+{
+    use RequiredFields;
+
+    protected $attributes = [
+        'name' => 'default-user', // default
+        'another' => '', // non-valid default
+        'non-existed-field' => 'some-random-value', // non-existed field in the database
+    ];
+}

tests/RequiredFieldsTest.php

@@ -1,10 +1,12 @@
 <?php
 
+namespace WatheqAlshowaiter\ModelRequiredFields\Tests;
+
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use WatheqAlshowaiter\ModelRequiredFields\Tests\Models\Brother;
 use WatheqAlshowaiter\ModelRequiredFields\Tests\Models\Father;
 use WatheqAlshowaiter\ModelRequiredFields\Tests\Models\Mother;
 use WatheqAlshowaiter\ModelRequiredFields\Tests\Models\Son;
-use WatheqAlshowaiter\ModelRequiredFields\Tests\TestCase;
 
 class RequiredFieldsTest extends TestCase
 {
@@ -246,4 +248,22 @@ public function test_get_required_fields_for_son_model_for_older_versions()
             'father_id',
         ], Son::getRequiredFieldsForOlderVersions());
     }
+
+    public function test_get_required_fields_excluding_default_model_attributes()
+    {
+        $this->assertEquals([
+            'email',
+        ], Brother::getRequiredFields());
+    }
+
+    public function test_get_required_fields_with_applications_defaults()
+    {
+        $expected = [
+            'email',
+            'name',
+        ];
+
+        $this->assertEquals($expected, Brother::getRequiredFieldsWithDefaults());
+        $this->assertEquals($expected, Brother::getRequiredFields($withNullables = false, $withDefaults = true));
+    }
 }

tests/database/migrations/2025_02_14_100247_create_brothers_table.php

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateBrothersTable extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('brothers', function (Blueprint $table) {
+            $table->string('email'); // required
+            $table->string('name'); // default => ignored because it has the default value in the model $attributes
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('brothers');
+    }
+}