Update user test state casting

Author: bfiessinger

tests/Casts/StateCaster.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Kodeine\Metable\Tests\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+class StateCaster implements CastsAttributes
+{
+    private string $baseStateClass;
+
+    public function __construct(string $baseStateClass)
+    {
+        $this->baseStateClass = $baseStateClass;
+    }
+
+	public function get($model, $key, $value, $attributes) {
+		if ( is_null( $value ) ) return null;
+
+		if (! is_subclass_of($value, $this->baseStateClass)) {
+			return null;
+		}
+
+		$stateClassName = $value::config()['default'];
+
+		$state = new $stateClassName($model);
+
+		return $state;
+	}
+	
+	public function set($model, $key, $value, $attributes) {
+		if ( is_null( $value ) ) return null;
+
+		if (! is_subclass_of($value, $this->baseStateClass)) {
+			throw new \Exception('Invalid state class.');
+		}
+
+		$value = new $value($model);
+
+		if ($value instanceof $this->baseStateClass) {
+			$value->setField($key);
+		}
+
+		return $value->getMorphClass();
+	}
+}

tests/Casts/UserCastedObject.php

@@ -3,22 +3,43 @@
 namespace Kodeine\Metable\Tests\Casts;
 
 use Illuminate\Contracts\Database\Eloquent\Castable;
-use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 
-class UserCastedObject implements Castable, CastsAttributes
+abstract class UserCastedObject implements Castable
 {
-	public $description;
-	
-	public function get($model, $key, $value, $attributes) {
-		if ( is_null( $value ) ) return null;
-		return json_decode( $value, true );
+	public function __construct($model) {
+		$this->model = $model;
+		$this->stateConfig = static::config();
 	}
-	
-	public function set($model, $key, $value, $attributes) {
-		return [$key => json_encode( $value )];
+
+	public static function config()
+	{
+		return [
+			'default' => null,
+		];
 	}
 
 	public static function castUsing(array $arguments) {
-		return new self();
+		return new StateCaster(static::class);
+	}
+
+    public function setField(string $field): self
+    {
+        $this->field = $field;
+
+        return $this;
+    }
+
+    public static function getMorphClass(): string
+    {
+        return static::$name ?? static::class;
+    }
+
+	public function make(string $name, $model)
+	{
+		if (is_null($name)) {
+			return null;
+		}
+
+		return new $name($model);
 	}
 }

tests/Casts/UserState/DefaultState.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Kodeine\Metable\Tests\Casts\UserState;
+
+class DefaultState extends State
+{
+	public string $description;
+	
+	public function __construct() {
+		$this->description = $this->description();
+	}
+
+	public function description(): string {
+		return 'This is a default description.';
+	}
+}

tests/Casts/UserState/State.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Kodeine\Metable\Tests\Casts\UserState;
+
+use Kodeine\Metable\Tests\Casts\UserCastedObject;
+
+abstract class State extends UserCastedObject
+{
+	abstract public function description(): string;
+
+	public static function config()
+	{
+		return [
+			'default' => DefaultState::class,
+		];
+	}
+}

tests/MetableTest.php

@@ -10,6 +10,7 @@
 use Kodeine\Metable\Tests\Models\UserTest;
 use Illuminate\Database\Capsule\Manager as Capsule;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Kodeine\Metable\Tests\Casts\UserState\DefaultState;
 
 class MetableTest extends TestCase
 {
@@ -49,6 +50,16 @@ public static function setUpBeforeClass(): void {
 		} );
 	}
 
+	public function testCast() {
+		$user = new UserTest;
+
+		$this->assertNull( $user->state, 'Casted object should be null by default' );
+
+		$user->state = DefaultState::class;
+
+		$this->assertTrue( $user->state instanceof DefaultState, 'Casted object should be instanceof DefaultState' );		
+	}
+
 	public function testFluentMeta() {
 		$user = new UserTest;
 

tests/Models/UserTest.php

@@ -6,13 +6,13 @@
 use Illuminate\Events\Dispatcher;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasOne;
-use Kodeine\Metable\Tests\Casts\UserCastedObject;
-use Kodeine\Metable\Tests\Traits\HasUserCasts;
+use Kodeine\Metable\Tests\Casts\UserState\State;
+use Kodeine\Metable\Tests\Traits\HasUserStates;
 
 class UserTest extends Model
 {
 	use Metable;
-	use HasUserCasts;
+	use HasUserStates;
 
 	public $defaultMetaValues = [
 		'default_meta_key' => 'default_meta_value',
@@ -21,9 +21,9 @@ class UserTest extends Model
 	public $hideMeta = false;
 
 	public $disableFluentMeta = false;
-	
+
 	protected $casts = [
-		'state' => UserCastedObject::class,
+		'state' => State::class,
 	];
 
 	public function getNullCastAttribute() {

tests/Traits/HasUserCasts.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Kodeine\Metable\Tests\Traits;
+
+use Kodeine\Metable\Tests\Casts\UserState\State;
+
+trait HasUserStates
+{
+	public $casted = [
+		'state' => State::class,
+	];
+
+	public static function bootHasUserCasts()
+	{
+		self::creating( function ( $model ) {
+			$model->setDefaultCastedProperties();
+		} );
+	}
+
+	public function initializeHasUserCasts()
+	{
+		$this->setDefaultCastedProperties();
+	}
+
+	private function getStateConfigs()
+	{
+		$casts = $this->getCasts();
+		
+		$states = [];
+
+		foreach ($casts as $prop => $state) {
+			if (! is_subclass_of($state, UserCastedObject::class)) {
+				continue;
+			}
+
+			$states[$prop] = $state::config();
+		}
+
+		return $states;
+	}
+
+	private function setDefaultCastedProperties() 
+	{
+		foreach ( $this->getStateConfigs() as $prop => $config ) {
+			if ($this->{$prop} === null) {
+				continue;
+			}
+
+			if ( ! isset( $config['default'] ) ) {
+				continue;
+			}
+
+			$this->{$prop} = $config['default'];
+		}
+	}
+}