Don't output crazy, context-less namespaces and local-name xpaths when trying to output namespaced attributes

Author: Empact

History.txt

@@ -9,6 +9,8 @@
 
   * attributes collected :as => [] were previously output improperly,
     as a single attribute on a single node
+  * don't output crazy, context-less namespaces and local-name xpaths
+    when trying to output namespaced attributes
 
 == 3.1.2 (October 18, 2009)
 

README.rdoc

@@ -95,7 +95,9 @@ in this case.
 
 === Namespace Support
 
-Namespaces are supported via the xml_namespace declaration and the :from and :namespace attr options.  See spec/xml/namespace_spec.rb for usage.
+Namespaced nodes are supported via the xml_namespace and xml_namespaces declarations and the :from and :namespace attr options.  See spec/xml/namespace_spec.rb for usage.
+
+Note that ROXML does not currently support outputting namespaced nodes.  This is planned for a future version.
 
 == Manipulation
 

TODO

@@ -2,6 +2,8 @@ Planned:
 
 v 3.2
 
+  * Support outputting namespaced attrs
+
   * Consider class_inheritable_attribute rather than superclass.try stuff.
 
   * Do some benchmarking

lib/roxml.rb

@@ -22,6 +22,7 @@ module InstanceMethods # :nodoc:
     # Returns an XML object representing this object
     def to_xml(params = {})
       params.reverse_merge!(:name => self.class.tag_name, :namespace => self.class.roxml_namespace)
+      params[:namespace] = nil if ['*', 'xmlns'].include?(params[:namespace])
       XML::Node.create([params[:namespace], params[:name]].compact.join(':')).tap do |root|
         refs = (self.roxml_references.present? \
           ? self.roxml_references \

lib/roxml/xml/references.rb

@@ -177,10 +177,10 @@ def update_xml(xml, value)
           xml.name = value
         elsif array?
           value.each do |v|
-            add(xml.add_child(XML::Node.create(xpath_name)), v)
+            add(xml.add_child(XML::Node.create(name)), v)
           end
         else
-          add(xml.add_child(XML::Node.create(xpath_name)), value)
+          add(xml.add_child(XML::Node.create(name)), value)
         end
       end
     end
@@ -294,7 +294,7 @@ def update_xml(xml, value)
         elsif value.is_a?(ROXML)
           xml.add_child(value.to_xml(params))
         else
-          node = XML::Node.create(xpath_name)
+          node = XML::Node.create(name)
           node.content = value.to_xml
           xml.add_child(node)
         end

spec/xml/attributes_spec.rb

@@ -9,7 +9,7 @@
   <node name="third" />
 </myxml>)
   end
-  
+
   context "plain vanilla" do
     before do
       @ref = ROXML::XMLAttributeRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => false), RoxmlObject.new)
@@ -36,4 +36,36 @@
       xml.to_s.squeeze(' ').should == @xml.root.to_s.squeeze(' ')
     end
   end
+  
+  context "when the namespaces are different" do
+    before do
+      @xml = ROXML::XML::Parser.parse %(
+      <document>
+      <myxml xmlns="http://example.com/three" xmlns:one="http://example.com/one" xmlns:two="http://example.com/two">
+        <one:node name="first" />
+        <two:node name="second" />
+        <node name="third" />
+      </myxml>
+      </document>
+      )
+    end
+
+    context "with :namespace => '*'" do
+      before do
+        @ref = ROXML::XMLAttributeRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true, :namespace => '*'), RoxmlObject.new)
+      end
+
+      it "should collect all instances" do
+        pending "Test bug?"
+        @ref.value_in(@xml).should == ["first", "second", "third"]
+      end
+
+      it "should output all instances with namespaces" do
+        pending "Full namespace write support"
+        xml = ROXML::XML::Node.create('result')
+        @ref.update_xml(xml, ["first", "second", "third"])
+        xml.should == @xml.root
+      end
+    end
+  end
 end

spec/xml/namespace_spec.rb

@@ -51,6 +51,7 @@ class VApp
       it "should reproduce the input xml" do
         output = ROXML::XML::Document.new
         output.root = VApp.from_xml(@xml).to_xml
+        pending "Full namespace write support"
         output.should == ROXML::XML::Parser.parse(@xml)
       end
     end

spec/xml/object_spec.rb

@@ -0,0 +1,82 @@
+require 'spec/spec_helper'
+
+describe ROXML::XMLObjectRef do
+  class SubObject
+    include ROXML
+
+    xml_reader :value, :from => :attr
+
+    def initialize(value = nil)
+      @value = value
+    end
+  end
+
+  before do
+    @xml = ROXML::XML::Parser.parse %(
+<myxml>
+  <node>
+    <name value="first" />
+    <name value="second" />
+    <name value="third" />
+  </node>
+</myxml>)
+  end
+
+  context "plain vanilla" do
+    before do
+      @ref = ROXML::XMLObjectRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => false, :sought_type => SubObject), RoxmlObject.new)
+    end
+
+    it "should return one instance" do
+      @ref.value_in(@xml).value.should == "first"
+    end
+    it "should output one instance"
+  end
+  
+  context "with :as => []" do
+    before do
+      @ref = ROXML::XMLObjectRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true, :sought_type => SubObject), RoxmlObject.new)
+    end
+
+    it "should collect all instances" do
+      @ref.value_in(@xml).map(&:value).should == ["first", "second", "third"]
+    end
+
+    it "should output all instances" do
+      xml = ROXML::XML::Node.create('myxml')
+      @ref.update_xml(xml, ["first", "second", "third"].map {|value| SubObject.new(value) })
+      xml.to_s.squeeze(' ').should == @xml.root.to_s.squeeze(' ')
+    end
+  end
+  
+  context "when the namespaces are different" do
+    before do
+      @xml = ROXML::XML::Parser.parse %(
+      <myxml xmlns="http://example.com/three" xmlns:one="http://example.com/one" xmlns:two="http://example.com/two">
+        <node>
+          <one:name>first</one:name>
+          <two:name>second</two:name>
+          <name>third</name>
+        </node>
+      </myxml>)
+    end
+
+    context "with :namespace => '*'" do
+      before do
+        @ref = ROXML::XMLObjectRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true, :namespace => '*', :sought_type => SubObject), RoxmlObject.new)
+      end
+
+      it "should collect all instances" do
+        pending "Test bug?"
+        @ref.value_in(@xml).map(&:value).should == ["first", "second", "third"]
+      end
+
+      it "should output all instances with namespaces" do
+        pending "Full namespace write support"
+        xml = ROXML::XML::Node.create('myxml')
+        @ref.update_xml(xml, ["first", "second", "third"].map {|value| SubObject.new(value) })
+        xml.should == @xml.root
+      end
+    end
+  end
+end

spec/xml/text_spec.rb

@@ -0,0 +1,71 @@
+require 'spec/spec_helper'
+
+describe ROXML::XMLTextRef do
+  before do
+    @xml = ROXML::XML::Parser.parse %(
+<myxml>
+  <node>
+    <name>first</name>
+    <name>second</name>
+    <name>third</name>
+  </node>
+</myxml>)
+  end
+
+  context "plain vanilla" do
+    before do
+      @ref = ROXML::XMLTextRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => false), RoxmlObject.new)
+    end
+
+    it "should return one instance" do
+      @ref.value_in(@xml).should == "first"
+    end
+    it "should output one instance"
+  end
+  
+  context "with :as => []" do
+    before do
+      @ref = ROXML::XMLTextRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true), RoxmlObject.new)
+    end
+
+    it "should collect all instances" do
+      @ref.value_in(@xml).should == ["first", "second", "third"]
+    end
+
+    it "should output all instances" do
+      xml = ROXML::XML::Node.create('myxml')
+      @ref.update_xml(xml, ["first", "second", "third"])
+      xml.to_s.squeeze(' ').should == @xml.root.to_s.squeeze(' ')
+    end
+  end
+  
+  context "when the namespaces are different" do
+    before do
+      @xml = ROXML::XML::Parser.parse %(
+      <myxml xmlns="http://example.com/three" xmlns:one="http://example.com/one" xmlns:two="http://example.com/two">
+        <node>
+          <one:name>first</one:name>
+          <two:name>second</two:name>
+          <name>third</name>
+        </node>
+      </myxml>)
+    end
+
+    context "with :namespace => '*'" do
+      before do
+        @ref = ROXML::XMLTextRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true, :namespace => '*'), RoxmlObject.new)
+      end
+
+      it "should collect all instances" do
+        @ref.value_in(@xml).should == ["first", "second", "third"]
+      end
+
+      it "should output all instances with namespaces" do
+        pending "Full namespace write support"
+        xml = ROXML::XML::Node.create('myxml')
+        @ref.update_xml(xml, ["first", "second", "third"])
+        xml.should == @xml.root
+      end
+    end
+  end
+end