Renames examples classes.

dbalabka · dbalabka · commit 3191f9ff790e · 2019-08-27T19:32:33.000+03:00
Replace var_dump() with assert()
diff --git a/README.md b/README.md
@@ -133,14 +133,16 @@ any static property that isn't an Enum element then you should override the `\Db
 $viewAction = Action::$view;
 
 // it is possible to compare Enum elements
-var_dump($viewAction === Action::$view);
+assert($viewAction === Action::$view);
 
 // you can get Enum element by name 
 $editAction = Action::valueOf('edit');
+assert($editAction === Action::$edit);
 
 // iterate over all Enum elements
 foreach (Action::values() as $name => $action) {
-    echo $action;
+    assert($action instanceof Action);
+    assert($name === (string) $action);
 }
 ```
 
diff --git a/examples/Enum/Action.php b/examples/Enum/Action.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Fixtures;
+namespace Dbalabka\Examples\Enum;
 
 use Dbalabka\Enumeration;
 
diff --git a/examples/Enum/CardType.php b/examples/Enum/CardType.php
@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace Dbalabka\Examples\Enum;
+
+use Dbalabka\Enumeration;
+
+final class CardType extends Enumeration
+{
+    public static $amex;
+    public static $visa;
+    public static $masterCard;
+
+    protected static function initializeValues() : void
+    {
+        self::$amex = new self();
+        self::$visa = new self();
+        self::$masterCard  = new self();
+    }
+}
+CardType::initialize();
diff --git a/examples/Enum/Color.php b/examples/Enum/Color.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Fixtures;
+namespace Dbalabka\Examples\Enum;
 
 use Dbalabka\Enumeration;
 
diff --git a/examples/Enum/Day.php b/examples/Enum/Day.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Fixtures;
+namespace Dbalabka\Examples\Enum;
 
 use Dbalabka\Enumeration;
 
diff --git a/examples/Enum/Flag.php b/examples/Enum/Flag.php
@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+namespace Dbalabka\Examples\Enum;
+
+use Dbalabka\Enumeration;
+
+final class Flag extends Enumeration
+{
+    public static $noState;
+    public static $ok;
+    public static $notOk;
+    public static $unavailable;
+
+    private $flagValue;
+
+    protected function __construct()
+    {
+        $this->flagValue = 1 << $this->ordinal();
+    }
+
+    public function getFlagValue() : int
+    {
+        return $this->flagValue;
+    }
+}
+Flag::initialize();
diff --git a/examples/Enum/Planet.php b/examples/Enum/Planet.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Fixtures;
+namespace Dbalabka\Examples\Enum;
 
 use Dbalabka\Enumeration;
 
diff --git a/examples/cardType.php b/examples/cardType.php
diff --git a/examples/card_type.php b/examples/card_type.php
@@ -0,0 +1,44 @@
+<?php
+declare(strict_types=1);
+
+use Dbalabka\Examples\Enum\CardType;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$values = CardType::values();
+assert(is_array($values));
+assert($values['amex'] === CardType::$amex);
+assert($values['visa'] === CardType::$visa);
+assert($values['masterCard'] === CardType::$masterCard);
+
+
+class Card
+{
+    public $type;
+
+    public function __construct(CardType $type)
+    {
+        $this->type = $type;
+    }
+}
+
+$card = new Card(CardType::$amex);
+assert($card->type !== CardType::$visa, 'We can use strict comparision, because each Enum\'s element is singleton');
+assert($card->type === CardType::$amex);
+
+foreach (CardType::values() as $name => $type) {
+    assert($type instanceof CardType, 'Array values are Enums instances');
+    assert($name === (string) $type, 'Array keys are Enums elements names');
+}
+
+$a = CardType::$visa;
+switch ($a) {
+    case CardType::$amex:
+        assert(false, 'Incorrect, it is not amex');
+        break;
+    case CardType::$visa:
+        assert(true, 'Correct, it is visa!');
+        break;
+}
+
+
diff --git a/examples/class_static_construct.php b/examples/class_static_construct.php
@@ -1,10 +1,9 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Enumeration;
-use Dbalabka\Examples\Fixtures\Color;
+use Dbalabka\Examples\Enum\Color;
 
 $composer = require_once(__DIR__ . '/../vendor/autoload.php');
 $loader = new ConstructStatic\Loader($composer);
 
-var_dump(Color::$red instanceof Color && Color::$red === Color::$red);
+assert(Color::$red instanceof Color && Color::$red === Color::$red);
diff --git a/examples/day.php b/examples/day.php
@@ -1,15 +1,18 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Examples\Fixtures\Day;
+use Dbalabka\Examples\Enum\Day;
+
+if (version_compare(PHP_VERSION, '7.4.0', '<')) {
+    throw new \Exception('This code requires PHP >= 7.4');
+}
 
 $composer = require_once(__DIR__ . '/../vendor/autoload.php');
 $loader = new ConstructStatic\Loader($composer);
 
-
 class EnumTest
 {
-    private Day $day;
+    private $day;
 
     public function __construct(Day $day) {
         $this->day = $day;
diff --git a/examples/flag.php b/examples/flag.php
@@ -1,43 +1,20 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Enumeration;
+use Dbalabka\Examples\Enum\Flag;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
-final class Flag extends Enumeration
-{
-    public static $red;
-    public static $blue;
-    public static $green;
-
-    protected static function initializeValues(): void
-    {
-        self::$red = new self(1);
-        self::$blue = new self(2);
-        self::$green = new self(4);
-    }
-}
-Flag::initialize();
-
-var_dump(Flag::values());
-
-$red = Flag::$red;
-$green = Flag::$green;
-var_dump('a', Flag::$red < Flag::$green);
+assert(Flag::$noState < Flag::$ok);
+assert(Flag::$noState < Flag::$notOk);
+assert(Flag::$noState < Flag::$unavailable);
+assert(Flag::$ok < Flag::$notOk);
+assert(Flag::$ok < Flag::$unavailable);
+assert(Flag::$notOk < Flag::$unavailable);
 
+set_error_handler(function ($errno, $errstr) {
+    assert($errstr === sprintf('Object of class %s could not be converted to int', Flag::class));
+});
 // Operators overloading is not supported by PHP (see https://wiki.php.net/rfc/operator-overloading)
-var_dump('b', Flag::$red & Flag::$green);
-
-try {
-    var_dump('c', $red() & $green());
-} catch (\Throwable $e) {
-    echo 'Error: ' . $e->getMessage();
-}
-var_dump('d', 1 & 2);
-
-try {
-    var_dump('e', (Flag::$red)() & (Flag::$green)());
-} catch (\Throwable $e) {
-    echo 'Error: ' . $e->getMessage();
-}
+assert(1 === (Flag::$notOk & Flag::$unavailable));
+restore_error_handler();
diff --git a/examples/php-enum_comparision.php b/examples/php-enum_comparision.php
@@ -2,12 +2,13 @@
 declare(strict_types=1);
 
 use Dbalabka\Enumeration;
-use Dbalabka\Examples\Fixtures\Color;
+use Dbalabka\Examples\Enum\Color;
 use MyCLabs\Enum\Enum;
-use Dbalabka\Examples\Fixtures\Action;
+use Dbalabka\Examples\Enum\Action;
 
 $composer = require_once(__DIR__ . '/../vendor/autoload.php');
 $loader = new ConstructStatic\Loader($composer);
 
 $viewAction = Action::$view;
 
+// TODO: implement
diff --git a/examples/planet.php b/examples/planet.php
@@ -1,7 +1,11 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Examples\Fixtures\Planet;
+use Dbalabka\Examples\Enum\Planet;
+
+if (version_compare(PHP_VERSION, '7.4.0', '<')) {
+    throw new \Exception('This code requires PHP >= 7.4');
+}
 
 $composer = require_once(__DIR__ . '/../vendor/autoload.php');
 $loader = new ConstructStatic\Loader($composer);
diff --git a/examples/serialization_php74.php b/examples/serialization_php74.php
@@ -1,35 +1,19 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Enumeration;
+use Dbalabka\EnumerationException;
+use Dbalabka\Examples\Enum\Color;
 
-require_once(__DIR__ . '/../vendor/autoload.php');
-
-final class Color extends Enumeration
-{
-    public static Color $red;
-    public static Color $green;
-    public static Color $blue;
-
-    private int $value;
-
-    public function __construct(int $value)
-    {
-        $this->value = $value;
-    }
-
-    protected static function initializeValues(): void
-    {
-        self::$red = new self(1);
-        self::$blue = new self(2);
-        self::$green = new self(3);
-    }
+if (version_compare(PHP_VERSION, '7.4.0', '<')) {
+    throw new \Exception('This code requires PHP >= 7.4');
 }
-Color::initialize();
+
+$composer = require_once(__DIR__ . '/../vendor/autoload.php');
+$loader = new ConstructStatic\Loader($composer);
 
 class Square implements Serializable
 {
-    public Color $color;
+    public $color;
 
     public function __construct(Color $color)
     {
@@ -52,20 +36,20 @@ public function unserialize($serialized)
 $red = Color::$red;
 try {
     $serialized = serialize($red);
-} catch (\Dbalabka\EnumerationException $e) {
-    echo 'Error: ' . $e->getMessage() . PHP_EOL;
+} catch (EnumerationException $e) {
+    assert($e->getMessage() === 'Enum serialization is not allowed');
 }
 
 
 $serializedSquare = serialize($square);
 $square = unserialize($serializedSquare);
 
-var_dump($square->color === Color::$red);
+assert($square->color === Color::$red);
 
 
 class Dot
 {
-    public Color $color;
+    public $color;
 
     public function __construct(Color $color)
     {
@@ -87,4 +71,4 @@ public function __unserialize($payload)
 $serializedDot = serialize($dot);
 $dot = unserialize($serializedDot);
 
-var_dump($dot->color === Color::$red);
+assert($dot->color === Color::$red);
