Merge pull request facebookarchive#906 from yguedidi/rework_node

Rework GraphNode API

Author: SammyK

src/GraphNode/GraphNode.php

@@ -25,7 +25,7 @@
 /**
  * @package Facebook
  */
-class GraphNode implements \ArrayAccess, \Countable, \IteratorAggregate
+class GraphNode
 {
     /**
      * @var array maps object key names to Graph object types
@@ -37,7 +37,7 @@ class GraphNode implements \ArrayAccess, \Countable, \IteratorAggregate
      *
      * @var array
      */
-    protected $fields = [];
+    private $fields = [];
 
     /**
      * Init this Graph object.
@@ -81,7 +81,7 @@ public function getFieldNames()
      *
      * @return array
      */
-    public function all()
+    public function getFields()
     {
         return $this->fields;
     }
@@ -103,110 +103,23 @@ public function asArray()
     }
 
     /**
-     * Run a map over each field.
-     *
-     * @param \Closure $callback
-     *
-     * @return static
-     */
-    public function map(\Closure $callback)
-    {
-        return new static(array_map($callback, $this->fields, array_keys($this->fields)));
-    }
-
-    /**
-     * Get all fields as JSON.
-     *
-     * @param int $options
+     * Convert the collection to its string representation.
      *
      * @return string
      */
-    public function asJson($options = 0)
-    {
-        return json_encode($this->uncastFields(), $options);
-    }
-
-    /**
-     * Count the number of fields in the collection.
-     *
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->fields);
-    }
-
-    /**
-     * Get an iterator for the fields.
-     *
-     * @return \ArrayIterator
-     */
-    public function getIterator()
-    {
-        return new \ArrayIterator($this->fields);
-    }
-
-    /**
-     * Determine if an item exists at an offset.
-     *
-     * @param mixed $key
-     *
-     * @return bool
-     */
-    public function offsetExists($key)
-    {
-        return array_key_exists($key, $this->fields);
-    }
-
-    /**
-     * Get an item at a given offset.
-     *
-     * @param mixed $key
-     *
-     * @return mixed
-     */
-    public function offsetGet($key)
-    {
-        return $this->fields[$key];
-    }
-
-    /**
-     * Set the item at a given offset.
-     *
-     * @param mixed $key
-     * @param mixed $value
-     *
-     * @return void
-     */
-    public function offsetSet($key, $value)
-    {
-        if (is_null($key)) {
-            $this->fields[] = $value;
-        } else {
-            $this->fields[$key] = $value;
-        }
-    }
-
-    /**
-     * Unset the item at a given offset.
-     *
-     * @param string $key
-     *
-     * @return void
-     */
-    public function offsetUnset($key)
+    public function __toString()
     {
-        unset($this->fields[$key]);
+        return json_encode($this->uncastFields());
     }
 
     /**
-     * Convert the collection to its string representation.
+     * Getter for $graphNodeMap.
      *
-     * @return string
+     * @return array
      */
-    public function __toString()
+    public static function getNodeMap()
     {
-        return $this->asJson();
+        return static::$graphNodeMap;
     }
 
     /**
@@ -219,7 +132,7 @@ public function __toString()
      *
      * @return array
      */
-    public function castFields(array $data)
+    private function castFields(array $data)
     {
         $fields = [];
 
@@ -245,7 +158,7 @@ public function castFields(array $data)
      *
      * @return array
      */
-    public function uncastFields()
+    private function uncastFields()
     {
         $fields = $this->asArray();
 
@@ -258,6 +171,28 @@ public function uncastFields()
         }, $fields);
     }
 
+    /**
+     * Determines if a value from Graph should be cast to DateTime.
+     *
+     * @param string $key
+     *
+     * @return bool
+     */
+    private function shouldCastAsDateTime($key)
+    {
+        return in_array($key, [
+            'created_time',
+            'updated_time',
+            'start_time',
+            'stop_time',
+            'end_time',
+            'backdated_time',
+            'issued_at',
+            'expires_at',
+            'publish_time'
+        ], true);
+    }
+
     /**
      * Detects an ISO 8601 formatted string.
      *
@@ -269,7 +204,7 @@ public function uncastFields()
      * @see http://www.cl.cam.ac.uk/~mgk25/iso-time.html
      * @see http://en.wikipedia.org/wiki/ISO_8601
      */
-    public function isIso8601DateString($string)
+    private function isIso8601DateString($string)
     {
         // This insane regex was yoinked from here:
         // http://www.pelagodesign.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
@@ -285,36 +220,14 @@ public function isIso8601DateString($string)
         return preg_match($crazyInsaneRegexThatSomehowDetectsIso8601, $string) === 1;
     }
 
-    /**
-     * Determines if a value from Graph should be cast to DateTime.
-     *
-     * @param string $key
-     *
-     * @return bool
-     */
-    public function shouldCastAsDateTime($key)
-    {
-        return in_array($key, [
-            'created_time',
-            'updated_time',
-            'start_time',
-            'stop_time',
-            'end_time',
-            'backdated_time',
-            'issued_at',
-            'expires_at',
-            'publish_time'
-        ], true);
-    }
-
     /**
      * Casts a date value from Graph to DateTime.
      *
      * @param int|string $value
      *
      * @return \DateTime
      */
-    public function castToDateTime($value)
+    private function castToDateTime($value)
     {
         if (is_int($value)) {
             $dt = new \DateTime();
@@ -333,18 +246,8 @@ public function castToDateTime($value)
      *
      * @return Birthday
      */
-    public function castToBirthday($value)
+    private function castToBirthday($value)
     {
         return new Birthday($value);
     }
-
-    /**
-     * Getter for $graphNodeMap.
-     *
-     * @return array
-     */
-    public static function getNodeMap()
-    {
-        return static::$graphNodeMap;
-    }
 }

tests/FacebookTest.php

@@ -274,7 +274,7 @@ public function testPaginationReturnsProperResponse()
         $nextPage = $fb->next($graphEdge);
         $this->assertInstanceOf(GraphEdge::class, $nextPage);
         $this->assertInstanceOf(GraphUser::class, $nextPage[0]);
-        $this->assertEquals('Foo', $nextPage[0]['name']);
+        $this->assertEquals('Foo', $nextPage[0]->getField('name'));
 
         $lastResponse = $fb->getLastResponse();
         $this->assertInstanceOf(Response::class, $lastResponse);

tests/GraphNode/GraphEdgeTest.php

@@ -103,29 +103,20 @@ public function testCanMapOverNodes()
         $graphEdge = new GraphEdge(
             $this->request,
             [
-                new GraphNode(['name' => 'dummy']),
-                new GraphNode(['name' => 'dummy']),
+                new GraphNode(['name' => 'dummy1']),
+                new GraphNode(['name' => 'dummy2']),
             ],
             ['paging' => $this->pagination],
             '/1234567890/likes'
         );
 
-        $graphEdge = $graphEdge->map(function (GraphNode $node) {
-            $node['name'] = str_replace('dummy', 'foo', $node['name']);
-            return $node;
-        });
+        $output = '';
 
-        $graphEdgeToCompare = new GraphEdge(
-            $this->request,
-            [
-                new GraphNode(['name' => 'foo']),
-                new GraphNode(['name' => 'foo'])
-            ],
-            ['paging' => $this->pagination],
-            '/1234567890/likes'
-        );
+        $graphEdge->map(function (GraphNode $node) use (&$output) {
+            $output .= $node->getField('name');
+        });
 
-        $this->assertEquals($graphEdgeToCompare, $graphEdge);
+        $this->assertEquals('dummy1dummy2', $output);
     }
 
     public function testAnExistingPropertyCanBeAccessed()

tests/GraphNode/GraphNodeFactoryTest.php

@@ -348,19 +348,19 @@ public function testAGraphEdgeWillBeCastRecursively()
 
         // Story
         $storyObject = $graphNode[0];
-        $this->assertInstanceOf(GraphNode::class, $storyObject['from']);
-        $this->assertInstanceOf(GraphEdge::class, $storyObject['likes']);
-        $this->assertInstanceOf(GraphEdge::class, $storyObject['comments']);
+        $this->assertInstanceOf(GraphNode::class, $storyObject->getField('from'));
+        $this->assertInstanceOf(GraphEdge::class, $storyObject->getField('likes'));
+        $this->assertInstanceOf(GraphEdge::class, $storyObject->getField('comments'));
 
         // Story Comments
-        $storyComments = $storyObject['comments'];
+        $storyComments = $storyObject->getField('comments');
         $firstStoryComment = $storyComments[0];
-        $this->assertInstanceOf(GraphNode::class, $firstStoryComment['from']);
+        $this->assertInstanceOf(GraphNode::class, $firstStoryComment->getField('from'));
 
         // Message
         $messageObject = $graphNode[1];
-        $this->assertInstanceOf(GraphEdge::class, $messageObject['to']);
-        $toUsers = $messageObject['to'];
+        $this->assertInstanceOf(GraphEdge::class, $messageObject->getField('to'));
+        $toUsers = $messageObject->getField('to');
         $this->assertInstanceOf(GraphNode::class, $toUsers[0]);
     }
 
@@ -422,10 +422,10 @@ public function testAGraphEdgeWillGenerateTheProperParentGraphEdges()
         $factory = new GraphNodeFactory($res);
         $graphEdge = $factory->makeGraphEdge();
         $topGraphEdge = $graphEdge->getParentGraphEdge();
-        $childGraphEdgeOne = $graphEdge[0]['likes']->getParentGraphEdge();
-        $childGraphEdgeTwo = $graphEdge[1]['likes']->getParentGraphEdge();
-        $childGraphEdgeThree = $graphEdge[1]['photos']->getParentGraphEdge();
-        $childGraphEdgeFour = $graphEdge[1]['photos'][0]['likes']->getParentGraphEdge();
+        $childGraphEdgeOne = $graphEdge[0]->getField('likes')->getParentGraphEdge();
+        $childGraphEdgeTwo = $graphEdge[1]->getField('likes')->getParentGraphEdge();
+        $childGraphEdgeThree = $graphEdge[1]->getField('photos')->getParentGraphEdge();
+        $childGraphEdgeFour = $graphEdge[1]->getField('photos')[0]->getField('likes')->getParentGraphEdge();
 
         $this->assertNull($topGraphEdge);
         $this->assertEquals('/111/likes', $childGraphEdgeOne);