[Validator] Added `CssColor` constraint #40168

welcoMattic · 2021-02-12T15:55:43Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets
License	MIT
Doc PR	symfony/symfony-docs#14965

This PR introduces a new CssColor constraint. It comes with 3 validation modes:

Long, which allows all hexadecimal representation of a color, or 9 (#EEEEEEFF) characters
Short, which only allows hexadecimal colors on 4 (#EEE), 5 (#FFF00) characters
Named colors, which matches the official list of named colors
HTML5, which allows hexadecimal colors on 7 (#EEEEEE) characters as well as the HTML5 input type color

I know that such a color validation already exists in Symfony (in the ColorType class), but it's hardcoded in the FormType, and not usable as an assert Annotation. We could decide to remove this hardcoded validation in favor of the new added CssColor constraint. Let me know, if yes, I will make the change.

norkunas · 2021-02-12T16:21:04Z

Why only hex? Maybe Color constraint with hex, rgb(a),hsl(a) support would be better :)

welcoMattic · 2021-02-12T16:33:06Z

@norkunas Yes, I thought about it. But I was not sure if we have to support hex,rgb(a),hsl(a) in the same Constraint. I think that we should make separate Constraints to avoid to guess the format. WDYT?

norkunas · 2021-02-12T16:34:02Z

Also good idea :)

javiereguiluz · 2021-02-12T16:39:50Z

Actually, CSS 4 defines four kinds of hexadecimal colors (https://www.w3.org/TR/css-color-4/#typedef-hex-color):

6-digit: #00ff00
8-digit: #0000ffcc
3-digit: #0f0
4-digit: #0f0c

src/Symfony/Component/Validator/Constraints/HexaColorValidator.php

fancyweb · 2021-02-12T18:10:41Z

Interesting previous discussions on #35626

OskarStark · 2021-02-12T19:43:43Z

I would prefer HexColor instead of HexaColor

src/Symfony/Component/Validator/Tests/Constraints/HexaColorValidatorTest.php

javiereguiluz · 2021-05-25T13:22:45Z

Here are some comments in case we want to move this forward:

I'd rename HexaColor to CssColor, because this constraint is only about CSS-valid colors
CssColor would also match Symfony's primary target: the web (and we use CSS colors even when outside the web; e.g. Symfony's Console true colors are defined with some of the CSS-valid formats)
Even if it's called CssColor we don't need to support from the beginning all current (and future) ways of defining CSS colors. This is the same as CardScheme constraint: it only supported a few of the most popular cards at first and, in the following years, we added more cards. Even if it's called CardScheme, it doesn't support all the existing card schemes yet ... but that's fine; it's still very useful and widely used (so, we can add a CssColor without supporting ALL color formats at first, specially the less used ones)

src/Symfony/Component/Validator/CHANGELOG.md

src/Symfony/Component/Validator/Resources/translations/validators.fr.xlf

fabpot · 2021-07-04T09:26:22Z

@welcoMattic How can we move forward?

welcoMattic · 2021-07-04T10:12:33Z

@fabpot I intend to apply Javier's comments, and make a first version of this constraint that we can improve later following user's needs.

welcoMattic · 2021-07-04T17:14:17Z

I addressed @javiereguiluz's comments about making a first usable version of CssColor Constraint, with common formats support, which are:

6-digit: #00ff00
8-digit: #0000ffcc
3-digit: #0f0
4-digit: #0f0c
basic named colors (black|red|green|yellow|blue|magenta|cyan|white) (if required for 1st version, we could copy paste the official list of named colors)

Let me know if we are agree on this 1st version

src/Symfony/Component/Validator/CHANGELOG.md

src/Symfony/Component/Validator/Constraints/CssColor.php

src/Symfony/Component/Validator/Tests/Constraints/CssColorTest.php

src/Symfony/Component/Validator/Constraints/CssColor.php

javiereguiluz

Mathieu, you've done a fantastic job here. This constraint is much more complete than I imagined. It's great!

I left some minor comments ... and I also wonder if modes is the best word to describe the different types of CSS colors allowed by the constraint. I can't suggest a better alternative, but modes doesn't feel 100% correct to me.

Thanks!

src/Symfony/Component/Validator/Constraints/CssColor.php

src/Symfony/Component/Validator/Resources/translations/validators.en.xlf

welcoMattic · 2021-09-29T21:05:29Z

@javiereguiluz thanks! About $modes, what do you think about renaming it to $formats?
I've addressed all other comments, thanks for the review

status: needs review

src/Symfony/Component/Validator/CHANGELOG.md

welcoMattic · 2021-09-30T13:37:24Z

Fabbot is wrong about the italian typo correction, it's possibile and not possible.

welcoMattic · 2021-10-06T08:23:21Z

@javiereguiluz @derrabus I don't know exactly when the feature freeze will happen, but I think this PR is ready to be merged in 5.4.

derrabus · 2021-10-06T16:58:24Z

I agree, this PR is ready. But I need a second approval to merge a feature PR.

fabpot · 2021-10-06T17:05:06Z

Thank you @welcoMattic.

This PR was merged into the 5.4 branch. Discussion ---------- [Validator] Added CssColor constraint This PR introduces the new `CssColor` constraint, contributed in symfony/symfony#40168 Commits ------- fc1539c Added CssColor constraint

drupol · 2021-10-08T11:56:23Z

src/Symfony/Component/Validator/Constraints/CssColor.php

+     */
+    public function __construct($formats, string $message = null, array $groups = null, $payload = null, array $options = null)
+    {
+        $validationModesAsString = array_reduce(self::$validationModes, function ($carry, $value) {


Hi, I'm reading this PR and wondering if it wouldn't be a good idea to type things as much as we can when doing a chance?

Since Symfony 6 has better typing support, wouldn't it be a good idea to require adding typing when submitting a PR ?

Thanks

It could be great, but in this case I made a little mistake, this array_reduce is overengineered, it has to be a implode call.

Looking at it twice now, and indeed, it could be replace with an implode :)

carsonbot added Status: Needs Review Validator Feature labels Feb 12, 2021

welcoMattic force-pushed the hexadecimal-constraint branch from 74700e0 to fc3a5ef Compare February 12, 2021 15:56

welcoMattic mentioned this pull request Feb 12, 2021

[Validator] Added CssColor constraint symfony/symfony-docs#14965

Merged

welcoMattic force-pushed the hexadecimal-constraint branch from fc3a5ef to ed5f06d Compare February 12, 2021 16:11

xabbuh added this to the 5.x milestone Feb 12, 2021

stof reviewed Feb 12, 2021

View reviewed changes

src/Symfony/Component/Validator/Constraints/HexaColorValidator.php Outdated Show resolved Hide resolved

localheinz reviewed Feb 14, 2021

View reviewed changes

src/Symfony/Component/Validator/Tests/Constraints/HexaColorValidatorTest.php Outdated Show resolved Hide resolved

javiereguiluz mentioned this pull request Jun 22, 2021

[Form] Allow hexadecimal colors with 3 characters in ColorType #41785

Closed

YaFou reviewed Jun 26, 2021

View reviewed changes

src/Symfony/Component/Validator/CHANGELOG.md Outdated Show resolved Hide resolved

src/Symfony/Component/Validator/Resources/translations/validators.fr.xlf Outdated Show resolved Hide resolved

welcoMattic force-pushed the hexadecimal-constraint branch 3 times, most recently from cf0bba7 to cead49a Compare July 4, 2021 17:08

derrabus reviewed Jul 4, 2021

View reviewed changes

src/Symfony/Component/Validator/CHANGELOG.md Outdated Show resolved Hide resolved

derrabus changed the title ~~[Validator] Added HexaColor constraint~~ [Validator] Added CssColor constraint Jul 4, 2021

OskarStark reviewed Jul 4, 2021

View reviewed changes

src/Symfony/Component/Validator/Constraints/CssColor.php Outdated Show resolved Hide resolved

OskarStark reviewed Jul 4, 2021

View reviewed changes

src/Symfony/Component/Validator/Tests/Constraints/CssColorTest.php Outdated Show resolved Hide resolved

welcoMattic force-pushed the hexadecimal-constraint branch from 0eae445 to 454d531 Compare July 4, 2021 20:45

norkunas reviewed Jul 5, 2021

View reviewed changes

src/Symfony/Component/Validator/Constraints/CssColor.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Sep 29, 2021

javiereguiluz reviewed Sep 29, 2021

View reviewed changes

welcoMattic force-pushed the hexadecimal-constraint branch 4 times, most recently from 347b2a1 to 781598a Compare September 29, 2021 21:12

carsonbot added Status: Needs Review and removed Status: Needs Work labels Sep 29, 2021

welcoMattic force-pushed the hexadecimal-constraint branch 2 times, most recently from a741651 to 23709e7 Compare September 29, 2021 21:19

derrabus approved these changes Sep 29, 2021

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 29, 2021

norkunas reviewed Sep 30, 2021

View reviewed changes

src/Symfony/Component/Validator/CHANGELOG.md Outdated Show resolved Hide resolved

welcoMattic force-pushed the hexadecimal-constraint branch from 23709e7 to 8925155 Compare September 30, 2021 07:16

Added new CssColor constraint

b36371c

welcoMattic force-pushed the hexadecimal-constraint branch from 8925155 to b36371c Compare September 30, 2021 09:05

fabpot approved these changes Oct 6, 2021

View reviewed changes

fabpot merged commit 428434c into symfony:5.4 Oct 6, 2021

welcoMattic deleted the hexadecimal-constraint branch October 8, 2021 09:50

drupol reviewed Oct 8, 2021

View reviewed changes

This was referenced Nov 5, 2021

Release v5.4.0-BETA1 #43937

Merged

Release v6.0.0-BETA1 #43939

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Validator] Added `CssColor` constraint #40168

[Validator] Added `CssColor` constraint #40168

welcoMattic commented Feb 12, 2021 •

edited

Loading

norkunas commented Feb 12, 2021

welcoMattic commented Feb 12, 2021

norkunas commented Feb 12, 2021

javiereguiluz commented Feb 12, 2021 •

edited

Loading

fancyweb commented Feb 12, 2021

OskarStark commented Feb 12, 2021

javiereguiluz commented May 25, 2021

fabpot commented Jul 4, 2021

welcoMattic commented Jul 4, 2021

welcoMattic commented Jul 4, 2021 •

edited

Loading

javiereguiluz left a comment

welcoMattic commented Sep 29, 2021 •

edited

Loading

welcoMattic commented Sep 30, 2021

welcoMattic commented Oct 6, 2021

derrabus commented Oct 6, 2021

fabpot commented Oct 6, 2021

drupol Oct 8, 2021

welcoMattic Oct 8, 2021

drupol Oct 8, 2021

[Validator] Added CssColor constraint #40168

[Validator] Added CssColor constraint #40168

Conversation

welcoMattic commented Feb 12, 2021 • edited Loading

norkunas commented Feb 12, 2021

welcoMattic commented Feb 12, 2021

norkunas commented Feb 12, 2021

javiereguiluz commented Feb 12, 2021 • edited Loading

fancyweb commented Feb 12, 2021

OskarStark commented Feb 12, 2021

javiereguiluz commented May 25, 2021

fabpot commented Jul 4, 2021

welcoMattic commented Jul 4, 2021

welcoMattic commented Jul 4, 2021 • edited Loading

javiereguiluz left a comment

Choose a reason for hiding this comment

welcoMattic commented Sep 29, 2021 • edited Loading

welcoMattic commented Sep 30, 2021

welcoMattic commented Oct 6, 2021

derrabus commented Oct 6, 2021

fabpot commented Oct 6, 2021

drupol Oct 8, 2021

Choose a reason for hiding this comment

welcoMattic Oct 8, 2021

Choose a reason for hiding this comment

drupol Oct 8, 2021

Choose a reason for hiding this comment

[Validator] Added `CssColor` constraint #40168

[Validator] Added `CssColor` constraint #40168

welcoMattic commented Feb 12, 2021 •

edited

Loading

javiereguiluz commented Feb 12, 2021 •

edited

Loading

welcoMattic commented Jul 4, 2021 •

edited

Loading

welcoMattic commented Sep 29, 2021 •

edited

Loading