ratom 0.4.2 → 0.5.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.5.0 2008-07-28
+
+* Fix bug where processing instructions break parsing.
+* Added Custom extension element classes. (Ignacio Carrera)
+
 == 0.4.2 2008-07-09
 
 * Update to libxml-ruby version 0.8.x

data/Manifest.txt

@@ -36,6 +36,7 @@ spec/fixtures/created_entry.atom
 spec/fixtures/entry.atom
 spec/fixtures/multiple_entry.atom
 spec/fixtures/simple_single_entry.atom
+spec/fixtures/with_stylesheet.atom
 spec/paging/first_paged_feed.atom
 spec/paging/last_paged_feed.atom
 spec/paging/middle_paged_feed.atom

data/README.txt

@@ -181,6 +181,50 @@ You can then call to_xml and rAtom will serialize the extension elements into xm
 Notice that the output repeats the xmlns attribute for each of the extensions, this is semantically the same the input XML, just a bit
 ugly.  It seems to be a limitation of the libxml-Ruby API. But if anyone knows a work around I'd gladly accept a patch (or even advice).
 
+==== Custom Extension Classes 
+
+As of version 0.5.0 you can also define your own classes for a extension elements.  This is done by first creating an alias
+for the namespace for the class and then using the +element+ method on the Atom::Feed or Atom::Entry class to tell rAtom
+to use your custom class when it encounters the extension element.
+
+For example, say we have the following piece Atom XML with a structured extension element:
+
+  <?xml version='1.0' encoding='UTF-8'?>
+  <entry xmlns='http://www.w3.org/2005/Atom' xmlns:custom='http://custom.namespace'>
+    <id>https://custom.namespace/id/1</id>
+    <link rel='self' type='application/atom+xml' href='https://custom.namespace/id/1'/>
+    <custom:property name='foo' value='bar'/>
+    <custom:property name='baz' value='bat'/>
+  </entry>
+	
+And we want the +custom:property+ elements to be parsed as our own custom class called Custom::Property that is
+defined like this:
+
+  class Custom::Property
+    attr_accessor :name, :value
+    def initialize(xml)
+      # Custom XML handling
+    end
+  end
+	
+We can tell rAtom about our custom namespace and custom class using the following method calls:
+
+  Atom::Feed..add_extension_namespace :custom, "http://custom.namespace"
+  Atom::Entry.elements "custom:property", :class => Custom::Property
+	
+The first method call registers an alias for the "http://custom.namespace" namespace and the second method call
+tell rAtom that when it encounters a custom:property element within a Feed it should create an instance of Custom::Property
+and pass the XML Reader to the constructor of the instance.  It is then up to the constructor to populate the objects attributes 
+from the XML.  
+
+The custom property will then be available as a method on the rAtom class.  In the above example:
+
+  @feed.custom_property.size == 2
+  @feed.custom_property.first.name == 'foo'
+  @feed.custom_property.first.value == 'bar'
+	
+(Thanks to nachokb for this feature!!)
+
 === Basic Authentication
 
 All methods that involve HTTP requests now support HTTP Basic Authentication.  Authentication credentials are passed

data/lib/atom/version.rb

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

data/lib/atom/xml/parser.rb

@@ -77,7 +77,7 @@ module Atom
         loop do
           case xml.node_type
           when XML::Reader::TYPE_ELEMENT
-            if element_specs.include?(xml.local_name) && [Atom::NAMESPACE, Atom::Pub::NAMESPACE].include?(xml.namespace_uri)
+            if element_specs.include?(xml.local_name) && (self.class.known_namespaces + [Atom::NAMESPACE, Atom::Pub::NAMESPACE]).include?(xml.namespace_uri)
               element_specs[xml.local_name].parse(self, xml)
             elsif attributes.any?
               while (xml.move_to_next_attribute == 1)
@@ -98,7 +98,9 @@ module Atom
       end
     
       def next_node_is?(xml, element, ns = nil)
-        xml.next == 1 && current_node_is?(xml, element, ns)
+        # Get to the next element
+        while xml.next == 1 && xml.node_type != XML::Reader::TYPE_ELEMENT; end
+        current_node_is?(xml, element, ns)
       end
       
       def current_node_is?(xml, element, ns = nil)
@@ -114,6 +116,9 @@ module Atom
           def ordered_element_specs; self.class.ordered_element_specs; end
           def attributes; self.class.attributes; end
           def o.namespace(ns = @namespace); @namespace = ns; end
+          def o.add_extension_namespace(ns, url); self.extensions_namespaces[ns.to_s] = url; end
+          def o.extensions_namespaces; @extensions_namespaces ||= {} end
+          def o.known_namespaces; @known_namespaces ||= [] end
         end
         o.send(:extend, DeclarationMethods)
       end
@@ -138,6 +143,9 @@ module Atom
         namespace_map = NamespaceMap.new(self.class.namespace) if namespace_map.nil?
         node = XML::Node.new(root_name)
         node['xmlns'] = self.class.namespace unless nodeonly || !self.class.respond_to?(:namespace)
+        self.class.extensions_namespaces.each do |ns_alias,uri|
+          node["xmlns:#{ns_alias}"] = uri
+        end
 
         self.class.ordered_element_specs.each do |spec|
           if spec.single?
@@ -210,8 +218,10 @@ module Atom
           options.merge!(names.pop) if names.last.is_a?(Hash) 
         
           names.each do |name|
-            attr_accessor name          
-            self.ordered_element_specs << self.element_specs[name.to_s] = ParseSpec.new(name, options)
+            attr_accessor name.to_s.sub(/:/, '_').to_sym
+            ns, local_name = name.to_s[/(.*):(.*)/,1], $2 || name
+            self.known_namespaces << self.extensions_namespaces[ns] if ns
+            self.ordered_element_specs << self.element_specs[local_name.to_s] = ParseSpec.new(name, options)
           end
         end
             
@@ -220,8 +230,16 @@ module Atom
           options.merge!(names.pop) if names.last.is_a?(Hash)
         
           names.each do |name|
-            attr_accessor name
-            self.ordered_element_specs << self.element_specs[name.to_s.singularize] = ParseSpec.new(name, options)
+            name_sym = name.to_s.sub(/:/, '_').to_sym
+            attr_writer name_sym
+            define_method name_sym do 
+              ivar = :"@#{name_sym}"
+              self.instance_variable_set ivar, [] unless self.instance_variable_defined? ivar
+              self.instance_variable_get ivar
+            end
+            ns, local_name = name.to_s[/(.*):(.*)/,1], $2 || name
+            self.known_namespaces << self.extensions_namespaces[ns] if ns
+            self.ordered_element_specs << self.element_specs[local_name.to_s.singularize] = ParseSpec.new(name, options)
           end
         end
       
@@ -314,7 +332,9 @@ module Atom
           when :single
             target.send("#{@attribute}=".to_sym, build(target, xml))
           when :collection
-            target.send("#{@attribute}") << build(target, xml)
+            collection = target.send(@attribute.to_s)
+            element    = build(target, xml)
+            collection << element
           end
         end
       

data/spec/atom_spec.rb

@@ -8,6 +8,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'net/http'
 require 'time'
+require 'spec/property'
 
 shared_examples_for 'simple_single_entry.atom attributes' do
   it "should parse title" do
@@ -183,6 +184,12 @@ describe Atom do
     it_should_behave_like "simple_single_entry.atom attributes"
   end
   
+  describe 'FeedWithStyleSheet' do
+    it "should load without failure" do
+      lambda { feed = Atom::Feed.load_feed(File.open('spec/fixtures/with_stylesheet.atom')) }.should_not raise_error
+    end
+  end
+  
   describe 'ComplexFeed' do
     before(:all) do
       @feed = Atom::Feed.load_feed(File.open('spec/fixtures/complex_single_entry.atom'))
@@ -1045,6 +1052,43 @@ describe Atom do
     end
   end
   
+  describe 'custom_extensions' do
+    before(:all) do
+      Atom::Entry.add_extension_namespace :ns_alias, "http://custom.namespace"
+      Atom::Entry.elements "ns_alias:property", :class => Atom::Extensions::Property
+      @entry = Atom::Entry.load_entry(File.open('spec/fixtures/entry_with_custom_extensions.atom'))
+    end
+    
+    it "should_load_custom_extensions_for_entry" do
+      @entry.ns_alias_property.should_not == []
+    end
+    
+    it "should_load_2_custom_extensions_for_entry" do
+      @entry.ns_alias_property.size.should == 2
+    end
+    
+    it "should load correct_data_for_custom_extensions_for_entry" do
+      @entry.ns_alias_property.map { |x| [x.name, x.value] }.should == [['foo', 'bar'], ['baz', 'bat']]
+    end
+  end
+  
+  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
+       @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
+     end
+
+     it "should load correct data for custom extensions for entry" do
+       @entry.custom_property.name.should == 'foo'
+       @entry.custom_property.value.should == 'bar'
+     end
+   end
+  
   describe Atom::Link do
     before(:each) do
       @href = 'http://example.org/next'

data/spec/fixtures/with_stylesheet.atom

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<?xml-stylesheet href="http://www.blogger.com/styles/atom.css" type="text/css"?>
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/'>
+	<id>tag:blogger.com,1999:blog-3343849602113720282</id>
+	<updated>2008-07-26T09:01:19.322+01:00</updated>
+	<title type='text'>Blockstack.tv</title>
+	<link rel='alternate' type='text/html' href='http://blockstack.blogspot.com/'/>
+</feed>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ratom
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - Peerworks
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-23 00:00:00 +09:30
+date: 2008-07-28 00:00:00 +09:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ files:
 - spec/fixtures/entry.atom
 - spec/fixtures/multiple_entry.atom
 - spec/fixtures/simple_single_entry.atom
+- spec/fixtures/with_stylesheet.atom
 - spec/paging/first_paged_feed.atom
 - spec/paging/last_paged_feed.atom
 - spec/paging/middle_paged_feed.atom