Changes how model properties are determined as set (#28)

Author: JasonTheAdams

src/Models/ModelProperty.php

@@ -19,6 +19,16 @@ class ModelProperty {
 	 */
 	private bool $isDirty = false;
 
+	/**
+	 * Whether the original value has been set.
+	 */
+	private bool $isOriginalValueSet = false;
+
+	/**
+	 * Whether the value has been set.
+	 */
+	private bool $isValueSet = false;
+
 	/**
 	 * The key of the property.
 	 */
@@ -58,6 +68,8 @@ public function __construct( string $key, ModelPropertyDefinition $definition, $
 
 			$this->value = $initialValue;
 			$this->originalValue = $this->value;
+			$this->isValueSet = true;
+			$this->isOriginalValueSet = true;
 		}
 	}
 
@@ -98,7 +110,7 @@ public function getOriginalValue() {
 	 * @return mixed
 	 */
 	public function getValue() {
-		return $this->value ?? null;
+		return $this->isValueSet ? $this->value : null;
 	}
 
 	/**
@@ -125,7 +137,7 @@ public function isDirty(): bool {
 	 * @since 2.0.0
 	 */
 	public function isSet(): bool {
-		return isset( $this->value );
+		return $this->isValueSet;
 	}
 
 	/**
@@ -134,10 +146,11 @@ public function isSet(): bool {
 	 * @since 2.0.0
 	 */
 	public function revertChanges(): void {
-		if ( isset( $this->originalValue ) ) {
+		if ( $this->isOriginalValueSet ) {
 			$this->value = $this->originalValue;
+			$this->isValueSet = true;
 		} else {
-			unset( $this->value );
+			$this->isValueSet = false;
 		}
 
 		$this->isDirty = false;
@@ -150,6 +163,7 @@ public function revertChanges(): void {
 	 */
 	public function commitChanges(): void {
 		$this->originalValue = $this->value;
+		$this->isOriginalValueSet = $this->isValueSet;
 		$this->isDirty = false;
 	}
 
@@ -166,7 +180,8 @@ public function setValue( $value ): self {
 		}
 
 		$this->value = $value;
-		$this->isDirty = $value !== $this->originalValue;
+		$this->isValueSet = true;
+		$this->isDirty = ! $this->isOriginalValueSet || $value !== $this->originalValue;
 
 		return $this;
 	}
@@ -177,12 +192,10 @@ public function setValue( $value ): self {
 	 * @since 2.0.0
 	 */
 	public function unset(): void {
-		// Only attempt to unset if the property is already set
-		if (isset($this->value)) {
-			unset( $this->value );
-		}
+		// Mark the value as unset
+		$this->isValueSet = false;
 
 		// If the orginal value had a value we have now deviated
-		$this->isDirty = isset( $this->originalValue );
+		$this->isDirty = $this->isOriginalValueSet;
 	}
 }

tests/wpunit/ModelPropertyTest.php

@@ -184,6 +184,39 @@ public function testRevertChanges() {
 		$this->assertSame('John', $property->getOriginalValue());
 	}
 
+	/**
+	 * @since 2.0.0
+	 *
+	 * @covers ::isSet
+	 */
+	public function testIsSet() {
+		$definition = new ModelPropertyDefinition();
+
+		// Test with initial value
+		$property = new ModelProperty('name', $definition, 'John');
+		$this->assertTrue($property->isSet());
+
+		// Test with no initial value
+		$property = new ModelProperty('name', $definition);
+		$this->assertFalse($property->isSet());
+
+		// Test with default value
+		$definition = (new ModelPropertyDefinition())->default('default-value');
+		$property = new ModelProperty('name', $definition);
+		$this->assertTrue($property->isSet());
+
+		// Test with null value
+		$definition = (new ModelPropertyDefinition())->nullable();
+		$property = new ModelProperty('name', $definition);
+		$this->assertFalse($property->isSet());
+		$property->setValue(null);
+		$this->assertTrue($property->isSet());
+
+		// Test that a null initial value is also considered set
+		$property = new ModelProperty('name', $definition, null);
+		$this->assertTrue($property->isSet());
+	}
+
 	/**
 	 * @since 2.0.0
 	 *