Merge pull request #5 from autorusltd/release/v1.4.0

v1.4.0

Author: fenric

.scrutinizer.yml

@@ -1,4 +1,9 @@
 build:
+  environment:
+    php:
+      version: '8.0'
+      ini:
+        'xdebug.mode': 'coverage'
   nodes:
     analysis:
       tests:

src/ResponseFactoryAwareTrait.php

@@ -9,7 +9,13 @@
 use Arus\Http\Response\Resource\Errors;
 use Psr\Http\Message\ResponseInterface;
 use Sunrise\Http\Message\ResponseFactory;
-use Symfony\Component\Validator\ConstraintViolationListInterface;
+use Symfony\Component\Validator\ConstraintViolationInterface;
+use InvalidArgumentException;
+
+/**
+ * Import functions
+ */
+use function is_array;
 
 /**
  * ResponseFactoryAwareTrait
@@ -98,20 +104,48 @@ public function error(string $message, string $source = null, $code = null, int
     }
 
     /**
-     * @param ConstraintViolationListInterface $violations
+     * @param iterable $violations
      * @param int $status
      *
      * @return ResponseInterface
+     *
+     * @throws InvalidArgumentException
      */
-    public function violations(ConstraintViolationListInterface $violations, int $status = 400) : ResponseInterface
+    public function violations(iterable $violations, int $status = 400) : ResponseInterface
     {
         $errors = [];
         foreach ($violations as $violation) {
-            $errors[] = new Error(
-                $violation->getMessage(),
-                $violation->getPropertyPath(),
-                $violation->getCode()
-            );
+            if ($violation instanceof ConstraintViolationInterface) {
+                $errors[] = new Error(
+                    $violation->getMessage(),
+                    $violation->getPropertyPath(),
+                    $violation->getCode()
+                );
+
+                continue;
+            }
+
+            if (is_array($violation) && isset($violation['message'], $violation['source'])) {
+                $errors[] = new Error(
+                    $violation['message'],
+                    $violation['source'],
+                    $violation['code'] ?? null
+                );
+
+                continue;
+            }
+
+            if (is_array($violation) && isset($violation['message'], $violation['property'])) {
+                $errors[] = new Error(
+                    $violation['message'],
+                    $violation['property'],
+                    $violation['code'] ?? null
+                );
+
+                continue;
+            }
+
+            throw new InvalidArgumentException('Unexpected violation');
         }
 
         return $this->json(new Errors(...$errors), $status);

tests/ResponseFactoryTest.php

@@ -13,6 +13,7 @@
 use Laminas\Diactoros\ResponseFactory as ZendResponseFactory;
 use Symfony\Component\Validator\ConstraintViolationList;
 use Symfony\Component\Validator\ConstraintViolation;
+use InvalidArgumentException;
 
 /**
  * ResponseFactoryTest
@@ -308,4 +309,121 @@ public function testCreateJsonViolationsResponseWithCustomStatusCode() : void
 
         $this->assertSame(500, $response->getStatusCode());
     }
+
+    /**
+     * @return void
+     */
+    public function testViolationsWithObjects() : void
+    {
+        $response = (new class () {
+            use ResponseFactoryAwareTrait;
+        })->violations([
+            new ConstraintViolation('foo', null, [], null, 'bar', null, null, 'baz'),
+            new ConstraintViolation('qux', null, [], null, 'quux', null, null, 'quuux'),
+        ]);
+
+        $this->assertSame(400, $response->getStatusCode());
+
+        $this->assertSame(
+            '{"errors":[{"code":"baz","source":"bar","message":"foo"},' .
+                '{"code":"quuux","source":"quux","message":"qux"}]}',
+            $response->getBody()->__toString()
+        );
+    }
+
+    /**
+     * @return void
+     */
+    public function testViolationsWithSourceableArrays() : void
+    {
+        $response = (new class () {
+            use ResponseFactoryAwareTrait;
+        })->violations([
+            ['code' => 'foo', 'source' => 'bar', 'message' => 'baz'],
+            ['code' => 'bar', 'source' => 'baz', 'message' => 'qux'],
+        ]);
+
+        $this->assertSame(400, $response->getStatusCode());
+
+        $this->assertSame(
+            '{"errors":[{"code":"foo","source":"bar","message":"baz"},' .
+                '{"code":"bar","source":"baz","message":"qux"}]}',
+            $response->getBody()->__toString()
+        );
+    }
+
+    /**
+     * @return void
+     */
+    public function testViolationsWithSourceableArraysWithoutCodes() : void
+    {
+        $response = (new class () {
+            use ResponseFactoryAwareTrait;
+        })->violations([
+            ['source' => 'bar', 'message' => 'baz'],
+            ['source' => 'baz', 'message' => 'qux'],
+        ]);
+
+        $this->assertSame(400, $response->getStatusCode());
+
+        $this->assertSame(
+            '{"errors":[{"code":null,"source":"bar","message":"baz"},' .
+                '{"code":null,"source":"baz","message":"qux"}]}',
+            $response->getBody()->__toString()
+        );
+    }
+
+    /**
+     * @return void
+     */
+    public function testViolationsWithPropertyableArrays() : void
+    {
+        $response = (new class () {
+            use ResponseFactoryAwareTrait;
+        })->violations([
+            ['code' => 'foo', 'property' => 'bar', 'message' => 'baz'],
+            ['code' => 'bar', 'property' => 'baz', 'message' => 'qux'],
+        ]);
+
+        $this->assertSame(400, $response->getStatusCode());
+
+        $this->assertSame(
+            '{"errors":[{"code":"foo","source":"bar","message":"baz"},' .
+                '{"code":"bar","source":"baz","message":"qux"}]}',
+            $response->getBody()->__toString()
+        );
+    }
+
+    /**
+     * @return void
+     */
+    public function testViolationsWithPropertyableArraysWithoutCodes() : void
+    {
+        $response = (new class () {
+            use ResponseFactoryAwareTrait;
+        })->violations([
+            ['property' => 'bar', 'message' => 'baz'],
+            ['property' => 'baz', 'message' => 'qux'],
+        ]);
+
+        $this->assertSame(400, $response->getStatusCode());
+
+        $this->assertSame(
+            '{"errors":[{"code":null,"source":"bar","message":"baz"},' .
+                '{"code":null,"source":"baz","message":"qux"}]}',
+            $response->getBody()->__toString()
+        );
+    }
+
+    /**
+     * @return void
+     */
+    public function testViolationsWithInvalidData() : void
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        (new class () {
+            use ResponseFactoryAwareTrait;
+        })->violations([null]);
+    }
 }