[tests] Rework of errors for Args helper.

LastDragon-ru · LastDragon-ru · commit d10956545d65 · 2021-05-02T11:28:05.000+04:00
diff --git a/packages/testing/src/Constraints/Json/JsonMatchesSchema.php b/packages/testing/src/Constraints/Json/JsonMatchesSchema.php
@@ -53,7 +53,7 @@ public function evaluate($other, string $description = '', bool $returnResult =
     protected function matches($other): bool {
         $helper       = null;
         $loader       = $this->schema->getLoader();
-        $schema       = new Schema(Args::getJson($this->schema->getSchema()) ?? Args::invalidJson());
+        $schema       = new Schema(Args::getJson($this->schema->getSchema()));
         $this->result = (new Validator($helper, $loader))->schemaValidation($other, $schema);
         $matches      = $this->result->isValid();
 
diff --git a/packages/testing/src/Constraints/Json/JsonSchemaLoader.php b/packages/testing/src/Constraints/Json/JsonSchemaLoader.php
@@ -48,7 +48,7 @@ public function loadSchema(string $uri): ISchema|null {
         $schema = null;
 
         if ($file) {
-            $schema = new Schema(Args::getJson($file) ?? Args::invalidJson());
+            $schema = new Schema(Args::getJson($file));
         }
 
         // Return
diff --git a/packages/testing/src/Constraints/Response/ContentTypeTest.php b/packages/testing/src/Constraints/Response/ContentTypeTest.php
@@ -3,7 +3,7 @@
 namespace LastDragon_ru\LaraASP\Testing\Constraints\Response;
 
 use GuzzleHttp\Psr7\Response;
-use InvalidArgumentException;
+use LastDragon_ru\LaraASP\Testing\Exceptions\InvalidArgumentResponse;
 use PHPUnit\Framework\TestCase;
 use stdClass;
 
@@ -16,9 +16,7 @@ class ContentTypeTest extends TestCase {
      * @covers ::evaluate
      */
     public function testEvaluate(): void {
-        $this->expectExceptionObject(new InvalidArgumentException(
-            'It is not a `Psr\Http\Message\ResponseInterface` instance.',
-        ));
+        $this->expectExceptionObject(new InvalidArgumentResponse('$response', new stdClass()));
 
         $this->assertFalse((new ContentType(''))->evaluate(new stdClass()));
     }
diff --git a/packages/testing/src/Constraints/Response/HeaderTest.php b/packages/testing/src/Constraints/Response/HeaderTest.php
@@ -3,7 +3,7 @@
 namespace LastDragon_ru\LaraASP\Testing\Constraints\Response;
 
 use GuzzleHttp\Psr7\Response;
-use InvalidArgumentException;
+use LastDragon_ru\LaraASP\Testing\Exceptions\InvalidArgumentResponse;
 use PHPUnit\Framework\Constraint\IsEqual;
 use PHPUnit\Framework\TestCase;
 use stdClass;
@@ -17,9 +17,7 @@ class HeaderTest extends TestCase {
      * @covers ::evaluate
      */
     public function testEvaluate(): void {
-        $this->expectExceptionObject(new InvalidArgumentException(
-            'It is not a `Psr\Http\Message\ResponseInterface` instance.',
-        ));
+        $this->expectExceptionObject(new InvalidArgumentResponse('$response', new stdClass()));
 
         $this->assertFalse((new Header('Test'))->evaluate(new stdClass()));
     }
diff --git a/packages/testing/src/Constraints/Response/Response.php b/packages/testing/src/Constraints/Response/Response.php
@@ -46,7 +46,7 @@ public function getConstraints(): array {
      */
     public function evaluate($other, string $description = '', bool $returnResult = false): ?bool {
         return parent::evaluate(
-            Args::getResponse($other) ?? Args::invalidResponse(),
+            Args::getResponse($other),
             $description,
             $returnResult,
         );
diff --git a/packages/testing/src/Constraints/Response/StatusCodeTest.php b/packages/testing/src/Constraints/Response/StatusCodeTest.php
@@ -3,7 +3,7 @@
 namespace LastDragon_ru\LaraASP\Testing\Constraints\Response;
 
 use GuzzleHttp\Psr7\Response;
-use InvalidArgumentException;
+use LastDragon_ru\LaraASP\Testing\Exceptions\InvalidArgumentResponse;
 use PHPUnit\Framework\TestCase;
 use stdClass;
 
@@ -16,9 +16,7 @@ class StatusCodeTest extends TestCase {
      * @covers ::evaluate
      */
     public function testEvaluate(): void {
-        $this->expectExceptionObject(new InvalidArgumentException(
-            'It is not a `Psr\Http\Message\ResponseInterface` instance.',
-        ));
+        $this->expectExceptionObject(new InvalidArgumentResponse('$response', new stdClass()));
 
         $this->assertFalse((new StatusCode(200))->evaluate(new stdClass()));
     }
diff --git a/packages/testing/src/Constraints/Xml/XmlMatchesSchema.php b/packages/testing/src/Constraints/Xml/XmlMatchesSchema.php
@@ -30,7 +30,7 @@ class XmlMatchesSchema extends Constraint {
     protected array $errors = [];
 
     public function __construct(SplFileInfo $schema) {
-        $this->schema = Args::getFile($schema) ?? Args::invalidFile();
+        $this->schema = Args::getFile($schema);
     }
 
     // <editor-fold desc="\PHPUnit\Framework\Constraint\Constraint">
@@ -39,11 +39,13 @@ public function __construct(SplFileInfo $schema) {
      * @inheritdoc
      */
     public function evaluate($other, string $description = '', bool $returnResult = false): ?bool {
-        return parent::evaluate(
-            Args::getFile($other) ?? Args::getDomDocument($other) ?? Args::invalidXml(),
-            $description,
-            $returnResult,
-        );
+        if ($other instanceof SplFileInfo) {
+            $other = Args::getFile($other);
+        } else {
+            $other = Args::getDomDocument($other);
+        }
+
+        return parent::evaluate($other, $description, $returnResult);
     }
 
     /**
diff --git a/packages/testing/src/Exceptions/InvalidArgument.php b/packages/testing/src/Exceptions/InvalidArgument.php
@@ -0,0 +1,15 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use InvalidArgumentException;
+use LastDragon_ru\LaraASP\Testing\PackageException;
+
+use function gettype;
+use function is_object;
+
+abstract class InvalidArgument extends InvalidArgumentException implements PackageException {
+    protected function getType(mixed $value): string {
+        return is_object($value) ? $value::class : gettype($value);
+    }
+}
diff --git a/packages/testing/src/Exceptions/InvalidArgumentJson.php b/packages/testing/src/Exceptions/InvalidArgumentJson.php
@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use Throwable;
+
+use function sprintf;
+
+class InvalidArgumentJson extends InvalidArgument {
+    public function __construct(
+        protected string $argument,
+        protected mixed $value,
+        Throwable $previous = null,
+    ) {
+        parent::__construct(sprintf(
+            'Argument `%1$s` must be a valid JSON.',
+            $this->argument,
+        ), 0, $previous);
+    }
+}
diff --git a/packages/testing/src/Exceptions/InvalidArgumentResponse.php b/packages/testing/src/Exceptions/InvalidArgumentResponse.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use Psr\Http\Message\ResponseInterface;
+use Throwable;
+
+use function sprintf;
+
+class InvalidArgumentResponse extends InvalidArgument {
+    public function __construct(
+        protected string $argument,
+        protected mixed $value,
+        Throwable $previous = null,
+    ) {
+        parent::__construct(sprintf(
+            'Argument `%1$s` must be instance of `%2$s`, `%3$s` given.',
+            $this->argument,
+            ResponseInterface::class,
+            $this->getType($this->value),
+        ), 0, $previous);
+    }
+}
diff --git a/packages/testing/src/Exceptions/InvalidArgumentSplFileInfo.php b/packages/testing/src/Exceptions/InvalidArgumentSplFileInfo.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use SplFileInfo;
+use Throwable;
+
+use function sprintf;
+
+class InvalidArgumentSplFileInfo extends InvalidArgument {
+    public function __construct(
+        protected string $argument,
+        protected mixed $value,
+        Throwable $previous = null,
+    ) {
+        parent::__construct(sprintf(
+            'Argument `%1$s` must be instance of `%2$s`, `%3$s` given.',
+            $this->argument,
+            SplFileInfo::class,
+            $this->getType($this->value),
+        ), 0, $previous);
+    }
+}
diff --git a/packages/testing/src/Exceptions/InvalidArgumentSplFileInfoIsNotAFile.php b/packages/testing/src/Exceptions/InvalidArgumentSplFileInfoIsNotAFile.php
@@ -0,0 +1,22 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use SplFileInfo;
+use Throwable;
+
+use function sprintf;
+
+class InvalidArgumentSplFileInfoIsNotAFile extends InvalidArgument {
+    public function __construct(
+        protected string $argument,
+        protected SplFileInfo $value,
+        Throwable $previous = null,
+    ) {
+        parent::__construct(sprintf(
+            'Argument `%1$s` is not a file (path: `%2$s`).',
+            $this->argument,
+            $this->value->getPathname(),
+        ), 0, $previous);
+    }
+}
diff --git a/packages/testing/src/Exceptions/InvalidArgumentSplFileInfoIsNotReadable.php b/packages/testing/src/Exceptions/InvalidArgumentSplFileInfoIsNotReadable.php
@@ -0,0 +1,24 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use InvalidArgumentException;
+use LastDragon_ru\LaraASP\Testing\PackageException;
+use SplFileInfo;
+use Throwable;
+
+use function sprintf;
+
+class InvalidArgumentSplFileInfoIsNotReadable extends InvalidArgumentException implements PackageException {
+    public function __construct(
+        protected string $argument,
+        protected SplFileInfo $value,
+        Throwable $previous = null,
+    ) {
+        parent::__construct(sprintf(
+            'Argument `%1$s` is file but not readable (path: `%2$s`).',
+            $this->argument,
+            $this->value->getPathname(),
+        ), 0, $previous);
+    }
+}
diff --git a/packages/testing/src/Exceptions/InvalidArgumentXml.php b/packages/testing/src/Exceptions/InvalidArgumentXml.php
@@ -0,0 +1,22 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing\Exceptions;
+
+use DOMDocument;
+use Throwable;
+
+use function sprintf;
+
+class InvalidArgumentXml extends InvalidArgument {
+    public function __construct(
+        protected string $argument,
+        protected mixed $value,
+        Throwable $previous = null,
+    ) {
+        parent::__construct(sprintf(
+            'Argument `%1$s` must be instance of `%2$s` or a valid XML string.',
+            $this->argument,
+            DOMDocument::class,
+        ), 0, $previous);
+    }
+}
diff --git a/packages/testing/src/PackageException.php b/packages/testing/src/PackageException.php
@@ -0,0 +1,9 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Testing;
+
+use Throwable;
+
+interface PackageException extends Throwable {
+    // empty
+}
diff --git a/packages/testing/src/Responses/JsonResponse.php b/packages/testing/src/Responses/JsonResponse.php
@@ -24,7 +24,7 @@ public function __construct(
         JsonSerializable|SplFileInfo|stdClass|array|string|int|float|bool|null $content = null,
     ) {
         if ($content) {
-            $content = Args::getJson($content) ?? Args::invalidJson();
+            $content = Args::getJson($content);
         }
 
         parent::__construct(
diff --git a/packages/testing/src/Utils/Args.php b/packages/testing/src/Utils/Args.php

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function loadSchema(string $uri): ISchema\|null {`
`48`	`48`	`$schema = null;`
`49`	`49`
`50`	`50`	`if ($file) {`
`51`		`- $schema = new Schema(Args::getJson($file) ?? Args::invalidJson());`
	`51`	`+ $schema = new Schema(Args::getJson($file));`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`// Return`