Refactor Validators and Rules structure

Reorganized and refactored the architecture of Validators and Rules within the codebase. The Rules were moved under the base namespace rather than under Validators. Additionally, implemented the ColumnValidator and ScvValidator, and refactored the abstract base Validator class into AbstractValidator. Adjustments were also applied to unit tests receiving the impact of these changes, ensuring comprehensive test coverage over the refactored structure.

src/Csv/Column.php

@@ -18,7 +18,7 @@
 
 use JBZoo\CsvBlueprint\Utils;
 use JBZoo\CsvBlueprint\Validators\ErrorSuite;
-use JBZoo\CsvBlueprint\Validators\Validator;
+use JBZoo\CsvBlueprint\Validators\ColumnValidator;
 use JBZoo\Data\Data;
 
 final class Column
@@ -111,7 +111,7 @@ public function getInherit(): string
 
     public function validate(string $cellValue, int $line): ErrorSuite
     {
-        return (new Validator($this))->validate($cellValue, $line);
+        return (new ColumnValidator($this))->validate($cellValue, $line);
     }
 
     private function prepareRuleSet(string $schemaKey): array

src/Csv/CsvFile.php

@@ -81,6 +81,8 @@ public function getRecordsChunk(int $offset = 0, int $limit = -1): TabularDataRe
 
     public function validate(bool $quickStop = false): ErrorSuite
     {
+        // $fileValidator
+
         $errors = new ErrorSuite($this->getCsvFilename());
 
         $errors

src/Validators/Rules/AbstarctRule.php → src/Rules/AbstarctRule.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 use JBZoo\CsvBlueprint\Utils;
 use JBZoo\CsvBlueprint\Validators\Error;

src/Validators/Rules/AllowValues.php → src/Rules/AllowValues.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 class AllowValues extends AbstarctRule
 {

src/Validators/Rules/CardinalDirection.php → src/Rules/CardinalDirection.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 class CardinalDirection extends AllowValues
 {

src/Validators/Rules/DateFormat.php → src/Rules/DateFormat.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class DateFormat extends AbstarctRule
 {

src/Validators/Rules/ExactValue.php → src/Rules/ExactValue.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class ExactValue extends AbstarctRule
 {

src/Validators/Rules/IsBool.php → src/Rules/IsBool.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsBool extends AllowValues
 {

src/Validators/Rules/IsDomain.php → src/Rules/IsDomain.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsDomain extends AbstarctRule
 {

src/Validators/Rules/IsEmail.php → src/Rules/IsEmail.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsEmail extends AbstarctRule
 {

src/Validators/Rules/IsFloat.php → src/Rules/IsFloat.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 class IsFloat extends AbstarctRule
 {

src/Validators/Rules/IsInt.php → src/Rules/IsInt.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsInt extends AbstarctRule
 {

src/Validators/Rules/IsIp.php → src/Rules/IsIp.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsIp extends AbstarctRule
 {

src/Validators/Rules/IsLatitude.php → src/Rules/IsLatitude.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsLatitude extends IsFloat
 {

src/Validators/Rules/IsLongitude.php → src/Rules/IsLongitude.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsLongitude extends IsFloat
 {

src/Validators/Rules/IsUrl.php → src/Rules/IsUrl.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsUrl extends AbstarctRule
 {

src/Validators/Rules/IsUuid4.php → src/Rules/IsUuid4.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class IsUuid4 extends AbstarctRule
 {

src/Validators/Rules/Max.php → src/Rules/Max.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class Max extends IsFloat
 {

src/Validators/Rules/MaxDate.php → src/Rules/MaxDate.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class MaxDate extends AbstarctRule
 {

src/Validators/Rules/MaxLength.php → src/Rules/MaxLength.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class MaxLength extends AbstarctRule
 {

src/Validators/Rules/Min.php → src/Rules/Min.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class Min extends IsFloat
 {

src/Validators/Rules/MinDate.php → src/Rules/MinDate.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class MinDate extends AbstarctRule
 {

src/Validators/Rules/MinLength.php → src/Rules/MinLength.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class MinLength extends AbstarctRule
 {

src/Validators/Rules/NotEmpty.php → src/Rules/NotEmpty.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class NotEmpty extends AbstarctRule
 {

src/Validators/Rules/OnlyCapitalize.php → src/Rules/OnlyCapitalize.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class OnlyCapitalize extends AbstarctRule
 {

src/Validators/Rules/OnlyLowercase.php → src/Rules/OnlyLowercase.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class OnlyLowercase extends AbstarctRule
 {

src/Validators/Rules/OnlyTrimed.php → src/Rules/OnlyTrimed.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class OnlyTrimed extends AbstarctRule
 {

src/Validators/Rules/OnlyUppercase.php → src/Rules/OnlyUppercase.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class OnlyUppercase extends AbstarctRule
 {

src/Validators/Rules/Precision.php → src/Rules/Precision.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 final class Precision extends AbstarctRule
 {

src/Validators/Rules/Regex.php → src/Rules/Regex.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 use JBZoo\CsvBlueprint\Utils;
 

src/Validators/Rules/RuleException.php → src/Rules/RuleException.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 class RuleException extends \JBZoo\CsvBlueprint\Exception
 {

src/Validators/Rules/UsaMarketName.php → src/Rules/UsaMarketName.php

@@ -14,7 +14,7 @@
 
 declare(strict_types=1);
 
-namespace JBZoo\CsvBlueprint\Validators\Rules;
+namespace JBZoo\CsvBlueprint\Rules;
 
 class UsaMarketName extends AllowValues
 {

src/Validators/AbstractValidator.php

@@ -0,0 +1,22 @@
+<?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\Validators;
+
+abstract class AbstractValidator
+{
+    abstract public function validate(?string $cellValue, int $line): ErrorSuite;
+}

src/Validators/Validator.php → src/Validators/ColumnValidator.php

@@ -18,7 +18,7 @@
 
 use JBZoo\CsvBlueprint\Csv\Column;
 
-final class Validator
+final class ColumnValidator extends AbstractValidator
 {
     private Ruleset $ruleset;
 

src/Validators/Ruleset.php

@@ -16,8 +16,8 @@
 
 namespace JBZoo\CsvBlueprint\Validators;
 
+use JBZoo\CsvBlueprint\Rules\AbstarctRule;
 use JBZoo\CsvBlueprint\Utils;
-use JBZoo\CsvBlueprint\Validators\Rules\AbstarctRule;
 
 final class Ruleset
 {
@@ -41,7 +41,7 @@ public function __construct(array $rules, string $columnNameId)
      */
     public function createRule(string $ruleName, null|array|bool|float|int|string $options = null): AbstarctRule
     {
-        $classname = __NAMESPACE__ . '\\Rules\\' . Utils::kebabToCamelCase($ruleName);
+        $classname = '\\JBZoo\\CsvBlueprint\\Rules\\' . Utils::kebabToCamelCase($ruleName);
         if (\class_exists($classname)) {
             // @phpstan-ignore-next-line
             return new $classname($this->columnNameId, $options);

src/Validators/ScvValidator.php

@@ -0,0 +1,25 @@
+<?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\Validators;
+
+final class ScvValidator extends AbstractValidator
+{
+    public function validate(?string $cellValue, int $line): ErrorSuite
+    {
+        return new ErrorSuite();
+    }
+}

tests/Blueprint/MiscTest.php

@@ -61,7 +61,7 @@ public function testFullListOfRules(): void
 
         $finder = (new Finder())
             ->files()
-            ->in(PROJECT_ROOT . '/src/Validators/Rules')
+            ->in(PROJECT_ROOT . '/src/Rules')
             ->ignoreDotFiles(false)
             ->ignoreVCS(true)
             ->name('/\\.php$/');