Merge branch 'develop'

* develop:
  specify next release
  add shortcut to define optional keys on a shape

Author: Baptouuuu

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.0 - 2024-03-05
+
+### Added
+
+- You can now do `Shape::of(...)->optional('key', $constraint)` instead of `Shape::of(...)->with('key', $constraint)->optional('key')` thus avoiding to repeat the key name
+
 ## 1.1.1 - 2024-02-24
 
 ### Fixed

proofs/shape.php

@@ -132,4 +132,31 @@ static function($assert) {
             );
         },
     );
+
+    yield test(
+        'Shape with optional key with constraint directly specified',
+        static function($assert) {
+            $assert->true(
+                Shape::of('foo', Is::int())
+                    ->optional('bar', Is::bool())
+                    ->asPredicate()([
+                        'foo' => 42,
+                    ]),
+            );
+            $assert->same(
+                [
+                    'foo' => 42,
+                ],
+                Shape::of('foo', Is::int())
+                    ->optional('bar', Is::bool())([
+                        'foo' => 42,
+                        'baz' => 'invalid',
+                    ])
+                    ->match(
+                        static fn($value) => $value,
+                        static fn() => null,
+                    ),
+            );
+        },
+    );
 };

src/Shape.php

@@ -94,12 +94,17 @@ public function with(string $key, Constraint $constraint): self
     /**
      * @param non-empty-string $key
      */
-    public function optional(string $key): self
+    public function optional(string $key, Constraint $constraint = null): self
     {
         $optional = $this->optional;
         $optional[] = $key;
+        $constraints = $this->constraints;
+
+        if ($constraint instanceof Constraint) {
+            $constraints[$key] = $constraint;
+        }
 
-        return new self($this->constraints, $optional);
+        return new self($constraints, $optional);
     }
 
     public function and(Constraint $constraint): Constraint