Added support for resolving enum class from 'ClassName@method' notation

.styleci.yml

@@ -0,0 +1,6 @@
+preset: psr2
+
+enabled:
+  - align_phpdoc
+  - align_double_arrow
+  - align_equals

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Attila Fulop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/CastsEnums.php

@@ -24,7 +24,7 @@ trait CastsEnums
     public function getAttributeValue($key)
     {
         if ($this->isEnumAttribute($key)) {
-            $class = $this->enums[$key];
+            $class = $this->getEnumClass($key);
 
             return $class::create($this->getAttributeFromArray($key));
         }
@@ -57,7 +57,7 @@ public function getAttribute($key)
     public function setAttribute($key, $value)
     {
         if ($this->isEnumAttribute($key)) {
-            $enumClass = $this->enums[$key];
+            $enumClass = $this->getEnumClass($key);
             if (! $value instanceof $enumClass) {
                 $value = new $enumClass($value);
             }
@@ -82,4 +82,33 @@ private function isEnumAttribute($key)
         return isset($this->enums[$key]);
     }
 
-}
+    /**
+     * Returns the enum class. Supports 'FQCN\Class@method()' notation
+     *
+     * @param $key
+     *
+     * @return mixed
+     */
+    private function getEnumClass($key)
+    {
+        $result = $this->enums[$key];
+        if (strpos($result, '@')) {
+            $class  = str_before($result, '@');
+            $method = str_after($result, '@');
+
+            // If no namespace was set, prepend the Model's namespace to the
+            // class that resolves the enum class. Prevent this behavior,
+            // by setting the resolver class with a leading backslash
+            if (class_basename($class) == $class) {
+                $class =
+                    str_before(get_class($this), class_basename(get_class($this))) . // namespace of the model
+                    $class;
+            }
+
+            $result = $class::$method();
+        }
+
+        return $result;
+    }
+
+}

tests/AAASmokeTest.php

@@ -38,4 +38,4 @@ public function php_version_satisfies_requirements()
             . PHP_VERSION . ' found.');
     }
 
-}
+}

tests/DynamicClassResolverTest.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Contains the DynamicClassResolverTest class.
+ *
+ * @copyright   Copyright (c) 2017 Attila Fulop
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2017-10-16
+ *
+ */
+
+
+namespace Konekt\Enum\Eloquent\Tests;
+
+
+use Konekt\Enum\Eloquent\Tests\Models\Address;
+use Konekt\Enum\Eloquent\Tests\Models\AddressStatus;
+use Konekt\Enum\Eloquent\Tests\Models\AddressType;
+
+class DynamicClassResolverTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_resolves_fqcn_enum_class_name_from_the_at_notation()
+    {
+        $address = Address::create([
+            'type' => AddressType::SHIPPING,
+            'address' => 'Richard Avenue 33'
+        ]);
+
+        $this->assertInstanceOf(AddressType::class, $address->type);
+    }
+
+    /**
+     * @test
+     */
+    public function it_resolves_local_enum_class_name_from_the_at_notation()
+    {
+        $address = Address::create([
+            'type' => AddressType::SHIPPING,
+            'address' => 'Richard Avenue 33'
+        ]);
+
+        $this->assertInstanceOf(AddressStatus::class, $address->status);
+    }
+
+}

tests/EnumAccessorTest.php

@@ -95,4 +95,4 @@ public function it_doesnt_break_related_properties()
 
     }
 
-}
+}

tests/EnumMutatorTest.php

@@ -79,4 +79,4 @@ public function it_doesnt_accept_scalars_that_arent_valid_enum_values()
         $order->status = 'wtf';
     }
 
-}
+}

tests/Models/Address.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Contains the Address class.
+ *
+ * @copyright   Copyright (c) 2017 Attila Fulop
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2017-10-16
+ *
+ */
+
+
+namespace Konekt\Enum\Eloquent\Tests\Models;
+
+
+use Illuminate\Database\Eloquent\Model;
+use Konekt\Enum\Eloquent\CastsEnums;
+
+class Address extends Model
+{
+    use CastsEnums;
+
+    protected $guarded = ['id'];
+
+    protected $enums = [
+        'type'   => 'Konekt\\Enum\\Eloquent\\Tests\\Resolvers\\AddressTypeResolver@enumClass',
+        'status' => 'AddressStatusResolver@enumClass'
+    ];
+
+}

tests/Models/AddressStatus.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Contains the AddressStatus class.
+ *
+ * @copyright   Copyright (c) 2017 Attila Fulop
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2017-10-16
+ *
+ */
+
+
+namespace Konekt\Enum\Eloquent\Tests\Models;
+
+
+use Konekt\Enum\Enum;
+
+class AddressStatus extends Enum
+{
+    const __default = self::UNKNOWN;
+
+    const UNKNOWN   = null;
+    const VALID     = 'valid';
+    const INVALID   = 'invalid';
+}

tests/Models/AddressStatusResolver.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Contains the AddressStatusResolver class.
+ *
+ * @copyright   Copyright (c) 2017 Attila Fulop
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2017-10-16
+ *
+ */
+
+
+namespace Konekt\Enum\Eloquent\Tests\Models;
+
+
+class AddressStatusResolver
+{
+    /**
+     * Returns the enum class to use as address type enum
+     *
+     * @return string
+     */
+    public static function enumClass()
+    {
+        return AddressStatus::class;
+    }
+
+}

tests/Models/AddressType.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Contains the AddressType class.
+ *
+ * @copyright   Copyright (c) 2017 Attila Fulop
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2017-10-16
+ *
+ */
+
+
+namespace Konekt\Enum\Eloquent\Tests\Models;
+
+
+use Konekt\Enum\Enum;
+
+class AddressType extends Enum
+{
+    const BILLING  = 'billing';
+    const SHIPPING = 'shipping';
+}

tests/Models/Client.php

@@ -19,4 +19,4 @@ class Client extends Model
 {
     protected $guarded = ['id'];
 
-}
+}

tests/Models/Order.php

@@ -38,4 +38,4 @@ public function client()
         return $this->belongsTo(Client::class);
     }
 
-}
+}

tests/Models/OrderStatus.php

@@ -24,4 +24,4 @@ class OrderStatus extends Enum
     const SHIPPING   = 'shipping';
     const COMPLETED  = 'completed';
 
-}
+}

tests/Resolvers/AddressTypeResolver.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Contains the AddressTypeResolver class.
+ *
+ * @copyright   Copyright (c) 2017 Attila Fulop
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2017-10-16
+ *
+ */
+
+
+namespace Konekt\Enum\Eloquent\Tests\Resolvers;
+
+
+use Konekt\Enum\Eloquent\Tests\Models\AddressType;
+
+class AddressTypeResolver
+{
+    /**
+     * Returns the enum class to use as address type enum
+     *
+     * @return string
+     */
+    public static function enumClass()
+    {
+        return AddressType::class;
+    }
+
+}

tests/TestCase.php

@@ -41,6 +41,8 @@ protected function setUpDatabase()
         $this->capsule->bootEloquent();
 
         $this->capsule->schema()->dropIfExists('orders');
+        $this->capsule->schema()->dropIfExists('clients');
+        $this->capsule->schema()->dropIfExists('addresses');
 
         $this->capsule->schema()->create('orders', function (Blueprint $table) {
             $table->increments('id');
@@ -57,7 +59,15 @@ protected function setUpDatabase()
             $table->timestamps();
         });
 
+        $this->capsule->schema()->create('addresses', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('type');
+            $table->string('status')->nullable();
+            $table->string('address')->nullable();
+            $table->timestamps();
+        });
+
     }
 
 
-}
+}