More work on spec validation

Author: lindyhopchris

resources/lang/en/errors.php

@@ -64,6 +64,12 @@
         'code' => '',
     ],
 
+    'member_array_expected' => [
+        'title' => 'Non-Compliant JSON API Document',
+        'detail' => 'The member :member must be an array.',
+        'code' => '',
+    ],
+
     'member_identifier_expected' => [
         'title' => 'Non-Compliant JSON API Document',
         'detail' => 'The member :member must be a resource identifier.',

resources/lang/nl/errors.php

@@ -64,6 +64,12 @@
         'code' => '',
     ],
 
+    'member_array_expected' => [
+        'title' => 'Non-Compliant JSON API Document',
+        'detail' => 'Het onderdeel :member moet een array zijn.',
+        'code' => '',
+    ],
+
     'member_identifier_expected' => [
         'title' => 'Niet-Conform JSON API Document',
         'detail' => 'Het onderdeel :member moet een resource identifier zijn.',

src/Core/Document/ErrorList.php

@@ -23,6 +23,7 @@
 use IteratorAggregate;
 use LaravelJsonApi\Contracts\Serializable;
 use LogicException;
+use function array_merge;
 use function collect;
 
 class ErrorList implements Serializable, Countable, IteratorAggregate
@@ -97,6 +98,22 @@ public function push(Error ...$errors): self
         return $this;
     }
 
+    /**
+     * Merge errors.
+     *
+     * @param iterable $errors
+     * @return $this
+     */
+    public function merge(iterable $errors): self
+    {
+        if ($errors instanceof static) {
+            $this->stack = array_merge($this->stack, $errors->stack);
+            return $this;
+        }
+
+        return $this->push(...$errors);
+    }
+
     /**
      * @return bool
      */

src/Spec/Builder.php

@@ -20,15 +20,11 @@
 namespace LaravelJsonApi\Spec;
 
 use Illuminate\Pipeline\Pipeline;
+use function json_decode;
 
 class Builder
 {
 
-    /**
-     * @var Translator
-     */
-    private Translator $translator;
-
     /**
      * @var Pipeline
      */
@@ -39,20 +35,13 @@ class Builder
      */
     private ?string $expects = null;
 
-    /**
-     * @var bool
-     */
-    private bool $clientIds = false;
-
     /**
      * Builder constructor.
      *
-     * @param Translator $translator
      * @param Pipeline $pipeline
      */
-    public function __construct(Translator $translator, Pipeline $pipeline)
+    public function __construct(Pipeline $pipeline)
     {
-        $this->translator = $translator;
         $this->pipeline = $pipeline;
     }
 
@@ -70,36 +59,31 @@ public function expects(string $resourceType): self
     }
 
     /**
-     * Set whether client ids are allowed.
-     *
-     * @param bool $supported
-     * @return $this
-     */
-    public function clientIds(bool $supported = true): self
-    {
-        $this->clientIds = $supported;
-
-        return $this;
-    }
-
-    /**
-     * @param $json
+     * @param string|object $json
      * @return Document
      */
     public function build($json): Document
     {
+        if (is_string($json)) {
+            $json = json_decode($json, false, 512, JSON_THROW_ON_ERROR);
+        }
+
+        if (!is_object($json)) {
+            throw new \InvalidArgumentException('Expecting a string or object.');
+        }
+
         $pipes = [
-            new Validators\DataValidator($this->translator),
-            new Validators\TypeValidator($this->translator, $this->expects),
-            new Validators\ClientIdValidator($this->translator, $this->expects, $this->clientIds),
-            new Validators\AttributesValidator($this->translator),
-            new Validators\RelationshipsValidator($this->translator),
-            new Validators\RelationshipValidator($this->translator),
-            new Validators\FieldsValidator($this->translator),
+            Validators\DataValidator::class,
+            Validators\TypeValidator::class,
+            Validators\ClientIdValidator::class,
+            Validators\FieldsValidator::class,
+            Validators\AttributesValidator::class,
+            Validators\RelationshipsValidator::class,
+            Validators\RelationshipValidator::class,
         ];
 
         return $this->pipeline
-            ->send(Document::cast($json))
+            ->send(new Document($json, $this->expects))
             ->through($pipes)
             ->via('validate')
             ->thenReturn();

src/Spec/Document.php

@@ -20,7 +20,6 @@
 namespace LaravelJsonApi\Spec;
 
 use LaravelJsonApi\Core\Document\ErrorList;
-use function json_decode;
 
 class Document
 {
@@ -31,46 +30,32 @@ class Document
     private object $document;
 
     /**
-     * @var ErrorList
+     * @var string
      */
-    private ErrorList $errors;
+    private string $resourceType;
 
     /**
-     * @param $json
-     * @return static
+     * @var string|null
      */
-    public static function cast($json): self
-    {
-        if (is_string($json)) {
-            return self::fromString($json);
-        }
-
-        if (is_object($json)) {
-            return new self($json);
-        }
-
-        throw new \UnexpectedValueException('Expecting a string or decoded JSON object.');
-    }
+    private ?string $relation;
 
     /**
-     * Create a document from a string.
-     *
-     * @param string $json
-     * @return Document
+     * @var ErrorList
      */
-    public static function fromString(string $json): self
-    {
-        return new self(json_decode($json, false, JSON_THROW_ON_ERROR));
-    }
+    private ErrorList $errors;
 
     /**
      * Document constructor.
      *
      * @param object $document
+     * @param string $resourceType
+     * @param string|null $relation
      */
-    public function __construct(object $document)
+    public function __construct(object $document, string $resourceType, string $relation = null)
     {
         $this->document = $document;
+        $this->resourceType = $resourceType;
+        $this->relation = $relation;
         $this->errors = new ErrorList();
     }
 
@@ -93,7 +78,43 @@ public function __get($name)
     }
 
     /**
-     * Get a value.
+     * Get the document's expected resource type.
+     *
+     * @return string
+     */
+    public function type(): string
+    {
+        return $this->resourceType;
+    }
+
+    /**
+     * Get the relation that the document represents.
+     *
+     * @return string|null
+     */
+    public function relation(): ?string
+    {
+        return $this->relation;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isRelation(): bool
+    {
+        return is_string($this->relation);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isNotRelation(): bool
+    {
+        return !$this->isRelation();
+    }
+
+    /**
+     * Get a value from the document using dot notation.
      *
      * @param string $path
      * @param mixed|null $default

src/Spec/Factory.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * Copyright 2020 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Spec;
+
+use LaravelJsonApi\Spec\Values\Identifier;
+use LaravelJsonApi\Spec\Values\ToMany;
+use LaravelJsonApi\Spec\Values\ToOne;
+
+class Factory
+{
+
+    /**
+     * @var Specification
+     */
+    private Specification $spec;
+
+    /**
+     * @var Translator
+     */
+    private Translator $translator;
+
+    /**
+     * Factory constructor.
+     *
+     * @param Specification $spec
+     * @param Translator $translator
+     */
+    public function __construct(Specification $spec, Translator $translator)
+    {
+        $this->spec = $spec;
+        $this->translator = $translator;
+    }
+
+
+    /**
+     * Create a resource identifier object.
+     *
+     * @param string $path
+     * @param $value
+     * @return Identifier
+     */
+    public function createIdentifierValue(string $path, $value): Identifier
+    {
+        return new Identifier($this->spec, $this->translator, $path, $value);
+    }
+
+    /**
+     * Create a to-one relationship object.
+     *
+     * @param string $path
+     * @param $value
+     * @return ToOne
+     */
+    public function createToOneValue(string $path, $value): ToOne
+    {
+        return new ToOne($this->translator, $this, $path, $value);
+    }
+
+    /**
+     * Create a to-many relationship object.
+     *
+     * @param string $path
+     * @param $value
+     * @return ToMany
+     */
+    public function createToManyValue(string $path, $value): ToMany
+    {
+        return new ToMany($this->translator, $this, $path, $value);
+    }
+}