Merge pull request #1 from programmatordev/YAPV-1-validator-core

Validator core

Author: andrepimpao

composer.json

@@ -15,7 +15,8 @@
         "php": ">=8.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.0"
+        "phpunit/phpunit": "^10.0",
+        "symfony/var-dumper": "^6.3"
     },
     "autoload": {
         "psr-4": {

src/ChainedValidatorInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\ValidationException;
+
+interface ChainedValidatorInterface
+{
+    // --- Common ---
+
+    public function validate(mixed $input): bool;
+
+    /**
+     * @throws ValidationException
+     */
+    public function assert(mixed $input, string $name): void;
+
+    // --- Rules ---
+
+//    public function notBlank(): ChainedValidatorInterface;
+//
+//    public function greaterThan(mixed $constraint): ChainedValidatorInterface;
+}

src/Exception/InvalidRuleException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Exception;
+
+class InvalidRuleException extends \Exception
+{
+    protected $message = 'Invalid rule.';
+}

src/Exception/ValidationException.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Exception;
+
+class ValidationException extends \Exception
+{
+    public function __construct(string $message, array $parameters = [])
+    {
+        $message = $this->formatMessage($message, $parameters);
+        parent::__construct($message);
+    }
+
+    private function formatMessage(string $message, array $parameters = []): string
+    {
+        foreach ($parameters as $parameter => $value) {
+            $message = str_replace("{{ $parameter }}", $this->formatValue($value), $message);
+        }
+
+        return $message;
+    }
+
+    private function formatValue(mixed $value): string
+    {
+        if ($value instanceof \DateTimeInterface) {
+            return $value->format('Y-m-d H:i:s');
+        }
+
+        if (\is_object($value)) {
+            if ($value instanceof \Stringable) {
+                return $value->__toString();
+            }
+
+            return 'object';
+        }
+
+        if (\is_array($value)) {
+            return $this->formatValues($value);
+        }
+
+        if (\is_string($value)) {
+            return \sprintf('"%s"', $value);
+        }
+
+        if (\is_resource($value)) {
+            return 'resource';
+        }
+
+        if ($value === null) {
+            return 'null';
+        }
+
+        if ($value === false) {
+            return 'false';
+        }
+
+        if ($value === true) {
+            return 'true';
+        }
+
+        return (string) $value;
+    }
+
+    private function formatValues(array $values): string
+    {
+        foreach ($values as $key => $value) {
+            $values[$key] = $this->formatValue($value);
+        }
+
+        return \implode(', ', $values);
+    }
+}

src/Factory.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\InvalidRuleException;
+use ProgrammatorDev\YetAnotherPhpValidator\Rule\RuleInterface;
+
+class Factory
+{
+    private string $namespace = 'ProgrammatorDev\\YetAnotherPhpValidator\\Rule';
+
+    /**
+     * @throws InvalidRuleException
+     */
+    public function createRule(string $ruleName, array $arguments = []): RuleInterface
+    {
+        try {
+            $className = \sprintf('%s\\%s', $this->namespace, \ucfirst($ruleName));
+            return new $className(...$arguments);
+        }
+        catch (\Error) {
+            throw new InvalidRuleException(
+                \sprintf('"%s" rule does not exist.', $ruleName)
+            );
+        }
+    }
+}

src/Rule/AbstractRule.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Rule;
+
+class AbstractRule
+{
+    private string $name;
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function setName(string $name): static
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+}

src/Rule/RuleInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Rule;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\ValidationException;
+
+interface RuleInterface
+{
+    /**
+     * @throws ValidationException
+     */
+    public function validate(mixed $input): void;
+
+    public function getName(): string;
+
+    public function setName(string $name): static;
+}

src/StaticValidatorInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator;
+
+interface StaticValidatorInterface
+{
+//    public static function notBlank(): ChainedValidatorInterface;
+//
+//    public static function greaterThan(mixed $constraint): ChainedValidatorInterface;
+}

src/Validator.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\InvalidRuleException;
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\ValidationException;
+use ProgrammatorDev\YetAnotherPhpValidator\Rule\RuleInterface;
+
+/**
+ * @mixin StaticValidatorInterface
+ */
+class Validator
+{
+    private array $rules;
+
+    public function __construct(RuleInterface ...$rules)
+    {
+        $this->rules = $rules;
+    }
+
+    private static function create(): self
+    {
+        return new self();
+    }
+
+    /**
+     * @throws InvalidRuleException
+     */
+    public static function __callStatic(string $ruleName, array $arguments = []): self
+    {
+        return self::create()->__call($ruleName, $arguments);
+    }
+
+    /**
+     * @throws InvalidRuleException
+     */
+    public function __call(string $ruleName, array $arguments = []): self
+    {
+        $factory = new Factory();
+        $this->addRule($factory->createRule($ruleName, $arguments));
+
+        return $this;
+    }
+
+    /**
+     * @throws ValidationException
+     */
+    public function assert(mixed $input, string $name): void
+    {
+        foreach ($this->getRules() as $rule) {
+            $rule->setName($name)->validate($input);
+        }
+    }
+
+    public function validate(mixed $input): bool
+    {
+        try {
+            $this->assert($input, 'null');
+        }
+        catch (ValidationException) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * @return RuleInterface[]
+     */
+    private function getRules(): array
+    {
+        return $this->rules;
+    }
+
+    private function addRule(RuleInterface $rule): self
+    {
+        $this->rules[] = $rule;
+
+        return $this;
+    }
+}