Merge pull request #174 from clue-labs/chainable-attributes

Make attributes chainable
graphp · Oct 2, 2019 · e9e3be2 · e9e3be2
2 parents e14d3ac + a726e48
commit e9e3be2
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 13 deletions.
diff --git a/src/Attribute/AttributeAware.php b/src/Attribute/AttributeAware.php
@@ -23,13 +23,15 @@ public function getAttribute($name, $default = null);
      *
      * @param string $name
      * @param mixed  $value
+     * @return $this chainable
      */
     public function setAttribute($name, $value);
 
     /**
      * Removes a single attribute with the given $name
      *
      * @param string $name
+     * @return $this chainable
      */
     public function removeAttribute($name);
 

diff --git a/src/Attribute/AttributeBag.php b/src/Attribute/AttributeBag.php
@@ -16,6 +16,7 @@ interface AttributeBag extends AttributeAware
      * set an array of additional attributes
      *
      * @param array $attributes
+     * @return $this chainable
      */
     public function setAttributes(array $attributes);
 

diff --git a/src/Attribute/AttributeBagContainer.php b/src/Attribute/AttributeBagContainer.php
@@ -32,7 +32,7 @@ public function getAttribute($name, $default = null)
      *
      * @param  string $name
      * @param  mixed  $value
-     * @return self   For a fluid interface.
+     * @return $this chainable
      */
     public function setAttribute($name, $value)
     {
@@ -44,11 +44,14 @@ public function setAttribute($name, $value)
     /**
      * Removes a single attribute with the given $name
      *
-     * @param string $name
+     * @param  string $name
+     * @return $this chainable
      */
     public function removeAttribute($name)
     {
         unset($this->attributes[$name]);
+
+        return $this;
     }
 
     /**
@@ -65,7 +68,7 @@ public function getAttributes()
      * set an array of additional attributes
      *
      * @param  array $attributes
-     * @return self  For a fluid interface.
+     * @return $this chainable
      */
     public function setAttributes(array $attributes)
     {

diff --git a/src/Attribute/AttributeBagNamespaced.php b/src/Attribute/AttributeBagNamespaced.php
@@ -61,21 +61,26 @@ public function getAttribute($name, $default = null)
      *
      * @param  string $name
      * @param  mixed  $value
-     * @return void
+     * @return $this chainable
      */
     public function setAttribute($name, $value)
     {
         $this->bag->setAttribute($this->prefix . $name, $value);
+
+        return $this;
     }
 
     /**
      * Removes a single attribute with the given $name
      *
-     * @param string $name
+     * @param  string $name
+     * @return $this chainable
      */
     public function removeAttribute($name)
     {
         $this->bag->removeAttribute($this->prefix . $name);
+
+        return $this;
     }
 
     /**
@@ -105,13 +110,15 @@ public function getAttributes()
      * Each attribute is prefixed before setting in the base bag.
      *
      * @param  array $attributes
-     * @return void
+     * @return $this chainable
      */
     public function setAttributes(array $attributes)
     {
         foreach ($attributes as $name => $value) {
             $this->bag->setAttribute($this->prefix . $name, $value);
         }
+
+        return $this;
     }
 
     /**

diff --git a/src/Attribute/AttributeBagReference.php b/src/Attribute/AttributeBagReference.php
@@ -46,7 +46,7 @@ public function getAttribute($name, $default = null)
      *
      * @param  string $name
      * @param  mixed  $value
-     * @return self   For a fluid interface.
+     * @return $this chainable
      */
     public function setAttribute($name, $value)
     {
@@ -58,11 +58,14 @@ public function setAttribute($name, $value)
     /**
      * Removes a single attribute with the given $name
      *
-     * @param string $name
+     * @param  string $name
+     * @return $this chainable
      */
     public function removeAttribute($name)
     {
         unset($this->attributes[$name]);
+
+        return $this;
     }
 
     /**
@@ -79,7 +82,7 @@ public function getAttributes()
      * set an array of additional attributes
      *
      * @param  array $attributes
-     * @return self  For a fluid interface.
+     * @return $this chainable
      */
     public function setAttributes(array $attributes)
     {

diff --git a/src/Edge/Base.php b/src/Edge/Base.php
@@ -299,11 +299,15 @@ public function getAttribute($name, $default = null)
     public function setAttribute($name, $value)
     {
         $this->attributes[$name] = $value;
+
+        return $this;
     }
 
     public function removeAttribute($name)
     {
         unset($this->attributes[$name]);
+
+        return $this;
     }
 
     public function getAttributeBag()

diff --git a/src/Graph.php b/src/Graph.php
@@ -455,11 +455,15 @@ public function getAttribute($name, $default = null)
     public function setAttribute($name, $value)
     {
         $this->attributes[$name] = $value;
+
+        return $this;
     }
 
     public function removeAttribute($name)
     {
         unset($this->attributes[$name]);
+
+        return $this;
     }
 
     public function getAttributeBag()

diff --git a/src/Vertex.php b/src/Vertex.php
@@ -397,11 +397,15 @@ public function getAttribute($name, $default = null)
     public function setAttribute($name, $value)
     {
         $this->attributes[$name] = $value;
+
+        return $this;
     }
 
     public function removeAttribute($name)
     {
         unset($this->attributes[$name]);
+
+        return $this;
     }
 
     public function getAttributeBag()

diff --git a/tests/Attribute/AbstractAttributeAwareTest.php b/tests/Attribute/AbstractAttributeAwareTest.php
@@ -21,26 +21,61 @@ public function testAttributeAwareInterface()
      * @depends testAttributeAwareInterface
      * @param AttributeAware $entity
      */
-    public function testAttributeSetGetDefault(AttributeAware $entity)
+    public function testSetAttributeReturnsSelf(AttributeAware $entity)
+    {
+        $this->assertSame($entity, $entity->setAttribute('test', 'value'));
+
+        return $entity;
+    }
+
+    /**
+     * @depends testAttributeAwareInterface
+     * @param AttributeAware $entity
+     */
+    public function testGetAttributeReturnsValueIfItExists(AttributeAware $entity)
     {
         $entity->setAttribute('test', 'value');
+
         $this->assertEquals('value', $entity->getAttribute('test'));
+    }
 
+    /**
+     * @depends testAttributeAwareInterface
+     * @param AttributeAware $entity
+     */
+    public function testGetAttributeReturnsNullIfItDoesNotExist(AttributeAware $entity)
+    {
         $this->assertEquals(null, $entity->getAttribute('unknown'));
+    }
 
+    /**
+     * @depends testAttributeAwareInterface
+     * @param AttributeAware $entity
+     */
+    public function testGetAttributeReturnsExpicitDefaultIfItDoesNotExist(AttributeAware $entity)
+    {
         $this->assertEquals('default', $entity->getAttribute('unknown', 'default'));
     }
 
     /**
      * @depends testAttributeAwareInterface
      * @param AttributeAware $entity
      */
-    public function testAttributeSetRemoveGet(AttributeAware $entity)
+    public function testRemoveAttributeReturnsSelfIfItDoesNotExist(AttributeAware $entity)
+    {
+        $this->assertSame($entity, $entity->removeAttribute('unknown'));
+    }
+
+    /**
+     * @depends testAttributeAwareInterface
+     * @param AttributeAware $entity
+     */
+    public function testRemoveAttributeReturnsSelfAndGetAttributeThenReturnsNull(AttributeAware $entity)
     {
         $entity->setAttribute('test', 'value');
-        $this->assertEquals('value', $entity->getAttribute('test'));
 
-        $entity->removeAttribute('test');
+        $this->assertSame($entity, $entity->removeAttribute('test'));
+
         $this->assertEquals(null, $entity->getAttribute('test'));
     }