diff --git a/src/Symfony/Bundle/Resources/config/metadata/validator.xml b/src/Symfony/Bundle/Resources/config/metadata/validator.xml index 1f50b6fe007..dad9b282a96 100644 --- a/src/Symfony/Bundle/Resources/config/metadata/validator.xml +++ b/src/Symfony/Bundle/Resources/config/metadata/validator.xml @@ -22,6 +22,10 @@ + + + + diff --git a/src/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCssColorRestriction.php b/src/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCssColorRestriction.php new file mode 100644 index 00000000000..b25156c5d34 --- /dev/null +++ b/src/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCssColorRestriction.php @@ -0,0 +1,78 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace ApiPlatform\Symfony\Validator\Metadata\Property\Restriction; + +use ApiPlatform\Metadata\ApiProperty; +use Symfony\Component\Validator\Constraint; +use Symfony\Component\Validator\Constraints\CssColor; + +/** + * Class PropertySchemaRegexRestriction. + */ +class PropertySchemaCssColorRestriction implements PropertySchemaRestrictionMetadataInterface +{ + private const PATTERN_HEX_LONG = '/^#[0-9a-f]{6}$/iD'; + private const PATTERN_HEX_LONG_WITH_ALPHA = '/^#[0-9a-f]{8}$/iD'; + private const PATTERN_HEX_SHORT = '/^#[0-9a-f]{3}$/iD'; + private const PATTERN_HEX_SHORT_WITH_ALPHA = '/^#[0-9a-f]{4}$/iD'; + // List comes from https://www.w3.org/wiki/CSS/Properties/color/keywords#Basic_Colors + private const PATTERN_BASIC_NAMED_COLORS = '/^(black|silver|gray|white|maroon|red|purple|fuchsia|green|lime|olive|yellow|navy|blue|teal|aqua)$/iD'; + // List comes from https://www.w3.org/wiki/CSS/Properties/color/keywords#Extended_colors + private const PATTERN_EXTENDED_NAMED_COLORS = '/^(aliceblue|antiquewhite|aqua|aquamarine|azure|beige|bisque|black|blanchedalmond|blue|blueviolet|brown|burlywood|cadetblue|chartreuse|chocolate|coral|cornflowerblue|cornsilk|crimson|cyan|darkblue|darkcyan|darkgoldenrod|darkgray|darkgreen|darkgrey|darkkhaki|darkmagenta|darkolivegreen|darkorange|darkorchid|darkred|darksalmon|darkseagreen|darkslateblue|darkslategray|darkslategrey|darkturquoise|darkviolet|deeppink|deepskyblue|dimgray|dimgrey|dodgerblue|firebrick|floralwhite|forestgreen|fuchsia|gainsboro|ghostwhite|gold|goldenrod|gray|green|greenyellow|grey|honeydew|hotpink|indianred|indigo|ivory|khaki|lavender|lavenderblush|lawngreen|lemonchiffon|lightblue|lightcoral|lightcyan|lightgoldenrodyellow|lightgray|lightgreen|lightgrey|lightpink|lightsalmon|lightseagreen|lightskyblue|lightslategray|lightslategrey|lightsteelblue|lightyellow|lime|limegreen|linen|magenta|maroon|mediumaquamarine|mediumblue|mediumorchid|mediumpurple|mediumseagreen|mediumslateblue|mediumspringgreen|mediumturquoise|mediumvioletred|midnightblue|mintcream|mistyrose|moccasin|navajowhite|navy|oldlace|olive|olivedrab|orange|orangered|orchid|palegoldenrod|palegreen|paleturquoise|palevioletred|papayawhip|peachpuff|peru|pink|plum|powderblue|purple|red|rosybrown|royalblue|saddlebrown|salmon|sandybrown|seagreen|seashell|sienna|silver|skyblue|slateblue|slategray|slategrey|snow|springgreen|steelblue|tan|teal|thistle|tomato|turquoise|violet|wheat|white|whitesmoke|yellow|yellowgreen)$/iD'; + // List comes from https://drafts.csswg.org/css-color/#css-system-colors + private const PATTERN_SYSTEM_COLORS = '/^(Canvas|CanvasText|LinkText|VisitedText|ActiveText|ButtonFace|ButtonText|ButtonBorder|Field|FieldText|Highlight|HighlightText|SelectedItem|SelectedItemText|Mark|MarkText|GrayText)$/iD'; + private const PATTERN_KEYWORDS = '/^(transparent|currentColor)$/iD'; + private const PATTERN_RGB = '/^rgb\(\s*(0|255|25[0-4]|2[0-4]\d|1\d\d|0?\d?\d),\s*(0|255|25[0-4]|2[0-4]\d|1\d\d|0?\d?\d),\s*(0|255|25[0-4]|2[0-4]\d|1\d\d|0?\d?\d)\s*\)$/iD'; + private const PATTERN_RGBA = '/^rgba\(\s*(0|255|25[0-4]|2[0-4]\d|1\d\d|0?\d?\d),\s*(0|255|25[0-4]|2[0-4]\d|1\d\d|0?\d?\d),\s*(0|255|25[0-4]|2[0-4]\d|1\d\d|0?\d?\d),\s*(0|0?\.\d+|1(\.0)?)\s*\)$/iD'; + private const PATTERN_HSL = '/^hsl\(\s*(0|360|35\d|3[0-4]\d|[12]\d\d|0?\d?\d),\s*(0|100|\d{1,2})%,\s*(0|100|\d{1,2})%\s*\)$/iD'; + private const PATTERN_HSLA = '/^hsla\(\s*(0|360|35\d|3[0-4]\d|[12]\d\d|0?\d?\d),\s*(0|100|\d{1,2})%,\s*(0|100|\d{1,2})%,\s*(0|0?\.\d+|1(\.0)?)\s*\)$/iD'; + + private const COLOR_PATTERNS = [ + CssColor::HEX_LONG => self::PATTERN_HEX_LONG, + CssColor::HEX_LONG_WITH_ALPHA => self::PATTERN_HEX_LONG_WITH_ALPHA, + CssColor::HEX_SHORT => self::PATTERN_HEX_SHORT, + CssColor::HEX_SHORT_WITH_ALPHA => self::PATTERN_HEX_SHORT_WITH_ALPHA, + CssColor::BASIC_NAMED_COLORS => self::PATTERN_BASIC_NAMED_COLORS, + CssColor::EXTENDED_NAMED_COLORS => self::PATTERN_EXTENDED_NAMED_COLORS, + CssColor::SYSTEM_COLORS => self::PATTERN_SYSTEM_COLORS, + CssColor::KEYWORDS => self::PATTERN_KEYWORDS, + CssColor::RGB => self::PATTERN_RGB, + CssColor::RGBA => self::PATTERN_RGBA, + CssColor::HSL => self::PATTERN_HSL, + CssColor::HSLA => self::PATTERN_HSLA, + ]; + + /** + * {@inheritdoc} + * + * @param CssColor $constraint + */ + public function create(Constraint $constraint, ApiProperty $propertyMetadata): array + { + return [ + 'pattern' => '^('.implode('|', array_map( + fn ($format) => trim(self::COLOR_PATTERNS[$format], '/iD^$'), + (array) $constraint->formats + )).')$', + ]; + } + + /** + * {@inheritdoc} + */ + public function supports(Constraint $constraint, ApiProperty $propertyMetadata): bool + { + return $constraint instanceof CssColor; + } +} diff --git a/tests/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCssColorRestrictionTest.php b/tests/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCssColorRestrictionTest.php new file mode 100644 index 00000000000..03a91d1e1b5 --- /dev/null +++ b/tests/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaCssColorRestrictionTest.php @@ -0,0 +1,71 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace ApiPlatform\Tests\Symfony\Validator\Metadata\Property\Restriction; + +use ApiPlatform\Metadata\ApiProperty; +use ApiPlatform\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaCssColorRestriction; +use PHPUnit\Framework\Attributes\DataProvider; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Validator\Constraints\CssColor; +use Symfony\Component\Validator\Constraints\PositiveOrZero; + +final class PropertySchemaCssColorRestrictionTest extends TestCase +{ + private PropertySchemaCssColorRestriction $restriction; + + protected function setUp(): void + { + $this->restriction = new PropertySchemaCssColorRestriction(); + } + + #[DataProvider('supportsProvider')] + public function testSupports(mixed $constraint, ApiProperty $propertyMetadata, bool $expected): void + { + self::assertSame($expected, $this->restriction->supports($constraint, $propertyMetadata)); + } + + public static function supportsProvider(): \Generator + { + yield 'supported CssColor' => [new CssColor(), new ApiProperty(), true]; + yield 'unsupported other constraint' => [new PositiveOrZero(), new ApiProperty(), false]; + } + + #[DataProvider('createProvider')] + public function testCreate(CssColor $constraint, string $expectedPattern): void + { + $property = new ApiProperty(); + $result = $this->restriction->create($constraint, $property); + + self::assertArrayHasKey('pattern', $result); + self::assertSame($expectedPattern, $result['pattern']); + } + + public static function createProvider(): \Generator + { + yield 'HEX_LONG only' => [ + new CssColor(formats: [CssColor::HEX_LONG]), + '^(#[0-9a-f]{6})$', + ]; + + yield 'HEX_SHORT and KEYWORDS' => [ + new CssColor(formats: [CssColor::HEX_SHORT, CssColor::KEYWORDS]), + '^(#[0-9a-f]{3}|(transparent|currentColor))$', + ]; + + yield 'RGB + NAMED COLORS' => [ + new CssColor(formats: [CssColor::RGB, CssColor::BASIC_NAMED_COLORS]), + '^(rgb\\(\\s*(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),\\s*(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),\\s*(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d)\\s*\\)|(black|silver|gray|white|maroon|red|purple|fuchsia|green|lime|olive|yellow|navy|blue|teal|aqua))$', + ]; + } +}