Additions to attr method.

Allow attribute validator to be set using a class string or a `ValidatorInterface` object in addition to the shorthand string.

Author: lindyhopchris

src/Validator/Attributes/AttributesValidator.php

@@ -19,13 +19,13 @@
 namespace CloudCreativity\JsonApi\Validator\Attributes;
 
 use CloudCreativity\JsonApi\Contracts\Stdlib\ConfigurableInterface;
+use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
 use CloudCreativity\JsonApi\Error\ErrorObject;
 use CloudCreativity\JsonApi\Error\SourceObject;
 use CloudCreativity\JsonApi\Validator\AbstractValidator;
 use CloudCreativity\JsonApi\Validator\Helper\AllowedKeysTrait;
 use CloudCreativity\JsonApi\Validator\Helper\RequiredKeysTrait;
 use CloudCreativity\JsonApi\Validator\Type\TypeValidator;
-use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
 
 /**
  * Class AttributesValidator
@@ -106,24 +106,13 @@ public function getValidator($key)
      * Helper method to add a type validator for the specified key.
      *
      * @param $key
-     * @param null $type
+     * @param string|ValidatorInterface $type
      * @param array $options
      * @return $this
      */
     public function attr($key, $type = null, array $options = [])
     {
-        if (is_null($type)) {
-            $type = 'type';
-        }
-
-        $class = sprintf('CloudCreativity\JsonApi\Validator\Type\%sValidator', ucfirst($type));
-
-        if (!class_exists($class)) {
-            throw new \InvalidArgumentException(sprintf('Unrecognised attribute type: %s.', $type));
-        }
-
-        /** @var ValidatorInterface $validator */
-        $validator = new $class();
+        $validator = $this->parseType($type);
 
         if ($validator instanceof ConfigurableInterface) {
             $validator->configure($options);
@@ -231,4 +220,37 @@ protected function checkValue($key, $value)
         return $this;
     }
 
+    /**
+     * @param string|null|ValidatorInterface
+     * @return ValidatorInterface
+     */
+    protected function parseType($type)
+    {
+        if ($type instanceof ValidatorInterface) {
+          return $type;
+        } elseif (is_null($type)) {
+          return new TypeValidator();
+        } elseif (!is_string($type)) {
+          throw new \InvalidArgumentException('Expecting a string, ValidatorInterface or null.');
+        }
+
+        if (class_exists($type)) {
+          $class = $type;
+        } else {
+          $class = sprintf('CloudCreativity\JsonApi\Validator\Type\%sValidator', ucfirst($type));
+
+          if (!class_exists($class)) {
+            throw new \InvalidArgumentException(sprintf('Unrecognised attribute type: %s.', $type));
+          }
+        }
+
+        $validator = new $class();
+
+        if (!$validator instanceof ValidatorInterface) {
+          throw new \InvalidArgumentException(sprintf('Type %s does not resolve to a %s instance.', $type, ValidatorInterface::class));
+        }
+
+        return $validator;
+    }
+
 }

src/Validator/Resource/ResourceObjectValidator.php

@@ -80,7 +80,7 @@ public function id($id)
      * Set an attribute of the resource object.
      *
      * @param $key
-     * @param null $type
+     * @param mixed $type
      * @param array $options
      * @return $this
      */
@@ -204,4 +204,4 @@ public function getRelated($key)
     {
         return $this->getRelationships()->getValidator($key);
     }
-}
+}

test/Validator/Resource/ResourceObjectValidatorTest.php

@@ -18,6 +18,7 @@
 
 namespace CloudCreativity\JsonApi\Validator\Resource;
 
+use CloudCreativity\JsonApi\Contracts\Validator\ValidatorInterface;
 use CloudCreativity\JsonApi\Validator\Relationships\BelongsToValidator;
 use CloudCreativity\JsonApi\Validator\Relationships\HasManyValidator;
 use CloudCreativity\JsonApi\Validator\ResourceIdentifier\ExpectedIdValidator;
@@ -46,7 +47,7 @@ public function testId()
         $this->assertSame($validator, $validator->id($id));
         $this->assertEquals($expected, $validator->getIdValidator());
     }
-    
+
     public function testAttr()
     {
         $key = 'foo';
@@ -63,6 +64,26 @@ public function testAttr()
         $this->assertEquals($expected, $validator->getAttributes()->getValidator($key));
     }
 
+    public function testAttrWithClass()
+    {
+        $key = 'foo';
+        $expected = new StringValidator();
+        $validator = new ResourceObjectValidator();
+
+        $validator->attr($key, get_class($expected));
+        $this->assertEquals($expected, $validator->getAttributes()->getValidator($key));
+    }
+
+    public function testAttrWithValidator()
+    {
+        $key = 'foo';
+        $mock = $this->getMock(ValidatorInterface::class);
+        $validator = new ResourceObjectValidator();
+
+        $validator->attr($key, $mock);
+        $this->assertSame($mock, $validator->getAttributes()->getValidator($key));
+    }
+
     public function testBelongsTo()
     {
         $key = 'foo';
@@ -164,4 +185,4 @@ public function testAcceptsEmptyAttributesAndRelationships()
 
         $this->assertTrue($validator->isValid($input));
     }
-}
+}