Merge branch 'release/2.1.0'

Author: Kevin Buchholz

CHANGELOG.md

@@ -3,6 +3,12 @@
 ## Next release
 
 
+## 2.1.0 - 2020-04-08 - minor release
+
+### Added
+- Implementation of the `Castable` interface of Laravel 7.5 
+
+
 ## 2.0.0 - 2020-03-29 - major release
 
 ### Added

README.md

@@ -34,7 +34,7 @@ Enum implementation for Laravel. Based on [eloquent/enumeration](https://github.
 ## Requirements
 
 * eloquent/enumeration 6.0 or newer
-* Laravel 7 or newer;
+* Laravel 7.5 or newer;
 * PHP 7.3 or newer
 
 ## Install
@@ -314,6 +314,24 @@ echo $type === UserType::defaultMember(); // "true"
 echo $type->value; // "0"
 ```
 
+Since Laravel 7.5 and version 2.1 of this package it is also possible to use the enum itself as cast type hint, but beware that `null` is always an allowed value.
+
+```php
+<?php
+
+namespace App\Models;
+
+use App\Enums\UserType;
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+    protected $casts = [
+        'type' => UserType::class, 
+    ];
+}
+```
+
 ## Weighted Enums
 
 It is Possible to define weights for enum members. the standard way is to define the weights a config file and them implement the `Weighted`-interface with the `IsWeighted`-trait and define the path to your config. The weights can be defined as integer or float values.

composer.json

@@ -11,7 +11,9 @@
         "validation",
         "localization",
         "typed",
-        "extendible"
+        "extendible",
+        "castable",
+        "casts"
     ],
     "license": "MIT",
     "homepage": "https://github.com/sourceboat/laravel-enumeration",
@@ -26,15 +28,15 @@
     "require": {
         "php": ">=7.3",
         "eloquent/enumeration": "^6.0",
-        "illuminate/console": ">=7.0",
-        "illuminate/contracts": ">=7.0",
-        "illuminate/support": ">=7.0"
+        "illuminate/console": ">=7.5",
+        "illuminate/contracts": ">=7.5",
+        "illuminate/support": ">=7.5"
     },
     "require-dev": {
         "consistence/coding-standard": "3.10",
         "orchestra/testbench": "^5.0",
         "phpmd/phpmd": "^2.6",
-        "phpunit/phpunit": "8.3.* || 8.4.* || 8.5.* || 9.0.*",
+        "phpunit/phpunit": "9.*",
         "slevomat/coding-standard": "6.0.8",
         "squizlabs/php_codesniffer": "^3.5"
     },

src/Enumeration.php

@@ -3,15 +3,18 @@
 namespace Sourceboat\Enumeration;
 
 use Eloquent\Enumeration\AbstractEnumeration;
+use Illuminate\Contracts\Database\Eloquent\Castable;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Support\Str;
+use Sourceboat\Enumeration\Casts\Enum;
 use Sourceboat\Enumeration\Rules\EnumerationValue;
 
 /**
  * Abstract class to extend from for enum functionality.
  *
  * @SuppressWarnings(PHPMD.TooManyPublicMethods)
  */
-abstract class Enumeration extends AbstractEnumeration
+abstract class Enumeration extends AbstractEnumeration implements Castable
 {
     /**
      * Path to the localization for the enum-values.
@@ -224,4 +227,9 @@ public function __call($method, $arguments)
             return $this->is(static::memberByKey($key, false));
         }
     }
+
+    public static function castUsing(): CastsAttributes
+    {
+        return new Enum(static::class);
+    }
 }

tests/TestModel.php

@@ -10,5 +10,6 @@ class TestModel extends Model
     protected $casts = [
         'role' => Enum::class . ':' . UserRole::class . ',0',
         'type' => Enum::class . ':' . FruitType::class,
+        'typeCastable' => FruitType::class,
     ];
 }

tests/feature/ModelCastsEnumsTest.php

@@ -30,6 +30,7 @@ public function testGetDefaultMemberWhenNotSet(): void
     public function testGetNullWhenNotSetAndNullable(): void
     {
         $this->assertNull($this->model->type);
+        $this->assertNull($this->model->typeCastable);
     }
 
     /**
@@ -75,6 +76,24 @@ public function testSetterValidationWithCorrectNullValue(): void
         }
     }
 
+    /**
+     * Check if the validation when setting an enum-property
+     * with a correct value of null throws no exception.
+     */
+    public function testSetterValidationWithCorrectNullValueCastable(): void
+    {
+        try {
+            $this->model->typeCastable = FruitType::NUT();
+            $this->assertEquals(FruitType::NUT(), $this->model->typeCastable);
+
+            $this->model->typeCastable = null;
+            $this->assertTrue(true);
+            $this->assertNull($this->model->typeCastable);
+        } catch (UndefinedMemberException $e) {
+            $this->assertTrue(false, 'Correct value was rejected');
+        }
+    }
+
     /**
      * Check if the validation when setting an enum-property
      * with a correct skalar value throws no exception.