Add is_binary rule (#126)

This rule validates whether an input is a valid binary number or not,
supporting values either with or without a `0b` prefix.

README.md

@@ -11,11 +11,11 @@
 <!-- /top-badges -->
 
 <!-- rules-counter -->
-[![Static Badge](https://img.shields.io/badge/Rules-380-green?label=Total%20number%20of%20rules&labelColor=darkgreen&color=gray)](schema-examples/full.yml)
-[![Static Badge](https://img.shields.io/badge/Rules-166-green?label=Cell%20rules&labelColor=blue&color=gray)](src/Rules/Cell)
+[![Static Badge](https://img.shields.io/badge/Rules-381-green?label=Total%20number%20of%20rules&labelColor=darkgreen&color=gray)](schema-examples/full.yml)
+[![Static Badge](https://img.shields.io/badge/Rules-167-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-28/54/9-green?label=Plan%20to%20add&labelColor=gray&color=gray)](tests/schemas/todo.yml)
+[![Static Badge](https://img.shields.io/badge/Rules-27/54/9-green?label=Plan%20to%20add&labelColor=gray&color=gray)](tests/schemas/todo.yml)
 <!-- /rules-counter -->
 
 A console utility designed for validating CSV files against a strictly defined schema and validation rules outlined
@@ -432,6 +432,7 @@ columns:
 
       # Specific formats
       is_bool: true                     # Allow only boolean values "true" and "false", case-insensitive.
+      is_binary: true                   # Both: with or without "0b" prefix. Example: "0b10" or "10"
       is_hex: true                      # Both: with or without "0x" prefix. Example: "0x1A" or "1A"
       is_uuid: true                     # Validates whether the input is a valid UUID. It also supports validation of specific versions 1, 3, 4 and 5.
       is_slug: true                     # Only slug format. Example: "my-slug-123". It can contain letters, numbers, and dashes.

schema-examples/full.json

@@ -104,6 +104,7 @@
                 "date_age_max"            : 100,
 
                 "is_bool"                 : true,
+                "is_binary"               : true,
                 "is_hex"                  : true,
                 "is_uuid"                 : true,
                 "is_slug"                 : true,

schema-examples/full.php

@@ -125,6 +125,7 @@
                 'date_age_max'     => 100,
 
                 'is_bool'          => true,
+                'is_binary'        => true,
                 'is_hex'           => true,
                 'is_uuid'          => true,
                 'is_slug'          => true,

schema-examples/full.yml

@@ -171,6 +171,7 @@ columns:
 
       # Specific formats
       is_bool: true                     # Allow only boolean values "true" and "false", case-insensitive.
+      is_binary: true                   # Both: with or without "0b" prefix. Example: "0b10" or "10"
       is_hex: true                      # Both: with or without "0x" prefix. Example: "0x1A" or "1A"
       is_uuid: true                     # Validates whether the input is a valid UUID. It also supports validation of specific versions 1, 3, 4 and 5.
       is_slug: true                     # Only slug format. Example: "my-slug-123". It can contain letters, numbers, and dashes.

schema-examples/full_clean.yml

@@ -132,6 +132,7 @@ columns:
       date_age_max: 100
 
       is_bool: true
+      is_binary: true
       is_hex: true
       is_uuid: true
       is_slug: true

src/Rules/Cell/IsBinary.php

@@ -0,0 +1,45 @@
+<?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;
+
+final class IsBinary extends AbstractCellRule
+{
+    public function getHelpMeta(): array
+    {
+        return [
+            [],
+            [
+                self::DEFAULT => [
+                    'true',
+                    'Both: with or without "0b" prefix. Example: "0b10" or "10"',
+                ],
+            ],
+        ];
+    }
+
+    public function validateRule(string $cellValue): ?string
+    {
+        if (
+            \preg_match('/^[01]+(_[01]+)*$/', $cellValue) === 0
+            && \preg_match('/^0[bB][01]+(_[01]+)*$/', $cellValue) === 0
+        ) {
+            return "Value \"<c>{$cellValue}</c>\" is not a valid binary number. Example: \"0b10\" or \"10\"";
+        }
+
+        return null;
+    }
+}

tests/Rules/Cell/IsBinaryTest.php

@@ -0,0 +1,61 @@
+<?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\IsBinary;
+use JBZoo\PHPUnit\Rules\TestAbstractCellRule;
+
+use function JBZoo\PHPUnit\isSame;
+
+final class IsBinaryTest extends TestAbstractCellRule
+{
+    protected string $ruleClass = IsBinary::class;
+
+    public function testPositive(): void
+    {
+        $rule = $this->create(true);
+        isSame(null, $rule->validate(''));
+        isSame('', $rule->test('0'));
+        isSame('', $rule->test('1'));
+        isSame('', $rule->test('11'));
+        isSame('', $rule->test('10101010'));
+
+        isSame('', $rule->test('0b1'));
+        isSame('', $rule->test('0B0'));
+        isSame('', $rule->test('0b110101'));
+        isSame('', $rule->test('0B110101'));
+
+        $rule = $this->create(false);
+        isSame(null, $rule->validate('1'));
+    }
+
+    public function testNegative(): void
+    {
+        $rule = $this->create(true);
+        isSame(
+            'Value "qwerty" is not a valid binary number. Example: "0b10" or "10"',
+            $rule->test('qwerty'),
+        );
+
+        $rule = $this->create(true);
+        isSame(
+            '"is_binary" at line <red>1</red>, column "prop". ' .
+            'Value "<c>qwerty</c>" is not a valid binary number. Example: "0b10" or "10".',
+            (string)$rule->validate('qwerty'),
+        );
+    }
+}

tests/schemas/todo.yml

@@ -75,7 +75,6 @@ columns:
       is_card_number: true
 
       # Strings
-      is_binary: true
       is_charset: true
       is_hex_rgb_color: true
       no_whitespace: true