Merge branch 'release/5.0.0-rc.1'

Author: lindyhopchris

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+## [5.0.0-rc.1] - 2025-10-09
+
+### Added
+
+- **BREAKING**: The `Identifier` interface now has an `any()` method that returns `true` if any of the given identifiers
+  match the identifier. If you have implemented any custom identifiers, you can add the `IsIdentifier` trait to
+  implement this new method.
+- **BREAKING**: Add `message()` and `messages()` helper methods to the `ErrorList` interface. Although technically
+  breaking, this will not affect most implementations as the concrete error list class provided this package has been
+  updated.
+
 ## [4.1.0] - 2025-10-03
 
 ### Added
@@ -489,6 +500,10 @@ All notable changes to this project will be documented in this file. This projec
 
 Initial release.
 
+[5.0.0-rc.1]: https://github.com/cloudcreativity/ddd-modules/compare/v4.1.0...v5.0.0-rc.1
+
+[4.1.0]: https://github.com/cloudcreativity/ddd-modules/compare/v4.0.0...v4.1.0
+
 [4.0.0]: https://github.com/cloudcreativity/ddd-modules/compare/v3.4.0...v4.0.0
 
 [3.4.0]: https://github.com/cloudcreativity/ddd-modules/compare/v3.3.1...v3.4.0

composer.json

@@ -61,8 +61,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "4.x-dev",
-            "dev-next": "5.x-dev"
+            "dev-develop": "5.x-dev",
+            "dev-next": "6.x-dev"
         }
     },
     "minimum-stability": "stable",

docs/guide/upgrade.md

@@ -1,5 +1,27 @@
 # Upgrade Guide
 
+## 4.x to 5.x
+
+Upgrade using Composer:
+
+```bash
+composer config minimum-stability rc
+composer require cloudcreativity/ddd-modules:^5.0
+```
+
+### Identifiers
+
+A new `any()` method has been added to the `Identifier` interface. This will only affect your implementation if you have
+implemented any custom identifier classes. To solve, add the `IsIdentifier` trait to your class.
+
+### Other Changes
+
+Although this release contains other breaking changes, most implementations can upgrade without making any changes. This
+is because the majority of changes affect classes that are implemented by this package - and it is unlikely you are
+implementing these yourself.
+
+Refer to the changelog for a full list of changes.
+
 ## 3.x to 4.x
 
 Upgrade using Composer:
@@ -8,7 +30,9 @@ Upgrade using Composer:
 composer require cloudcreativity/ddd-modules:^4.0
 ```
 
-Although this release contains breaking changes, most implementations can upgrade without making any changes. This is because the majority of changes affect classes that are implemented by this package - and it is unlikely you are implementing these yourself.
+Although this release contains breaking changes, most implementations can upgrade without making any changes. This is
+because the majority of changes affect classes that are implemented by this package - and it is unlikely you are
+implementing these yourself.
 
 Refer to the changelog for a full list of changes.
 

src/Contracts/Toolkit/Identifiers/Identifier.php

@@ -22,6 +22,11 @@ interface Identifier extends Stringable, Contextual
      */
     public function is(?self $other): bool;
 
+    /**
+     * Is the identifier any of the provided identifiers?
+     */
+    public function any(?self ...$others): bool;
+
     /**
      * Fluent to-string method.
      */

src/Contracts/Toolkit/Result/ListOfErrors.php

@@ -38,7 +38,7 @@ public function contains(Closure|UnitEnum $matcher): bool;
     /**
      * Get all the unique error codes in the list.
      *
-     * @return array<UnitEnum>
+     * @return list<UnitEnum>
      */
     public function codes(): array;
 
@@ -47,6 +47,20 @@ public function codes(): array;
      */
     public function code(): ?UnitEnum;
 
+    /**
+     * Get all the unique error messages in the list.
+     *
+     * @return list<non-empty-string>
+     */
+    public function messages(): array;
+
+    /**
+     * Get the first error message in the list.
+     *
+     * @return non-empty-string|null
+     */
+    public function message(): ?string;
+
     /**
      * Return a new instance with the provided error pushed on to the end of the list.
      *

src/Toolkit/Identifiers/Guid.php

@@ -23,6 +23,8 @@
 
 final readonly class Guid implements Identifier
 {
+    use IsIdentifier;
+
     public static function from(Identifier $value): self
     {
         if ($value instanceof self) {

src/Toolkit/Identifiers/IntegerId.php

@@ -19,6 +19,8 @@
 
 final readonly class IntegerId implements Identifier, JsonSerializable
 {
+    use IsIdentifier;
+
     public static function from(Identifier|int $value): self
     {
         return match(true) {

src/Toolkit/Identifiers/IsIdentifier.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * Copyright 2025 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\Modules\Toolkit\Identifiers;
+
+use CloudCreativity\Modules\Contracts\Toolkit\Identifiers\Identifier;
+
+trait IsIdentifier
+{
+    public function any(?Identifier ...$others): bool
+    {
+        return array_any(
+            $others,
+            fn (?Identifier $other): bool => $this->is($other),
+        );
+    }
+}

src/Toolkit/Identifiers/StringId.php

@@ -19,6 +19,8 @@
 
 final readonly class StringId implements Identifier, JsonSerializable
 {
+    use IsIdentifier;
+
     public static function from(Identifier|string $value): self
     {
         return match(true) {

src/Toolkit/Identifiers/Uuid.php

@@ -20,6 +20,8 @@
 
 final class Uuid implements Identifier, JsonSerializable
 {
+    use IsIdentifier;
+
     private static ?IUuidFactory $factory = null;
 
     public static function setFactory(?IUuidFactory $factory): void