Merge pull request #5 from GeorgII-web/bool

Add `BoolType` abstract structure with `BoolStandard` implementation,…

Author: GeorgII-web

src/Abstract/Bool/BoolType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Abstract\Bool;
+
+/**
+ * @psalm-immutable
+ */
+abstract readonly class BoolType implements BoolTypeInterface
+{
+    abstract protected function __construct(bool $value);
+
+    public function toString(): string
+    {
+        return $this->value() ? 'true' : 'false';
+    }
+
+    public static function fromBool(bool $value): self
+    {
+        return new static($value);
+    }
+}

src/Abstract/Bool/BoolTypeInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Abstract\Bool;
+
+/**
+ * @psalm-immutable
+ */
+interface BoolTypeInterface
+{
+    public function value(): bool;
+
+    public static function fromString(string $value): self;
+
+    public static function fromBool(bool $value): self;
+
+    public function toString(): string;
+}

src/Bool/Alias/Boolean.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Bool\Alias;
+
+use PhpTypedValues\Bool\BoolStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class Boolean extends BoolStandard
+{
+}

src/Bool/BoolStandard.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Bool;
+
+use PhpTypedValues\Abstract\Bool\BoolType;
+use PhpTypedValues\Exception\BoolTypeException;
+
+use function sprintf;
+
+/**
+ * Boolean value.
+ *
+ * Example "true"
+ *
+ * @psalm-immutable
+ */
+readonly class BoolStandard extends BoolType
+{
+    protected bool $value;
+
+    public function __construct(bool $value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @throws BoolTypeException
+     */
+    public static function fromString(string $value): static
+    {
+        $lowerCaseValue = strtolower($value);
+
+        if ($lowerCaseValue === 'true') {
+            $boolValue = true;
+        } elseif ($lowerCaseValue === 'false') {
+            $boolValue = false;
+        } else {
+            throw new BoolTypeException(sprintf('Expected string "true" or "false", got "%s"', $value));
+        }
+
+        return new static($boolValue);
+    }
+
+    /**
+     * @throws BoolTypeException
+     */
+    public static function fromInt(int $value): static
+    {
+        if ($value === 1) {
+            $boolValue = true;
+        } elseif ($value === 0) {
+            $boolValue = false;
+        } else {
+            throw new BoolTypeException(sprintf('Expected int "1" or "0", got "%s"', $value));
+        }
+
+        return new static($boolValue);
+    }
+
+    public function value(): bool
+    {
+        return $this->value;
+    }
+}

src/Exception/BoolTypeException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Exception;
+
+class BoolTypeException extends TypeException
+{
+}

src/Float/Alias/Double.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Float\Alias;
+
+use PhpTypedValues\Float\FloatStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class Double extends FloatStandard
+{
+}

src/Integer/Alias/Integer.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Integer\Alias;
+
+use PhpTypedValues\Integer\IntegerStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class Integer extends IntegerStandard
+{
+}

src/String/Alias/Str.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\String\Alias;
+
+use PhpTypedValues\String\StringStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class Str extends StringStandard
+{
+}

src/psalmTest.php

@@ -8,15 +8,20 @@
 
 require_once 'vendor/autoload.php';
 
+use PhpTypedValues\Abstract\Bool\BoolTypeInterface;
+use PhpTypedValues\Bool\Alias\Boolean;
+use PhpTypedValues\Bool\BoolStandard;
 use PhpTypedValues\DateTime\DateTimeAtom;
 use PhpTypedValues\DateTime\DateTimeRFC3339;
 use PhpTypedValues\DateTime\Timestamp\TimestampMilliseconds;
 use PhpTypedValues\DateTime\Timestamp\TimestampSeconds;
+use PhpTypedValues\Float\Alias\Double;
 use PhpTypedValues\Float\Alias\FloatType;
 use PhpTypedValues\Float\Alias\NonNegativeFloat;
 use PhpTypedValues\Float\FloatNonNegative;
 use PhpTypedValues\Float\FloatStandard;
 use PhpTypedValues\Integer\Alias\Id;
+use PhpTypedValues\Integer\Alias\Integer;
 use PhpTypedValues\Integer\Alias\IntType;
 use PhpTypedValues\Integer\Alias\NonNegativeInt;
 use PhpTypedValues\Integer\Alias\PositiveInt;
@@ -27,6 +32,7 @@
 use PhpTypedValues\Integer\IntegerStandard;
 use PhpTypedValues\Integer\IntegerWeekDay;
 use PhpTypedValues\String\Alias\NonEmptyStr;
+use PhpTypedValues\String\Alias\Str;
 use PhpTypedValues\String\Alias\StrType;
 use PhpTypedValues\String\StringNonEmpty;
 use PhpTypedValues\String\StringStandard;
@@ -49,6 +55,7 @@
 echo IntegerStandard::fromString('10')->toString() . \PHP_EOL;
 echo Id::fromString('10')->toString() . \PHP_EOL;
 echo IntType::fromString('10')->toString() . \PHP_EOL;
+echo Integer::fromString('10')->toString() . \PHP_EOL;
 
 /**
  * String.
@@ -59,6 +66,7 @@
 echo StringStandard::fromString('hi')->toString() . \PHP_EOL;
 echo NonEmptyStr::fromString('hi')->toString() . \PHP_EOL;
 echo StrType::fromString('hi')->toString() . \PHP_EOL;
+echo Str::fromString('hi')->toString() . \PHP_EOL;
 
 /**
  * Float.
@@ -68,11 +76,22 @@
 echo FloatStandard::fromString('2.71828')->toString() . \PHP_EOL;
 echo NonNegativeFloat::fromString('2.71828')->toString() . \PHP_EOL;
 echo FloatType::fromString('2.71828')->toString() . \PHP_EOL;
+echo Double::fromString('2.71828')->toString() . \PHP_EOL;
 
 // PositiveFloat usage
 testPositiveFloat(FloatNonNegative::fromFloat(0.5)->value());
 echo FloatNonNegative::fromString('3.14159')->toString() . \PHP_EOL;
 
+/**
+ * Boolean.
+ */
+echo BoolStandard::fromString('true')->toString() . \PHP_EOL;
+echo BoolStandard::fromInt(1)->toString() . \PHP_EOL;
+echo BoolStandard::fromBool(true)->toString() . \PHP_EOL;
+echo Boolean::fromBool(Boolean::fromBool(true)->value())->toString() . \PHP_EOL;
+// Ensure interface method usage is visible to Psalm
+echo (testBool(BoolStandard::fromBool(true)) ? 'true' : 'false') . \PHP_EOL;
+
 /**
  * DateTime.
  */
@@ -145,3 +164,11 @@ function testPositiveFloat(float $f): float
 {
     return $f;
 }
+
+/**
+ * Exercise BoolTypeInterface::value() for Psalm.
+ */
+function testBool(BoolTypeInterface $b): bool
+{
+    return $b->value();
+}

tests/Arch/StructureTest.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use PhpTypedValues\Abstract\Bool\BoolType;
 use PhpTypedValues\Abstract\DateTime\DateTimeType;
 use PhpTypedValues\Abstract\Float\FloatType;
 use PhpTypedValues\Abstract\Integer\IntType;
@@ -36,3 +37,9 @@
     ->toExtend(DateTimeType::class)
     ->toBeClasses()
     ->toBeReadonly();
+
+arch('Boolean classes are final and read-only')
+    ->expect('PhpTypedValues\Bool')
+    ->toExtend(BoolType::class)
+    ->toBeClasses()
+    ->toBeReadonly();