Include attribute name in error messages when it's present #644

dood- · 2024-01-02T13:17:08Z

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues	#630

codecov · 2024-01-02T13:18:05Z

Codecov Report

Attention: Patch coverage is 93.25843% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 94.72%. Comparing base (e019e5c) to head (43e9f45).

Files	Patch %	Lines
src/Rule/Count.php	0.00%	3 Missing ⚠️
src/Rule/Length.php	0.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #644      +/-   ##
============================================
+ Coverage     94.60%   94.72%   +0.12%     
- Complexity      796      801       +5     
============================================
  Files            93       93              
  Lines          2426     2483      +57     
============================================
+ Hits           2295     2352      +57     
  Misses          131      131

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

what-the-diff · 2024-01-02T13:18:40Z

PR Summary

New Label Features
Introduced the feature of labels in error messages. This improvement allows custom labels to be used in classes, enhancing error readability by providing more specific descriptions. This will help update error messages on the application resulting in a more user-friendly interface.
New Method for Label Retrieve
Addition of a getLabels() method enabling easy access to the labels of class properties, which will aid in greater error specificity.
Modification of Various Validation Rules
Updated various validation rules both in files like Each.php, Email.php, In.php, Ip.php, Json.php, Length.php, Nested.php, Number.php, OneOf.php, Regex.php, Required.php, etc., and their corresponding "Rule Handler" files. These modifications equip each rule with a 'label' parameter to provide more lucid error messages, leading to an improved user experience.
Adjustments in Defined Classes
Changes in defined classes including StringValue, StringValueHandler, Subset, SubsetHandler, CountableLimitHandlerTrait, TrueValue, TrueValueHandler, Url, UrlHandler, ValidationContext, Validator and more. These changes result in improved handling and processing of error messages in various conditions.
Changes and Additions in Test Classes
Numerous test classes like ConfigTest, ObjectDataSetTest, RulesDumperTest, AtLeastTest, BooleanValueTest, CompositeTest and others, were updated. Modifications vary from changing default error messages, templates to adding the 'label' parameter. These alterations ensure comprehensive testing of the new feature, guaranteeing reliable functionality and performance.
Default Messages Enhanced in Rule Tests
Numerous rule test files such as CountTest.php, EachTest.php, EmailTest.php, EqualTest.php, GreaterThanTest.php and so on were updated. The improvement enables error messages to use a label placeholder instead of hard-coded values. This brings flexibility in error messages, making them more informative and helpful to users.
Updates to Documentation
The documentation has been updated to guide configuring rules via PHP attributes, promoting clarity for users.
Implementation of Debug Collector
The addition of a new feature for the debug collector aims at enhancing debugging capabilities.

Please note this is a high overview of the changes and not a granular breakdown.

docs/guide/en/configuring-rules-via-php-attributes.md

Co-authored-by: Alexander Makarov <[email protected]>

dood- · 2024-01-03T17:11:21Z

Since I added a new placeholder {label}, perhaps it is better to make the placeholder {attribute} always be replaced by the name of the property?

samdark · 2024-01-05T12:20:50Z

@vjik, @arogachev what do you think?

vjik

Hm. Is there a case when need attribute in message and at the same time, there is a label?

Seems, it's overhead. I suggest use placeholder {attribute} only and return translated label, if it exist, or translated attribute otherwise.

samdark · 2024-01-07T14:11:34Z

No, I can't imagine such a case and I agree with @vjik. @dood- would you please adjust the name to be {attribute}? Thanks.

dood- · 2024-01-07T16:35:29Z

@samdark, @vjik If we leave "The value" as a default value, then there is a problem with displaying the attribute names of arrays.

Here is a test for an example:

validator/tests/Rule/OneOfTest.php

Lines 172 to 180 in 1e73321

    
           'custom incorrect input message with parameters, attribute set' => [ 
        
               ['attribute' => 1], 
        
               [ 
        
                   'attribute' => new OneOf( 
        
                       ['attr1', 'attr2'], 
        
                       incorrectInputMessage: 'Attribute - {attribute}, type - {type}.', 
        
                   ), 
        
               ], 
        
               ['attribute' => ['Attribute - attribute, type - int.']],

We can not specify a Label attribute for the array or implement the LabelsProviderInterface, so the placeholder value will always be "The value"

vjik · 2024-01-08T06:39:09Z

If we leave "The value" as a default value

There will be no default value.

Will be one attribute {attribute}. Value of this placeholder by priority:

Translated label (if label exist).
Translated attribute.

For case with arrays always will be used translated attribute.

dood- · 2024-01-08T21:35:32Z

If necessary, I can remove Attribute::TARGET_CLASS from the Label attribute.
I also fixed the error messages when using "StopOnError". There, instead of the attribute name, a number was displayed

samdark · 2024-01-09T06:58:09Z

If necessary, I can remove Attribute::TARGET_CLASS from the Label attribute.

Yes, makes sense.

tests/Rule/AtLeastTest.php

src/ValidationContext.php

dood- · 2024-02-01T12:04:04Z

Also need kill mutants from mutation testing.

Is it possible to disable mutants for a specific php version or just use @infection-ignore-all?

samdark · 2024-02-09T07:04:35Z

I guess @vjik meant fixing tests so there are no mutants, not ignoring these.

vjik

Overall looks good 👍
There's just a little bit left to finish.

messages/ru/yii-validator.php

tests/Rule/DateTimeTest.php

arogachev · 2024-02-26T09:04:33Z

Thanks for you great work! I will review this as well.

arogachev · 2024-02-26T08:30:49Z

docs/guide/en/configuring-rules-via-php-attributes.md

@@ -74,7 +74,7 @@ final class User

 > **Note:** [readonly properties] are supported only starting from PHP 8.1.

-Error messages may include an `{attribute}` placeholder that is replaced with the name of the property. If you would 
+Error messages may include `{attribute}` or `{Attribute}` placeholder that is replaced with the name of the property. If you would 


Need to cover the differences between the two.

arogachev · 2024-02-26T08:52:57Z

src/Rule/AtLeastHandler.php

+                'attribute' => $context->getTranslatedAttribute(),
+                'Attribute' => StringHelper::uppercaseFirstCharacter($context->getTranslatedAttribute()),


These seem to be redundant in this case, because here there are multiple error attributes, not just a single one.

arogachev · 2024-02-26T08:59:03Z

src/ValidationContext.php

     */
-    public function getTranslatedAttribute(): ?string
+    public function getTranslatedAttribute(): string


Maybe add a method like getCapitalizedTranslatedAttribute() or additional argument in existing method with already applied StringHelper? That would reduce the code a bit.

arogachev · 2024-02-26T09:01:38Z

src/Rule/CompareHandler.php

@@ -61,6 +63,7 @@ public function validate(mixed $value, object $rule, ValidationContext $context)

        return (new Result())->addError($rule->getMessage(), [
            'attribute' => $context->getTranslatedAttribute(),
+            'Attribute' => StringHelper::uppercaseFirstCharacter($context->getTranslatedAttribute()),


Maybe group common parameters here and in other similar places?

CHANGELOG.md

src/ValidationContext.php

arogachev · 2024-02-26T12:15:44Z

src/Rule/AbstractCompare.php

-            '>=' => 'Value must be greater than or equal to "{targetValueOrAttribute}".',
-            '<' => 'Value must be less than "{targetValueOrAttribute}".',
-            '<=' => 'Value must be less than or equal to "{targetValueOrAttribute}".',
+            '==', => '{Attribute} must be equal to "{targetValueOrAttribute}".',


targetValueOrAttribute - support capitalization as well?

arogachev · 2024-02-26T12:16:15Z

src/Rule/AtLeast.php

@@ -62,7 +62,7 @@ final class AtLeast implements DumpedRuleInterface, SkipOnErrorInterface, WhenIn
    public function __construct(
        private array $attributes,
        private int $min = 1,
-        private string $incorrectInputMessage = 'The value must be an array or an object.',
+        private string $incorrectInputMessage = '{Attribute} must be an array or an object.',
        private string $message = 'At least {min, number} {min, plural, one{attribute} other{attributes}} from this ' .


attributes - support capitalization as well?

Co-authored-by: Alexey Rogachev <[email protected]>

docs/guide/en/customizing-error-messages.md

messages/ru/yii-validator.php

Co-authored-by: Alexander Makarov <[email protected]>

samdark · 2024-03-04T11:39:34Z

Thank you!

dood- added 4 commits January 2, 2024 15:44

Add the label placeholder

092d580

Add ability to use a label with classes

c305a4c

Update changelog

03434b7

Update docs

0c346dc

Add tests

b2e27e9

samdark requested changes Jan 3, 2024

View reviewed changes

docs/guide/en/configuring-rules-via-php-attributes.md Outdated Show resolved Hide resolved

docs/guide/en/configuring-rules-via-php-attributes.md Outdated Show resolved Hide resolved

Update docs/guide/en/configuring-rules-via-php-attributes.md

1e73321

Co-authored-by: Alexander Makarov <[email protected]>

samdark approved these changes Jan 3, 2024

View reviewed changes

samdark requested review from vjik and arogachev January 3, 2024 16:53

vjik reviewed Jan 6, 2024

View reviewed changes

vjik added the status:under discussion label Jan 6, 2024

Remove the label placeholder

a952cad

samdark approved these changes Jan 9, 2024

View reviewed changes

dood- and others added 3 commits January 9, 2024 14:23

Remove TARGET_CLASS from the Label attribute

35d0801

Update changelog and docs

20ee31a

Update composer.json

edea10a

vjik requested changes Jan 10, 2024

View reviewed changes

tests/Rule/AtLeastTest.php Outdated Show resolved Hide resolved

src/ValidationContext.php Outdated Show resolved Hide resolved

dood- added 3 commits January 10, 2024 14:35

Fix AtLeastTest

c8b5292

Change The value to Value

3202fa9

Add the Attribute placeholder

aca368e

Merge branch 'master' into enh-attribute-name-in-messages

338e647

samdark and others added 2 commits February 9, 2024 10:04

Merge branch 'master' into enh-attribute-name-in-messages

0d1f1dd

Fix DateTimeTest

6cbf418

samdark requested a review from vjik February 9, 2024 20:33

Merge branch 'master' into enh-attribute-name-in-messages

f0a62df

vjik requested changes Feb 18, 2024

View reviewed changes

messages/ru/yii-validator.php Show resolved Hide resolved

tests/Rule/DateTimeTest.php Outdated Show resolved Hide resolved

dood- and others added 6 commits February 23, 2024 00:32

Fix DateTime labels

536423a

Add translations

f41b6dd

Add attribute label to the ip rule

eeb487c

Fix tests

cee2b9a

Merge branch 'master' into enh-attribute-name-in-messages

418a0b1

fix doc

c97d425

vjik approved these changes Feb 25, 2024

View reviewed changes

arogachev requested changes Feb 26, 2024

View reviewed changes

dood- and others added 7 commits March 2, 2024 02:55

Remove redundant attribute

072e315

Add getCapitalizedTranslatedAttribute

b5b0bb9

Update docs

a1ec469

Add {attributes}

727503e

Update CHANGELOG.md

0f5d09f

Co-authored-by: Alexey Rogachev <[email protected]>

Fix mutant

7f85081

Add TargetAttribute and TargetValueOrAttribute

5e7bbfa

samdark approved these changes Mar 2, 2024

View reviewed changes

docs/guide/en/customizing-error-messages.md Outdated Show resolved Hide resolved

messages/ru/yii-validator.php Outdated Show resolved Hide resolved

Apply suggestions from code review

43e9f45

Co-authored-by: Alexander Makarov <[email protected]>

samdark merged commit f060162 into yiisoft:master Mar 4, 2024
22 of 26 checks passed

samdark removed the status:under discussion label Mar 4, 2024

arogachev mentioned this pull request Apr 3, 2024

Add aspect ratio support to Image rule #681

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include attribute name in error messages when it's present #644

Include attribute name in error messages when it's present #644

dood- commented Jan 2, 2024

codecov bot commented Jan 2, 2024 •

edited

Loading

what-the-diff bot commented Jan 2, 2024

dood- commented Jan 3, 2024

samdark commented Jan 5, 2024

vjik left a comment

samdark commented Jan 7, 2024

dood- commented Jan 7, 2024

vjik commented Jan 8, 2024

dood- commented Jan 8, 2024

samdark commented Jan 9, 2024

dood- commented Feb 1, 2024

samdark commented Feb 9, 2024

vjik left a comment

arogachev commented Feb 26, 2024

arogachev Feb 26, 2024

arogachev Feb 26, 2024

arogachev Feb 26, 2024

arogachev Feb 26, 2024

arogachev Feb 26, 2024

arogachev Feb 26, 2024

samdark commented Mar 4, 2024

		'attribute' => $context->getTranslatedAttribute(),
		'Attribute' => StringHelper::uppercaseFirstCharacter($context->getTranslatedAttribute()),

Include attribute name in error messages when it's present #644

Include attribute name in error messages when it's present #644

Conversation

dood- commented Jan 2, 2024

codecov bot commented Jan 2, 2024 • edited Loading

Codecov Report

what-the-diff bot commented Jan 2, 2024

PR Summary

dood- commented Jan 3, 2024

samdark commented Jan 5, 2024

vjik left a comment

Choose a reason for hiding this comment

samdark commented Jan 7, 2024

dood- commented Jan 7, 2024

vjik commented Jan 8, 2024

dood- commented Jan 8, 2024

samdark commented Jan 9, 2024

dood- commented Feb 1, 2024

samdark commented Feb 9, 2024

vjik left a comment

Choose a reason for hiding this comment

arogachev commented Feb 26, 2024

arogachev Feb 26, 2024

Choose a reason for hiding this comment

arogachev Feb 26, 2024

Choose a reason for hiding this comment

arogachev Feb 26, 2024

Choose a reason for hiding this comment

arogachev Feb 26, 2024

Choose a reason for hiding this comment

arogachev Feb 26, 2024

Choose a reason for hiding this comment

arogachev Feb 26, 2024

Choose a reason for hiding this comment

samdark commented Mar 4, 2024

codecov bot commented Jan 2, 2024 •

edited

Loading