Use nullable attributes when saving model

Author: MCMatters

composer.json

@@ -21,9 +21,6 @@
     "autoload": {
         "psr-4": {
             "McMatters\\NullableAttributes\\": "src/"
-        },
-        "files": [
-            "src/helpers.php"
-        ]
+        }
     }
 }

config/nullable-attributes.php

@@ -3,5 +3,6 @@
 declare(strict_types = 1);
 
 return [
-    'folder' => base_path().'/app/Models',
+    'folder' => base_path('app/Models'),
+    'cache'  => storage_path('app/nullable_attributes.php'),
 ];

src/Console/Cache.php

@@ -4,9 +4,11 @@
 
 namespace McMatters\NullableAttributes\Console;
 
-use File;
 use Illuminate\Console\Command;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\Pivot;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\File;
 use ReflectionClass;
 use ReflectionException;
 use Symfony\Component\ClassLoader\ClassMapGenerator;
@@ -33,21 +35,24 @@ class Cache extends Command
      */
     public function handle()
     {
-        $models = $this->loadModels();
+        $models = $this->getModels();
         $nullables = $this->findNullables($models);
+
         $content = '<?php'.PHP_EOL.'return '.var_export($nullables, true).';';
-        $fileName = storage_path('app/nullable_attributes.php');
+        $fileName = config('nullable-attributes.cache');
         File::put($fileName, $content);
+
         $this->info("Successfully written to the {$fileName}");
     }
 
     /**
      * @return array
      */
-    protected function loadModels(): array
+    protected function getModels(): array
     {
         $models = [];
-        $dir = config('nullable-attributes.folder');
+        $dir = config('nullable-attributes.models');
+
         foreach (ClassMapGenerator::createMap($dir) as $model => $path) {
             try {
                 $reflection = new ReflectionClass($model);
@@ -56,6 +61,7 @@ protected function loadModels(): array
             }
 
             if ($reflection->isInstantiable() &&
+                !$reflection->isSubclassOf(Pivot::class) &&
                 $reflection->isSubclassOf(Model::class)
             ) {
                 $models[] = $model;
@@ -73,10 +79,43 @@ protected function loadModels(): array
     protected function findNullables(array $models): array
     {
         $nullables = [];
+
         foreach ($models as $model) {
-            $nullables[$model] = get_model_nullable_attributes($model);
+            $nullables[$model] = $this->getNullablesFromDb($model);
         }
 
         return $nullables;
     }
+
+    /**
+     * @param string $model
+     *
+     * @return array
+     */
+    protected function getNullablesFromDb(string $model): array
+    {
+        static $manager;
+
+        if (null === $manager) {
+            $manager = DB::getDoctrineSchemaManager();
+        }
+
+        $attributes = [];
+
+        $table = (new $model)->getTable();
+        /** @var array $columns */
+        $columns = $manager->tryMethod('listTableColumns', $table);
+
+        if (!$columns) {
+            return [];
+        }
+
+        foreach ($columns as $column) {
+            if (!$column->getNotnull() && null === $column->getDefault()) {
+                $attributes[] = $column->getName();
+            }
+        }
+
+        return $attributes;
+    }
 }

src/Console/Clear.php

@@ -4,8 +4,8 @@
 
 namespace McMatters\NullableAttributes\Console;
 
-use File;
 use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
 
 /**
  * Class Clear
@@ -29,7 +29,7 @@ class Clear extends Command
      */
     public function handle()
     {
-        $fileName = storage_path('app/nullable_attributes.php');
+        $fileName = config('nullable-attributes.cache');
         File::delete($fileName);
         $this->info("Successfully removed {$fileName}");
     }

src/ServiceProvider.php

@@ -18,25 +18,21 @@ class ServiceProvider extends BaseServiceProvider
      */
     public function boot()
     {
+        $configPath = __DIR__.'/../config/nullable-attributes.php';
+
         $this->publishes([
-            __DIR__.'/../config/nullable-attributes.php' => config_path(
-                'nullable-attributes.php'
-            ),
-        ]);
+            $configPath => config_path('nullable-attributes.php'),
+        ], 'config');
+
+        $this->mergeConfigFrom($configPath, 'nullable-attributes');
+
+        $this->setNullableAttributes();
     }
 
     /**
      * Register methods.
      */
     public function register()
-    {
-        $this->registerCommands();
-    }
-
-    /**
-     * Register commands.
-     */
-    protected function registerCommands()
     {
         $this->app->singleton('command.nullable-attributes.cache', function () {
             return new Console\Cache();
@@ -50,4 +46,16 @@ protected function registerCommands()
             'command.nullable-attributes.clear',
         ]);
     }
+
+    /**
+     * @return void
+     */
+    protected function setNullableAttributes()
+    {
+        $cacheFile = config('nullable-attributes.cache');
+        $cache = file_exists($cacheFile) ? include $cacheFile : false;
+        $attributes = is_array($cache) ? $cache : [];
+
+        config(['nullable-attributes.attributes' => $attributes]);
+    }
 }

src/Traits/NullableAttributesTrait.php

@@ -4,70 +4,44 @@
 
 namespace McMatters\NullableAttributes\Traits;
 
+use Illuminate\Database\Eloquent\Model;
+
 /**
  * Class NullableAttributesTrait
  *
  * @package McMatters\NullableAttributes\Traits
  */
 trait NullableAttributesTrait
 {
-    /**
-     * @var array
-     */
-    protected static $nullableAttributes = [];
-
     /**
      * Boot trait.
      */
     public static function bootNullableAttributesTrait()
     {
-        static $cache;
-
-        if (null === $cache) {
-            $cacheFile = storage_path('app/nullable_attributes.php');
-            $cache = file_exists($cacheFile) ? include $cacheFile : false;
-            $cache = is_array($cache) ? $cache : false;
-        }
-
-        if (false !== $cache && isset($cache[static::class])) {
-            self::$nullableAttributes = $cache[static::class];
-
-            return;
-        }
-
-        self::$nullableAttributes = get_model_nullable_attributes(
-            static::class
-        );
+        self::saving(function (Model $model) {
+            $model->convertEmptyToNullableAttributes();
+        });
     }
 
     /**
-     * Workaround for empty values
-     *
-     * @param string $key
-     * @param mixed $val
+     * @return void
      */
-    public function setAttribute($key, $val)
+    protected function convertEmptyToNullableAttributes()
     {
-        if (is_string($val) &&
-            !($val = trim($val)) &&
-            in_array($key, static::$nullableAttributes, true)
-        ) {
-            $val = null;
-        }
-
-        return parent::setAttribute($key, $val);
-    }
+        /** @var array $nullableAttributes */
+        $nullableAttributes = array_get(
+            config('nullable-attributes.attributes'),
+            get_class($this),
+            []
+        );
 
-    /**
-     * @param string|null $modelName
-     * @return array
-     */
-    public function getNullableAttributes(string $modelName = null): array
-    {
-        if (null !== $modelName) {
-            return self::$nullableAttributes[$modelName] ?? [];
+        foreach ($nullableAttributes as $attribute) {
+            $modelAttribute = $this->getAttribute($attribute);
+            if ((is_array($modelAttribute) && empty($modelAttribute)) ||
+                (is_string($modelAttribute) && trim($modelAttribute) === '')
+            ) {
+                $this->setAttribute($attribute, null);
+            }
         }
-
-        return self::$nullableAttributes;
     }
 }