AbstractEnum 0.1

Author: Petr Knap

.gitignore

@@ -0,0 +1,4 @@
+.idea
+vendor
+phpunit.log
+composer.lock

composer.json

@@ -0,0 +1,37 @@
+{
+  "name": "petrknap/php-enum",
+  "description": "Enumerated type for PHP",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Petr Knap",
+      "email": "dev@petrknap.cz",
+      "homepage": "http://petrknap.cz",
+      "role": "Developer"
+    }
+  ],
+  "homepage": "https://github.com/petrknap/php-enum",
+  "config": {
+    "preferred-install": "dist"
+  },
+  "require": {
+    "php": ">=5.4"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "4.*"
+  },
+  "scripts": {
+    "test": [
+      "./vendor/bin/phpunit"
+    ],
+    "post-autoload-dump": [
+      "@test"
+    ]
+  },
+  "autoload": {
+    "psr-4": {
+      "PetrKnap\\Php\\Enum\\": "src/Enum",
+      "PetrKnap\\Php\\Enum\\Test\\": "tests/Enum"
+    }
+  }
+}

phpunit.xml

@@ -0,0 +1,10 @@
+<phpunit bootstrap="./vendor/autoload.php">
+    <testsuites>
+        <testsuite>
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <logging>
+        <log type="testdox-text" target="./tests/phpunit.log"/>
+    </logging>
+</phpunit>

src/Enum/AbstractEnum.php

@@ -0,0 +1,125 @@
+<?php
+
+namespace PetrKnap\Php\Enum;
+
+/**
+ * Abstract enum object
+ *
+ * @author  Petr Knap <dev@petrknap.cz>
+ * @since   2016-01-23
+ * @package PetrKnap\Php\Enum
+ * @version 0.1
+ * @license https://github.com/petrknap/php-enum/blob/master/LICENSE MIT
+ */
+abstract class AbstractEnum
+{
+    /**
+     * @var self[][]
+     */
+    private static $instances;
+
+    /**
+     * @var mixed[]
+     */
+    private $items = [];
+
+    /**
+     * @var mixed
+     */
+    private $key;
+
+    /**
+     * @var mixed
+     */
+    private $value;
+
+    /**
+     * @param mixed $key
+     * @throws EnumException
+     */
+    public function __construct($key)
+    {
+        $this->key = $key;
+        $this->value = $this->get($key);
+    }
+
+    /**
+     * Creates magical factories for easier access to enum
+     *
+     * @param mixed $key enum key
+     * @param array $args ignored
+     * @return mixed
+     */
+    public static function __callStatic($key, array $args)
+    {
+        $className = get_called_class();
+
+        $instances = &self::$instances[$className];
+
+        if (!is_array($instances)) {
+            $instances = [];
+        }
+
+        $instance = &$instances[$key];
+
+        if (!($instance instanceof $className)) {
+            $instance = new $className($key);
+        }
+
+        return $instance;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getKey()
+    {
+        return $this->key;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /**
+     * @param mixed[] $items
+     */
+    protected function setItems(array $items)
+    {
+        $this->items = $items;
+    }
+
+    /**
+     * @param mixed $key
+     * @return bool
+     */
+    private function exists($key)
+    {
+        return array_key_exists($key, $this->items);
+    }
+
+    /**
+     * @param mixed $key
+     * @return mixed
+     * @throws EnumException
+     */
+    private function get($key)
+    {
+        if (!$this->exists($key)) {
+            throw new EnumException(
+                sprintf(
+                    "%s does not exists in %s",
+                    $key,
+                    get_called_class()
+                ),
+                EnumException::OUT_OF_RANGE
+            );
+        }
+
+        return $this->items[$key];
+    }
+}

src/Enum/EnumException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace PetrKnap\Php\Enum;
+
+class EnumException extends \Exception
+{
+    const GENERAL = 0;
+    const OUT_OF_RANGE = 1;
+}

tests/Enum/EnumTest.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace PetrKnap\Php\Enum\Test;
+
+use PetrKnap\Php\Enum\EnumException;
+use PetrKnap\Php\Enum\Test\EnumTest\EnumMock;
+
+class EnumTest extends \PHPUnit_Framework_TestCase
+{
+    public function goodKeyProvider()
+    {
+        return [["A", "a"], ["B", "b"]];
+    }
+
+    public function wrongKeyProvider()
+    {
+        return [["C"], ["D"]];
+    }
+
+    /**
+     * @dataProvider goodKeyProvider
+     * @param string $key
+     * @param string $value
+     */
+    public function testEnumDirectConstruction_GoodKey($key, $value)
+    {
+        $enum = new EnumMock($key);
+
+        $this->assertInstanceOf(EnumMock::getClass(), $enum);
+        $this->assertSame($key, $enum->getKey());
+        $this->assertSame($value, $enum->getValue());
+    }
+
+    /**
+     * @dataProvider wrongKeyProvider
+     * @param string $key
+     */
+    public function testEnumDirectConstruction_WrongKey($key)
+    {
+        $this->setExpectedException(
+            get_class(new EnumException()),
+            "",
+            EnumException::OUT_OF_RANGE
+        );
+
+        new EnumMock($key);
+    }
+
+    /**
+     * @dataProvider goodKeyProvider
+     * @param string $key
+     * @param string $value
+     */
+    public function testEnumMagicConstruction_GoodKey($key, $value)
+    {
+        /** @var EnumMock $enum */
+        $enum = EnumMock::$key();
+
+        $this->assertInstanceOf(EnumMock::getClass(), $enum);
+        $this->assertSame($key, $enum->getKey());
+        $this->assertSame($value, $enum->getValue());
+    }
+
+    /**
+     * @dataProvider wrongKeyProvider
+     * @param string $key
+     */
+    public function testEnumMagicConstruction_WrongKey($key)
+    {
+        $this->setExpectedException(
+            get_class(new EnumException()),
+            "",
+            EnumException::OUT_OF_RANGE
+        );
+
+        EnumMock::$key();
+    }
+}

tests/Enum/EnumTest/EnumMock.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace PetrKnap\Php\Enum\Test\EnumTest;
+
+use PetrKnap\Php\Enum\AbstractEnum;
+
+/**
+ * @method static EnumMock A()
+ * @method static EnumMock B()
+ */
+class EnumMock extends AbstractEnum
+{
+    public function __construct($key)
+    {
+        $this->setItems([
+            "A" => "a",
+            "B" => "b"
+        ]);
+
+        parent::__construct($key);
+    }
+
+    /**
+     * Returns class name (PHP <5.5)
+     *
+     * @return string
+     */
+    public static function getClass()
+    {
+        return __CLASS__;
+    }
+}