Merge pull request #1 from m1x0n/feature/translator-support

Added translator support.

.travis.yml

@@ -13,6 +13,7 @@ install:
   - travis_retry composer install --no-interaction --prefer-dist
 
 script:
+  - vendor/bin/phpcs
   - vendor/bin/phpstan analyse -l 4 src
   - vendor/bin/phpunit
 

composer.json

@@ -19,7 +19,8 @@
         "opis/json-schema": "^1.0",
         "phpunit/phpunit": ">=7.1",
         "dg/bypass-finals": "^1.1",
-        "phpstan/phpstan": "^0.11.5"
+        "phpstan/phpstan": "^0.11.5",
+        "squizlabs/php_codesniffer": "^3.4"
     },
     "autoload": {
         "psr-4": {

phpcs.xml.dist

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+
+<ruleset name="Opis Error Presenter">
+    <description>Opis Error Presenter Rules</description>
+
+    <rule ref="PSR12"/>
+
+    <file>./src</file>
+    <file>./tests</file>
+</ruleset>

src/Contracts/Keyword.php

@@ -60,7 +60,7 @@ interface Keyword
         self::CONTAINS,
         self::PATTERN_PROPERTIES,
         self::ALL_OF,
-        self::ANY_OF.
+        self::ANY_OF ,
         self::ONE_OF,
         self::NOT,
     ];

src/Contracts/MessageFormatter.php

@@ -4,9 +4,9 @@
 
 namespace OpisErrorPresenter\Contracts;
 
-use Opis\JsonSchema\ValidationError;
-
 interface MessageFormatter
 {
-    public function format(ValidationError $error): string;
+    public function keyword(): string;
+
+    public function replacements(): array;
 }

src/Contracts/MessageTranslator.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpisErrorPresenter\Contracts;
+
+interface MessageTranslator
+{
+    public function translate(string $key, array $replacements = [], $locale = null): string;
+}

src/Contracts/PresentStrategy.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace OpisErrorPresenter\Contracts;

src/Implementation/Formatters/AdditionalItems.php

@@ -4,15 +4,7 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class AdditionalItems implements MessageFormatter
+class AdditionalItems extends Formatter
 {
-    private const MESSAGE = 'The attribute must not contain additional items.';
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = 'The attribute must not contain additional items.';
 }

src/Implementation/Formatters/AdditionalProperties.php

@@ -4,15 +4,7 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class AdditionalProperties implements MessageFormatter
+class AdditionalProperties extends Formatter
 {
-    private const MESSAGE = 'The attribute must not contain additional properties.';
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = 'The attribute must not contain additional properties.';
 }

src/Implementation/Formatters/AllOf.php

@@ -4,15 +4,7 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class AllOf implements MessageFormatter
+class AllOf extends Formatter
 {
-    private const MESSAGE = 'The attribute must be valid against all of the subschemas.';
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = 'The attribute must be valid against all of the subschemas.';
 }

src/Implementation/Formatters/AnyOf.php

@@ -4,15 +4,7 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class AnyOf implements MessageFormatter
+class AnyOf extends Formatter
 {
-    private const MESSAGE = 'The attribute does not match any of the subschemas.';
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = 'The attribute does not match any of the subschemas.';
 }

src/Implementation/Formatters/Constant.php

@@ -1,24 +1,17 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class Constant implements MessageFormatter
+class Constant extends Formatter
 {
-    private const MESSAGE = "The attribute value expected to be ':expected:'.";
+    public const MESSAGE = "The attribute value expected to be ':expected:'.";
 
-    public function format(ValidationError $error): string
+    public function replacements(): array
     {
-        $expected = $error->keywordArgs()['expected'];
-
-        $replacements = [
-            ':expected:' => $expected
+        return [
+            ':expected:' => $this->error->keywordArgs()['expected']
         ];
-
-        return strtr(self::MESSAGE, $replacements);
     }
 }

src/Implementation/Formatters/Contains.php

@@ -4,15 +4,7 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class Contains implements MessageFormatter
+class Contains extends Formatter
 {
-    private const MESSAGE = 'The attribute contains invalid items.';
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = 'The attribute contains invalid items.';
 }

src/Implementation/Formatters/Dependencies.php

@@ -4,19 +4,14 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class Dependencies implements MessageFormatter
+class Dependencies extends Formatter
 {
-    private const MESSAGE = "The attribute property ':missing:' is required.";
+    public const MESSAGE = "The attribute property ':missing:' is required.";
 
-    public function format(ValidationError $error): string
+    public function replacements(): array
     {
-        $missing = $error->keywordArgs()['missing'];
-
-        $replacements = [':missing:' => $missing];
-
-        return strtr(self::MESSAGE, $replacements);
+        return [
+            ':missing:' => $this->error->keywordArgs()['missing']
+        ];
     }
 }

src/Implementation/Formatters/ElseKeyword.php

@@ -4,15 +4,7 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class ElseKeyword implements MessageFormatter
+class ElseKeyword extends Formatter
 {
-    private const MESSAGE = "The attribute does not match schema for 'else'.";
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = "The attribute does not match schema for 'else'.";
 }

src/Implementation/Formatters/Enum.php

@@ -1,23 +1,25 @@
 <?php
+
 declare(strict_types=1);
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class Enum implements MessageFormatter
+class Enum extends Formatter
 {
-    private const MESSAGE = 'The attribute must be one of the following values: :expected:.';
+    public const MESSAGE = 'The attribute must be one of the following values: :expected:.';
 
-    public function format(ValidationError $error): string
+    public function replacements(): array
     {
-        $expected = $error->keywordArgs()['expected'];
+        $keywordArgs = $this->error->keywordArgs();
+        $expected = (array)$keywordArgs['expected'];
 
-        $replacements = [
-            ':expected:' => "'" . implode ("', '", $expected) . "'",
+        return [
+            ':expected:' => implode(', ', array_map(
+                function ($item) {
+                        return "'{$item}'";
+                },
+                $expected
+            )),
         ];
-
-        return strtr(self::MESSAGE, $replacements);
     }
 }

src/Implementation/Formatters/ExclusiveMaximum.php

@@ -4,19 +4,14 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class ExclusiveMaximum implements MessageFormatter
+class ExclusiveMaximum extends Formatter
 {
-    private const MESSAGE = 'The attribute value must be less than :max:.';
+    public const MESSAGE = 'The attribute value must be less than :max:.';
 
-    public function format(ValidationError $error): string
+    public function replacements(): array
     {
-        $max = $error->keywordArgs()['max'];
-
-        $replacements = [':max:' => $max];
-
-        return strtr(self::MESSAGE, $replacements);
+        return [
+            ':max:' => $this->error->keywordArgs()['max']
+        ];
     }
 }

src/Implementation/Formatters/ExclusiveMinimum.php

@@ -4,19 +4,14 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class ExclusiveMinimum implements MessageFormatter
+class ExclusiveMinimum extends Formatter
 {
-    private const MESSAGE = 'The attribute value must be greater than :min:.';
+    public const MESSAGE = 'The attribute value must be greater than :min:.';
 
-    public function format(ValidationError $error): string
+    public function replacements(): array
     {
-        $min = $error->keywordArgs()['min'];
-
-        $replacements = [':min:' => $min];
-
-        return strtr(self::MESSAGE, $replacements);
+        return [
+            ':min:' => $this->error->keywordArgs()['min']
+        ];
     }
 }

src/Implementation/Formatters/Format.php

@@ -4,18 +4,14 @@
 
 namespace OpisErrorPresenter\Implementation\Formatters;
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
-
-class Format implements MessageFormatter
+class Format extends Formatter
 {
-    private const MESSAGE = "The attribute should match ':format:' format.";
+    public const MESSAGE = "The attribute should match ':format:' format.";
 
-    public function format(ValidationError $error): string
+    public function replacements(): array
     {
-        $format = $error->keywordArgs()['format'] ?? null;
-        $replacements = $format ? [':format:' => $format] : [];
+        $format = $this->error->keywordArgs()['format'] ?? null;
 
-        return strtr(self::MESSAGE, $replacements);
+        return $format ? [':format:' => $format] : [];
     }
 }

src/Implementation/Formatters/Formatter.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpisErrorPresenter\Implementation\Formatters;
+
+use Opis\JsonSchema\ValidationError;
+use OpisErrorPresenter\Contracts\MessageFormatter;
+
+abstract class Formatter implements MessageFormatter
+{
+    /**
+     * @var ValidationError
+     */
+    protected $error;
+
+    public function __construct(ValidationError $error)
+    {
+        $this->error = $error;
+    }
+
+    public function keyword(): string
+    {
+        return $this->error->keyword();
+    }
+
+    public function replacements(): array
+    {
+        return [];
+    }
+}

src/Implementation/Formatters/InvalidAttribute.php

@@ -1,17 +1,10 @@
 <?php
-declare(strict_types = 1);
 
-namespace OpisErrorPresenter\Implementation\Formatters;
+declare(strict_types=1);
 
-use Opis\JsonSchema\ValidationError;
-use OpisErrorPresenter\Contracts\MessageFormatter;
+namespace OpisErrorPresenter\Implementation\Formatters;
 
-class InvalidAttribute implements MessageFormatter
+class InvalidAttribute extends Formatter
 {
-    private const MESSAGE = 'The attribute is invalid.';
-
-    public function format(ValidationError $error): string
-    {
-        return self::MESSAGE;
-    }
+    public const MESSAGE = 'The attribute is invalid.';
 }