Add 'is_hex_rgb_color' validation rule (#143)

A new validation rule called 'is_hex_rgb_color' has been added to the CSV Blueprint parsing tool. This update allows for RGB color codes in hexadecimal format to be validated. Changes have also been made to the README tutorial and enforcement logic for this validation rule. Tests have been created to ensure its proper functionality.
JBZoo · Apr 3, 2024 · ef6f379 · ef6f379
1 parent 7b447c9
commit ef6f379
Show file tree

Hide file tree

Showing 8 changed files with 146 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -11,11 +11,11 @@
 <!-- auto-update:/top-badges -->
 
 <!-- auto-update:rules-counter -->
-[![Static Badge](https://img.shields.io/badge/Rules-331-green?label=Total%20number%20of%20rules&labelColor=darkgreen&color=gray)](schema-examples/full.yml)
-[![Static Badge](https://img.shields.io/badge/Rules-117-green?label=Cell%20rules&labelColor=blue&color=gray)](src/Rules/Cell)
+[![Static Badge](https://img.shields.io/badge/Rules-332-green?label=Total%20number%20of%20rules&labelColor=darkgreen&color=gray)](schema-examples/full.yml)
+[![Static Badge](https://img.shields.io/badge/Rules-118-green?label=Cell%20rules&labelColor=blue&color=gray)](src/Rules/Cell)
 [![Static Badge](https://img.shields.io/badge/Rules-206-green?label=Aggregate%20rules&labelColor=blue&color=gray)](src/Rules/Aggregate)
 [![Static Badge](https://img.shields.io/badge/Rules-8-green?label=Extra%20checks&labelColor=blue&color=gray)](#extra-checks)
-[![Static Badge](https://img.shields.io/badge/Rules-17/54/10-green?label=Plan%20to%20add&labelColor=gray&color=gray)](tests/schemas/todo.yml)
+[![Static Badge](https://img.shields.io/badge/Rules-16/54/10-green?label=Plan%20to%20add&labelColor=gray&color=gray)](tests/schemas/todo.yml)
 <!-- auto-update:/rules-counter -->
 
 A console utility designed for validating CSV files against a strictly defined schema and validation rules outlined
@@ -538,6 +538,7 @@ columns:
       is_consonant: true                # Validates if the input contains only consonants. Example: "bcd".
       is_alnum: true                    # Validates whether the input is only alphanumeric. Example: "aBc123".
       is_alpha: true                    # This is similar to `is_alnum`, but it does not allow numbers. Example: "aBc".
+      is_hex_rgb_color: true            # Validates weather the input is a hex RGB color or not. Examples: "#FF0000", "#123", "ffffff", "fff".
 
       # Check if the value is a valid hash. Supported algorithms:
       #  - md2, md4, md5, sha1, sha224, sha256, sha384, sha512/224, sha512/256, sha512

diff --git a/schema-examples/full.json b/schema-examples/full.json
@@ -159,6 +159,8 @@
                 "is_consonant"            : true,
                 "is_alnum"                : true,
                 "is_alpha"                : true,
+                "is_hex_rgb_color"        : true,
+
                 "hash"                    : "set_algo",
                 "charset"                 : "charset_code",
                 "credit_card"             : "Any"

diff --git a/schema-examples/full.php b/schema-examples/full.php
@@ -173,12 +173,13 @@
                 'is_imei'     => true,
                 'is_isbn'     => true,
 
-                'is_version'   => true,
-                'is_punct'     => true,
-                'is_vowel'     => true,
-                'is_consonant' => true,
-                'is_alnum'     => true,
-                'is_alpha'     => true,
+                'is_version'       => true,
+                'is_punct'         => true,
+                'is_vowel'         => true,
+                'is_consonant'     => true,
+                'is_alnum'         => true,
+                'is_alpha'         => true,
+                'is_hex_rgb_color' => true,
 
                 'hash'    => 'set_algo',
                 'charset' => 'charset_code',

diff --git a/schema-examples/full.yml b/schema-examples/full.yml
@@ -241,6 +241,7 @@ columns:
       is_consonant: true                # Validates if the input contains only consonants. Example: "bcd".
       is_alnum: true                    # Validates whether the input is only alphanumeric. Example: "aBc123".
       is_alpha: true                    # This is similar to `is_alnum`, but it does not allow numbers. Example: "aBc".
+      is_hex_rgb_color: true            # Validates weather the input is a hex RGB color or not. Examples: "#FF0000", "#123", "ffffff", "fff".
 
       # Check if the value is a valid hash. Supported algorithms:
       #  - md2, md4, md5, sha1, sha224, sha256, sha384, sha512/224, sha512/256, sha512

diff --git a/schema-examples/full_clean.yml b/schema-examples/full_clean.yml
@@ -187,6 +187,7 @@ columns:
       is_consonant: true
       is_alnum: true
       is_alpha: true
+      is_hex_rgb_color: true
 
       hash: set_algo
 

diff --git a/src/Rules/Cell/IsHexRgbColor.php b/src/Rules/Cell/IsHexRgbColor.php
@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * JBZoo Toolbox - Csv-Blueprint.
+ *
+ * This file is part of the JBZoo Toolbox project.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT
+ * @copyright  Copyright (C) JBZoo.com, All rights reserved.
+ * @see        https://github.com/JBZoo/Csv-Blueprint
+ */
+
+declare(strict_types=1);
+
+namespace JBZoo\CsvBlueprint\Rules\Cell;
+
+use Respect\Validation\Validator;
+
+final class IsHexRgbColor extends AbstractCellRule
+{
+    public function getHelpMeta(): array
+    {
+        return [
+            [],
+            [
+                self::DEFAULT => [
+                    'true',
+                    'Validates weather the input is a hex RGB color or not. ' .
+                    'Examples: "#FF0000", "#123", "ffffff", "fff".',
+                ],
+            ],
+        ];
+    }
+
+    public function validateRule(string $cellValue): ?string
+    {
+        if ($cellValue === '') {
+            return null;
+        }
+
+        if (!Validator::hexRgbColor()->validate($cellValue)) {
+            return "Value \"<c>{$cellValue}</c>\" is not a valid hex RGB color.";
+        }
+
+        return null;
+    }
+}
diff --git a/tests/Rules/Cell/IsHexRgbColorTest.php b/tests/Rules/Cell/IsHexRgbColorTest.php
@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * JBZoo Toolbox - Csv-Blueprint.
+ *
+ * This file is part of the JBZoo Toolbox project.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT
+ * @copyright  Copyright (C) JBZoo.com, All rights reserved.
+ * @see        https://github.com/JBZoo/Csv-Blueprint
+ */
+
+declare(strict_types=1);
+
+namespace JBZoo\PHPUnit\Rules\Cell;
+
+use JBZoo\CsvBlueprint\Rules\Cell\IsHexRgbColor;
+use JBZoo\PHPUnit\Rules\TestAbstractCellRule;
+
+use function JBZoo\PHPUnit\isSame;
+
+final class IsHexRgbColorTest extends TestAbstractCellRule
+{
+    protected string $ruleClass = IsHexRgbColor::class;
+
+    public function testPositive(): void
+    {
+        $rule = $this->create(true);
+        isSame(null, $rule->validate(''));
+
+        $valid = [
+            '',
+            '#000',
+            '#00000F',
+            '#00000f',
+            '#123',
+            '#123456',
+            '#FFFFFF',
+            '#ffffff',
+            '123123',
+            'FFFFFF',
+            'ffffff',
+            '443',
+        ];
+
+        foreach ($valid as $value) {
+            isSame('', $rule->test($value), "\"{$value}\"");
+        }
+
+        $rule = $this->create(false);
+        isSame(null, $rule->validate(' 1'));
+    }
+
+    public function testNegative(): void
+    {
+        $rule = $this->create(true);
+
+        $invalid = [
+            ';',
+            '!@#$%^&*()',
+            '#0',
+            '#0000G0',
+            '#0FG',
+            '#1234',
+            '#AAAAAA1',
+            '#S',
+            '1234',
+            'foo',
+        ];
+
+        foreach ($invalid as $value) {
+            isSame(
+                "Value \"{$value}\" is not a valid hex RGB color.",
+                $rule->test($value),
+                $value,
+            );
+        }
+    }
+}
diff --git a/tests/schemas/todo.yml b/tests/schemas/todo.yml
@@ -67,8 +67,7 @@ columns:
       is_portuguese_nif: true         # Validates a Portuguese taxpayer number (NIF).
 
       # Strings
-      is_hex_rgb_color: true
-      no_whitespace: true
+      no_whitespace: t rue
 
       custom_func: callbak function