Merge pull request #30 from michael-rubel/update/boolean

Update `Boolean` object 🔧

Author: michael-rubel

README.md

@@ -12,7 +12,7 @@ A bunch of general-purpose value objects you can use in your Laravel application
 
 ---
 
-The package requires PHP `^8.0` and Laravel `^9.7`.
+The package requires PHP `^8.0.2` and Laravel `^9.33`.
 
 ## #StandWithUkraine
 [![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)

composer.json

@@ -17,7 +17,7 @@
     ],
     "require": {
         "php": "^8.0",
-        "illuminate/contracts": "^9.7",
+        "illuminate/contracts": "^9.33",
         "michael-rubel/laravel-formatters": "^7.0.4",
         "phpmath/bignumber": "^1.2",
         "spatie/laravel-package-tools": "^1.12"

phpstan.neon

@@ -20,6 +20,7 @@ parameters:
         - '#Method MichaelRubel\\ValueObjects\\Collection\\Complex\\Email\:\:username\(\) should return string but returns string\|null\.#'
         - '#Method MichaelRubel\\ValueObjects\\Collection\\Complex\\FullName\:\:firstName\(\) should return string but returns string\|null\.#'
         - '#Method MichaelRubel\\ValueObjects\\Collection\\Complex\\FullName\:\:lastName\(\) should return string but returns string\|null\.#'
+        - '#Parameter \#1 \$value of class Illuminate\\Support\\Stringable constructor expects string, int\|string given\.#'
 
     checkMissingIterableValueType: false
 

src/Collection/Primitive/Boolean.php

@@ -12,6 +12,7 @@
 
 namespace MichaelRubel\ValueObjects\Collection\Primitive;
 
+use Illuminate\Support\Stringable;
 use InvalidArgumentException;
 use MichaelRubel\ValueObjects\ValueObject;
 
@@ -32,23 +33,23 @@
 class Boolean extends ValueObject
 {
     /**
-     * @var bool|int|string
+     * @var bool
      */
-    protected bool|int|string $value;
+    protected bool $value;
 
     /**
-     * Allowed values that are treated as `true`.
+     * Values that represent `true` boolean.
      *
      * @var array
      */
-    protected array $trueValues = ['1', 'true', 'True', 'TRUE', 1, true];
+    protected array $trueValues = ['1', 'true', 1, 'on', 'yes'];
 
     /**
-     * Allowed values that are treated as `false`.
+     * Values that represent `false` boolean.
      *
      * @var array
      */
-    protected array $falseValues = ['0', 'false', 'False', 'FALSE', 0, false];
+    protected array $falseValues = ['0', 'false', 0, 'off', 'no'];
 
     /**
      * Create a new instance of the value object.
@@ -61,13 +62,7 @@ public function __construct(bool|int|string $value)
             throw new InvalidArgumentException(static::IMMUTABLE_MESSAGE);
         }
 
-        $this->value = $value;
-
-        $this->value = match (true) {
-            $this->isInTrueValues()  => true,
-            $this->isInFalseValues() => false,
-            default => throw new InvalidArgumentException('Invalid boolean.'),
-        };
+        ! is_bool($value) ? $this->handleNonBoolean($value) : $this->value = $value;
     }
 
     /**
@@ -77,27 +72,24 @@ public function __construct(bool|int|string $value)
      */
     public function value(): bool
     {
-        return (bool) $this->value;
+        return $this->value;
     }
 
     /**
      * Determine if the passed boolean is true.
      *
-     * @return bool
+     * @param  int|string  $value
+     * @return void
      */
-    protected function isInTrueValues(): bool
+    protected function handleNonBoolean(int|string $value): void
     {
-        return in_array($this->value, $this->trueValues, strict: true);
-    }
+        $string = new Stringable($value);
 
-    /**
-     * Determine if the passed boolean is false.
-     *
-     * @return bool
-     */
-    protected function isInFalseValues(): bool
-    {
-        return in_array($this->value, $this->falseValues, strict: true);
+        $this->value = match (true) {
+            $string->contains($this->trueValues, ignoreCase: true) => true,
+            $string->contains($this->falseValues, ignoreCase: true) => false,
+            default => throw new InvalidArgumentException('Invalid boolean.'),
+        };
     }
 
     /**
@@ -107,7 +99,7 @@ protected function isInFalseValues(): bool
      */
     public function toString(): string
     {
-        return ! empty($this->value()) ? 'true' : 'false';
+        return $this->value() ? 'true' : 'false';
     }
 
     /**

tests/Unit/Primitive/BooleanTest.php

@@ -23,6 +23,10 @@
     $this->assertFalse($valueObject->value());
     $valueObject = new Boolean('False');
     $this->assertFalse($valueObject->value());
+    $valueObject = new Boolean('off');
+    $this->assertFalse($valueObject->value());
+    $valueObject = new Boolean('no');
+    $this->assertFalse($valueObject->value());
     $valueObject = new Boolean('FALSE');
     $this->assertFalse($valueObject->value());
     $valueObject = new Boolean('true');
@@ -31,6 +35,10 @@
     $this->assertTrue($valueObject->value());
     $valueObject = new Boolean('TRUE');
     $this->assertTrue($valueObject->value());
+    $valueObject = new Boolean('on');
+    $this->assertTrue($valueObject->value());
+    $valueObject = new Boolean('yes');
+    $this->assertTrue($valueObject->value());
 });
 
 test('boolean can accept native booleans', function () {
@@ -97,10 +105,10 @@
     Boolean::macro('getNegativeValues', fn () => $this->falseValues);
     $valueObject = new Boolean(1);
     $this->assertSame([
-        '1', 'true', 'True', 'TRUE', 1, true,
+        '1', 'true', 1, 'on', 'yes',
     ], $valueObject->getPositiveValues());
     $this->assertSame([
-        '0', 'false', 'False', 'FALSE', 0, false,
+        '0', 'false', 0, 'off', 'no',
     ], $valueObject->getNegativeValues());
 });
 
@@ -155,28 +163,13 @@
 
 test('can extend protected methods in boolean', function () {
     $bool = new TestBoolean('true');
-    assertTrue($bool->isInTrueValues());
-    assertIsBool($bool->value());
-
-    $bool = new TestBoolean('false');
-    assertTrue($bool->isInFalseValues());
     assertIsBool($bool->value());
 });
 
 class TestBoolean extends Boolean
 {
     public function __construct(bool|int|string $value)
     {
-        $this->value = $value;
-    }
-
-    public function isInTrueValues(): bool
-    {
-        return parent::isInTrueValues();
-    }
-
-    public function isInFalseValues(): bool
-    {
-        return parent::isInFalseValues();
+        ! is_bool($value) ? $this->handleNonBoolean($value) : $this->value = $value;
     }
 }