respect-validation/tests/feature/Issues/Issue1334Test.php
Henrique Moody 1915b6fff7
Use paths to identify when a rule fails
When nested-structural validation fails, it's challenging to identify
which rule failed from the main exception message. A great example is
the `Issue796Test.php` file. The exception message says:

host must be a string

But you're left unsure whether it's the `host` key from the `mysql` key
or the `postgresql` key.

This commit changes that behaviour by introducing the concept of "Path."
The `path` represents the path that a rule has taken, and we can use it
in structural rules to identify the path of an array or object.

Here's what it looks like before and after:

```diff
-host must be a string
+`.mysql.host` must be a string
```

Because paths are a specific concept, I added a dot (`.`) at the
beginning of all paths when displaying them. I was inspired by the `jq`
syntax. I also added backticks around paths to distinguish them from any
other value.

I didn't manage to fix a test, and I skipped it instead of fixing it
because I want to make changes in how we display error messages as
arrays, and it will be easier to fix it then.
2024-12-27 23:28:35 +01:00

49 lines
1.9 KiB
PHP

<?php
/*
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
* SPDX-License-Identifier: MIT
*/
declare(strict_types=1);
test('https://github.com/Respect/Validation/issues/1334', expectAll(
function (): void {
v::notEmpty()->iterableType()->each(
v::key('street', v::stringType()->notEmpty())
->key('region', v::stringType()->notEmpty())
->key('country', v::stringType()->notEmpty())
->keyOptional('other', v::nullOr(v::notEmpty()->stringType())),
)->assert(
[
['region' => 'Oregon', 'country' => 'USA', 'other' => 123],
['street' => '', 'region' => 'Oregon', 'country' => 'USA'],
['street' => 123, 'region' => 'Oregon', 'country' => 'USA'],
],
);
},
'`.0.street` must be present',
<<<'FULL_MESSAGE'
- Each item in `[["region": "Oregon", "country": "USA", "other": 123], ["street": "", "region": "Oregon", "country": "USA"], ["s ... ]` must be valid
- `.0` must pass the rules
- `.street` must be present
- `.other` must pass the rules
- `.other` must be a string or must be null
- `.1` must pass the rules
- `.street` must not be empty
- `.2` must pass the rules
- `.street` must be a string
FULL_MESSAGE,
[
'each' => [
'__root__' => 'Each item in `[["region": "Oregon", "country": "USA", "other": 123], ["street": "", "region": "Oregon", "country": "USA"], ["s ... ]` must be valid',
0 => [
'__root__' => '`.0` must pass the rules',
'street' => '`.street` must be present',
'other' => '`.other` must be a string or must be null',
],
1 => '`.street` must not be empty',
2 => '`.street` must be a string',
],
],
));