rubysl-rss 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3eb93259d4e044e8483e641f7ffb1061f89eb98
-  data.tar.gz: 4b9d868c45af61dc53c8c1dec751933637003b07
+  metadata.gz: e1177001fe685f528a4bb3c920c180183fa69218
+  data.tar.gz: c26da1c990ff1f6a7115aac7ce35c074cda59db3
 SHA512:
-  metadata.gz: ba15661cec3b9b3825a555cd6604aab81a8b0b2067be5b334146e93255821f62ea8603afd2de34d4b7662fa81a9a6405d4b27579540dbce67c1e2d1c59de3142
-  data.tar.gz: c746088480be967b5d4e8491a796af8d8fdbba08563c412634b753afbb1ba608e1b4a088636f045437a9fbd3338fd230e78adaed49e30fd7605808e253d4ac76
+  metadata.gz: 7230587633c13aeaaf65a48b3420ff895753c9cda4241423c67673f39cbde43440168d7800066ca363cc367f4b285fe28e37c1db813756813b53139eb66e5a75
+  data.tar.gz: 38bca62ee7703a7c9b3b9ecbde53ce5c480acb54bc620dd5f118264c0cb0a70dca1166206fe3762d6d22d3d4bdb94f643390b8d8247b6e131fce4f7580d34997

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
-before_install:
-  - gem update --system
-  - gem --version
-  - gem install rubysl-bundler
-script: bundle exec mspec spec
+env:
+  - RUBYLIB=lib
+script: bundle exec mspec
 rvm:
-  - rbx-nightly-18mode
+  - 1.9.3
+  - rbx-nightly-19mode

data/lib/rss/0.9.rb

@@ -8,7 +8,7 @@ module RSS
 
     def self.append_features(klass)
       super
-      
+
       klass.install_must_call_validator('', "")
     end
   end
@@ -123,7 +123,7 @@ module RSS
       def not_need_to_call_setup_maker_variables
         %w(image textInput)
       end
-    
+
       class SkipDays < Element
         include RSS09
 
@@ -146,11 +146,11 @@ module RSS
               self.content = args[0]
             end
           end
-      
+
         end
-        
+
       end
-      
+
       class SkipHours < Element
         include RSS09
 
@@ -174,13 +174,13 @@ module RSS
             end
           end
         end
-        
+
       end
-      
+
       class Image < Element
 
         include RSS09
-        
+
         %w(url title link).each do |name|
           install_text_element(name, "", nil)
         end
@@ -239,9 +239,9 @@ module RSS
           end
         end
       end
-      
+
       class Item < Element
-        
+
         include RSS09
 
         [
@@ -269,7 +269,7 @@ module RSS
           @enclosure.setup_maker(item) if @enclosure
           @source.setup_maker(item) if @source
         end
-        
+
         class Source < Element
 
           include RSS09
@@ -279,7 +279,7 @@ module RSS
           ].each do |name, uri, required|
             install_get_attribute(name, uri, required)
           end
-          
+
           content_setup
 
           def initialize(*args)
@@ -341,7 +341,7 @@ module RSS
         class Category < Element
 
           include RSS09
-          
+
           [
             ["domain", "", false]
           ].each do |name, uri, required|
@@ -369,11 +369,11 @@ module RSS
             category.domain = domain
             category.content = content
           end
-          
+
         end
 
       end
-      
+
       class TextInput < Element
 
         include RSS09
@@ -399,9 +399,9 @@ module RSS
           maker.textinput
         end
       end
-      
+
     end
-    
+
   end
 
   RSS09::ELEMENTS.each do |name|
@@ -411,8 +411,8 @@ module RSS
   module ListenerMixin
     private
     def initial_start_rss(tag_name, prefix, attrs, ns)
-      check_ns(tag_name, prefix, ns, "")
-      
+      check_ns(tag_name, prefix, ns, "", false)
+
       @rss = Rss.new(attrs['version'], @version, @encoding, @standalone)
       @rss.do_validate = @do_validate
       @rss.xml_stylesheets = @xml_stylesheets
@@ -422,7 +422,7 @@ module RSS
       end
       @proc_stack.push(pr)
     end
-    
+
   end
 
 end

data/lib/rss/1.0.rb

@@ -8,7 +8,7 @@ module RSS
 
     def self.append_features(klass)
       super
-      
+
       klass.install_must_call_validator('', ::RSS::URI)
     end
 
@@ -64,13 +64,13 @@ module RSS
           URI
         end
       end
-      
+
       [
         ["resource", [URI, ""], true]
       ].each do |name, uri, required|
         install_get_attribute(name, uri, required)
       end
-      
+
       def initialize(*args)
         if Utils.element_initialize_arguments?(args)
           super
@@ -98,10 +98,10 @@ module RSS
       end
 
       @tag_name = 'Seq'
-      
+
       install_have_children_element("li", URI, "*")
       install_must_call_validator('rdf', ::RSS::RDF::URI)
-      
+
       def initialize(*args)
         if Utils.element_initialize_arguments?(args)
           super
@@ -114,7 +114,7 @@ module RSS
       def full_name
         tag_name_with_prefix(PREFIX)
       end
-      
+
       def setup_maker(target)
         lis.each do |li|
           target << li.resource
@@ -135,10 +135,10 @@ module RSS
       end
 
       @tag_name = 'Bag'
-      
+
       install_have_children_element("li", URI, "*")
       install_must_call_validator('rdf', URI)
-      
+
       def initialize(*args)
         if Utils.element_initialize_arguments?(args)
           super
@@ -151,7 +151,7 @@ module RSS
       def full_name
         tag_name_with_prefix(PREFIX)
       end
-      
+
       def setup_maker(target)
         lis.each do |li|
           target << li.resource
@@ -162,7 +162,7 @@ module RSS
     class Channel < Element
 
       include RSS10
-      
+
       class << self
 
         def required_uri
@@ -202,17 +202,17 @@ module RSS
       def maker_target(maker)
         maker.channel
       end
-      
+
       def setup_maker_attributes(channel)
         channel.about = about
       end
 
       class Image < Element
-        
+
         include RSS10
 
         class << self
-          
+
           def required_uri
             ::RSS::URI
           end
@@ -225,7 +225,7 @@ module RSS
           install_get_attribute(name, uri, required, nil, nil,
                                 "#{PREFIX}:#{name}")
         end
-      
+
         def initialize(*args)
           if Utils.element_initialize_arguments?(args)
             super
@@ -237,11 +237,11 @@ module RSS
       end
 
       class Textinput < Element
-        
+
         include RSS10
 
         class << self
-          
+
           def required_uri
             ::RSS::URI
           end
@@ -254,7 +254,7 @@ module RSS
           install_get_attribute(name, uri, required, nil, nil,
                                 "#{PREFIX}:#{name}")
         end
-      
+
         def initialize(*args)
           if Utils.element_initialize_arguments?(args)
             super
@@ -264,7 +264,7 @@ module RSS
           end
         end
       end
-      
+
       class Items < Element
 
         include RSS10
@@ -272,16 +272,16 @@ module RSS
         Seq = ::RSS::RDF::Seq
 
         class << self
-          
+
           def required_uri
             ::RSS::URI
           end
-          
+
         end
 
         install_have_child_element("Seq", URI, nil)
         install_must_call_validator('rdf', URI)
-        
+
         def initialize(*args)
           if Utils.element_initialize_arguments?(args)
             super
@@ -309,7 +309,7 @@ module RSS
       include RSS10
 
       class << self
-        
+
         def required_uri
           ::RSS::URI
         end
@@ -351,7 +351,7 @@ module RSS
         def required_uri
           ::RSS::URI
         end
-        
+
       end
 
 
@@ -436,7 +436,7 @@ module RSS
   module ListenerMixin
     private
     def initial_start_RDF(tag_name, prefix, attrs, ns)
-      check_ns(tag_name, prefix, ns, RDF::URI)
+      check_ns(tag_name, prefix, ns, RDF::URI, false)
 
       @rss = RDF.new(@version, @encoding, @standalone)
       @rss.do_validate = @do_validate

data/lib/rss/2.0.rb

@@ -29,7 +29,7 @@ module RSS
       Category = Item::Category
 
       class Item
-      
+
         [
           ["comments", "?"],
           ["author", "?"],
@@ -57,9 +57,9 @@ module RSS
           _setup_maker_element(item)
           @guid.setup_maker(item) if @guid
         end
-        
+
         class Guid < Element
-          
+
           include RSS09
 
           [

data/lib/rss/atom.rb

@@ -1,9 +1,24 @@
-require 'base64'
 require 'rss/parser'
 
 module RSS
+  ##
+  # Atom is an XML-based document format that is used to describe 'feeds' of related information.
+  # A typical use is in a news feed where the information is periodically updated and which users
+  # can subscribe to.  The Atom format is described in http://tools.ietf.org/html/rfc4287
+  #
+  # The Atom module provides support in reading and creating feeds.
+  #
+  # See the RSS module for examples consuming and creating feeds
   module Atom
+
+    ##
+    # The Atom URI W3C Namespace
+
     URI = "http://www.w3.org/2005/Atom"
+
+    ##
+    # The XHTML URI W3C Namespace
+
     XHTML_URI = "http://www.w3.org/1999/xhtml"
 
     module CommonModel
@@ -75,6 +90,10 @@ module RSS
       end
     end
 
+    # The TextConstruct module is used to define a Text construct Atom element,
+    # which is used to store small quantities of human-readable text
+    #
+    # The TextConstruct has a type attribute, e.g. text, html, xhtml
     module TextConstruct
       def self.append_features(klass)
         super
@@ -101,6 +120,7 @@ module RSS
       end
 
       attr_writer :xhtml
+
       def xhtml
         return @xhtml if @xhtml.nil?
         if @xhtml.is_a?(XML::Element) and
@@ -114,6 +134,7 @@ module RSS
                          {"xmlns" => XHTML_URI}, children)
       end
 
+      # Returns true if type is "xhtml"
       def have_xml_content?
         @type == "xhtml"
       end
@@ -141,7 +162,13 @@ module RSS
       end
     end
 
+    # The PersonConstruct module is used to define a Person Atom element that can be
+    # used to describe a person, corporation, or similar entity
+    #
+    # The PersonConstruct has a Name, Uri, and Email child elements
     module PersonConstruct
+
+      # Adds attributes for name, uri, and email to the +klass+
       def self.append_features(klass)
         super
         klass.class_eval do
@@ -159,22 +186,30 @@ module RSS
         target.__send__("new_#{self.class.name.split(/::/).last.downcase}")
       end
 
+      # The name of the person or entity
       class Name < RSS::Element
         include CommonModel
         include ContentModel
       end
 
+      # The URI of the person or entity
       class Uri < RSS::Element
         include CommonModel
         include URIContentModel
       end
 
+      # The email of the person or entity
       class Email < RSS::Element
         include CommonModel
         include ContentModel
       end
     end
 
+    # Element used to describe an Atom date and time in the ISO 8601 format
+    #
+    # Examples:
+    # * 2013-03-04T15:30:02Z
+    # * 2013-03-04T10:30:02-05:00
     module DateConstruct
       def self.append_features(klass)
         super
@@ -184,12 +219,17 @@ module RSS
         end
       end
 
+      # Raises NotAvailableValueError if element content is nil
       def atom_validate(ignore_unknown_element, tags, uri)
         raise NotAvailableValueError.new(tag_name, "") if content.nil?
       end
     end
 
     module DuplicateLinkChecker
+      # Checks if there are duplicate links with the same type and hreflang attributes
+      # that have an alternate (or empty) rel attribute
+      #
+      # Raises a TooMuchTagError if there are duplicates found
       def validate_duplicate_links(links)
         link_infos = {}
         links.each do |link|
@@ -204,6 +244,9 @@ module RSS
       end
     end
 
+    # Atom feed element
+    #
+    # A Feed has several metadata attributes in addition to a number of Entry child elements
     class Feed < RSS::Element
       include RootElementMixin
       include CommonModel
@@ -231,6 +274,7 @@ module RSS
                  tag, URI, occurs, tag, *args)
       end
 
+      # Creates a new Atom feed
       def initialize(version=nil, encoding=nil, standalone=nil)
         super("1.0", version, encoding, standalone)
         @feed_type = "atom"
@@ -239,6 +283,8 @@ module RSS
 
       alias_method :items, :entries
 
+      # Returns true if there are any authors for the feed or any of the Entry
+      # child elements have an author
       def have_author?
         authors.any? {|author| !author.to_s.empty?} or
           entries.any? {|entry| entry.have_author?(false)}
@@ -322,16 +368,32 @@ module RSS
         end
       end
 
+      # Atom Icon element
+      #
+      # Image that provides a visual identification for the Feed.  Image should have an aspect
+      # ratio of 1:1
       class Icon < RSS::Element
         include CommonModel
         include URIContentModel
       end
 
+      # Atom ID element
+      #
+      # Universally Unique Identifier (UUID) for the Feed
       class Id < RSS::Element
         include CommonModel
         include URIContentModel
       end
 
+      # Defines an Atom Link element
+      #
+      # A Link has the following attributes:
+      # * href
+      # * rel
+      # * type
+      # * hreflang
+      # * title
+      # * length
       class Link < RSS::Element
         include CommonModel
 
@@ -352,6 +414,10 @@ module RSS
         end
       end
 
+      # Atom Logo element
+      #
+      # Image that provides a visual identification for the Feed.  Image should have an aspect
+      # ratio of 2:1 (horizontal:vertical)
       class Logo < RSS::Element
         include CommonModel
         include URIContentModel
@@ -366,26 +432,40 @@ module RSS
         end
       end
 
+      # Atom Rights element
+      #
+      # TextConstruct that contains copyright information regarding the content in an Entry or Feed
       class Rights < RSS::Element
         include CommonModel
         include TextConstruct
       end
 
+      # Atom Subtitle element
+      #
+      # TextConstruct that conveys a description or subtitle for a Feed
       class Subtitle < RSS::Element
         include CommonModel
         include TextConstruct
       end
 
+      # Atom Title element
+      #
+      # TextConstruct that conveys a description or title for a feed or Entry
       class Title < RSS::Element
         include CommonModel
         include TextConstruct
       end
 
+      # Atom Updated element
+      #
+      # DateConstruct indicating the most recent time when an Entry or Feed was modified
+      # in a way the publisher considers significant
       class Updated < RSS::Element
         include CommonModel
         include DateConstruct
       end
 
+      # Defines a child Atom Entry element for an Atom Feed
       class Entry < RSS::Element
         include CommonModel
         include DuplicateLinkChecker
@@ -409,6 +489,10 @@ module RSS
                    tag, URI, occurs, tag, *args)
         end
 
+        # Returns whether any of the following are true
+        # * There are any authors in the feed
+        # * If the parent element has an author and the +check_parent+ parameter was given.
+        # * There is a source element that has an author
         def have_author?(check_parent=true)
           authors.any? {|author| !author.to_s.empty?} or
             (check_parent and @parent and @parent.have_author?) or
@@ -528,7 +612,7 @@ module RSS
             return false unless inline_other?
             return false if inline_other_xml?
 
-            media_type, subtype = mime_split
+            media_type, = mime_split
             return true if "text" == media_type.downcase
             false
           end
@@ -635,6 +719,8 @@ module RSS
       end
     end
 
+    # Defines a top-level Atom Entry element
+    #
     class Entry < RSS::Element
       include RootElementMixin
       include CommonModel
@@ -659,21 +745,25 @@ module RSS
                  tag, URI, occurs, tag, *args)
       end
 
+      # Creates a new Atom Entry element
       def initialize(version=nil, encoding=nil, standalone=nil)
         super("1.0", version, encoding, standalone)
         @feed_type = "atom"
         @feed_subtype = "entry"
       end
 
+      # Returns the Entry in an array
       def items
         [self]
       end
 
+      # sets up the +maker+ for constructing Entry elements
       def setup_maker(maker)
         maker = maker.maker if maker.respond_to?("maker")
         super(maker)
       end
 
+      # Returns where there are any authors present or there is a source with an author
       def have_author?
         authors.any? {|author| !author.to_s.empty?} or
           (source and source.have_author?)
@@ -717,7 +807,7 @@ module RSS
   module ListenerMixin
     private
     def initial_start_feed(tag_name, prefix, attrs, ns)
-      check_ns(tag_name, prefix, ns, Atom::URI)
+      check_ns(tag_name, prefix, ns, Atom::URI, false)
 
       @rss = Atom::Feed.new(@version, @encoding, @standalone)
       @rss.do_validate = @do_validate
@@ -732,7 +822,7 @@ module RSS
     end
 
     def initial_start_entry(tag_name, prefix, attrs, ns)
-      check_ns(tag_name, prefix, ns, Atom::URI)
+      check_ns(tag_name, prefix, ns, Atom::URI, false)
 
       @rss = Atom::Entry.new(@version, @encoding, @standalone)
       @rss.do_validate = @do_validate