Merge branch 'release/1.0.0'

Author: sebastiaanluca

CHANGELOG.md

@@ -6,6 +6,14 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ##  Unreleased
 
+##  1.0.0 (2018-08-19)
+
+### Fixed
+
+- Removed `$booleanDates` trait variable to resolve conflict with the model it's used in
+- Always return a valid array when retrieving all boolean dates
+- Fixed issue where converting a model to an array didn't include the correct boolean field values
+
 ##  0.2.1 (2018-07-26)
 
 ### Fixed

README.md

@@ -1,4 +1,4 @@
-# Easily convert Eloquent model booleans to dates and back
+# Easily convert Eloquent model boolean fields to dates and back
 
 [![Latest stable release][version-badge]][link-packagist]
 [![Software license][license-badge]](LICENSE.md)
@@ -76,7 +76,7 @@ class User extends Model
 }
 ```
 
-Adding the boolean dates _values_ to the `$dates` array is optional, but encouraged as it'll convert all your boolean datetimes to Carbon instances. 
+Adding the boolean dates _values_ to the `$dates` array is **optional**, but encouraged as it'll convert all your boolean datetimes to Carbon instances. 
 
 ## How to use
 
@@ -108,12 +108,18 @@ Of course you can also remove the saved date and time, for instance if a user re
 ```php
 $user = User::findOrFail(42);
 
-$user->allows_data_processing = false;
+$user->has_accepted_terms_and_conditions = false;
+// $user->has_accepted_terms_and_conditions = null;
+
+$user->allows_data_processing = 0;
+// $user->allows_data_processing = '0';
+
+$user->has_agreed_to_something = '';
 
 $user->save();
 ```
 
-False values are converted to `NULL`.
+False or false-y values are converted to `NULL`.
 
 ### Retrieving values
 
@@ -127,19 +133,7 @@ $user = User::findOrFail(42);
 $user->has_accepted_terms_and_conditions;
 
 /*
- * true (boolean)
- */
-
-$user->allows_data_processing;
-
-/*
- * false (boolean)
- */
-
-$user->has_agreed_to_something;
-
-/*
- * true (boolean)
+ * true or false (boolean)
  */
 ```
 
@@ -161,12 +155,6 @@ $user->accepted_processing_at;
 /*
  * NULL
  */
-
-$user->agreed_to_something_at;
-
-/*
- * 2018-05-10 16:24:22 (string or Carbon instance)
- */
 ```
 
 ### Array conversion
@@ -179,10 +167,10 @@ $user = User::findOrFail(42);
 $user->toArray();
 
 /*
- * Which will return:
+ * Which will return something like:
  * 
  * [
- *     'accepted_terms_at' => \Carbon\Carbon('2018-05-10 16:24:22'),
+ *     'accepted_terms_at' => '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,13 +24,13 @@
         }
     ],
     "require": {
-        "ext-json": "*",
         "laravel/framework": "^5.6",
         "nesbot/carbon": "^1.22",
         "php": "^7.2"
     },
     "require-dev": {
         "kint-php/kint": "^2.2",
+        "mockery/mockery": "^1.1",
         "orchestra/testbench": "^3.6",
         "phpunit/phpunit": "^7.2"
     },

src/BooleanDates.php

@@ -8,16 +8,6 @@
 
 trait BooleanDates
 {
-    /**
-     * Set the date of fields to the current date and time if a counterpart boolean field is
-     * true-ish.
-     *
-     * Keys and values should be in the format: `'boolean_field' => 'internal_timestamp_field'`.
-     *
-     * @var array
-     */
-    protected $booleanDates = [];
-
     /**
      * Convert the model's attributes to an array.
      *
@@ -76,7 +66,7 @@ public function setAttribute($key, $value)
      */
     public function getBooleanDates() : array
     {
-        return $this->booleanDates;
+        return $this->booleanDates ?? [];
     }
 
     /**
@@ -173,7 +163,7 @@ protected function addBooleanDateAttributesToArray(array $attributes) : array
                 continue;
             }
 
-            $attributes[$booleanField] = $date !== null;
+            $attributes[$booleanField] = $this->getBooleanDate($booleanField);
         }
 
         return $attributes;

tests/Feature/.gitkeep

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SebastiaanLuca\BooleanDates\Tests\Feature;
+
+use Carbon\Carbon;
+use SebastiaanLuca\BooleanDates\Tests\resources\TestModel;
+use SebastiaanLuca\BooleanDates\Tests\TestCase;
+
+class BooleanArrayTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it returns all boolean dates() : void
+    {
+        $model = new TestModel;
+
+        $expected = [
+            'has_accepted_terms_and_conditions' => 'accepted_terms_at',
+            'allows_data_processing' => 'accepted_processing_at',
+            'has_agreed_to_something' => 'agreed_to_something_at',
+        ];
+
+        $this->assertSame(
+            $expected,
+            $model->getBooleanDates()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it returns all attributes() : void
+    {
+        Carbon::setTestNow('2018-01-01 10:42:06');
+
+        $model = new TestModel;
+
+        $model->something = 'something';
+        $model->tested_at = Carbon::now();
+
+        $model->has_accepted_terms_and_conditions = false;
+        $model->allows_data_processing = true;
+        $model->has_agreed_to_something = '0';
+
+        $expected = [
+            'something' => 'something',
+            'tested_at' => '2018-01-01 10:42:06',
+
+            'has_accepted_terms_and_conditions' => false,
+            'allows_data_processing' => true,
+            'has_agreed_to_something' => false,
+
+            'accepted_terms_at' => null,
+            'accepted_processing_at' => '2018-01-01 10:42:06',
+            'agreed_to_something_at' => null,
+        ];
+
+        $this->assertArraySubset(
+            $expected,
+            $model->toArray()
+        );
+    }
+}

tests/Feature/BooleanArrayTest.php

@@ -0,0 +1,148 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SebastiaanLuca\BooleanDates\Tests\Feature;
+
+use Carbon\Carbon;
+use SebastiaanLuca\BooleanDates\Tests\resources\TestModel;
+use SebastiaanLuca\BooleanDates\Tests\TestCase;
+
+class BooleanAttributeTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it skips returning invalid fields() : void
+    {
+        $model = new TestModel;
+
+        $this->assertNull($model->getAttribute(null));
+        $this->assertNull($model->getAttribute(false));
+        $this->assertNull($model->getAttribute(''));
+        $this->assertNull($model->getAttribute('0'));
+    }
+
+    /**
+     * @test
+     */
+    public function it leaves other attributes untouched() : void
+    {
+        $model = new TestModel;
+
+        $model->something = 'something';
+
+        $this->assertSame(
+            'something',
+            $model->something
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it sets the date from a true boolean() : void
+    {
+        $model = new TestModel;
+
+        $model->has_accepted_terms_and_conditions = true;
+
+        $this->assertSame(
+            Carbon::now()->format('Y-m-d H:i:s'),
+            $model->accepted_terms_at
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it sets the date from a non empty string() : void
+    {
+        $model = new TestModel;
+
+        $model->has_accepted_terms_and_conditions = 'yes';
+
+        $this->assertSame(
+            Carbon::now()->format('Y-m-d H:i:s'),
+            $model->accepted_terms_at
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it sets the date from a positive integer value() : void
+    {
+        $model = new TestModel;
+
+        $model->has_agreed_to_something = 1;
+
+        $this->assertSame(
+            Carbon::now()->format('Y-m-d H:i:s'),
+            $model->agreed_to_something_at
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it sets the date from a positive integer string value() : void
+    {
+        $model = new TestModel;
+
+        $model->has_accepted_terms_and_conditions = '1';
+
+        $this->assertSame(
+            Carbon::now()->format('Y-m-d H:i:s'),
+            $model->accepted_terms_at
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it clears the date from a false boolean() : void
+    {
+        $model = new TestModel;
+
+        $model->allows_data_processing = false;
+
+        $this->assertNull($model->accepted_processing_at);
+    }
+
+    /**
+     * @test
+     */
+    public function it clears the date from null() : void
+    {
+        $model = new TestModel;
+
+        $model->has_agreed_to_something = null;
+
+        $this->assertNull($model->agreed_to_something_at);
+    }
+
+    /**
+     * @test
+     */
+    public function it clears the date from a false string value() : void
+    {
+        $model = new TestModel;
+
+        $model->has_accepted_terms_and_conditions = '0';
+
+        $this->assertNull($model->accepted_terms_at);
+    }
+
+    /**
+     * @test
+     */
+    public function it clears the date from an empty string value() : void
+    {
+        $model = new TestModel;
+
+        $model->has_accepted_terms_and_conditions = '0';
+
+        $this->assertNull($model->accepted_terms_at);
+    }
+}