Merge branch 'develop'

* develop:
  update copyright
  specify next release
  add Is::value()
  reuse workflows
  reuse workflows to test against php 8.4
  update changelog
  fix php 8.4 deprecations
  use innmind/static-analysis

Author: Baptouuuu

.github/workflows/ci.yml

@@ -4,92 +4,13 @@ on: [push]
 
 jobs:
   blackbox:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macOS-latest]
-        php-version: ['8.2', '8.3']
-        dependency-versions: ['lowest', 'highest']
-    name: 'BlackBox'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-          coverage: none
-      - name: Composer
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: ${{ matrix.dependencies }}
-      - name: BlackBox
-        run: php blackbox.php
+    uses: innmind/github-workflows/.github/workflows/black-box-matrix.yml@main
   coverage:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macOS-latest]
-        php-version: ['8.2', '8.3']
-        dependency-versions: ['lowest', 'highest']
-    name: 'Coverage'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-          coverage: xdebug
-      - name: Composer
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: ${{ matrix.dependencies }}
-      - name: BlackBox
-        run: php blackbox.php
-        env:
-          ENABLE_COVERAGE: 'true'
-      - uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+    uses: innmind/github-workflows/.github/workflows/coverage-matrix.yml@main
+    secrets: inherit
   psalm:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        php-version: ['8.2', '8.3']
-        dependency-versions: ['lowest', 'highest']
-    name: 'Psalm'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-      - name: Composer
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: ${{ matrix.dependencies }}
-      - name: Psalm
-        run: vendor/bin/psalm --shepherd
+    uses: innmind/github-workflows/.github/workflows/psalm-matrix.yml@main
   cs:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        php-version: ['8.2']
-    name: 'CS'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-      - name: Composer
-        uses: "ramsey/composer-install@v3"
-      - name: CS
-        run: vendor/bin/php-cs-fixer fix --diff --dry-run
+    uses: innmind/github-workflows/.github/workflows/cs.yml@main
+    with:
+      php-version: '8.2'

.github/workflows/documentation.yml

@@ -6,22 +6,5 @@ permissions:
   contents: write
 jobs:
   deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material
-      - run: mkdocs gh-deploy --force
+    uses: innmind/github-workflows/.github/workflows/documentation.yml@main
+    secrets: inherit

.github/workflows/release.yml

@@ -5,19 +5,7 @@ on:
     tags:
       - '*'
 
-permissions:
-  contents: write
-
 jobs:
   release:
-    name: Create release
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Create release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          tag: ${{ github.ref_name }}
-        run: |
-          gh release create "$tag" \
-              --repo="$GITHUB_REPOSITORY" \
-              --generate-notes
+    uses: innmind/github-workflows/.github/workflows/release.yml@main
+    secrets: inherit

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.8.0 - 2025-02-09
+
+### Added
+
+- `Is::value()` to allow to defined discriminators
+
+### Fixed
+
+- Support for PHP `8.4`
+
 ## 1.7.0 - 2024-11-11
 
 ### Changed

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Innmind
+Copyright (c) 2025 Innmind
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -25,7 +25,7 @@
         }
     },
     "require-dev": {
-        "vimeo/psalm": "~5.0",
+        "innmind/static-analysis": "~1.1",
         "innmind/black-box": "~5.5",
         "innmind/coding-standard": "~2.0"
     }

docs/constraints/primitives.md

@@ -68,3 +68,49 @@ use Innmind\Validation\Is;
 
 $validate = Is::list(Is::string());
 ```
+
+## Specified value
+
+This constraint makes sure the the input value is the expected one.
+
+```php
+use Innmind\Validation\Is;
+
+$validate = Is::value(42);
+```
+
+If you call the constraint with any other value than `42`, the validation will fail. Of course you can specify any value of any type you wish.
+
+??? tip
+    This is especially useful to define discriminators when the input can be multiple [shapes](array-shapes.md) that are defined by a key.
+
+    ```php
+    use Innmind\Validation\Is;
+
+    $shapeA = Is::shape('discriminator', Is::value('a'))
+        ->with('some-key', Is::string());
+    $shapeB = Is::shape('discriminator', Is::value('b'))
+        ->with('other-key', Is::int());
+
+    $validate = $shapeA->or($shapeB);
+    ```
+
+    If you can `$validate` with one of the following values it will succeed:
+
+    === "A"
+        ```php
+        [
+            'discriminator' => 'a',
+            'some-key' => 'foo',
+        ]
+        ```
+
+    === "B"
+        ```php
+        [
+            'discriminator' => 'b',
+            'other-key' => 42,
+        ]
+        ```
+
+    Otherwise it will fail for any other array shape.

proofs/is.php

@@ -643,4 +643,53 @@ static function($assert, $value) {
             );
         },
     );
+
+    yield proof(
+        'Is::value()',
+        given(
+            Set\Type::any(),
+            Set\Type::any(),
+            Set\Strings::any(),
+        )->filter(static fn($a, $b) => $a !== $b),
+        static function($assert, $a, $b, $message) {
+            $assert->same(
+                $a,
+                Is::value($a)($a)->match(
+                    static fn($value) => $value,
+                    static fn() => null,
+                ),
+            );
+            $assert->null(
+                Is::value($a)($b)->match(
+                    static fn($value) => $value,
+                    static fn() => null,
+                ),
+            );
+            $assert->same(
+                [['$', $message]],
+                Is::value($a, $message)($b)->match(
+                    static fn() => null,
+                    static fn($failures) => $failures
+                        ->map(static fn($failure) => [
+                            $failure->path()->toString(),
+                            $failure->message(),
+                        ])
+                        ->toList(),
+                ),
+            );
+            $assert
+                ->string(
+                    Is::value($a)($b)->match(
+                        static fn() => null,
+                        static fn($failures) => $failures
+                            ->map(static fn($failure) => [
+                                $failure->path()->toString(),
+                                $failure->message(),
+                            ])
+                            ->toList()[0][1],
+                    ),
+                )
+                ->startsWith('Not of expected value of type');
+        },
+    );
 };

src/Is.php

@@ -125,7 +125,7 @@ public static function null(): self
      *
      * @return Constraint<mixed, list<E>>
      */
-    public static function list(Constraint $each = null): Constraint
+    public static function list(?Constraint $each = null): Constraint
     {
         /** @var self<array, list<mixed>> */
         $list = new self(\array_is_list(...), 'list');
@@ -182,6 +182,28 @@ public static function just(?string $message = null): Constraint
         ));
     }
 
+    /**
+     * @psalm-pure
+     * @template V
+     *
+     * @param V $value
+     * @param ?non-empty-string $message
+     *
+     * @return Constraint<mixed, V>
+     */
+    public static function value(mixed $value, ?string $message = null): Constraint
+    {
+        return Of::callable(static fn(mixed $in) => match ($in) {
+            $value => Validation::success($value),
+            default => Validation::fail(Failure::of(
+                $message ?? \sprintf(
+                    'Not of expected value of type %s',
+                    \gettype($value),
+                ),
+            )),
+        });
+    }
+
     /**
      * @param non-empty-string $message
      *

src/Shape.php

@@ -87,7 +87,7 @@ public function with(string $key, Constraint $constraint): self
     /**
      * @param non-empty-string $key
      */
-    public function optional(string $key, Constraint $constraint = null): self
+    public function optional(string $key, ?Constraint $constraint = null): self
     {
         $optional = $this->optional;
         $optional[] = $key;