[Fix #3] Implement Attribute Name Validation (#61)

* Implement attribute name validation

* Add tests for attribute name validation

* Fix type

* Add assertion

* Remove whitespace on blank line

* Remove whitespace on blank lines

Author: francislavoie

src/Document/Resource/ResourceObject.php

@@ -37,6 +37,9 @@ public function setAttribute(string $name, $value)
         if ($this->isReservedName($name)) {
             throw new \InvalidArgumentException('Can not use a reserved name');
         }
+        if (!$this->isValidMemberName($name)) {
+            throw new \OutOfBoundsException('Not a valid attribute name');
+        }
         if (isset($this->relationships[$name])) {
             throw new \LogicException("Field $name already exists in relationships");
         }
@@ -92,4 +95,9 @@ private function isReservedName(string $name): bool
     {
         return in_array($name, ['id', 'type']);
     }
+
+    private function isValidMemberName(string $name): bool
+    {
+        return preg_match('/^(?=[^-_ ])[a-zA-Z0-9\x{0080}-\x{FFFF}-_ ]*(?<=[^-_ ])$/u', $name) === 1;
+    }
 }

test/Document/Resource/ResourceFieldsTest.php

@@ -47,7 +47,7 @@ public function testCanNotSetAttributeIfRelationshipExists()
      * @param string $name
      * @expectedException \InvalidArgumentException
      * @expectedExceptionMessage Can not use a reserved name
-     * @dataProvider             invalidAttributeNames
+     * @dataProvider             reservedAttributeNames
      */
     public function testAttributeCanNotHaveReservedNames(string $name)
     {
@@ -59,19 +59,73 @@ public function testAttributeCanNotHaveReservedNames(string $name)
      * @param string $name
      * @expectedException \InvalidArgumentException
      * @expectedExceptionMessage Can not use a reserved name
-     * @dataProvider             invalidAttributeNames
+     * @dataProvider             reservedAttributeNames
      */
     public function testRelationshipCanNotHaveReservedNames(string $name)
     {
         $res = new ResourceObject('books', 'abc');
         $res->setRelationship($name, Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));
     }
 
-    public function invalidAttributeNames(): array
+    /**
+     * @param string $name
+     * @expectedException \OutOfBoundsException
+     * @expectedExceptionMessage Not a valid attribute name
+     * @dataProvider             invalidAttributeNames
+     */
+    public function testAttributeNameIsNotValid(string $name)
+    {
+        $res = new ResourceObject('books', 'abc');
+        $res->setAttribute($name, 1);
+    }
+
+    /**
+     * @param string $name
+     * @dataProvider             validAttributeNames
+     */
+    public function testAttributeNameIsValid(string $name)
+    {
+        $res = new ResourceObject('books', 'abc');
+        $res->setAttribute($name, 1);
+        $this->assertTrue(true);
+    }
+
+    public function reservedAttributeNames(): array
     {
         return [
             ['id'],
             ['type'],
         ];
     }
+
+    public function invalidAttributeNames(): array
+    {
+        return [
+            ['_abcde'],
+            ['abcd_'],
+            ['abc$EDS'],
+            ['#abcde'],
+            ['abcde('],
+            ['b_'],
+            ['_a'],
+            ['$ab_c-d'],
+            ['-abc'],
+        ];
+    }
+
+    public function validAttributeNames(): array
+    {
+        return [
+            ['abcd'],
+            ['abcA4C'],
+            ['abc_d3f45'],
+            ['abd_eca'],
+            ['a'],
+            ['b'],
+            ['ab'],
+            ['a-bc_de'],
+            ['abcéêçèÇ_n'],
+            ['abc 汉字 abc'],
+        ];
+    }
 }