Author support in JSONFeed format

alexdebril · Mar 9, 2021 · 80ad861 · 80ad861
1 parent 98beaf5
commit 80ad861
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 19 deletions.
diff --git a/src/FeedIo/Formatter/JsonFormatter.php b/src/FeedIo/Formatter/JsonFormatter.php
@@ -32,7 +32,7 @@ public function toString(FeedInterface $feed) : string
      */
     public function toArray(FeedInterface $feed) : array
     {
-        return array_filter([
+        $out =  array_filter([
             'version' => 'https://jsonfeed.org/version/1',
             'title' => $feed->getTitle(),
             'description' => $feed->getDescription(),
@@ -42,6 +42,9 @@ public function toArray(FeedInterface $feed) : array
             'icon' => $feed->getLogo(),
             'items' => iterator_to_array($this->itemsToArray($feed)),
         ]);
+        $this->handleAuthor($feed, $out);
+
+        return $out;
     }
 
     /**
@@ -93,17 +96,12 @@ public function isHtml(string $string) : bool
         return $string !== strip_tags($string);
     }
 
-    /**
-     * @param Feed\ItemInterface $item
-     * @param array $array
-     * @return array
-     */
-    public function handleAuthor(Feed\ItemInterface $item, array &$array) : array
+    public function handleAuthor(Feed\NodeInterface $node, array &$array) : array
     {
-        if (! is_null($item->getAuthor())) {
+        if (! is_null($node->getAuthor())) {
             $array['author'] = array_filter([
-                'name' => $item->getAuthor()->getName(),
-                'url' => $item->getAuthor()->getUri(),
+                'name' => $node->getAuthor()->getName(),
+                'url' => $node->getAuthor()->getUri(),
             ]);
         }
 

diff --git a/src/FeedIo/Parser/JsonParser.php b/src/FeedIo/Parser/JsonParser.php
@@ -12,6 +12,7 @@
 
 use FeedIo\Feed\Item;
 use FeedIo\Feed\Item\Author;
+use FeedIo\Feed\NodeInterface;
 use FeedIo\FeedInterface;
 use FeedIo\ParserAbstract;
 use FeedIo\Reader\Document;
@@ -32,6 +33,7 @@ public function parseContent(Document $document, FeedInterface $feed) : FeedInte
         $feed->setLink($this->readOffset($data, 'feed_url'));
         $feed->setUrl($this->readOffset($data, 'home_page_url'));
         $feed->setLogo($this->readOffset($data, 'icon'));
+        $this->readAuthor($feed, $data);
 
         if (array_key_exists('items', $data)) {
             $this->parseItems($data['items'], $feed);
@@ -74,15 +76,7 @@ public function parseItems(iterable $items, FeedInterface $feed) : JsonParser
             $contentHtml = $this->readOffset($dataItem, 'content_html');
             $item->setDescription($this->readOffset($dataItem, 'content_text', $contentHtml));
             $item->setLink($this->readOffset($dataItem, 'url'));
-
-            if (array_key_exists('author', $dataItem)) {
-                $authorItem = $dataItem['author'];
-                $author = new Author();
-                $author->setName($this->readOffset($authorItem, 'name'));
-                $author->setUri($this->readOffset($authorItem, 'url'));
-                $author->setEmail($this->readOffset($authorItem, 'email'));
-                $item->setAuthor($author);
-            }
+            $this->readAuthor($item, $dataItem);
             $feed->add($item);
         }
 
@@ -103,4 +97,16 @@ public function readOffset(array $data, string $offsetName, string $default = nu
 
         return $default;
     }
+
+    protected function readAuthor(NodeInterface $node, array $data): void
+    {
+        if (array_key_exists('author', $data)) {
+            $authorItem = $data['author'];
+            $author = new Author();
+            $author->setName($this->readOffset($authorItem, 'name'));
+            $author->setUri($this->readOffset($authorItem, 'url'));
+            $author->setEmail($this->readOffset($authorItem, 'email'));
+            $node->setAuthor($author);
+        }
+    }
 }
diff --git a/tests/FeedIo/JsonFormatterTest.php b/tests/FeedIo/JsonFormatterTest.php
@@ -30,6 +30,9 @@ public function testToString()
         $feed = new Feed();
         $feed->setTitle('feed title');
         $feed->setLogo(self::LOGO);
+        $author = new Item\Author();
+        $author->setName('alex');
+        $feed->setAuthor($author);
 
         foreach ($items as $item) {
             $feed->add($item);
@@ -41,6 +44,7 @@ public function testToString()
         $this->assertJson($string);
         $json = json_decode($string, true);
 
+        $this->assertEquals('alex', $json['author']['name']);
         $this->assertEquals('feed title', $json['title']);
         $this->assertEquals('http://localhost/logo.jpeg', $json['icon']);
         $this->assertCount(2, $json['items']);

diff --git a/tests/FeedIo/Parser/JsonParserTest.php b/tests/FeedIo/Parser/JsonParserTest.php
@@ -33,6 +33,7 @@ public function testParseContent()
 
         $this->assertEquals('JSON Feed', $feed->getTitle());
         $this->assertEquals('https://jsonfeed.org/graphics/icon.png', $feed->getLogo());
+        $this->assertEquals('Brent Simmons and Manton Reece', $feed->getAuthor()->getName());
 
         $items = $feed->toArray()['items'];