Improved attribute and relationship name validation (#45)

Author: f3ath

src/Document/Resource/ResourceObject.php

@@ -23,8 +23,8 @@ class ResourceObject extends ResourceIdentifier
 
     public function setAttribute(string $name, $value)
     {
-        if (in_array($name, ['id', 'type'])) {
-            throw new \InvalidArgumentException('Invalid attribute name');
+        if ($this->isReservedName($name)) {
+            throw new \InvalidArgumentException('Can not use a reserved name');
         }
         if (isset($this->relationships[$name])) {
             throw new \LogicException("Field $name already exists in relationships");
@@ -34,6 +34,9 @@ public function setAttribute(string $name, $value)
 
     public function setRelationship(string $name, Relationship $relationship)
     {
+        if ($this->isReservedName($name)) {
+            throw new \InvalidArgumentException('Can not use a reserved name');
+        }
         if (isset($this->attributes[$name])) {
             throw new \LogicException("Field $name already exists in attributes");
         }
@@ -74,4 +77,13 @@ public function identifies(ResourceInterface $resource): bool
         }
         return false;
     }
+
+    /**
+     * @param  string $name
+     * @return bool
+     */
+    private function isReservedName(string $name): bool
+    {
+        return in_array($name, ['id', 'type']);
+    }
 }

test/Document/Resource/ResourceFireldsTest.php renamed to test/Document/Resource/ResourceFieldsTest.php

@@ -27,7 +27,7 @@
  *
  * @see http://jsonapi.org/format/#document-resource-object-fields
  */
-class ResourceFireldsTest extends TestCase
+class ResourceFieldsTest extends TestCase
 {
     /**
      * @expectedException \LogicException
@@ -50,4 +50,36 @@ public function testCanNotSetAttributeIfRelationshipExists()
         $res->setRelationship('foo', Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));
         $res->setAttribute('foo', 'bar');
     }
+
+    /**
+     * @param string $name
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Can not use a reserved name
+     * @dataProvider             invalidAttributeNames
+     */
+    public function testAttributeCanNotHaveReservedNames(string $name)
+    {
+        $res = new ResourceObject('books', 'abc');
+        $res->setAttribute($name, 1);
+    }
+
+    /**
+     * @param string $name
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Can not use a reserved name
+     * @dataProvider             invalidAttributeNames
+     */
+    public function testRelationshipCanNotHaveReservedNames(string $name)
+    {
+        $res = new ResourceObject('books', 'abc');
+        $res->setRelationship($name, Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));
+    }
+
+    public function invalidAttributeNames(): array
+    {
+        return [
+            ['id'],
+            ['type'],
+        ];
+    }
 }

test/Document/Resource/ResourceTest.php

@@ -92,24 +92,4 @@ public function resourceProvider()
             ],
         ];
     }
-
-    /**
-     * @param string $name
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Invalid attribute name
-     * @dataProvider             invalidAttributeNames
-     */
-    public function testAttributeCanNotHaveReservedNames(string $name)
-    {
-        $r = new ResourceObject('books', 'abc');
-        $r->setAttribute($name, 1);
-    }
-
-    public function invalidAttributeNames(): array
-    {
-        return [
-            ['id'],
-            ['type'],
-        ];
-    }
 }