Automatically detect a model's boolean date fields

Author: sebastiaanluca

CHANGELOG.md

@@ -6,6 +6,10 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ##  Unreleased
 
+### Added
+
+- Automatically detect a model's boolean date fields
+
 ### Changed
 
 - Add support for Laravel 5.8 (requires PHP 7.2 or higher)

README.md

@@ -40,7 +40,7 @@ $user->has_accepted_terms_and_conditions;
 $user->accepted_terms_and_conditions_at;
 
 /*
- * 2018-05-10 16:24:22 (string or Carbon instance)
+ * 2018-05-10 16:24:22 (Carbon instance)
  */
 ```
 
@@ -76,7 +76,7 @@ $user->accepted_terms_and_conditions_at;
 composer require sebastiaanluca/laravel-boolean-dates
 ```
 
-**Require the `HasBooleanDates` trait** in your Eloquent model, then add the `$booleanDates` and `$dates` (optional) fields:
+**Require the `HasBooleanDates` trait** in your Eloquent model, then add the `$booleanDates` field:
 
 ```php
 <?php
@@ -96,22 +96,9 @@ class User extends Model
         'allows_data_processing' => 'accepted_processing_at',
         'has_agreed_to_something' => 'agreed_to_something_at',
     ];
-    
-    /**
-     * The attributes that should be mutated to dates.
-     *
-     * @var array
-     */
-    protected $dates = [
-        'accepted_terms_at',
-        'accepted_processing_at',
-        'agreed_to_something_at',
-    ];
 }
 ```
 
-Adding the boolean date fields to the `$dates` array is **optional**, but encouraged as it'll convert all your boolean datetimes to Carbon instances.
-
 To wrap up, create a **migration** to create a new or alter your existing table and add the timestamp fields:
 
 ```php
@@ -210,7 +197,7 @@ $user = User::findOrFail(42);
 $user->accepted_terms_at;
 
 /*
- * 2018-05-10 16:24:22 (string or Carbon instance)
+ * 2018-05-10 16:24:22 (Carbon instance)
  */
 
 $user->accepted_processing_at;
@@ -233,7 +220,7 @@ $user->toArray();
  * Which will return something like:
  * 
  * [
- *     'accepted_terms_at' => '2018-05-10 16:24:22',
+ *     'accepted_terms_at' => \Carbon\Carbon('2018-05-10 16:24:22'),
  *     'accepted_processing_at' => NULL,
  *     'agreed_to_something_at' => \Carbon\Carbon('2018-05-10 16:24:22'),
  *     'accepted_terms_and_conditions' => true,

src/HasBooleanDates.php

@@ -8,6 +8,19 @@
 
 trait HasBooleanDates
 {
+    /**
+     * Initialize the trait.
+     */
+    public function initializeHasBooleanDates() : void
+    {
+        $this->dates = array_unique(
+            array_merge(
+                $this->dates,
+                array_values($this->getBooleanDates())
+            )
+        );
+    }
+
     /**
      * Convert the model's attributes to an array.
      *

tests/Feature/BooleanAttributeTest.php

@@ -48,8 +48,8 @@ public function it sets the date from a true boolean() : void
         $model->has_accepted_terms_and_conditions = true;
 
         $this->assertSame(
-            Carbon::now()->format('Y-m-d H:i:s'),
-            $model->accepted_terms_at
+            Carbon::now()->format('Y-m-d H:i'),
+            $model->accepted_terms_at->format('Y-m-d H:i')
         );
     }
 
@@ -63,8 +63,8 @@ public function it sets the date from a non empty string() : void
         $model->has_accepted_terms_and_conditions = 'yes';
 
         $this->assertSame(
-            Carbon::now()->format('Y-m-d H:i:s'),
-            $model->accepted_terms_at
+            Carbon::now()->format('Y-m-d H:i'),
+            $model->accepted_terms_at->format('Y-m-d H:i')
         );
     }
 
@@ -78,8 +78,8 @@ public function it sets the date from a positive integer value() : void
         $model->has_agreed_to_something = 1;
 
         $this->assertSame(
-            Carbon::now()->format('Y-m-d H:i:s'),
-            $model->agreed_to_something_at
+            Carbon::now()->format('Y-m-d H:i'),
+            $model->agreed_to_something_at->format('Y-m-d H:i')
         );
     }
 
@@ -93,8 +93,8 @@ public function it sets the date from a positive integer string value()
         $model->has_accepted_terms_and_conditions = '1';
 
         $this->assertSame(
-            Carbon::now()->format('Y-m-d H:i:s'),
-            $model->accepted_terms_at
+            Carbon::now()->format('Y-m-d H:i'),
+            $model->accepted_terms_at->format('Y-m-d H:i')
         );
     }
 

tests/resources/TestModel.php

@@ -24,14 +24,4 @@ class TestModel extends Model
         'allows_data_processing' => 'accepted_processing_at',
         'has_agreed_to_something' => 'agreed_to_something_at',
     ];
-
-    /**
-     * The attributes that should be mutated to dates.
-     *
-     * @var array
-     */
-    protected $dates = [
-        'accepted_processing_at',
-        'tested_at',
-    ];
 }