ROXML 3.0.0

data/spec/shared_specs.rb

@@ -0,0 +1,15 @@
+require 'spec/spec_helper'
+
+describe "freezable xml reference", :shared => true do
+  describe "with :frozen option" do
+    it "should be frozen" do
+      @frozen.frozen?.should be_true
+    end
+  end
+
+  describe "without :frozen option" do
+    it "should not be frozen" do
+      @unfrozen.frozen?.should be_false
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'pathname'
+require 'test/support/fixtures'
+require 'lib/roxml'
+
+require 'spec/shared_specs' if defined?(Spec)
+
+def xml_for(name)
+  Pathname.new(File.dirname(__FILE__)).expand_path.dirname.join("examples/xml/#{name}.xml")
+end
+
+class RoxmlObject
+  include ROXML
+end

data/spec/support/libxml.rb

@@ -0,0 +1,3 @@
+module ROXML
+  XML_PARSER = 'libxml'
+end

data/spec/support/nokogiri.rb

@@ -0,0 +1,3 @@
+module ROXML
+  XML_PARSER = 'nokogiri'
+end

data/spec/xml/attributes_spec.rb

@@ -0,0 +1,36 @@
+require 'spec/spec_helper'
+
+describe ROXML::XMLAttributeRef do
+  before do
+    @xml = ROXML::XML::Parser.parse %(
+    <myxml>
+      <node name="first" />
+      <node name="second" />
+      <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)
+    end
+
+    it "should return one instance" do
+      @ref.send(:fetch_value, @xml).should == "first"
+    end
+    it "should output one instance"
+  end
+  
+  context "with :as => []" do
+    before do
+      @ref = ROXML::XMLAttributeRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true), RoxmlObject.new)
+    end
+
+    it "should collect all instances" do
+      @ref.send(:fetch_value, @xml).should == ["first", "second", "third"]
+    end
+
+    it "should output all instances"
+  end
+end

data/spec/xml/namespace_spec.rb

@@ -0,0 +1,240 @@
+require 'spec/spec_helper.rb'
+
+describe ROXML, "with namespaces" do
+  context "when an included namespace is not defined in the xml" do
+    context "where the missing namespace is the default" do
+      it "should raise"
+
+      context "but the namespace is declared in the body" do
+        it "should succeed"
+      end
+    end
+    
+    context "where the missing namespace is included in a namespacey from" do
+      it "should raise"
+
+      context "but the namespace is declared in the body" do
+        it "should succeed"
+      end
+    end
+    
+    context "where the missing namespace is included in an explicit :namespace" do
+      it "should raise"
+
+      context "but the namespace is declared in the body" do
+        it "should succeed"
+      end
+    end
+  end
+  
+  describe "roxml namespacey declaration", :shared => true do
+    context "with a namespacey :from" do
+      context "and an explicit :namespace" do
+        it "should raise" do
+          proc do
+            Class.new do
+              include ROXML
+              xml_reader :default_namespace_with_namespacey_from_and_explicit_namespace, :from => 'namespacey:with_namespacey_from', :namespace => 'explicit'
+            end
+          end.should raise_error(ROXML::ContradictoryNamespaces)
+        end
+      end
+
+      context "and :namespace => false" do
+        it "should raise" do
+          proc do
+            Class.new do
+              include ROXML
+              xml_reader :default_namespace_with_namespacey_from_and_namespace_false, :from => 'namespacey:with_namespacey_from', :namespace => false
+            end
+          end.should raise_error(ROXML::ContradictoryNamespaces)
+        end
+      end
+    end
+  end
+
+  describe "roxml namespacey declaration with default", :shared => true do
+    it_should_behave_like "roxml namespacey declaration"
+    
+    it "should use the default namespace" do
+      @instance.default_namespace.should == 'default namespace node'
+    end
+    
+    context "and :namespace => false" do
+      it "should find the namespace-less node" do
+        @instance.default_namespace_with_namespace_false.should == 'namespaceless node'
+      end
+    end
+
+    context "with an explicit :namespace" do
+      it "should use the explicit namespace" do
+        @instance.default_and_explicit_namespace == 'explicit namespace node'
+      end
+    end
+
+    context "with a namespace-less :from" do
+      it "should use the default namespace" do
+        @instance.default_namespace_with_namespaceless_from.should == 'default namespace node'
+      end
+      
+      context "and :namespace => false" do
+        it "should find the namespace-less node" do
+          @instance.default_namespace_with_namespaceless_from_and_namespace_false.should == 'namespaceless node'
+        end
+      end
+
+      context "and an explicit :namespace" do
+        it "should use the explicit namespace" do
+          @instance.default_namespace_with_namespaceless_from_and_explicit_namespace.should == 'explicit namespace node'
+        end
+      end
+    end
+
+    context "with a namespacey :from" do
+      it "should use the :from namespace" do
+        @instance.default_namespace_with_namespacey_from.should == 'namespacey node'
+      end
+    end
+  end
+
+  context "with a default namespace declared" do
+    class DefaultNamespaceyObject
+      include ROXML
+      xml_namespace :default_declared
+
+      xml_reader :default_namespace
+      xml_reader :default_namespace_with_namespace_false, :namespace => false
+      xml_reader :default_and_explicit_namespace, :namespace => 'explicit'
+      xml_reader :default_namespace_with_namespaceless_from, :from => 'with_namespaceless_from'
+      xml_reader :default_namespace_with_namespaceless_from_and_explicit_namespace, :from => 'with_namespaceless_from', :namespace => 'explicit'
+      xml_reader :default_namespace_with_namespaceless_from_and_namespace_false, :from => 'with_namespaceless_from', :namespace => false
+      xml_reader :default_namespace_with_namespacey_from, :from => 'namespacey:with_namespacey_from'
+
+      # These are handled in the "roxml namespacey declaration" shared spec
+      # xml_reader :default_namespace_with_namespacey_from_and_namespace_false, :from => 'namespacey:with_namespaceless_from', :namespace => false
+      # xml_reader :default_namespace_with_namespacey_from_and_explicit_namespace, :from => 'namespacey:with_namespaceless_from', :namespace => 'explicit'
+    end
+
+    before do
+      @instance = DefaultNamespaceyObject.from_xml(%{
+        <book xmlns:namespacey="http://www.aws.com/aws" xmlns:default_declared="http://www.aws.com/default" xmlns:explicit="http://www.aws.com/different">
+          <default_declared:default_namespace>default namespace node</default_declared:default_namespace>
+          <namespacey:with_namespacey_from>namespacey node</namespacey:with_namespacey_from>
+          <explicit:with_namespaceless_from>explicit namespace node</explicit:with_namespaceless_from>
+          <with_namespaceless_from>namespaceless node</with_namespaceless_from>
+          <default_declared:with_namespaceless_from>default namespace node</default_declared:with_namespaceless_from>
+          <explicit:default_and_explicit_namespace>explicit namespace node</explicit:default_and_explicit_namespace>
+          <default_namespace_with_namespace_false>namespaceless node</default_namespace_with_namespace_false>
+        </book>
+      })
+    end
+    
+    it_should_behave_like "roxml namespacey declaration with default"
+  end
+
+  context "with a default namespace on the root node" do
+    class XmlDefaultNamespaceyObject
+      include ROXML
+      xml_reader :default_namespace
+      xml_reader :default_namespace_with_namespace_false, :namespace => false
+      xml_reader :default_and_explicit_namespace, :namespace => 'explicit'
+      xml_reader :default_namespace_with_namespaceless_from, :from => 'with_namespaceless_from'
+      xml_reader :default_namespace_with_namespaceless_from_and_explicit_namespace, :from => 'with_namespaceless_from', :namespace => 'explicit'
+      xml_reader :default_namespace_with_namespaceless_from_and_namespace_false, :from => 'with_namespaceless_from', :namespace => false
+      xml_reader :default_namespace_with_namespacey_from, :from => 'namespacey:with_namespacey_from'
+
+      # These are handled in the "roxml namespacey declaration" shared spec
+      # xml_reader :default_namespace_with_namespacey_from_and_namespace_false, :from => 'namespacey:with_namespaceless_from', :namespace => false
+      # xml_reader :default_namespace_with_namespacey_from_and_explicit_namespace, :from => 'namespacey:with_namespaceless_from', :namespace => 'explicit'
+    end
+
+    before do
+      @instance = XmlDefaultNamespaceyObject.from_xml(%{
+        <book xmlns="http://www.aws.com/xml_default" xmlns:namespacey="http://www.aws.com/aws" xmlns:default_declared="http://www.aws.com/default" xmlns:explicit="http://www.aws.com/different">
+          <default_namespace>default namespace node</default_namespace>
+          <namespacey:with_namespacey_from>namespacey node</namespacey:with_namespacey_from>
+          <explicit:with_namespaceless_from>explicit namespace node</explicit:with_namespaceless_from>
+          <with_namespaceless_from xmlns="">namespaceless node</with_namespaceless_from>
+          <with_namespaceless_from>default namespace node</with_namespaceless_from>
+          <explicit:default_and_explicit_namespace>explicit namespace node</explicit:default_and_explicit_namespace>
+          <default_namespace_with_namespace_false xmlns="">namespaceless node</default_namespace_with_namespace_false>
+        </book>
+      })
+    end
+
+    it_should_behave_like "roxml namespacey declaration with default"
+  end
+
+  context "without a default namespace" do
+    class NamespaceyObject
+      include ROXML
+
+      xml_reader :no_default_namespace
+      xml_reader :no_default_namespace_with_namespace_false, :namespace => false
+      xml_reader :no_default_but_an_explicit_namespace, :namespace => 'explicit'
+      xml_reader :no_default_namespace_with_namespaceless_from, :from => 'with_namespaceless_from'
+      xml_reader :no_default_namespace_with_namespaceless_from_and_explicit_namespace, :from => 'with_namespaceless_from', :namespace => 'explicit'
+      xml_reader :no_default_namespace_with_namespaceless_from_and_namespace_false, :from => 'with_namespaceless_from', :namespace => false
+      xml_reader :no_default_namespace_with_namespacey_from, :from => 'namespacey:with_namespacey_from'
+
+      # These are handled in the "roxml namespacey declaration" shared spec
+      # xml_reader :no_default_namespace_with_namespacey_from_and_explicit_namespace, :from => 'namespacey:with_namespacey_from', :namespace => 'explicit'
+      # xml_reader :no_default_namespace_with_namespacey_from_and_namespace_false, :from => 'namespacey:with_namespacey_from', :namespace => false
+    end
+
+    before do
+      @instance = NamespaceyObject.from_xml(%{
+        <book xmlns:namespacey="http://www.aws.com/aws" xmlns:explicit="http://www.aws.com/different">
+          <namespacey:with_namespacey_from>namespacey node</namespacey:with_namespacey_from>
+          <explicit:with_namespaceless_from>explicit namespace node</explicit:with_namespaceless_from>
+          <with_namespaceless_from>namespaceless node</with_namespaceless_from>
+          <explicit:no_default_but_an_explicit_namespace>explicit namespace node</explicit:no_default_but_an_explicit_namespace>
+          <no_default_namespace_with_namespace_false>namespaceless node</no_default_namespace_with_namespace_false>
+          <no_default_namespace>namespaceless node</no_default_namespace>
+        </book>
+      })
+    end
+    
+    it_should_behave_like "roxml namespacey declaration"
+
+    it "should find the namespace-less node" do
+      @instance.no_default_namespace.should == 'namespaceless node'
+    end
+
+    context "with :namespace => false" do
+      it "should find the namespace-less node" do
+        @instance.no_default_namespace_with_namespace_false.should == 'namespaceless node'
+      end
+    end
+
+    context "with an explicit :namespace" do
+      it "should use the explicit namespace" do
+        @instance.no_default_but_an_explicit_namespace.should == 'explicit namespace node'
+      end
+    end
+
+    context "with a namespace-less :from" do
+      it "should find the namespace-less node" do
+        @instance.no_default_namespace_with_namespaceless_from.should == 'namespaceless node'
+      end
+    
+      context "and an explicit :namespace" do
+        it "should use the explicit namespace" do
+          @instance.no_default_namespace_with_namespaceless_from_and_explicit_namespace.should == 'explicit namespace node'
+        end
+      end
+
+      context "with :namespace => false" do
+        it "should find the namespace-less node" do
+          @instance.no_default_namespace_with_namespaceless_from_and_namespace_false.should == 'namespaceless node'
+        end
+      end
+    end
+
+    context "with a namespacey :from" do
+      it "should use the :from namespace" do
+        @instance.no_default_namespace_with_namespacey_from.should == 'namespacey node'
+      end
+    end
+  end
+end

data/spec/xml/namespaces_spec.rb

@@ -0,0 +1,32 @@
+require 'spec/spec_helper.rb'
+
+describe ROXML, "#xml_namespaces" do
+  class Tires
+     include ROXML
+
+     xml_namespaces \
+       :bobsbike => 'http://bobsbikes.example.com',
+       :alicesauto => 'http://alicesautosupply.example.com/'
+
+     xml_reader :bike_tires, :as => [], :from => '@name', :in => 'bobsbike:tire'
+     xml_reader :car_tires, :as => [], :from => '@name', :in => 'alicesauto:tire'
+   end
+
+  before do
+     @xml = %{<?xml version="1.0"?>
+       <inventory xmlns="http://alicesautosupply.example.com/" xmlns:bike="http://bobsbikes.example.com">
+        <tire name="super slick racing tire" />
+        <tire name="all weather tire" />
+        <bike:tire name="skinny street" />
+       </inventory>
+     }
+  end
+  
+  it "should remap default namespaces" do
+    Tires.from_xml(@xml).car_tires.should =~ ['super slick racing tire', 'all weather tire']
+  end
+
+  it "should remap prefix namespaces" do
+    Tires.from_xml(@xml).bike_tires.should == ['skinny street']
+  end
+end

data/spec/xml/parser_spec.rb

@@ -0,0 +1,26 @@
+require 'spec/spec_helper.rb'
+
+describe ROXML::XML::Parser do
+  before do
+    # quiet the error handler
+    ROXML::XML::Error.reset_handler if ROXML::XML::Error.respond_to?(:reset_handler)
+  end
+  
+  it "should raise on malformed xml" do
+    unless ROXML::XML_PARSER == 'nokogiri' # nokogiri is less strict and auto-closes for some reason
+      proc { Book.from_xml(fixture(:book_malformed)) }.should raise_error(ROXML::XML::Error)
+    end
+  end
+
+  it "should escape invalid characters on output to text node" do
+    node = ROXML::XML::Node.create("entities")
+    node.content = " < > ' \" & "
+    node.to_s.should == "<entities> &lt; &gt; ' \" &amp; </entities>"
+  end
+
+  it "should esape invalid characters for attribute name" do
+    node = ROXML::XML::Node.create("attr_holder")
+    node.attributes["entities"] = "\"'<>&"
+    node.to_s.should == %{<attr_holder entities="&quot;'&lt;&gt;&amp;"/>}
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,13 @@
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "roxml-new #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/tasks/rspec.rake

@@ -0,0 +1,25 @@
+require 'spec/rake/spectask'
+desc "Run specs"
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec' << 'examples'
+  spec.spec_opts = ['--options', "spec/spec.opts"]
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  [:libxml, :nokogiri].each do |parser|
+    desc "Spec ROXML under the #{parser} parser"
+    Spec::Rake::SpecTask.new(parser) do |spec|
+      spec.libs << 'lib' << 'spec' << 'examples'
+      spec.spec_opts = ['--options=spec/spec.opts']
+      spec.spec_files = ["spec/support/#{parser}.rb"] + FileList['spec/**/*_spec.rb']
+    end
+  end
+end
+
+desc "Run specs with rcov"
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end

data/tasks/test.rake

@@ -0,0 +1,35 @@
+require 'rake/testtask'
+Rake::TestTask.new(:bugs) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/bugs/*_bugs.rb'
+  test.verbose = true
+end
+
+desc "Test ROXML using the default parser selection behavior"
+task :test do
+  require 'rake/runtest'
+  Rake.run_tests 'test/unit/*_test.rb'
+end
+
+namespace :test do
+  desc "Test ROXML under the Nokogiri parser"
+  task :nokogiri do
+    module ROXML
+      XML_PARSER = 'nokogiri'
+    end
+    Rake::Task["test"].invoke
+  end
+
+   desc "Test ROXML under the LibXML parser"
+  task :libxml do
+    module ROXML
+      XML_PARSER = 'libxml'
+    end
+    Rake::Task["test"].invoke
+  end
+
+  desc "Runs tests under RCOV"
+  task :rcov do
+    system "rcov -T --no-html -x '^/'  #{FileList['test/unit/*_test.rb']}"
+  end
+end