Move required into validation interface.

This provides better handling of dependent validators.

Author: lindyhopchris

README.md

@@ -19,6 +19,8 @@ A common scenario would be to decode received input for a resource object and th
 attributes within a controller. For example:
 
 ``` php
+<?php
+
 class ArticleController
 {
 
@@ -46,6 +48,7 @@ The above example can be refactored to use validators to parse the provided cont
 controller:
 
 ``` php
+<?php
 
 use CloudCreativity\JsonApi\Validator\Resource\ResourceObjectValidator;
 use CloudCreativity\JsonApi\Validator\Document\DocumentValidator;
@@ -61,8 +64,9 @@ class ArticleController
     $validator->type('article')
       ->attr('title', 'string')
       ->attr('content', 'string')
-      ->belongsTo('author', 'person')
-      ->required(['author']);
+      ->belongsTo('author', 'person', [
+        'required' => true,
+      ]);
 
     return $validator;
   }
@@ -88,6 +92,10 @@ In this refactored controller, `$data` can be used knowing that it has passed va
 been cast to an instance of `CloudCreativity\JsonApi\Object\Document\Document`, providing a fluid interface for
 handling the input within the controller.
 
+If the provided input did not pass validation, then the decoder throws a
+`CloudCreativity\JsonApi\Error\MultiErrorException` which contains the JSON API error messages indicating what is
+invalid, including JSON pointers to the source of the validation error.
+
 ## Status
 
 This repository is under active development and is currently in a pre-release state.

src/Contracts/Validator/KeyedValidatorInterface.php

@@ -22,7 +22,7 @@
  * Interface KeyedValidatorInterface
  * @package CloudCreativity\JsonApi
  */
-interface KeyedValidatorInterface extends ValidatorInterface
+interface KeyedValidatorInterface extends ValidatorInterface, \IteratorAggregate
 {
 
     /**
@@ -32,18 +32,6 @@ interface KeyedValidatorInterface extends ValidatorInterface
      */
     public function setValidator($key, ValidatorInterface $validator);
 
-    /**
-     * @param $keyOrKeys
-     * @return $this
-     */
-    public function setRequiredKeys($keyOrKeys);
-
-    /**
-     * @param $keyOrKeys
-     * @return $this
-     */
-    public function addRequiredKeys($keyOrKeys);
-
     /**
      * @param $key
      * @return ValidatorInterface
@@ -63,17 +51,6 @@ public function hasValidator($key);
      */
     public function keys();
 
-    /**
-     * @param $key
-     * @return bool
-     */
-    public function isRequiredKey($key);
-
-    /**
-     * @return bool
-     */
-    public function hasRequiredKeys();
-
     /**
      * @param $keyOrKeys
      * @return $this
@@ -90,4 +67,4 @@ public function addAllowedKeys($keyOrKeys);
      * @return bool
      */
     public function isAllowedKey($key);
-}
+}

src/Contracts/Validator/ValidatorInterface.php

@@ -32,4 +32,14 @@ interface ValidatorInterface extends ErrorsAwareInterface
      * @return bool
      */
     public function isValid($value);
-}
+
+    /**
+     * Whether a value must be provided for validation.
+     *
+     * If the validator is being used as a dependent validator, then the parent validator can use this method to detect
+     * if there must be a provided value to pass to the dependent validator.
+     *
+     * @return bool
+     */
+    public function isRequired();
+}

src/Validator/AbstractKeyedValidator.php

@@ -0,0 +1,171 @@
+<?php
+
+/**
+ * Copyright 2015 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.
+ */
+
+namespace CloudCreativity\JsonApi\Validator;
+
+use CloudCreativity\JsonApi\Contracts\Validator\KeyedValidatorInterface;
+use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
+use CloudCreativity\JsonApi\Validator\Helper\AllowedKeysTrait;
+
+/**
+ * Class AbstractKeyedValidator
+ * @package CloudCreativity\JsonApi
+ */
+abstract class AbstractKeyedValidator extends AbstractValidator implements KeyedValidatorInterface
+{
+
+    use AllowedKeysTrait;
+
+    const ERROR_REQUIRED = 'required';
+
+    /**
+     * Validators for use with keys within the attributes.
+     *
+     * @var array
+     */
+    protected $_validators = [];
+
+    /**
+     * @param $key
+     * @param ValidatorInterface $validator
+     * @return $this
+     */
+    public function setValidator($key, ValidatorInterface $validator)
+    {
+        $this->_validators[$key] = $validator;
+
+        return $this;
+    }
+
+    /**
+     * @param ValidatorInterface[] $validators
+     * @return $this
+     */
+    public function setValidators(array $validators)
+    {
+        foreach ($validators as $key => $validator) {
+
+            if (!$validator instanceof ValidatorInterface) {
+                throw new \InvalidArgumentException('Expecting only ValidatorInterface instances.');
+            }
+
+            $this->setValidator($key, $validator);
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param $key
+     * @return ValidatorInterface
+     */
+    public function getValidator($key)
+    {
+        if (!isset($this->_validators[$key])) {
+            throw new \RuntimeException(sprintf('No validator for key "%s".', $key));
+        }
+
+        return $this->_validators[$key];
+    }
+
+    /**
+     * @return ValidatorInterface[]
+     */
+    public function getValidators()
+    {
+        return $this->_validators;
+    }
+
+    /**
+     * @param $key
+     * @return bool
+     */
+    public function hasValidator($key)
+    {
+        return isset($this->_validators[$key]);
+    }
+
+    /**
+     * @return array
+     */
+    public function keys()
+    {
+        return array_keys($this->_validators);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isRequired()
+    {
+        /** @var ValidatorInterface $validator */
+        foreach ($this as $validator) {
+
+            if ($validator->isRequired()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param $key
+     * @return bool
+     */
+    public function isRequiredKey($key)
+    {
+        if (!$this->hasValidator($key)) {
+            return false;
+        }
+
+        return $this
+            ->getValidator($key)
+            ->isRequired();
+    }
+
+    /**
+     * @return \ArrayIterator
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator($this->_validators);
+    }
+
+    /**
+     * @param object $value
+     */
+    protected function checkRequired($value)
+    {
+        if (!is_object($value)) {
+            throw new \RuntimeException('Expecting an object to check required keys.');
+        }
+
+        /** @var ValidatorInterface $validator */
+        foreach ($this as $key => $validator) {
+
+            if (!$validator->isRequired()) {
+                continue;
+            }
+
+            if (!isset($value->{$key})) {
+                $this->error(static::ERROR_REQUIRED, '/' . $key);
+            }
+        }
+    }
+}