Merge pull request #6 from dbalabka/code-cleanup

Code cleanup

Author: dbalabka

README.md

@@ -19,7 +19,7 @@ and [Python Enums](https://docs.python.org/3/library/enum.html).
 A basic way to declare a named Enumeration class:
 ```php
 <?php
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class Action extends Enumeration
 {
@@ -126,14 +126,16 @@ multiple Enumeration classes.
    > On the other hand, it makes sense to allow sharing some common behavior between a group of enumerations...
    > (from [Python Enum documentation](https://docs.python.org/3/library/enum.html#restricted-enum-subclassing))
 2. Constructor should always be declared as non-public (`private` or `protected`) to avoid unwanted class instantiation.
-3. Implementation is based on assumption that all class static properties are elements of Enum. If there is a need to declare
-any static property that isn't an Enum element then you should override the `\Dbalabka\Enumeration::getStaticVars()` method.
-4. The method `Dbalabka\Enumeration::initialize()` should be called after each Enumeration class declaration. Please use the 
+3. Implementation is based on assumption that all class static properties are elements of Enum. <!-- If there is a need to declare
+any static property that isn't an Enum element then you should override the `\Dbalabka\Enumeration\Enumeration::$notEnumVars` method. -->
+4. The method `Dbalabka\Enumeration\Enumeration::initialize()` should be called after each Enumeration class declaration. Please use the 
 [vladimmi/construct-static](https://github.com/vladimmi/construct-static) custom loader to avoid boilerplate code.
 
 ## Usage
 ```php
 <?php
+use Dbalabka\Enumeration\Examples\Enum\Action;
+
 $viewAction = Action::$view;
 
 // it is possible to compare Enum elements
@@ -147,6 +149,7 @@ assert($editAction === Action::$edit);
 foreach (Action::values() as $name => $action) {
     assert($action instanceof Action);
     assert($name === (string) $action);
+    assert($name === $action->name());
 }
 ```
 

composer.json

@@ -23,13 +23,13 @@
     },
     "autoload": {
         "psr-4": {
-            "Dbalabka\\": "src"
+            "Dbalabka\\Enumeration\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Dbalabka\\Examples\\": "examples",
-            "Dbalabka\\Tests\\": "tests"
+            "Dbalabka\\Enumeration\\Examples\\": "examples",
+            "Dbalabka\\Enumeration\\Tests\\": "tests"
         }
     }
 }

examples/Enum/Action.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Enum;
+namespace Dbalabka\Enumeration\Examples\Enum;
 
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class Action extends Enumeration
 {

examples/Enum/CardType.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Enum;
+namespace Dbalabka\Enumeration\Examples\Enum;
 
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class CardType extends Enumeration
 {

examples/Enum/Color.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Enum;
+namespace Dbalabka\Enumeration\Examples\Enum;
 
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class Color extends Enumeration
 {

examples/Enum/Day.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Enum;
+namespace Dbalabka\Enumeration\Examples\Enum;
 
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class Day extends Enumeration
 {

examples/Enum/Flag.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Enum;
+namespace Dbalabka\Enumeration\Examples\Enum;
 
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class Flag extends Enumeration
 {

examples/Enum/Planet.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Dbalabka\Examples\Enum;
+namespace Dbalabka\Enumeration\Examples\Enum;
 
-use Dbalabka\Enumeration;
+use Dbalabka\Enumeration\Enumeration;
 
 final class Planet extends Enumeration
 {

examples/card_type.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Examples\Enum\CardType;
+use Dbalabka\Enumeration\Examples\Enum\CardType;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 

examples/class_static_construct.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-use Dbalabka\Examples\Enum\Color;
+use Dbalabka\Enumeration\Examples\Enum\Color;
 
 $composer = require_once(__DIR__ . '/../vendor/autoload.php');
 $loader = new ConstructStatic\Loader($composer);