respect-validation/tests/feature/ShouldNotOverwriteDefinedNamesTest.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

25 lines
648 B
PHP

<?php
/*
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
* SPDX-License-Identifier: MIT
*/
declare(strict_types=1);
$input = ['email' => 'not an email'];
test('Scenario #1', expectMessage(
fn() => v::key('email', v::email()->setName('Email'))->setName('Foo')->assert($input),
'Email must be a valid email address',
));
test('Scenario #2', expectMessage(
fn() => v::key('email', v::email())->setName('Email')->assert($input),
'Email must be a valid email address',
));
test('Scenario #3', expectMessage(
fn() => v::key('email', v::email())->assert($input),
'`.email` must be a valid email address',
));