initial commit

Author: MartkCz

.gitignore

@@ -0,0 +1,6 @@
+## ide
+.idea
+
+## composer
+vendor
+composer.lock

README.md

@@ -0,0 +1,37 @@
+Type safe enums
+
+## Getting started
+
+Create enum class
+```php
+/**
+ * @method static self ENGLAND() 
+ * @method static self USA() 
+ */
+class CountryEnum 
+{
+    protected static function getEnums(): array
+    {
+        return ['england', 'usa'];
+    }
+
+}
+```
+
+## Usage
+
+static method must be always uppercase
+```php
+assert(CountryEnum::USA() === CountryEnum::USA());
+
+function country(CountryEnum $country): string {
+    return $country->value();
+}
+
+assert(country(CountryEnum::USA()) === 'usa');
+```
+
+convert enum value to object:
+```php 
+assert(CountryEnum::get('usa') === CountryEnum::USA());
+```

codeception.yml

@@ -0,0 +1,14 @@
+namespace: Tests
+suites:
+    unit:
+        path: .
+
+settings:
+    shuffle: true
+    lint: true
+paths:
+    tests: tests
+    output: tests/_output
+    support: tests/_support
+    data: tests
+     

composer.json

@@ -0,0 +1,22 @@
+{
+	"name": "warengo/enum",
+	"type": "library",
+	"require": {
+		"php": ">=7.4"
+	},
+	"autoload": {
+		"psr-4": {
+			"Warengo\\Enum\\": "src/"
+		}
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"Warengo\\Tests\\": "tests/src/"
+		}
+	},
+	"require-dev": {
+		"codeception/codeception": "^4.1",
+		"codeception/module-phpbrowser": "^1.0.0",
+		"codeception/module-asserts": "^1.0.0"
+	}
+}

src/Enum.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types = 1);
+
+namespace Warengo\Enum;
+
+abstract class Enum extends EnumStatic
+{
+
+	private string $value;
+
+	final protected function __construct(string $value)
+	{
+		$this->value = $value;
+	}
+
+	public function value(): string
+	{
+		return $this->value;
+	}
+
+	public function __toString(): string
+	{
+		return $this->value;
+	}
+
+}

src/EnumListInterface.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types = 1);
+
+namespace Warengo\Enum;
+
+interface EnumListInterface
+{
+
+	public function has(string $name): bool;
+
+	public function get(string $name): string;
+
+}

src/EnumStatic.php

@@ -0,0 +1,80 @@
+<?php declare(strict_types = 1);
+
+namespace Warengo\Enum;
+
+use Warengo\Enum\Exceptions\InvalidArgumentException;
+use Warengo\Enum\Storage\EnumStorage;
+
+/**
+ * @internal
+ */
+abstract class EnumStatic
+{
+
+	/** @var EnumStorage[] */
+	private static array $storages = [];
+
+	/** @var mixed[] */
+	private static array $lists = [];
+
+	/**
+	 * @return string[]
+	 */
+	abstract protected static function getEnums(): array;
+
+	/**
+	 * @param mixed[] $arguments
+	 */
+	final public static function __callStatic(string $name, array $arguments)
+	{
+		if ($name !== strtoupper($name)) {
+			throw new InvalidArgumentException(sprintf('Called static class must be uppercase, %s given', $name));
+		}
+
+		return static::get($name);
+	}
+
+	/**
+	 * @return static
+	 */
+	final public static function get(string $name)
+	{
+		$name = strtolower($name);
+		$storage = self::getStorage();
+		if (!$storage->has($name)) {
+			if (!isset(self::getEnumsCached()[$name])) {
+				throw new InvalidArgumentException(
+					sprintf('Enum %s not exists in %s', strtoupper($name), static::class)
+				);
+			}
+
+			$storage->set($name, new static($name));
+		}
+
+		return $storage->get($name);
+	}
+
+	/**
+	 * @return string[]
+	 */
+	private static function getEnumsCached(): array
+	{
+		if (!isset(self::$lists[static::class])) {
+			foreach (static::getEnums() as $value) {
+				self::$lists[static::class][$value] = true;
+			}
+		}
+
+		return self::$lists[static::class];
+	}
+
+	private static function getStorage(): EnumStorage
+	{
+		if (!isset(self::$storages[static::class])) {
+			self::$storages[static::class] = new EnumStorage(static::class);
+		}
+
+		return self::$storages[static::class];
+	}
+
+}

src/Exceptions/InvalidArgumentException.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace Warengo\Enum\Exceptions;
+
+class InvalidArgumentException extends \InvalidArgumentException
+{
+
+}

src/Exceptions/UnexpectedValueException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace Warengo\Enum\Exceptions;
+
+use Exception;
+
+class UnexpectedValueException extends Exception
+{
+
+}

src/Storage/EnumStorage.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace Warengo\Enum\Storage;
+
+use Warengo\Enum\Enum;
+use Warengo\Enum\Exceptions\InvalidArgumentException;
+use Warengo\Enum\Exceptions\UnexpectedValueException;
+
+class EnumStorage
+{
+
+	/** @var Enum[] */
+	private $storage = [];
+
+	private string $class;
+
+	public function __construct(string $class)
+	{
+		$this->class = $class;
+	}
+
+	public function has(string $name): bool
+	{
+		return isset($this->storage[$name]);
+	}
+
+	public function get(string $name): Enum
+	{
+		if (!isset($this->storage[$name])) {
+			throw new InvalidArgumentException(sprintf('%s not exists in enum storage', $name));
+		}
+
+		return $this->storage[$name];
+	}
+
+	public function set(string $name, Enum $enum): void
+	{
+		if (!$enum instanceof $this->class) {
+			throw new UnexpectedValueException(
+				sprintf('Value must be instance of %s, %s given', $this->class, get_class($enum))
+			);
+		}
+
+		$this->storage[$name] = $enum;
+	}
+
+}