ratom 0.3.4 → 0.3.5

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.5 2008-05-03
+
+* Make sure atom:entries appears last.
+* Better examples in the documentation. Docs for Feed and Entry list attributes.
+* Gave Feeds authors and contributors.
+* Fixed a couple warnings.
+
 == 0.3.4 2008-04-21
 
 * Remove useless variable warning.  (Sam Roberts)

data/README.txt

@@ -46,23 +46,67 @@ And then iterate over the entries in the feed using:
     # do cool stuff
   end
   
-To construct a Feed
+To construct the following example Feed is from the Atom spec:
 
-  feed = Atom::Feed.new do |feed|
-    feed.title = "My Cool Feed"
-    feed.id = "http://example.com/my_feed.atom"
-    feed.updated = Time.now
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom">
+
+    <title>Example Feed</title> 
+    <link href="http://example.org/"/>
+    <updated>2003-12-13T18:30:02Z</updated>
+    <author> 
+      <name>John Doe</name>
+    </author> 
+    <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
+
+    <entry>
+      <title>Atom-Powered Robots Run Amok</title>
+      <link href="http://example.org/2003/12/13/atom03"/>
+      <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
+      <updated>2003-12-13T18:30:02Z</updated>
+      <summary>Some text.</summary>
+    </entry>
+
+  </feed>
+  
+To build this in rAtom we would do:
+
+  feed = Atom::Feed.new do |f|
+    f.title = "Example Feed"
+    f.links << Atom::Link.new(:href => "http://example.org/")
+    f.updated = Time.parse('2003-12-13T18:30:02Z')
+    f.authors << Atom::Person.new(:name => 'John Doe')
+    f.id = "urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6"
+    f.entries << Atom::Entry.new do |e|
+      e.title = "Atom-Powered Robots Run Amok"
+      e.links << Atom::Link.new(:href => "http://example.org/2003/12/13/atom03")
+      e.id = "urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a"
+      e.updated = Time.parse('2003-12-13T18:30:02Z')
+      e.summary = "Some text."
+    end
   end
   
-To output a Feed as XML use to_xml
+To output the Feed as XML use to_xml
 
   > puts feed.to_xml
   <?xml version="1.0"?>
   <feed xmlns="http://www.w3.org/2005/Atom">
-    <title>My Cool Feed</title>
-    <id>http://example.com/my_feed.atom</id>
-    <updated>2008-03-03T23:19:44+10:30</updated>
+    <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
+    <title>Example Feed</title>
+    <updated>2003-12-13T18:30:02Z</updated>
+    <link href="http://example.org/"/>
+    <author>
+      <name>John Doe</name>
+    </author>
+    <entry>
+      <title>Atom-Powered Robots Run Amok</title>
+      <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
+      <summary>Some text.</summary>
+      <updated>2003-12-13T18:30:02Z</updated>
+      <link href="http://example.org/2003/12/13/atom03"/>
+    </entry>
   </feed>
+  
 
 See Feed and Entry for details on the methods and attributes of those classes.
 

data/lib/atom.rb

@@ -36,7 +36,7 @@ module Atom # :nodoc:
     # +localname+:: The local name of the extension element.
     #
     def [](ns, localname)
-      if @simple_extensions.nil?
+      if !defined?(@simple_extensions) || @simple_extensions.nil?
         @simple_extensions = {}
       end
       
@@ -238,7 +238,8 @@ module Atom # :nodoc:
       XHTML = 'http://www.w3.org/1999/xhtml'      
       attribute :type, :'xml:lang'
       
-      def initialize(xml)        
+      def initialize(xml)     
+        super("")   
         parse(xml, :once => true)
         starting_depth = xml.depth
         
@@ -246,9 +247,9 @@ module Atom # :nodoc:
         while xml.read == 1 && xml.node_type != XML::Reader::TYPE_ELEMENT; end
         
         if xml.local_name == 'div' && xml.namespace_uri == XHTML
-          super(xml.read_inner_xml.strip.gsub(/\s+/, ' '))
+          set_content(xml.read_inner_xml.strip.gsub(/\s+/, ' '))
         else
-          super(xml.read_outer_xml)
+          set_content(xml.read_outer_xml)
         end
         
         # get back to the end of the element we were created with
@@ -330,8 +331,24 @@ module Atom # :nodoc:
   #
   # A feed can be converted to XML using, the to_xml method that returns a valid atom document in a String.
   #
+  # == Attributes
+  #
+  # A feed has the following attributes:
+  #
+  # +id+:: A unique id for the feed.
+  # +updated+:: The Time the feed was updated.
+  # +title+:: The title of the feed.
+  # +subtitle+:: The subtitle of the feed.
+  # +authors+:: An array of Atom::Person objects that are authors of this feed.
+  # +contributors+:: An array of Atom::Person objects that are contributors to this feed.
+  # +generator+:: A Atom::Generator.
+  # +rights+:: A string describing the rights associated with this feed.
+  # +entries+:: An array of Atom::Entry objects.
+  # +links+:: An array of Atom:Link objects. (This is actually an Atom::Links array which is an Array with some sugar).
+  #
   # == References
   # See also http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.feed
+  #
   class Feed
     include Xml::Parseable
     include SimpleExtensions
@@ -344,8 +361,10 @@ module Atom # :nodoc:
     element :id, :rights
     element :generator, :class => Generator
     element :title, :subtitle, :class => Content
-    element :updated, :published, :class => Time, :content_only => true
-    elements :links, :entries
+    element :updated, :class => Time, :content_only => true
+    elements :links
+    elements :authors, :contributors, :class => Person
+    elements :entries
     
     # Initialize a Feed.
     #
@@ -358,7 +377,7 @@ module Atom # :nodoc:
     # +o+:: An XML Reader or a Hash of attributes.
     #
     def initialize(o = {})
-      @links, @entries = Links.new, []
+      @links, @entries, @authors, @contributors = Links.new, [], [], []
       
       case o
       when XML::Reader
@@ -448,8 +467,27 @@ module Atom # :nodoc:
   #
   # A Entry can be converted to XML using, the to_xml method that returns a valid atom entry document in a String.
   #
+  # == Attributes
+  #
+  # An entry has the following attributes:
+  #
+  # +id+:: A unique id for the entry.
+  # +updated+:: The Time the entry was updated.
+  # +published+:: The Time the entry was published.
+  # +title+:: The title of the entry.
+  # +summary+:: A short textual summary of the item.
+  # +authors+:: An array of Atom::Person objects that are authors of this entry.
+  # +contributors+:: An array of Atom::Person objects that are contributors to this entry.
+  # +rights+:: A string describing the rights associated with this entry.
+  # +links+:: An array of Atom:Link objects. (This is actually an Atom::Links array which is an Array with some sugar).
+  # +source+:: Metadata of a feed that was the source of this item, for feed aggregators, etc.
+  # +categories+:: Array of Atom::Categories.
+  # +content+:: The content of the entry. This will be one of Atom::Content::Text, Atom::Content:Html or Atom::Content::Xhtml.
+  #
   # == References
-  # See also http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.entry
+  # See also http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.entry for more detailed
+  # definitions of the attributes.
+  #
   class Entry
     include Xml::Parseable
     include SimpleExtensions
@@ -632,6 +670,7 @@ module Atom # :nodoc:
       end        
     end
     
+    remove_method :length=
     def length=(v)
       @length = v.to_i
     end

data/lib/atom/pub.rb

@@ -62,6 +62,7 @@ module Atom
         parse(o)
       end
 
+      remove_method :categories
       def categories; self; end
     end
     

data/lib/atom/version.rb

@@ -2,7 +2,7 @@ module Atom #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 4
+    TINY  = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/atom/xml/parser.rb

@@ -88,9 +88,11 @@ module Atom
   
       def Parseable.included(o)
         o.class_eval do
+          def o.ordered_element_specs;  @ordered_element_specs ||= []; end
           def o.element_specs;  @element_specs ||= {}; end
           def o.attributes; @attributes ||= []; end
           def element_specs; self.class.element_specs; end
+          def ordered_element_specs; self.class.ordered_element_specs; end
           def attributes; self.class.attributes; end
           def o.namespace(ns = @namespace); @namespace = ns; end
         end
@@ -113,29 +115,29 @@ module Atom
         namespace_map = NamespaceMap.new if namespace_map.nil?
         node = XML::Node.new(root_name)
         node['xmlns'] = self.class.namespace unless nodeonly || !self.class.respond_to?(:namespace)
-        
-        self.class.element_specs.values.select {|s| s.single? }.each do |spec|
-          if attribute = self.send(spec.attribute)
-            if attribute.respond_to?(:to_xml)
-              node << attribute.to_xml(true, spec.name, spec.options[:namespace], namespace_map)
-            else
-              n =  XML::Node.new(spec.name)
-              n['xmlns'] = spec.options[:namespace]              
-              n << (attribute.is_a?(Time)? attribute.xmlschema : attribute.to_s)
-              node << n
+
+        self.class.ordered_element_specs.each do |spec|
+          if spec.single?
+            if attribute = self.send(spec.attribute)
+              if attribute.respond_to?(:to_xml)
+                node << attribute.to_xml(true, spec.name, spec.options[:namespace], namespace_map)
+              else
+                n =  XML::Node.new(spec.name)
+                n['xmlns'] = spec.options[:namespace]              
+                n << (attribute.is_a?(Time)? attribute.xmlschema : attribute.to_s)
+                node << n
+              end
             end
-          end
-        end  
-        
-        self.class.element_specs.values.select {|s| !s.single? }.each do |spec|
-          self.send(spec.attribute).each do |attribute|
-            if attribute.respond_to?(:to_xml)
-              node << attribute.to_xml(true, spec.name.singularize, nil, namespace_map)
-            else
-              n = XML::Node.new(spec.name.singularize)
-              n['xmlns'] = spec.options[:namespace]
-              n << attribute.to_s
-              node << n
+          else
+            self.send(spec.attribute).each do |attribute|
+              if attribute.respond_to?(:to_xml)
+                node << attribute.to_xml(true, spec.name.singularize, nil, namespace_map)
+              else
+                n = XML::Node.new(spec.name.singularize)
+                n['xmlns'] = spec.options[:namespace]
+                n << attribute.to_s
+                node << n
+              end
             end
           end
         end
@@ -186,7 +188,7 @@ module Atom
         
           names.each do |name|
             attr_accessor name          
-            self.element_specs[name.to_s] = ParseSpec.new(name, options)
+            self.ordered_element_specs << self.element_specs[name.to_s] = ParseSpec.new(name, options)
           end
         end
             
@@ -196,7 +198,7 @@ module Atom
         
           names.each do |name|
             attr_accessor name
-            self.element_specs[name.to_s.singularize] = ParseSpec.new(name, options)
+            self.ordered_element_specs << self.element_specs[name.to_s.singularize] = ParseSpec.new(name, options)
           end
         end
       

data/spec/atom_spec.rb

@@ -42,6 +42,14 @@ shared_examples_for 'simple_single_entry.atom attributes' do
     @feed.alternate.href.should == 'http://example.org/'
   end
   
+  it "should have 1 author" do
+    @feed.should have(1).authors
+  end
+  
+  it "should have 'John Doe' as the author's name" do
+    @feed.authors.first.name.should == "John Doe"
+  end
+  
   it "should parse title" do
     @entry.title.should == 'Atom-Powered Robots Run Amok'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ratom
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Peerworks
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-21 00:00:00 +09:30
+date: 2008-05-03 00:00:00 +09:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency