Add extension support

Author: jdecool

doc/render-feed.md

@@ -18,6 +18,13 @@ $item = new Item('2347259');
 $item->setUrl('https://example.org/2347259');
 $item->setDatePublished(new DateTime('2016-02-09 14:22:00', new DateTimeZone('+0200')));
 $item->setContentText('Cats are neat. https://example.org/cats');
+$item->addExtension('blue_shed', [
+    'about' => 'https://blueshed-podcasts.com/json-feed-extension-docs',
+    'explicit': false,
+    'copyright' => '1948 by George Orwell',
+    'owner' => 'Big Brother and the Holding Company',
+    'subtitle' => 'All shouting, all the time. Double. Plus. Good.'
+]);
 
 $feed = new Feed('Brent Simmons’s Microblog');
 $feed->setUserComment('This is a microblog feed. You can add this to your feed reader using the following URL: https://example.org/feed.json');

src/Item.php

@@ -3,6 +3,7 @@
 namespace JDecool\JsonFeed;
 
 use DateTime;
+use InvalidArgumentException;
 
 class Item
 {
@@ -48,6 +49,9 @@ class Item
     /** @var Attachment[] */
     private $attachments;
 
+    /** @var array */
+    private $extensions;
+
     /**
      * Constructor
      *
@@ -59,6 +63,7 @@ public function __construct($id)
 
         $this->tags = [];
         $this->attachments = [];
+        $this->extensions = [];
     }
 
     /**
@@ -398,4 +403,47 @@ public function setAttachments(array $attachments)
 
         return $this;
     }
+
+    /**
+     * Add an extension to the item
+     *
+     * @param string $key
+     * @param array $value
+     * @return Item
+     */
+    public function addExtension($key, array $value)
+    {
+        if (!is_string($key)) {
+            throw new InvalidArgumentException('Extension key must be a string');
+        }
+
+        $this->extensions[$key] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get all extensions
+     *
+     * @return array
+     */
+    public function getExtensions()
+    {
+        return $this->extensions;
+    }
+
+    /**
+     * Get an extension
+     *
+     * @param string $key
+     * @return array|null
+     */
+    public function getExtension($key)
+    {
+        if (!isset($this->extensions[$key])) {
+            return null;
+        }
+
+        return $this->extensions[$key];
+    }
 }

src/Reader/Version1/FeedReader.php

@@ -141,12 +141,17 @@ private function readItemNode(array $content)
 
                 default:
                     try {
-                        $this->accessor->setValue($item, $key, $value);
+                        if ('_' === $key[0]) {
+                            $item->addExtension(substr($key, 1), $value);
+                        } else {
+                            $this->accessor->setValue($item, $key, $value);
+                        }
                     } catch (NoSuchPropertyException $e) {
                         if ($this->isErrorEnabled) {
                             throw InvalidFeedException::invalidItemProperty($key);
                         }
                     }
+                    break;
             }
         }
 

src/Writer/Version1/Renderer.php

@@ -136,6 +136,12 @@ private function renderItem(Item $item)
             }, $attachments);
         }
 
+        if ($extensions = $item->getExtensions()) {
+            foreach ($extensions as $key => $extension) {
+                $result['_'.$key] = $extension;
+            }
+        }
+
         return $result;
     }
 

test/Fixtures/extension.json

@@ -0,0 +1,28 @@
+{
+  "version": "https://jsonfeed.org/version/1",
+  "title": "My Example Feed",
+  "items": [
+    {
+      "id": "2",
+      "content_text": "This is a second item.",
+      "url": "https://example.org/second-item",
+      "_extItem2": {
+        "foo": "value",
+        "bar": "value"
+      },
+      "_extAuthor": {
+        "john": "doe",
+        "jane": "doe"
+      }
+    },
+    {
+      "id": "1",
+      "content_html": "<p>Hello, world!</p>",
+      "url": "https://example.org/initial-post",
+      "_extAuthor": {
+        "john": "doe",
+        "jane": "doe"
+      }
+    }
+  ]
+}

test/ItemTest.php

@@ -117,4 +117,31 @@ public function testSetAttachments()
         $this->assertEquals(2, count($item->getAttachments()));
         $this->assertEquals($attachments, $item->getAttachments());
     }
+
+    public function testAddExtension()
+    {
+        $extension1 = [
+            'about' => 'https://blueshed-podcasts.com/json-feed-extension-docs',
+            'explicit' => false,
+            'copyright' => '1948 by George Orwell',
+            'owner' => 'Big Brother and the Holding Company',
+            'subtitle' => 'All shouting, all the time. Double. Plus. Good.'
+        ];
+
+        $item = new Item('myid');
+        $item->addExtension('blue_shed', $extension1);
+
+        $this->assertEquals(1, count($item->getExtensions()));
+        $this->assertEquals($extension1, $item->getExtension('blue_shed'));
+
+        $extension2 = [
+            'foo1' => 'bar1',
+            'foo2' => 'bar2',
+        ];
+        $item->addExtension('blue_shed2', $extension2);
+
+        $this->assertEquals(2, count($item->getExtensions()));
+        $this->assertEquals($extension1, $item->getExtension('blue_shed'));
+        $this->assertEquals($extension2, $item->getExtension('blue_shed2'));
+    }
 }

test/Reader/Version1/FeedReaderTest.php

@@ -193,6 +193,32 @@ public function testReaderWithInvalidPropertyWithErrorEnabled()
         $this->assertEquals('Brent Simmons’s Microblog', $feed->getTitle());
     }
 
+    public function testReadExtensions()
+    {
+        $input = $this->getFixtures('extension');
+        $reader = FeedReader::create();
+
+        $feed = $reader->readFromJson($input);
+        $this->assertInstanceOf('JDecool\JsonFeed\Feed', $feed);
+        $this->assertEquals('My Example Feed', $feed->getTitle());
+
+        $items = $feed->getItems();
+        $this->assertCount(2, $items);
+
+        $item = new Item('2');
+        $item->setContentText('This is a second item.');
+        $item->setUrl('https://example.org/second-item');
+        $item->addExtension('extItem2', ['foo' => 'value', 'bar' => 'value']);
+        $item->addExtension('extAuthor', ['john' => 'doe', 'jane' => 'doe']);
+        $this->assertEquals($item, $items[0]);
+
+        $item = new Item('1');
+        $item->setContentHtml('<p>Hello, world!</p>');
+        $item->setUrl('https://example.org/initial-post');
+        $item->addExtension('extAuthor', ['john' => 'doe', 'jane' => 'doe']);
+        $this->assertEquals($item, $items[1]);
+    }
+
     private function getFixtures($name)
     {
         return file_get_contents(self::$fixturesPath.'/'.$name.'.json');

test/Writer/Version1/RendererTest.php

@@ -93,6 +93,29 @@ public function testMicroblogFeed()
         $this->assertJsonStringEqualsJsonString($expected, $render->render($feed));
     }
 
+    public function testRenderExtension()
+    {
+        $feed = new Feed('My Example Feed');
+
+        $item2 = new Item('2');
+        $item2->setContentText('This is a second item.');
+        $item2->setUrl('https://example.org/second-item');
+        $item2->addExtension('extItem2', ['foo' => 'value', 'bar' => 'value']);
+        $item2->addExtension('extAuthor', ['john' => 'doe', 'jane' => 'doe']);
+        $feed->addItem($item2);
+
+        $item1 = new Item('1');
+        $item1->setContentHtml('<p>Hello, world!</p>');
+        $item1->setUrl('https://example.org/initial-post');
+        $item1->addExtension('extAuthor', ['john' => 'doe', 'jane' => 'doe']);
+        $feed->addItem($item1);
+
+        $expected = $this->getFixtures('extension');
+
+        $render = new Renderer();
+        $this->assertJsonStringEqualsJsonString($expected, $render->render($feed));
+    }
+
     private function getFixtures($name)
     {
         return file_get_contents(self::$fixturesPath.'/'.$name.'.json');