ratom 0.3.2 → 0.3.3

data/History.txt

@@ -1,4 +1,11 @@
-== 0.3.2 2008-04-09
+== 0.3.3 2008-04-09
+
+* Better serialization of namespaced elements. ratom will now generate prefixes for namespaces and write them as
+  attributes on the root element.
+* Extensions read as attributes are now written as attributes.
+* When programmatically setting an extension value you can tell ratom to write it as an attribute using:
+  
+  entry['http://example.org', 'extattr'].as_attribute = true  
 
 * Add support for atom:category.
 * Support extension attributes using the same mechanism as extension elements.

data/lib/atom.rb

@@ -40,8 +40,20 @@ module Atom # :nodoc:
         @simple_extensions = {}
       end
       
+      if @simple_extension_attributes.nil?
+        @simple_extension_attributes = {}
+      end
+      
       key = "{#{ns},#{localname}}"
-      (@simple_extensions[key] or @simple_extensions[key] = [])
+      (@simple_extensions[key] or @simple_extensions[key] = ValueProxy.new)
+    end
+    
+    class ValueProxy < DelegateClass(Array)
+      attr_accessor :as_attribute
+      def initialize
+        super([])
+        @as_attribute = false
+      end
     end
   end
   
@@ -170,9 +182,8 @@ module Atom # :nodoc:
         parse(xml, :once => true)
       end
       
-      def to_xml(nodeonly = true, name = 'content', namespace = nil)
-        node = XML::Node.new(name)
-        node['xmlns'] = namespace
+      def to_xml(nodeonly = true, name = 'content', namespace = nil, namespace_map = Atom::Xml::NamespaceMap.new)
+        node = XML::Node.new("#{namespace_map.get(Atom::NAMESPACE)}:#{name}")
         node << self.to_s
         node
       end
@@ -196,7 +207,7 @@ module Atom # :nodoc:
         end        
       end
       
-      def to_xml(nodeonly = true, name = 'content', namespace = nil) # :nodoc:
+      def to_xml(nodeonly = true, name = 'content', namespace = nil, namespace_map = Atom::Xml::NamespaceMap.new) # :nodoc:
         require 'iconv'
         # Convert from utf-8 to utf-8 as a way of making sure the content is UTF-8.
         #
@@ -206,10 +217,9 @@ module Atom # :nodoc:
         # to try and recitfy the situation.
         #
         begin
-          node = XML::Node.new(name)
-          node << Iconv.iconv('utf-8', 'utf-8', self.to_s)
+          node = XML::Node.new("#{namespace_map.get(Atom::NAMESPACE)}:#{name}")
+          node << Iconv.iconv('utf-8', 'utf-8', self.to_s, namespace_map = nil)
           node['type'] = 'html'
-          node['xmlns'] = namespace
           node['xml:lang'] = self.xml_lang        
           node
         rescue Iconv::IllegalSequence => e
@@ -240,13 +250,12 @@ module Atom # :nodoc:
         while xml.read == 1 && xml.depth > starting_depth; end
       end
       
-      def to_xml(nodeonly = true, name = 'content', namespace = nil)
-        node = XML::Node.new(name)
+      def to_xml(nodeonly = true, name = 'content', namespace = nil, namespace_map = Atom::Xml::NamespaceMap.new)
+        node = XML::Node.new("#{namespace_map.get(Atom::NAMESPACE)}:#{name}")
         node['type'] = 'xhtml'
         node['xml:lang'] = self.xml_lang
-        node['xmlns'] = namespace
         
-        div = XML::Node.new('div')        
+        div = XML::Node.new('div')
         div['xmlns'] = XHTML
         div
         

data/lib/atom/version.rb

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

data/lib/atom/xml/parser.rb

@@ -31,6 +31,27 @@ end
 
 module Atom
   module Xml # :nodoc:
+   class NamespaceMap
+      def initialize
+        @i = 0
+        @map = {}
+      end
+      
+      def get(ns)
+        if ns == Atom::NAMESPACE
+          @map[ns] = "atom"
+        elsif ns == Atom::Pub::NAMESPACE
+          @map[ns] = "app"
+        else
+          @map[ns] or @map[ns] = "ns#{@i += 1}"
+        end
+      end
+      
+      def each(&block)
+        @map.each(&block)
+      end
+    end
+    
     module Parseable # :nodoc:
       def parse(xml, options = {})
         starting_depth = xml.depth
@@ -45,6 +66,7 @@ module Atom
                   # Support attribute names with namespace prefixes
                   self.send("#{xml.name.sub(/:/, '_')}=", xml.value)
                 elsif self.respond_to?(:simple_extensions)
+                  self[xml.namespace_uri, xml.local_name].as_attribute = true
                   self[xml.namespace_uri, xml.local_name] << xml.value
                 end
               end
@@ -87,14 +109,15 @@ module Atom
         end
       end
       
-      def to_xml(nodeonly = false, root_name = self.class.name.demodulize.downcase, namespace = nil)        
+      def to_xml(nodeonly = false, root_name = self.class.name.demodulize.downcase, namespace = nil, namespace_map = nil)
+        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])
+              node << attribute.to_xml(true, spec.name, spec.options[:namespace], namespace_map)
             else
               n =  XML::Node.new(spec.name)
               n['xmlns'] = spec.options[:namespace]              
@@ -107,7 +130,7 @@ module Atom
         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)
+              node << attribute.to_xml(true, spec.name.singularize, nil, namespace_map)
             else
               n = XML::Node.new(spec.name.singularize)
               n['xmlns'] = spec.options[:namespace]
@@ -129,10 +152,13 @@ module Atom
           self.simple_extensions.each do |name, value_array|
             if name =~ /\{(.*),(.*)\}/
               value_array.each do |value|
-                ext = XML::Node.new($2)
-                ext['xmlns'] = $1
-                ext << value
-                node << ext
+                if value_array.as_attribute
+                  node["#{namespace_map.get($1)}:#{$2}"] = value
+                else
+                  ext = XML::Node.new("#{namespace_map.get($1)}:#{$2}")
+                  ext << value
+                  node << ext
+                end
               end
             else
               STDERR.print "Couldn't split #{name}"
@@ -141,6 +167,10 @@ module Atom
         end
         
         unless nodeonly
+          namespace_map.each do |ns, prefix|
+            node["xmlns:#{prefix}"] = ns
+          end
+          
           doc = XML::Document.new
           doc.root = node
           doc.to_s

data/spec/atom/pub_spec.rb

@@ -152,8 +152,7 @@ describe Atom::Pub do
       end
     
       it "should put title in Atom namespace" do
-        # TODO fix this to use a prefix?
-        @xml.should match(%r{title xmlns="#{Atom::NAMESPACE}"})
+        @xml.should match(%r{atom:title})
       end
       
       it_should_behave_like 'parser of spec/app/service.xml'

data/spec/atom_spec.rb

@@ -974,6 +974,10 @@ describe Atom do
         @entry.categories.first["http://example.org/example", "attribute"].first.should == "extension"
       end
       
+      it "should write a simple extension attribute as an attribute" do
+        @entry.categories.first.to_xml(true)['ns1:attribute'].should == 'extension'
+      end
+      
       it "should read an extension with the same local name as an Atom element" do
         @feed['http://example.org/example', 'title'].should == ['Extension Title']
       end
@@ -1105,7 +1109,7 @@ describe Atom do
   
   describe Atom::Content::Html do
     it "should escape ampersands in entities" do
-      Atom::Content::Html.new("&nbsp;").to_xml.to_s.should == "<content type=\"html\">&amp;nbsp;</content>"
+      Atom::Content::Html.new("&nbsp;").to_xml.to_s.should == "<atom:content type=\"html\">&amp;nbsp;</atom:content>"
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ratom
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Peerworks