ratom 0.5.2 → 0.6.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.6.0 2009-19-03
+
+* Now depends on libxml-ruby 1.1.2.
+* Added support for hreflang on links. (David Arango)
+* Update to work with latest version of libxml-ruby. (oortle & me)
+* Content::Text and Content::Xhtml can now be created with String's like Content::Html.
+* Make sure Atom::Generator outputs the generator name as the text of the element.
+
 == 0.5.2 2008-12-06
 
 * Remove whitespace modification in content. (dlisboa)

data/config/hoe.rb

@@ -60,7 +60,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-  p.extra_deps = [['libxml-ruby', '>= 0.8.0']]     
+  p.extra_deps = [['libxml-ruby', '>= 1.1.2']]     
   
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
   

data/lib/atom.rb

@@ -8,7 +8,7 @@
 require 'forwardable'
 require 'delegate'
 require 'rubygems'
-gem 'libxml-ruby', '>= 0.8.0'
+gem 'libxml-ruby', '>= 1.1.2'
 require 'xml/libxml'
 require 'atom/xml/parser.rb'
 
@@ -84,6 +84,14 @@ module Atom # :nodoc:
       
       yield(self) if block_given?
     end
+    
+    def to_xml(nodeonly = true, name = 'generator', namespace = nil, namespace_map = Atom::Xml::NamespaceMap.new)
+      node = XML::Node.new("#{namespace_map.prefix(Atom::NAMESPACE, name)}")
+      node << @name if @name
+      node['uri'] = @uri if @uri
+      node['version'] = @version if @version
+      node
+    end
   end
     
   # Represents a Category as defined by the Atom Syndication Format specification.
@@ -185,9 +193,15 @@ module Atom # :nodoc:
     # Text content within an Atom document.
     class Text < Base      
       attribute :type, :'xml:lang'
-      def initialize(xml)
-        super(xml.read_string)
-        parse(xml, :once => true)
+      def initialize(o)
+        case o
+        when String
+          super(o)
+          @type = "text"
+        when XML::Reader
+          super(o.read_string)
+          parse(o, :once => true)  
+        end        
       end
       
       def to_xml(nodeonly = true, name = 'content', namespace = nil, namespace_map = Atom::Xml::NamespaceMap.new)
@@ -241,22 +255,29 @@ module Atom # :nodoc:
       XHTML = 'http://www.w3.org/1999/xhtml'      
       attribute :type, :'xml:lang'
       
-      def initialize(xml)     
-        super("")   
-        parse(xml, :once => true)
-        starting_depth = xml.depth
-        
-        # Get the next element - should be a div according to the atom spec
-        while xml.read == 1 && xml.node_type != XML::Reader::TYPE_ELEMENT; end
-        
-        if xml.local_name == 'div' && xml.namespace_uri == XHTML
-          set_content(xml.read_inner_xml.strip.gsub(/\s+/, ' '))
-        else
-          set_content(xml.read_outer_xml)
+      def initialize(o)
+        case o
+        when String
+          super(o)
+          @type = "xhtml"
+        when XML::Reader
+          super("")   
+          xml = o
+          parse(xml, :once => true)
+          starting_depth = xml.depth
+
+          # Get the next element - should be a div according to the atom spec
+          while xml.read && xml.node_type != XML::Reader::TYPE_ELEMENT; end        
+
+          if xml.local_name == 'div' && xml.namespace_uri == XHTML        
+            set_content(xml.read_inner_xml.strip.gsub(/\s+/, ' '))
+          else
+            set_content(xml.read_outer_xml)
+          end
+
+          # get back to the end of the element we were created with
+          while xml.read == 1 && xml.depth > starting_depth; end          
         end
-        
-        # get back to the end of the element we were created with
-        while xml.read == 1 && xml.depth > starting_depth; end
       end
       
       def to_xml(nodeonly = true, name = 'content', namespace = nil, namespace_map = Atom::Xml::NamespaceMap.new)
@@ -533,7 +554,7 @@ module Atom # :nodoc:
           o.read
           parse(o)
         else
-          raise ArgumentError, "Entry created with node other than atom:entry: #{o.name}"
+          raise ParseError, "Entry created with node other than atom:entry: #{o.name}"
         end
       when Hash
         o.each do |k,v|
@@ -573,7 +594,11 @@ module Atom # :nodoc:
     #
     # Returns the first link with rel == 'alternate' that matches the given type.
     def alternate(type = nil)
-      detect { |link| (link.rel.nil? || link.rel == Link::Rel::ALTERNATE) && (type.nil? || type == link.type) }
+      detect { |link| 
+        (link.rel.nil? || link.rel == Link::Rel::ALTERNATE) && (type.nil? || type == link.type) && (link.hreflang.nil?) 
+      } || detect { |link| 
+        (link.rel.nil? || link.rel == Link::Rel::ALTERNATE) && (type.nil? || type == link.type) 
+      }
     end
     
     # Get all alternates.
@@ -654,7 +679,7 @@ module Atom # :nodoc:
     end    
     
     include Xml::Parseable
-    attribute :href, :rel, :type, :length
+    attribute :href, :rel, :type, :length, :hreflang
         
     # Create a link.
     #
@@ -669,7 +694,7 @@ module Atom # :nodoc:
           raise ArgumentError, "Link created with node other than atom:link: #{o.name}"
         end
       when Hash
-        [:href, :rel, :type, :length].each do |attr|
+        [:href, :rel, :type, :length, :hreflang].each do |attr|
           self.send("#{attr}=", o[attr])
         end
       else

data/lib/atom/version.rb

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

data/lib/atom/xml/parser.rb

@@ -261,9 +261,9 @@ module Atom
                xml = 
                 case o
                 when String
-                  XML::Reader.new(o)
+                  XML::Reader.string(o)
                 when IO
-                  XML::Reader.new(o.read)
+                  XML::Reader.io(o)
                 when URI
                   raise ArgumentError, "#{class_name}.load only handles http URIs" if o.scheme != 'http'
                   response = nil
@@ -283,7 +283,7 @@ module Atom
                   end
                   case response
                   when Net::HTTPSuccess
-                    XML::Reader.new(response.body)
+                    XML::Reader.string(response.body)
                   when nil
                     raise ArgumentError.new("nil response to #{o}")
                   else
@@ -294,9 +294,9 @@ module Atom
                 end
 
                 if error_handler
-                  xml.set_error_handler(&error_handler)
+                  XML::Error.set_handler(&error_handler)
                 else
-                  xml.set_error_handler do |reader, message, severity, base, line|
+                  XML::Error.set_handler do |reader, message, severity, base, line|
                     if severity == XML::Reader::SEVERITY_ERROR
                       raise ParseError, "#{message} at #{line} in #{o}"
                     end

data/spec/atom_spec.rb

@@ -654,6 +654,20 @@ describe Atom do
           @entry.links.map{|l| l.href }.should include('http://www.snellspace.com/public/linktests/example')
         end
       end
+
+      describe 'linktest9' do
+        before(:all) do
+          @entry = @entries[8]
+        end
+        
+        it "should parse all links" do
+          @entry.should have(3).links
+        end
+        
+        it "should pick the alternate without hreflang" do
+          @entry.alternate.href.should == 'http://www.snellspace.com/public/linktests/alternate'
+        end
+      end
     end
     
     describe 'ordertest.atom' do
@@ -1071,21 +1085,40 @@ describe Atom do
   
   describe 'single custom_extensions' do
      before(:all) do
-       Atom::Entry.add_extension_namespace :custom, "http://custom.namespace"
-       Atom::Entry.element "custom:property", :class => Atom::Extensions::Property
+       Atom::Entry.add_extension_namespace :custom, "http://single.custom.namespace"
+       Atom::Entry.element "custom:singleproperty", :class => Atom::Extensions::Property
        @entry = Atom::Entry.load_entry(File.open('spec/fixtures/entry_with_single_custom_extension.atom'))
      end
 
      it "should load single custom extensions for entry" do
-       @entry.custom_property.should_not be_nil
+       @entry.custom_singleproperty.should_not be_nil
      end
 
      it "should load correct data for custom extensions for entry" do
-       @entry.custom_property.name.should == 'foo'
-       @entry.custom_property.value.should == 'bar'
+       @entry.custom_singleproperty.name.should == 'foo'
+       @entry.custom_singleproperty.value.should == 'bar'
      end
    end
-  
+
+  describe 'write_support' do
+    # FIXME this example depends on "custom_extensions" for configuring Atom::Entry
+    before(:all) do
+      @entry = Atom::Entry.new
+      @entry.ns_alias_property << Atom::Extensions::Property.new('ratom', 'rocks')
+      @entry.ns_alias_property << Atom::Extensions::Property.new('custom extensions', 'also rock')
+      @node = @entry.to_xml(true)
+    end
+
+    it "should_write_custom_extensions_on_to_xml" do
+      @node.children.size.should == 2
+      ratom, custom_extensions = @node.children
+      ratom.attributes["name"].should == "ratom"
+      ratom.attributes["value"].should == "rocks"
+      custom_extensions.attributes["name"].should == "custom extensions"
+      custom_extensions.attributes["value"].should == "also rock"
+    end
+  end
+
   describe Atom::Link do
     before(:each) do
       @href = 'http://example.org/next'
@@ -1185,6 +1218,22 @@ describe Atom do
     end
   end
   
+  describe Atom::Content::Text do
+    it "should be createable from a string" do
+      txt = Atom::Content::Text.new("This is some text")
+      txt.should == "This is some text"
+      txt.type.should == "text"
+    end
+  end
+  
+  describe Atom::Content::Xhtml do
+    it "should be createable from a string" do
+      txt = Atom::Content::Xhtml.new("<p>This is some text</p>")
+      txt.should == "<p>This is some text</p>"
+      txt.type.should == "xhtml"
+    end
+  end
+    
   describe 'Atom::Category initializer' do
     it "should create a empty category" do
       lambda { Atom::Category.new }.should_not raise_error
@@ -1233,18 +1282,23 @@ describe Atom do
     end
     
     it "should create from a hash" do
-      source = Atom::Generator.new(:name => 'generator', :uri => 'http://generator')
-      source.name.should == 'generator'
-      source.uri.should == 'http://generator'
+      generator = Atom::Generator.new(:name => 'generator', :uri => 'http://generator')
+      generator.name.should == 'generator'
+      generator.uri.should == 'http://generator'
     end
     
     it "should create from a block" do
-      source = Atom::Generator.new do |source|
-        source.name = 'generator'
-        source.uri = 'http://generator'
+      generator = Atom::Generator.new do |generator|
+        generator.name = 'generator'
+        generator.uri = 'http://generator'
       end
-      source.name.should == 'generator'
-      source.uri.should == 'http://generator'
+      generator.name.should == 'generator'
+      generator.uri.should == 'http://generator'
+    end
+    
+    it "should output the name as the text of the generator element" do
+      generator = Atom::Generator.new({:name => "My Generator"})
+      generator.to_xml(true).to_s.should == "<generator>My Generator</generator>"      
     end
   end
 end

data/spec/conformance/linktests.xml

@@ -90,4 +90,14 @@
     <link href="http://www.snellspace.com/public/linktests/alternate" />
   </entry>
   
+  <entry>
+    <id>tag:snellspace.com,2006:/atom/conformance/linktest/8</id>
+    <title>Entry with links in different languages</title>
+    <updated>2005-01-18T15:00:06Z</updated>
+    <summary>The aggregator should pick the second link as alternate.</summary>
+    <link rel="alternate" hreflang="es" href="http://www.snellspace.com/es/public/linktests/alternate" />
+    <link rel="alternate" href="http://www.snellspace.com/public/linktests/alternate" />
+    <link rel="alternate" hreflang="cat" href="http://www.snellspace.com/cat/public/linktests/alternate" />
+  </entry>
+  
 </feed>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ratom
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors: 
 - Peerworks
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-06 00:00:00 +10:30
+date: 2009-03-19 00:00:00 +10:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.0
+        version: 1.1.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe