Merge branch 'feature/use-trait-initializer' into develop

Author: sebastiaanluca

.travis.yml

@@ -1,7 +1,8 @@
 language: php
 
 php:
-  - 7.2
+  - "7.2"
+  - "7.3"
   - nightly
 
 cache:
@@ -10,10 +11,8 @@ cache:
 
 env:
   matrix:
-    - LARAVEL_VERSION="5.6.*" COMPOSER_FLAGS="--prefer-lowest"
-    - LARAVEL_VERSION="5.6.*" COMPOSER_FLAGS="--prefer-stable"
-    - LARAVEL_VERSION="5.7.*" COMPOSER_FLAGS="--prefer-lowest"
-    - LARAVEL_VERSION="5.7.*" COMPOSER_FLAGS="--prefer-stable"
+    - LARAVEL_VERSION="5.8.*" COMPOSER_FLAGS="--prefer-lowest"
+    - LARAVEL_VERSION="5.8.*" COMPOSER_FLAGS="--prefer-stable"
     - LARAVEL_VERSION="dev-master" ORCHESTRA_VERSION="dev-master" COMPOSER_FLAGS="--prefer-lowest" MINIMUM_STABILITY="dev"
     - LARAVEL_VERSION="dev-master" ORCHESTRA_VERSION="dev-master" COMPOSER_FLAGS="--prefer-stable" MINIMUM_STABILITY="dev"
 

CHANGELOG.md

@@ -6,6 +6,19 @@ 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)
+- Renamed `BooleanDates` trait to `HasBooleanDates`
+
+### Removed
+
+- Dropped support for Laravel 5.7 and lower
+
 ## 1.1.1 (2018-09-04)
 
 ### Fixed

README.md

@@ -10,9 +10,9 @@
 [![Follow @sebastiaanluca on Twitter][twitter-profile-badge]][link-twitter]
 [![Share this package on Twitter][twitter-share-badge]][link-twitter-share]
 
-Say you've got a registration page for users where they need to accept your terms and perhaps can opt-in to certain features using checkboxes. With the new(-ish) GDPR privacy laws, you're somewhat required to not just keep track of the fact *if* they accepted those (or not), but also *when* they did.
+**A package to automatically convert boolean fields to dates (and back to booleans) so you always know when something was accepted or changed.**
 
-**This package automatically converts those boolean fields to dates so you always know when something was accepted or changed.**
+Say you've got a registration page for users where they need to accept your terms and perhaps can opt-in to certain features using checkboxes. With the new(-ish) GDPR privacy laws, you're somewhat required to not just keep track of the fact *if* they accepted those (or not), but also *when* they did.
 
 ### Example
 
@@ -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,17 +76,17 @@ $user->accepted_terms_and_conditions_at;
 composer require sebastiaanluca/laravel-boolean-dates
 ```
 
-**Require the `BooleanDates` 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
 
 use Illuminate\Database\Eloquent\Model;
-use SebastiaanLuca\BooleanDates\BooleanDates;
+use SebastiaanLuca\BooleanDates\HasBooleanDates;
 
 class User extends Model
 {
-    use BooleanDates;
+    use HasBooleanDates;
 
     /**
      * @var array
@@ -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,

composer.json

@@ -24,15 +24,16 @@
         }
     ],
     "require": {
-        "laravel/framework": "^5.6",
+        "laravel/framework": "^5.8",
         "nesbot/carbon": "^1.22.1|^2.0",
         "php": "^7.2"
     },
     "require-dev": {
-        "kint-php/kint": "^2.2",
-        "mockery/mockery": "^1.1",
-        "orchestra/testbench": "^3.6",
-        "phpunit/phpunit": "^7.2"
+        "dms/phpunit-arraysubset-asserts": "^0.1.0",
+        "kint-php/kint": "^3.1",
+        "mockery/mockery": "^1.2",
+        "orchestra/testbench": "^3.8",
+        "phpunit/phpunit": "^8.0"
     },
     "autoload": {
         "psr-4": {

src/BooleanDates.php renamed to src/HasBooleanDates.php

@@ -6,8 +6,21 @@
 
 use Carbon\Carbon;
 
-trait BooleanDates
+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/BooleanArrayTest.php

@@ -5,11 +5,14 @@
 namespace SebastiaanLuca\BooleanDates\Tests\Feature;
 
 use Carbon\Carbon;
+use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
 use SebastiaanLuca\BooleanDates\Tests\resources\TestModel;
 use SebastiaanLuca\BooleanDates\Tests\TestCase;
 
 class BooleanArrayTest extends TestCase
 {
+    use ArraySubsetAsserts;
+
     /**
      * @test
      */
@@ -58,7 +61,7 @@ public function it returns all attributes() : void
             'agreed_to_something_at' => null,
         ];
 
-        $this->assertArraySubset(
+        static::assertArraySubset(
             $expected,
             $model->toArray()
         );

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

@@ -5,11 +5,11 @@
 namespace SebastiaanLuca\BooleanDates\Tests\resources;
 
 use Illuminate\Database\Eloquent\Model;
-use SebastiaanLuca\BooleanDates\BooleanDates;
+use SebastiaanLuca\BooleanDates\HasBooleanDates;
 
 class TestModel extends Model
 {
-    use BooleanDates;
+    use HasBooleanDates;
 
     /**
      * Set the date of fields to the current date and time if a counterpart boolean field is
@@ -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',
-    ];
 }