Release/3.0.0 (#13)

Author: gustavofreze

README.md

@@ -47,11 +47,11 @@ With the implementation of the `ValueObject` interface, and the `ValueObjectAdap
 namespace Example;
 
 use TinyBlocks\Vo\ValueObject;
-use TinyBlocks\Vo\ValueObjectAdapter;
+use TinyBlocks\Vo\ValueObjectBehavior;
 
 final class TransactionId implements ValueObject
 {
-    use ValueObjectAdapter;
+    use ValueObjectBehavior;
 
     public function __construct(private readonly string $value)
     {
@@ -67,7 +67,7 @@ The `equals` method compares the value of two VOs, and checks if they are equal.
 $transactionId = new TransactionId(value: 'e6e2442f-3bd8-421f-9ac2-f9e26ac4abd2');
 $otherTransactionId = new TransactionId(value: 'e6e2442f-3bd8-421f-9ac2-f9e26ac4abd2');
 
-$transactionId->equals(other: $otherTransactionId); # 1 (true)
+$transactionId->equals(other: $otherTransactionId); # true
 ```
 
 <div id='license'></div>

composer.json

@@ -39,7 +39,8 @@
         }
     },
     "require": {
-        "php": "^8.2"
+        "php": "^8.2",
+        "tiny-blocks/immutable-object": "^1"
     },
     "require-dev": {
         "phpmd/phpmd": "^2.15",
@@ -68,6 +69,9 @@
         "tests-no-coverage": [
             "@test-no-coverage",
             "@test-mutation-no-coverage"
+        ],
+        "tests-file-no-coverage": [
+            "@test-no-coverage"
         ]
     }
 }

src/Immutable.php

@@ -4,6 +4,8 @@
 
 namespace TinyBlocks\Vo;
 
+use TinyBlocks\Immutable\Immutable;
+
 /**
  * A Value Object is an immutable type that is only distinguishable by the state of its properties, that is,
  * unlike an entity, which has a unique identifier and remains distinct even if its properties are
@@ -14,15 +16,11 @@
 interface ValueObject extends Immutable
 {
     /**
-     * Returns object values.
-     * @return array
-     */
-    public function values(): array;
-
-    /**
-     * Compare two ValueObjects, and tell if they are equal.
-     * @param ValueObject $other
-     * @return bool
+     * Compares this ValueObject with another to determine if they are equal.
+     * Two ValueObjects are considered equal if their properties have the same values.
+     *
+     * @param ValueObject $other The ValueObject to compare with.
+     * @return bool True if the objects are equal, false otherwise.
      */
     public function equals(ValueObject $other): bool;
 }

src/Internal/Exceptions/InvalidProperty.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TinyBlocks\Vo;
+
+use TinyBlocks\Immutable\Immutability;
+
+trait ValueObjectBehavior
+{
+    use Immutability;
+
+    public function equals(ValueObject $other): bool
+    {
+        return get_object_vars($this) == get_object_vars($other);
+    }
+}

src/Internal/Exceptions/PropertyCannotBeChanged.php

@@ -5,11 +5,11 @@
 namespace TinyBlocks\Vo\Models;
 
 use TinyBlocks\Vo\ValueObject;
-use TinyBlocks\Vo\ValueObjectAdapter;
+use TinyBlocks\Vo\ValueObjectBehavior;
 
 final readonly class Order implements ValueObject
 {
-    use ValueObjectAdapter;
+    use ValueObjectBehavior;
 
     public function __construct(public int $id, public iterable $products = [])
     {