Changeset 169

Timestamp:

01/29/07 00:13:51 (2 years ago)

Author:

mikey

Message:

added more stuff from rss specification available at http://rssboard.org/rss-specification

Files:

• trunk/src/main/php/net/stubbles/xml/rss/stubRSSFeedGenerator.php (modified) (6 diffs)
• trunk/src/main/php/net/stubbles/xml/rss/stubRSSFeedItem.php (modified) (9 diffs)
• trunk/src/test/php/net/stubbles/xml/rss/stubRSSFeedGeneratorTestCase.php (modified) (2 diffs)
• trunk/src/test/php/net/stubbles/xml/rss/stubRSSFeedItemTestCase.php (modified) (5 diffs)

trunk/src/main/php/net/stubbles/xml/rss/stubRSSFeedGenerator.php

@@ -12 +12 @@
-/**
- * Class for generating a rss 2.0 feed.
+ * 
+ * The implementation follows the rss specification available at
+ * http://rssboard.org/rss-specification. However some of the elements are 
+ * not implemented:
+ * pubDate    
+ * category   Why categorize a whole feed when the items can be categorized?
+ * cloud      This implies security and spamming dangers.
+ * rating
+ * textInput  Most aggregators ignore it.
+ * skipHours  Usage relies on behaviour of aggregators.
+ * skipDays   Usage relies on behaviour of aggregators.
- *
- * @package     stubbles
- * @subpackage  xml_rss
+ * @see         http://rssboard.org/rss-specification
- */
-class stubRSSFeedGenerator extends stubBaseObject
-{
-    /**
-title of rss feed
-
-
-
-ivate $title
-
-source of rss feed
-
-
-
-ivate $link        = null
-
-source description
-
-
-
-ivate $description = null
+name of the channel
+
+
+
+otected $title   
+
+URL to the HTML website corresponding to the channel
+
+
+
+otected $link           = ''
+
+phrase or sentence describing the channel
+
+
+
+otected $description    = ''
-    /**
-     * list of items in feed
-     *
-
-
-ivate $items
+stub
+
+otected $items   
-    /**
-     * the generator of this rss feed
@@ -47 +59 @@
-     * @var  string
-     */
-ivate $generator
+otected $generator   
-    /**
-     * list of stylesheets to append as processing instructions
@@ -53 +65 @@
-     * @var  array<string>
-     */
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    /**
@@ -73 +142 @@
-     * add an item to the feed
-     *
-
+
+
+
-     * @return  stubRssFeedItem  the added item
-     */
-
-
-
+, $link, $description
+
+, $link, $description
-        array_push($this->items, $rssFeedItem);
-        return $rssFeedItem;
@@ -101 +172 @@
-    {
-        $this->stylesheets[] = $stylesheet;
+    }
+    
+    /**
+     * set the language the channel is written in
+     *
+     * @param  string  $language
+     */
+    public function setLanguage($language)
+    {
+        $this->language = $language;
+    }
+    
+    /**
+     * set copyright notice for content in the channel
+     *
+     * @param  string  $copyright
+     */
+    public function setCopyright($copyright)
+    {
+        $this->copyright = $copyright;
+    }
+    
+    /**
+     * set email address for person responsible for editorial content
+     *
+     * @param  string  $managingEditor
+     */
+    public function setManagingEditor($managingEditor)
+    {
+        if (strstr($managingEditor, '@') === false) {
+            $this->managingEditor = 'nospam@example.com (' . $managingEditor . ')';
+        } else {
+            $this->managingEditor = $managingEditor;
+        }
+    }
+    
+    /**
+     * set email address for person responsible for technical issues relating to channel
+     *
+     * @param  string  $webMaster
+     */
+    public function setWebMaster($webMaster)
+    {
+        if (strstr($webMaster, '@') === false) {
+            $this->webMaster = 'nospam@example.com (' . $webMaster . ')';
+        } else {
+            $this->webMaster = $webMaster;
+        }
+    }
+    
+    /**
+     * set the last time when the content of the channel changed
+     *
+     * @param   string|int   $lastBuildDate  last time the content of the channel changed
+     */
+    public function setLastBuildDate($lastBuildDate)
+    {
+        if (is_int($lastBuildDate) == false) {
+            $lastBuildDate = strtotime($lastBuildDate);
+            if (false === $lastBuildDate) {
+                throw new stubXMLException('Argument must be a unix timestamp or a valid string representation of a time.');
+            }
+        }
+        
+        $this->lastBuildDate = date('D d M Y H:i:s O', $lastBuildDate);
+    }
+    
+    /**
+     * set number of minutes that indicates how long a channel can be cached 
+     * before refreshing from the source
+     *
+     * @param  int  $ttl
+     */
+    public function setTimeToLive($ttl)
+    {
+        $this->ttl = $ttl;
+    }
+    
+    /**
+     * specify a GIF, JPEG or PNG image to be displayed with the channel
+     *
+     * @param   string  $url          URL of a GIF, JPEG or PNG image that represents the channel
+     * @param   string  $description  contains text that is included in the TITLE attribute of the link formed around the image in the HTML rendering
+     * @param   int     $width        indicating the width of the image in pixels, must be 0 < $width <= 144, default 88
+     * @param   int     $height       indicating the height of the image in pixels, must be 0 < $height <= 400, default 31
+     * @throws  stubXMLException  in case $width or $height have invalid values
+     */
+    public function setImage($url, $description, $width = 88, $height = 31)
+    {
+        if (144 < $width || 0 > $width) {
+            throw new stubXMLException('Width must be a value between 0 and 144.');
+        }
+        
+        if (400 < $height || 0 > $height) {
+            throw new stubXMLException('Height must be a value between 0 and 400.');
+        }
+        
+        $this->image = array('url'         => $url,
+                             'description' => $description,
+                             'width'       => $width,
+                             'height'      => $height
+                       );
-    }
-
@@ -124 +297 @@
-        $xmlStreamWriter->writeElement('description', array(), $this->description);
-        $xmlStreamWriter->writeElement('generator', array(), $this->generator);
+        
+        if (null !== $this->language) {
+            $xmlStreamWriter->writeElement('language', array(), $this->language);
+        }
+        
+        if (null !== $this->copyright) {
+            $xmlStreamWriter->writeElement('copyright', array(), $this->copyright);
+        }
+        
+        if (null !== $this->managingEditor) {
+            $xmlStreamWriter->writeElement('managingEditor', array(), $this->managingEditor);
+        }
+        
+        if (null !== $this->webMaster) {
+            $xmlStreamWriter->writeElement('webMaster', array(), $this->webMaster);
+        }
+        
+        if (null !== $this->lastBuildDate) {
+            $xmlStreamWriter->writeElement('lastBuildDate', array(), $this->lastBuildDate);
+        }
+        
+        if (null !== $this->ttl) {
+            $xmlStreamWriter->writeElement('ttl', array(), $this->ttl);
+        }
+        
+        if (strlen($this->image['url']) > 0) {
+            $xmlStreamWriter->writeStartElement('image');
+            $xmlStreamWriter->writeElement('url', array(), $this->image['url']);
+            $xmlStreamWriter->writeElement('title', array(), $this->title);
+            $xmlStreamWriter->writeElement('link', array(), $this->link);
+            $xmlStreamWriter->writeElement('width', array(), $this->image['width']);
+            $xmlStreamWriter->writeElement('height', array(), $this->image['height']);
+            $xmlStreamWriter->writeElement('description', array(), $this->image['description']);
+            $xmlStreamWriter->writeEndElement();
+        }
+        
-        $xmlStreamWriter->writeEndElement(); // end channel element
-        foreach ($this->items as $item) {

trunk/src/main/php/net/stubbles/xml/rss/stubRSSFeedItem.php

@@ -13 +13 @@
- * @package     stubbles
- * @subpackage  xml_rss
+ * @see         http://rssboard.org/rss-specification
- */
-class stubRSSFeedItem extends stubBaseObject
-{
-    /**
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /**
-     * content of rss feed item
@@ -45 +88 @@
-     * @var  string
-     */
-
-
-
-
-
-
-
+
-
-    /**
-     * constructor
-     *
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        return $item;
-    }
-
-    /**
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-     *
-     * @param   string           $author  author of rss feed item
@@ -115 +134 @@
-        return $this;
-    }
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        return $this;
-    }
@@ -146 +211 @@
-        return $this;
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-     *
-     * @return  string
@@ -168 +248 @@
-
-    /**
- the source
+s the URL
-     *
-     * @return  string
@@ -176 +256 @@
-        return $this->link;
-    }
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-     *
-     * @return  string
@@ -186 +276 @@
-        return $this->author;
-    }
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /**
-     * return the content of the item
@@ -198 +358 @@
-
-    /**
-     * return the publishing date of the item
-     *
-     * @return  string
-     */
-    public function getPubDate()
-    {
-        return $this->pubDate;
-    }
-
-    /**
-     * serialize the item to xml
-     *
@@ -215 +365 @@
-    {
-        $xmlStreamWriter->writeStartElement('item');
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        if (null !== $this->pubDate) {
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-        
-        $xmlStreamWriter->writeEndElement(); // end item

trunk/src/test/php/net/stubbles/xml/rss/stubRSSFeedGeneratorTestCase.php

@@ -67 +67 @@
-    {
-        $this->assertEqual($this->rssFeedGenerator->countItems(), 0);
-
+, 'bar', 'baz'
-        $this->assertEqual($this->rssFeedGenerator->countItems(), 1);
-        $mockXmlStreamWriter = new MockstubXMLStreamWriter();
@@ -76 +76 @@
-        $this->rssFeedGenerator->serialize($mockXmlStreamWriter);
-    }
+    
+    /**
+     * test that optional channel elements are handled as expected
+     */
+    public function testWithAllChannelElements()
+    {
+        $this->rssFeedGenerator->setLanguage('en_EN');
+        $this->rssFeedGenerator->setCopyright('© 2007 Stubbles Development Team');
+        $this->rssFeedGenerator->setManagingEditor('mikey');
+        $this->rssFeedGenerator->setWebMaster('schst');
+        $this->rssFeedGenerator->setLastBuildDate(50);
+        $this->rssFeedGenerator->setTimeToLive(60);
+        $this->rssFeedGenerator->setImage('http://example.org/example.gif', 'foo');
+        
+        $mockXmlStreamWriter = new MockstubXMLStreamWriter();
+        $mockXmlStreamWriter->expectNever('writeProcessingInstruction');
+        $mockXmlStreamWriter->expectCallCount('writeStartElement', 3);
+        $mockXmlStreamWriter->expectCallCount('writeEndElement', 3);
+        $mockXmlStreamWriter->expectCallCount('writeElement', 16);
+        $this->rssFeedGenerator->serialize($mockXmlStreamWriter);
+    }
+    
+    /**
+     * assure that invalid dates throw a stubXMLException
+     */
+    public function testInvalidLastBuildDate()
+    {
+        $this->expectException('stubXMLException');
+        $this->rssFeedGenerator->setLastBuildDate('foo');
+    }
+    
+    /**
+     * assure that an invalid width throws a stubXMLException
+     */
+    public function testImageWidthTooSmall()
+    {
+        $this->expectException('stubXMLException');
+        $this->rssFeedGenerator->setImage('http://example.org/example.gif', 'foo', -1);
+    }
+    
+    /**
+     * assure that an invalid width throws a stubXMLException
+     */
+    public function testImageWidthTooGreat()
+    {
+        $this->expectException('stubXMLException');
+        $this->rssFeedGenerator->setImage('http://example.org/example.gif', 'foo', 145);
+    }
+    
+    /**
+     * assure that an invalid height throws a stubXMLException
+     */
+    public function testImageHeightTooSmall()
+    {
+        $this->expectException('stubXMLException');
+        $this->rssFeedGenerator->setImage('http://example.org/example.gif', 'foo', -1);
+    }
+    
+    /**
+     * assure that an invalid height throws a stubXMLException
+     */
+    public function testImageHeightTooGreat()
+    {
+        $this->expectException('stubXMLException');
+        $this->rssFeedGenerator->setImage('http://example.org/example.gif', 'foo', 401);
+    }
-}
-?>

trunk/src/test/php/net/stubbles/xml/rss/stubRSSFeedItemTestCase.php

@@ -35 +35 @@
-    public function setUp()
-    {
-
+, 'http://stubbles.net/', 'description'
-                                             ->byAuthor('mikey')
-
+
+
+
+
+
-                                             ->publishedOn(50)
+                                             ->inspiredBySource('stubbles', 'http://stubbles.net/source/')
-                                             ->withContent('<foo>bar</foo><baz/>')
-
-
-
+
+
-    }
-
@@ -50 +54 @@
-    public function testValues()
-    {
-        $this->assertEqual($this->rssFeedItem1->getId(), 'dummy');
-        $this->assertEqual($this->rssFeedItem1->getTitle(), 'test1');
-        $this->assertEqual($this->rssFeedItem1->getLink(), 'http://stubbles.net/');
+        $this->assertEqual($this->rssFeedItem1->getDescription(), 'description');
-        $this->assertEqual($this->rssFeedItem1->getAuthor(), 'nospam@example.com (mikey)');
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        $this->assertEqual($this->rssFeedItem1->getPubDate(), 'Thu 01 Jan 1970 01:00:50 +0100');
+        $this->assertEqual($this->rssFeedItem1->getSources(), array(array('name' => 'stubbles',
+                                                                          'url'  => 'http://stubbles.net/source/'
+                                                                    )
+                                                              )
+        );
-        
-        $this->rssFeedItem1->byAuthor('test@example.net (mikey)');
-        $this->assertEqual($this->rssFeedItem1->getAuthor(), 'test@example.net (mikey)');
+        
+        $this->rssFeedItem1->withGuid('dummy2', false);
+        $this->assertEqual($this->rssFeedItem1->getGuid(), 'dummy2');
+        $this->assertFalse($this->rssFeedItem1->isGuidPermaLink());
-    }
-    
@@ -66 +95 @@
-    public function testEmptyValues()
-    {
-        $this->assertNull($this->rssFeedItem2->getId());
-        $this->assertEqual($this->rssFeedItem2->getTitle(), 'test2');
-
-
+
+
+
+
+
+
+
+
+
-        $this->assertEqual($this->rssFeedItem2->getContent(), '');
-        $this->assertNull($this->rssFeedItem2->getPubDate());
-    }
-    
@@ -81 +115 @@
-        $mockXmlStreamWriter = new MockstubXMLStreamWriter();
-        $mockXmlStreamWriter->expectOnce('writeStartElement', array('item'));
-
-
-
-
-
-
-
-
-
-
-
+
-        $this->rssFeedItem1->serialize($mockXmlStreamWriter);
-    }
@@ -102 +126 @@
-        $mockXmlStreamWriter = new MockstubXMLStreamWriter();
-        $mockXmlStreamWriter->expectOnce('writeStartElement', array('item'));
-
-
-
-
-
-
-
-
+
-        $this->rssFeedItem2->serialize($mockXmlStreamWriter);
-    }