From f8d9cddcc69499999477da11a03112d287eee90d Mon Sep 17 00:00:00 2001
From: Igor Scheller <igor.scheller@igorshp.de>
Date: Wed, 21 Oct 2020 00:11:33 +0200
Subject: [PATCH] Added CleanupModel stub

---
 src/Controllers/CleanupModel.php              | 34 +++++++++++++
 tests/Unit/Controllers/CleanupModelTest.php   | 51 +++++++++++++++++++
 .../Stub/CleanupModelImplementation.php       | 21 ++++++++
 tests/Unit/Controllers/Stub/TestModel.php     | 21 ++++++++
 4 files changed, 127 insertions(+)
 create mode 100644 src/Controllers/CleanupModel.php
 create mode 100644 tests/Unit/Controllers/CleanupModelTest.php
 create mode 100644 tests/Unit/Controllers/Stub/CleanupModelImplementation.php
 create mode 100644 tests/Unit/Controllers/Stub/TestModel.php

diff --git a/src/Controllers/CleanupModel.php b/src/Controllers/CleanupModel.php
new file mode 100644
index 00000000..b1f28f8b
--- /dev/null
+++ b/src/Controllers/CleanupModel.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Engelsystem\Controllers;
+
+use ArrayAccess;
+use Illuminate\Database\Eloquent\Model;
+
+trait CleanupModel
+{
+    /**
+     * Used to replace null values with en empty string
+     *
+     * Required because isset on a null value returns false which gets interpreted as missing properties by Twig
+     *
+     * @param Model[]|ArrayAccess|Model $models
+     * @param string[]                  $attributes
+     */
+    protected function cleanupModelNullValues($models, array $attributes = [])
+    {
+        $models = $models instanceof Model ? [$models] : $models;
+        foreach ($models as $model) {
+            /** @var Model $model */
+            $attributes = $attributes ?: array_merge(
+                array_keys($model->getAttributes()),
+                array_keys($model->getCasts()),
+                $model->getFillable(),
+                $model->getDates()
+            );
+            foreach ($attributes as $attribute) {
+                $model->$attribute = is_null($model->$attribute) ? '' : $model->$attribute;
+            }
+        }
+    }
+}
diff --git a/tests/Unit/Controllers/CleanupModelTest.php b/tests/Unit/Controllers/CleanupModelTest.php
new file mode 100644
index 00000000..3a25f136
--- /dev/null
+++ b/tests/Unit/Controllers/CleanupModelTest.php
@@ -0,0 +1,51 @@
+<?php
+
+namespace Engelsystem\Test\Unit\Controllers;
+
+use Engelsystem\Test\Unit\Controllers\Stub\CleanupModelImplementation;
+use Engelsystem\Test\Unit\Controllers\Stub\TestModel;
+use Engelsystem\Test\Unit\HasDatabase;
+use Engelsystem\Test\Unit\TestCase;
+
+class CleanupModelTest extends TestCase
+{
+    use HasDatabase;
+
+    /**
+     * @covers \Engelsystem\Controllers\CleanupModel::cleanupModelNullValues
+     */
+    public function testCleanupModelNullValues()
+    {
+        $cleanup = new CleanupModelImplementation();
+
+        $model = new TestModel();
+        $model->foo = null;
+        $model2 = new TestModel();
+        $model3 = new TestModel();
+
+        $cleanup->cleanup($model);
+        $cleanup->cleanup([$model2]);
+        $cleanup->cleanup($model3, ['text']);
+
+        $this->assertTrue(isset($model->text));
+        $this->assertTrue(isset($model->created_at));
+        $this->assertTrue(isset($model->foo));
+        $this->assertEquals('', $model->text);
+
+        $this->assertTrue(isset($model2->text));
+
+        $this->assertTrue(isset($model3->text));
+        $this->assertNull($model3->another_text);
+        $this->assertNull($model3->foo);
+    }
+
+    /**
+     * Setup the DB
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->initDatabase();
+    }
+}
diff --git a/tests/Unit/Controllers/Stub/CleanupModelImplementation.php b/tests/Unit/Controllers/Stub/CleanupModelImplementation.php
new file mode 100644
index 00000000..b62efb3f
--- /dev/null
+++ b/tests/Unit/Controllers/Stub/CleanupModelImplementation.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Engelsystem\Test\Unit\Controllers\Stub;
+
+use ArrayAccess;
+use Engelsystem\Controllers\CleanupModel;
+use Illuminate\Database\Eloquent\Model;
+
+class CleanupModelImplementation
+{
+    use CleanupModel;
+
+    /**
+     * @param Model|ArrayAccess|Model[] $model
+     * @param array                     $attributes
+     */
+    public function cleanup($model, array $attributes = []): void
+    {
+        $this->cleanupModelNullValues($model, $attributes);
+    }
+}
diff --git a/tests/Unit/Controllers/Stub/TestModel.php b/tests/Unit/Controllers/Stub/TestModel.php
new file mode 100644
index 00000000..dc054753
--- /dev/null
+++ b/tests/Unit/Controllers/Stub/TestModel.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Engelsystem\Test\Unit\Controllers\Stub;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property string      $text
+ * @property string      $another_text
+ * @property Carbon|null $created_at
+ * @property Carbon|null $updated_at
+ */
+class TestModel extends Model
+{
+    /** @var string[] */
+    protected $fillable = [
+        'text',
+        'another_text',
+    ];
+}