Merge branch 'release/v0.2.0' into main

.github/workflows/integrate.yml

@@ -44,7 +44,7 @@ jobs:
           dependency-versions: "highest"
 
       - name: "Check source code for syntax errors"
-        run: "composer exec -- parallel-lint src/ ecs.php"
+        run: "composer exec -- parallel-lint src/ stubs/ ecs.php"
         # @TODO Check template files for syntax errors
 
   unit_tests:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.1.0 (2022-09-08)
+* Moved Sanitizer Provider interfaces to lucid-support
+* Removed force* methods
+* Added Processor level validation hook
+* Added Email & URL Processors
+
 ## v0.1.0 (2022-09-07)
 * Built initial Sanitizer structure
 * Added core Processor and Constraint types

composer.json

@@ -15,7 +15,7 @@
         "decodelabs/coercion": "^0.2.2",
         "decodelabs/dictum": "^0.4",
         "decodelabs/exceptional": "^0.4",
-        "decodelabs/tightrope": "^0.1.1",
+        "decodelabs/lucid-support": "^0.1.1",
         "decodelabs/veneer": "^0.9.2",
 
         "nesbot/carbon": "^2.25"
@@ -27,7 +27,9 @@
         "php-parallel-lint/php-parallel-lint": "^1.3",
         "symplify/easy-coding-standard": "^11",
 
-        "decodelabs/phpstan-decodelabs": "^0.6"
+        "decodelabs/phpstan-decodelabs": "^0.6",
+        "decodelabs/atlas": "^0.10.1",
+        "decodelabs/terminus": "^0.8.3"
     },
     "suggest": {},
     "autoload": {
@@ -41,7 +43,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "0.1.x-dev"
+            "dev-develop": "0.2.x-dev"
         }
     },
     "config": {
@@ -53,10 +55,10 @@
         "analyze": "phpstan analyze --no-progress",
         "ecs": "ecs check --no-progress-bar",
         "ecs-fix": "ecs check --no-progress-bar --fix",
-        "lint": "parallel-lint src/ tests/ ecs.php",
-        "eclint": "eclint check src/ tests/ ecs.php",
-        "eclint-fix": "eclint fix src/ tests/ ecs.php",
-        "non-ascii": "! LC_ALL=C.UTF-8 find src/ -type f -name \"*.php\" -print0 | xargs -0 -- grep -PHn \"[^ -~]\" | grep -v '// @ignore-non-ascii$'",
+        "lint": "parallel-lint src/ stubs/ ecs.php",
+        "eclint": "eclint check src/ stubs/ ecs.php",
+        "eclint-fix": "eclint fix src/ stubs/ ecs.php",
+        "non-ascii": "! LC_ALL=C.UTF-8 find src/ stubs/ -type f -name \"*.php\" -print0 | xargs -0 -- grep -PHn \"[^ -~]\" | grep -v '// @ignore-non-ascii$'",
         "check": [
             "@composer update",
             "@analyze",

phpstan.neon

@@ -1,5 +1,4 @@
 parameters:
     paths:
         - src/
-        - tests/
     level: max

src/Lucid/Constraint.php

@@ -27,6 +27,7 @@ public function __construct(Processor $processor);
      */
     public static function getProcessorOutputTypes(): ?array;
 
+    public function getName(): string;
     public function getWeight(): int;
 
     /**
@@ -54,10 +55,4 @@ public function alterValue(mixed $value): mixed;
      * @phpstan-return Generator<int, Error|null, mixed, bool>
      */
     public function validate(mixed $value): Generator;
-
-    /**
-     * @phpstan-param TValue $value
-     * @phpstan-return TValue
-     */
-    public function constrain(mixed $value): mixed;
 }

src/Lucid/Constraint/DateTime/Max.php

@@ -65,13 +65,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if ($value->greaterThan($this->max)) {
-            $value = new Carbon('now');
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/DateTime/Min.php

@@ -65,13 +65,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if ($value->lessThan($this->min)) {
-            $value = new Carbon('now');
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/Interval/Max.php

@@ -65,13 +65,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if ($value->greaterThan($this->max)) {
-            $value = new CarbonInterval();
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/Interval/Min.php

@@ -65,13 +65,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if ($value->lessThan($this->min)) {
-            $value = new CarbonInterval();
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/Number/Max.php

@@ -58,16 +58,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if (
-            $this->max !== null &&
-            $value > $this->max
-        ) {
-            $value = $this->max;
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/Number/Min.php

@@ -58,16 +58,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if (
-            $this->min !== null &&
-            $value < $this->min
-        ) {
-            $value = $this->min;
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/Processor.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * @package Lucid
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Lucid\Constraint;
+
+use DecodeLabs\Lucid\Constraint;
+use DecodeLabs\Lucid\ConstraintTrait;
+
+/**
+ * This constraint is used to wrap the main Processor
+ * to be passed to Error objects
+ *
+ * @template TValue
+ * @implements Constraint<TValue, TValue>
+ */
+class Processor implements Constraint
+{
+    /**
+     * @phpstan-use ConstraintTrait<TValue, TValue>
+     */
+    use ConstraintTrait;
+
+    public const OUTPUT_TYPES = [];
+
+    public function getName(): string
+    {
+        return $this->processor->getName();
+    }
+
+    public function getWeight(): int
+    {
+        return 1;
+    }
+}

src/Lucid/Constraint/String/Emojis.php

@@ -71,13 +71,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if (!$this->emojis) {
-            $value = preg_replace(self::REGEX, '', $value) ?? $value;
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/String/MaxLength.php

@@ -70,15 +70,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        $length = mb_strlen($value);
-
-        if ($length > $this->length) {
-            $value = substr($value, 0, $this->length);
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/String/MaxWords.php

@@ -71,17 +71,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        $words = Dictum::countWords($value);
-
-        if ($words > $this->words) {
-            $parts = explode(' ', $value);
-            $parts = array_slice($parts, 0, $this->words);
-            $value = implode(' ', $parts);
-        }
-
-        return $value;
-    }
 }

src/Lucid/Constraint/String/MinLength.php

@@ -70,9 +70,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        return str_pad($value, (int)$this->length, ' ');
-    }
 }

src/Lucid/Constraint/String/Pattern.php

@@ -65,20 +65,4 @@ public function validate(mixed $value): Generator
 
         return true;
     }
-
-    public function constrain(mixed $value): mixed
-    {
-        if (
-            $this->pattern !== null &&
-            !filter_var(
-                $value,
-                \FILTER_VALIDATE_REGEXP,
-                ['options' => ['regexp' => $this->pattern]]
-            )
-        ) {
-            $value = '';
-        }
-
-        return $value;
-    }
 }

src/Lucid/ConstraintTrait.php

@@ -10,6 +10,7 @@
 namespace DecodeLabs\Lucid;
 
 use Generator;
+use ReflectionClass;
 
 /**
  * @template TParam
@@ -44,6 +45,12 @@ public static function getProcessorOutputTypes(): ?array
         return null;
     }
 
+    public function getName(): string
+    {
+        return (new ReflectionClass($this))
+            ->getShortName();
+    }
+
     public function getWeight(): int
     {
         return 10;
@@ -86,13 +93,4 @@ public function validate(mixed $value): Generator
         yield null;
         return true;
     }
-
-    /**
-     * @phpstan-param TValue $value
-     * @phpstan-return TValue
-     */
-    public function constrain(mixed $value): mixed
-    {
-        return $value;
-    }
 }