Required keys sets expectations for input, fixes #3

Author: lindyhopchris

src/Contracts/Validator/KeyedValidatorInterface.php

@@ -0,0 +1,44 @@
+<?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\Contracts\Validator;
+
+/**
+ * Interface KeyedValidatorInterface
+ * @package CloudCreativity\JsonApi
+ */
+interface KeyedValidatorInterface extends ValidatorInterface
+{
+
+    /**
+     * @param $key
+     * @return ValidatorInterface
+     */
+    public function getValidator($key);
+
+    /**
+     * @param $key
+     * @return bool
+     */
+    public function isRequiredKey($key);
+
+    /**
+     * @return bool
+     */
+    public function hasRequiredKeys();
+}

src/Validator/Attributes/AttributesValidator.php

@@ -19,6 +19,7 @@
 namespace CloudCreativity\JsonApi\Validator\Attributes;
 
 use CloudCreativity\JsonApi\Contracts\Stdlib\ConfigurableInterface;
+use CloudCreativity\JsonApi\Contracts\Validator\KeyedValidatorInterface;
 use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
 use CloudCreativity\JsonApi\Error\ErrorObject;
 use CloudCreativity\JsonApi\Error\SourceObject;
@@ -31,7 +32,7 @@
  * Class AttributesValidator
  * @package CloudCreativity\JsonApi
  */
-class AttributesValidator extends AbstractValidator implements ConfigurableInterface
+class AttributesValidator extends AbstractValidator implements ConfigurableInterface, KeyedValidatorInterface
 {
 
     use RequiredKeysTrait,

src/Validator/Helper/RequiredKeysTrait.php

@@ -66,6 +66,23 @@ public function getRequiredKeys()
         return (array) $this->_requiredKeys;
     }
 
+    /**
+     * @return bool
+     */
+    public function hasRequiredKeys()
+    {
+        return !empty($this->_requiredKeys);
+    }
+
+    /**
+     * @param $key
+     * @return bool
+     */
+    public function isRequiredKey($key)
+    {
+        return in_array($key, $this->_requiredKeys, true);
+    }
+
     /**
      * @return $this
      */

src/Validator/Relationships/RelationshipsValidator.php

@@ -18,6 +18,7 @@
 
 namespace CloudCreativity\JsonApi\Validator\Relationships;
 
+use CloudCreativity\JsonApi\Contracts\Validator\KeyedValidatorInterface;
 use CloudCreativity\JsonApi\Validator\AbstractValidator;
 use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
 use CloudCreativity\JsonApi\Error\ErrorObject;
@@ -27,7 +28,7 @@
  * Class RelationshipsValidator
  * @package CloudCreativity\JsonApi
  */
-class RelationshipsValidator extends AbstractValidator
+class RelationshipsValidator extends AbstractValidator implements KeyedValidatorInterface
 {
 
     use RequiredKeysTrait;

src/Validator/Resource/AbstractResourceObjectValidator.php

@@ -18,6 +18,7 @@
 
 namespace CloudCreativity\JsonApi\Validator\Resource;
 
+use CloudCreativity\JsonApi\Contracts\Validator\KeyedValidatorInterface;
 use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
 use CloudCreativity\JsonApi\Error\ErrorObject;
 use CloudCreativity\JsonApi\Object\Resource\ResourceObject;
@@ -100,39 +101,49 @@ abstract public function getTypeValidator();
     abstract public function getIdValidator();
 
     /**
-     * Whether attributes must always be present in the resource object.
+     * Get the attributes validator or null if the resource object must not have attributes.
      *
-     * @return bool
+     * @return ValidatorInterface
      */
-    abstract public function isExpectingAttributes();
+    abstract public function getAttributesValidator();
 
     /**
-     * Get the attributes validator or null if the resource object must not have attributes.
+     * Get the relationships validator or null if the resource object must not have relationships.
      *
      * @return ValidatorInterface
      */
-    abstract public function getAttributesValidator();
+    abstract public function getRelationshipsValidator();
 
     /**
-     * Whether relationships must always be present in the resource object.
-     *
      * @return bool
      */
-    abstract public function isExpectingRelationships();
+    public function hasIdValidator()
+    {
+        return $this->getIdValidator() instanceof ValidatorInterface;
+    }
 
     /**
-     * Get the relationships validator or null if the resource object must not have relationships.
+     * Whether the resource object expects to have attributes.
      *
-     * @return ValidatorInterface
+     * @return bool
      */
-    abstract public function getRelationshipsValidator();
+    public function isExpectingAttributes()
+    {
+        $attr = $this->getAttributesValidator();
+
+        return ($attr instanceof KeyedValidatorInterface && $attr->hasRequiredKeys());
+    }
 
     /**
+     * Whether the resource object expects to have relationships.
+     *
      * @return bool
      */
-    public function hasIdValidator()
+    public function isExpectingRelationships()
     {
-        return $this->getIdValidator() instanceof ValidatorInterface;
+        $rel = $this->getRelationshipsValidator();
+
+        return ($rel instanceof KeyedValidatorInterface && $rel->hasRequiredKeys());
     }
 
     /**
@@ -213,12 +224,14 @@ protected function validateId(StandardObject $object)
      */
     protected function validateAttributes(StandardObject $object)
     {
+        $expectation = $this->isExpectingAttributes();
+
         // valid if the object does not have attributes, and attributes are not expected.
-        if (!$object->has(ResourceObject::ATTRIBUTES) && !$this->isExpectingAttributes()) {
+        if (!$object->has(ResourceObject::ATTRIBUTES) && !$expectation) {
             return $this;
         }
 
-        if (!$object->has(ResourceObject::ATTRIBUTES) && $this->isExpectingAttributes()) {
+        if (!$object->has(ResourceObject::ATTRIBUTES) && $expectation) {
             $this->error(static::ERROR_MISSING_ATTRIBUTES);
             return $this;
         }
@@ -243,12 +256,14 @@ protected function validateAttributes(StandardObject $object)
      */
     protected function validateRelationships(StandardObject $object)
     {
+        $expectation = $this->isExpectingRelationships();
+
         // valid if no relationships and not expecting relationships
-        if (!$object->has(ResourceObject::RELATIONSHIPS) && !$this->isExpectingRelationships()) {
+        if (!$object->has(ResourceObject::RELATIONSHIPS) && !$expectation) {
             return $this;
         }
 
-        if (!$object->has(ResourceObject::RELATIONSHIPS) && $this->isExpectingRelationships()) {
+        if (!$object->has(ResourceObject::RELATIONSHIPS) && $expectation) {
             $this->error(static::ERROR_MISSING_RELATIONSHIPS);
             return $this;
         }

src/Validator/Resource/AttributesValidatorTrait.php

@@ -33,11 +33,6 @@ trait AttributesValidatorTrait
      */
     protected $_attributesValidator;
 
-    /**
-     * @var bool
-     */
-    protected $_expectingAttributes = true;
-
     /**
      * @param ValidatorInterface $validator
      * @return $this
@@ -61,25 +56,6 @@ public function getAttributesValidator()
         return $this->_attributesValidator;
     }
 
-    /**
-     * @param $bool
-     * @return $this
-     */
-    public function setExpectingAttributes($bool)
-    {
-        $this->_expectingAttributes = (bool) $bool;
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isExpectingAttributes()
-    {
-        return (bool) $this->_expectingAttributes;
-    }
-
     /**
      * @return AttributesValidator
      */

src/Validator/Resource/RelationshipsValidatorTrait.php

@@ -33,11 +33,6 @@ trait RelationshipsValidatorTrait
      */
     protected $_relationshipsValidator;
 
-    /**
-     * @var bool
-     */
-    protected $_expectingRelationships = false;
-
     /**
      * @param ValidatorInterface $validator
      * @return $this
@@ -61,25 +56,6 @@ public function getRelationshipsValidator()
         return $this->_relationshipsValidator;
     }
 
-    /**
-     * @param $bool
-     * @return $this
-     */
-    public function setExpectingRelationships($bool)
-    {
-        $this->_expectingRelationships = (bool) $bool;
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isExpectingRelationships()
-    {
-        return (bool) $this->_expectingRelationships;
-    }
-
     /**
      * @return RelationshipsValidator
      */

test/Validator/Attributes/AttributesValidatorTest.php

@@ -69,8 +69,11 @@ public function testNotAllowed()
     public function testRequiredKeys()
     {
         $validator = new AttributesValidator();
+
+        $this->assertFalse($validator->hasRequiredKeys());
         $this->assertSame($validator, $validator->setRequiredKeys([static::KEY_A, static::KEY_B]));
         $this->assertTrue($validator->isValid($this->data));
+        $this->assertTrue($validator->hasRequiredKeys());
     }
 
     public function testMissingRequired()

test/Validator/Relationships/RelationshipsValidatorTest.php

@@ -130,11 +130,15 @@ public function testUnrecognisedKey()
 
     public function testRequired()
     {
+        $this->assertFalse($this->validator->hasRequiredKeys());
+
         $this->assertSame($this->validator, $this->validator->setRequiredKeys([
             static::KEY_A,
             static::KEY_B,
         ]));
 
+        $this->assertTrue($this->validator->hasRequiredKeys());
+
         $this->validator->setValidators([
             static::KEY_A => $this->a,
             static::KEY_B => $this->b,

test/Validator/Resource/AbstractResourceObjectValidatorTest.php

@@ -22,7 +22,7 @@
 use CloudCreativity\JsonApi\Error\ErrorCollection;
 use CloudCreativity\JsonApi\Error\ErrorObject;
 use CloudCreativity\JsonApi\Object\Resource\ResourceObject;
-use Neomerx\JsonApi\Document\Error;
+use CloudCreativity\JsonApi\Contracts\Validator\KeyedValidatorInterface;
 
 class AbstractResourceObjectValidatorTest extends \PHPUnit_Framework_TestCase
 {
@@ -184,10 +184,16 @@ public function testInvalidId()
 
     public function testMissingAttributes()
     {
-        $this->validator
-            ->method('isExpectingAttributes')
+        $mock = $this->getMock(KeyedValidatorInterface::class);
+
+        $mock->expects($this->atLeastOnce())
+            ->method('hasRequiredKeys')
             ->willReturn(true);
 
+        $this->validator
+            ->method('getAttributesValidator')
+            ->willReturn($mock);
+
         $this->assertFalse($this->validator->isValid($this->input));
 
         /** @var ErrorObject $error */
@@ -246,10 +252,16 @@ public function testInvalidAttributes()
 
     public function testMissingRelationships()
     {
-        $this->validator
-            ->method('isExpectingRelationships')
+        $mock = $this->getMock(KeyedValidatorInterface::class);
+
+        $mock->expects($this->atLeastOnce())
+            ->method('hasRequiredKeys')
             ->willReturn(true);
 
+        $this->validator
+            ->method('getRelationshipsValidator')
+            ->willReturn($mock);
+
         $this->assertFalse($this->validator->isValid($this->input));
 
         /** @var ErrorObject $error */