Support <content:encoded>

Signed-off-by: Hidehito Nozawa <[email protected]>

Author: suin

README.md

@@ -33,7 +33,8 @@ $channel
 $item = new Item();
 $item
     ->title('Blog Entry Title')
-    ->description('<div>Blog body</div>')
+    ->description('Blog body')
+    ->contentEncoded('<div>Blog body</div>')
     ->url('http://blog.example.com/2012/08/21/blog-entry/')
     ->author('Hidehito Nozawa')
     ->pubDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))
@@ -56,22 +57,23 @@ Output:
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<rss version="2.0">
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
   <channel>
     <title>Channel Title</title>
     <link>http://blog.example.com</link>
     <description>Channel Description</description>
     <language>en-US</language>
     <copyright>Copyright 2012, Foo Bar</copyright>
-    <pubDate>Tue, 21 Aug 2012 19:50:37 +0900</pubDate>
-    <lastBuildDate>Tue, 21 Aug 2012 19:50:37 +0900</lastBuildDate>
+    <pubDate>Tue, 21 Aug 2012 10:50:37 +0000</pubDate>
+    <lastBuildDate>Tue, 21 Aug 2012 10:50:37 +0000</lastBuildDate>
     <ttl>60</ttl>
-    <item>
+    <item xmlns:default="http://purl.org/rss/1.0/modules/content/">
       <title>Blog Entry Title</title>
       <link>http://blog.example.com/2012/08/21/blog-entry/</link>
-      <description>&lt;div&gt;Blog body&lt;/div&gt;</description>
+      <description>Blog body</description>
+      <content:encoded xmlns="http://purl.org/rss/1.0/modules/content/"><![CDATA[<div>Blog body</div>]]></content:encoded>
       <guid>http://blog.example.com/2012/08/21/blog-entry/</guid>
-      <pubDate>Tue, 21 Aug 2012 19:50:37 +0900</pubDate>
+      <pubDate>Tue, 21 Aug 2012 10:50:37 +0000</pubDate>
       <author>Hidehito Nozawa</author>
     </item>
     <item>

examples/simple-feed.php

@@ -28,7 +28,8 @@
 $item = new Item();
 $item
     ->title('Blog Entry Title')
-    ->description('<div>Blog body</div>')
+    ->description('Blog body')
+    ->contentEncoded('<div>Blog body</div>')
     ->url('http://blog.example.com/2012/08/21/blog-entry/')
     ->author('Hidehito Nozawa')
     ->pubDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))

src/Suin/RSSWriter/Feed.php

@@ -30,7 +30,7 @@ public function addChannel(ChannelInterface $channel)
      */
     public function render()
     {
-        $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8" ?><rss version="2.0" />', LIBXML_NOERROR | LIBXML_ERR_NONE | LIBXML_ERR_FATAL);
+        $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8" ?><rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" />', LIBXML_NOERROR | LIBXML_ERR_NONE | LIBXML_ERR_FATAL);
 
         foreach ($this->channels as $channel) {
             $toDom = dom_import_simplexml($xml);

src/Suin/RSSWriter/Item.php

@@ -17,6 +17,9 @@ class Item implements ItemInterface
     /** @var string */
     protected $description;
 
+    /** @var string */
+    protected $contentEncoded;
+
     /** @var array */
     protected $categories = [];
 
@@ -53,6 +56,12 @@ public function description($description)
         return $this;
     }
 
+    public function contentEncoded($content)
+    {
+        $this->contentEncoded = $content;
+        return $this;
+    }
+
     public function category($name, $domain = null)
     {
         $this->categories[] = [$name, $domain];
@@ -97,6 +106,14 @@ public function asXML()
         $xml->addChild('link', $this->url);
         $xml->addChild('description', $this->description);
 
+        if ($this->contentEncoded) {
+            // SimpleXMLElement does not support CDATA transformation
+            $element = $xml->addChild('encoded', null, 'http://purl.org/rss/1.0/modules/content/');
+            $element = dom_import_simplexml($element);
+            $elementOwner = $element->ownerDocument;
+            $element->appendChild($elementOwner->createCDATASection($this->contentEncoded));
+        }
+
         foreach ($this->categories as $category) {
             $element = $xml->addChild('category', $category[0]);
 

src/Suin/RSSWriter/ItemInterface.php

@@ -29,6 +29,13 @@ public function url($url);
      */
     public function description($description);
 
+    /**
+     * Set content:encoded
+     * @param string $content
+     * @return $this
+     */
+    public function contentEncoded($content);
+
     /**
      * Set item category
      * @param string $name Category name

tests/Suin/RSSWriter/FeedTest.php

@@ -30,7 +30,7 @@ public function testRender()
         $channel3->expects($this->once())->method('asXML')->will($this->returnValue($xml3));
         $this->reveal($feed)->attr('channels', [$channel1, $channel2, $channel3]);
         $expect = '<?xml version="1.0" encoding="UTF-8" ?>
-            <rss version="2.0">
+            <rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
                 <channel><title>channel1</title></channel>
                 <channel><title>channel2</title></channel>
                 <channel><title>channel3</title></channel>
@@ -54,7 +54,7 @@ public function testRender_with_japanese()
         $this->reveal($feed)->attr('channels', [$channel1, $channel2, $channel3]);
         $expect = <<< 'XML'
 <?xml version="1.0" encoding="UTF-8"?>
-<rss version="2.0">
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
   <channel>
     <title>日本語1</title>
   </channel>
@@ -85,7 +85,7 @@ public function test__toString()
         $channel3->expects($this->once())->method('asXML')->will($this->returnValue($xml3));
         $this->reveal($feed)->attr('channels', [$channel1, $channel2, $channel3]);
         $expect = '<?xml version="1.0" encoding="UTF-8" ?>
-            <rss version="2.0">
+            <rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
                 <channel><title>channel1</title></channel>
                 <channel><title>channel2</title></channel>
                 <channel><title>channel3</title></channel>

tests/Suin/RSSWriter/ItemTest.php

@@ -32,6 +32,34 @@ public function testDescription()
         $this->assertAttributeSame($description, 'description', $item);
     }
 
+    public function testContentEncoded()
+    {
+        $item = new Item();
+        $this->assertSame($item, $item->contentEncoded('<div>contents</div>'));
+        $this->assertAttributeSame('<div>contents</div>', 'contentEncoded', $item);
+
+        $feed = new Feed();
+        $channel = new Channel();
+        $item->appendTo($channel);
+        $channel->appendTo($feed);
+
+        $expected = '<?xml version="1.0" encoding="UTF-8"?>
+        <rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
+          <channel>
+            <title/>
+            <link/>
+            <description/>
+            <item xmlns:default="http://purl.org/rss/1.0/modules/content/">
+              <title/>
+              <link/>
+              <description/>
+              <content:encoded xmlns="http://purl.org/rss/1.0/modules/content/"><![CDATA[<div>contents</div>]]></content:encoded>
+            </item>
+          </channel>
+        </rss>';
+        $this->assertXmlStringEqualsXmlString($expected, $feed->render());
+    }
+
     public function testCategory()
     {
         $category = uniqid();