roxml 2.3.2 → 2.4.0

data/lib/roxml/xml/rexml.rb

@@ -39,11 +39,11 @@ module ROXML
     class Parser
       class << self
         def parse(string)
-          REXML::Document.new(string)
+          REXML::Document.new(string, :ignore_whitespace_nodes => :all)
         end
 
         def parse_file(path)
-          REXML::Document.new(open(path), :ignore_whitespace_nodes => :all)
+          parse(open(path))
         end
 
         def register_error_handler(&block)

data/roxml.gemspec

@@ -1,105 +1,44 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
-  s.name = "roxml"
-  s.summary = "Ruby Object to XML mapping library"
-  s.version = "2.3.2"
-  s.homepage = "http://roxml.rubyforge.org"
-  s.platform = Gem::Platform::RUBY
+  s.name = %q{roxml}
+  s.version = "2.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Woosley", "Zak Mandhro", "Anders Engstrom", "Russ Olsen"]
-  s.email = "ben.woosley@gmail.com"
-  s.rubyforge_project = 'roxml'
-  s.files = [
-    'README.rdoc',
-    'MIT-LICENSE',
-    'Rakefile',
-    'roxml.gemspec',
-    'lib/roxml.rb',
-    'lib/roxml/extensions/active_support.rb',
-    'lib/roxml/extensions/array.rb',
-    'lib/roxml/extensions/array/conversions.rb',
-    'lib/roxml/extensions/string.rb',
-    'lib/roxml/extensions/string/conversions.rb',
-    'lib/roxml/extensions/string/iterators.rb',
-    'lib/roxml/extensions/deprecation.rb',
-    'lib/roxml/options.rb',
-    'lib/roxml/xml.rb',
-    'lib/roxml/xml/libxml.rb',
-    'lib/roxml/xml/rexml.rb',
-    'test/fixtures/book_malformed.xml',
-    'test/fixtures/book_pair.xml',
-    'test/fixtures/book_text_with_attribute.xml',
-    'test/fixtures/book_valid.xml',
-    'test/fixtures/book_with_authors.xml',
-    'test/fixtures/book_with_contributions.xml',
-    'test/fixtures/book_with_contributors_attrs.xml',
-    'test/fixtures/book_with_contributors.xml',
-    'test/fixtures/book_with_default_namespace.xml',
-    'test/fixtures/book_with_depth.xml',
-    'test/fixtures/book_with_publisher.xml',
-    'test/fixtures/book_with_wrapped_attr.xml',
-    'test/fixtures/dictionary_of_attrs.xml',
-    'test/fixtures/dictionary_of_attr_name_clashes.xml',
-    'test/fixtures/dictionary_of_guarded_names.xml',
-    'test/fixtures/dictionary_of_mixeds.xml',
-    'test/fixtures/dictionary_of_names.xml',
-    'test/fixtures/dictionary_of_name_clashes.xml',
-    'test/fixtures/dictionary_of_texts.xml',
-    'test/fixtures/library_uppercase.xml',
-    'test/fixtures/library.xml',
-    'test/fixtures/muffins.xml',
-    'test/fixtures/node_with_attr_name_conflicts.xml',
-    'test/fixtures/node_with_name_conflicts.xml',
-    'test/fixtures/nameless_ageless_youth.xml',
-    'test/fixtures/numerology.xml',
-    'test/fixtures/person_with_guarded_mothers.xml',
-    'test/fixtures/person_with_mothers.xml',
-    'test/fixtures/person.xml',
-    'test/mocks/mocks.rb',
-    'test/mocks/dictionaries.rb',
-    'test/release/dependencies_test.rb',
-    'test/test_helper.rb',
-    'test/unit/inheritance_test.rb',
-    'test/unit/options_test.rb',
-    'test/unit/roxml_test.rb',
-    'test/unit/string_test.rb',
-    'test/unit/to_xml_test.rb',
-    'test/unit/xml_attribute_test.rb',
-    'test/unit/xml_block_test.rb',
-    'test/unit/xml_bool_test.rb',
-    'test/unit/xml_construct_test.rb',
-    'test/unit/xml_hash_test.rb',
-    'test/unit/xml_initialize_test.rb',
-    'test/unit/xml_name_test.rb',
-    'test/unit/xml_namespace_test.rb',
-    'test/unit/xml_object_test.rb',
-    'test/unit/xml_required_test.rb',
-    'test/unit/xml_text_test.rb']
-  s.requirements << 'none'
-  s.add_dependency 'extensions', '>= 0.6.0'
-  s.add_dependency 'activesupport', '>= 2.0.0'
-  s.require_path = 'lib'
-  s.test_files = [
-    'test/unit/inheritance_test.rb',
-    'test/unit/options_test.rb',
-    'test/unit/roxml_test.rb',
-    'test/unit/string_test.rb',
-    'test/unit/to_xml_test.rb',
-    'test/unit/xml_attribute_test.rb',
-    'test/unit/xml_block_test.rb',
-    'test/unit/xml_bool_test.rb',
-    'test/unit/xml_construct_test.rb',
-    'test/unit/xml_hash_test.rb',
-    'test/unit/xml_initialize_test.rb',
-    'test/unit/xml_name_test.rb',
-    'test/unit/xml_namespace_test.rb',
-    'test/unit/xml_object_test.rb',
-    'test/unit/xml_required_test.rb',
-    'test/unit/xml_text_test.rb']
+  s.date = %q{2009-01-15}
+  s.description = %q{ROXML is a Ruby library designed to make it easier for Ruby developers to work with XML. Using simple annotations, it enables Ruby classes to be mapped to XML. ROXML takes care of the marshalling and unmarshalling of mapped attributes so that developers can focus on building first-class Ruby classes. As a result, ROXML simplifies the development of RESTful applications, Web Services, and XML-RPC.}
+  s.email = %q{ben.woosley@gmail.com}
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "TODO", "html/index.html", "html/style.css", "lib/roxml.rb", "lib/roxml/extensions/active_support.rb", "lib/roxml/extensions/array.rb", "lib/roxml/extensions/array/conversions.rb", "lib/roxml/extensions/deprecation.rb", "lib/roxml/extensions/string.rb", "lib/roxml/extensions/string/conversions.rb", "lib/roxml/extensions/string/iterators.rb", "lib/roxml/options.rb", "lib/roxml/xml.rb", "lib/roxml/xml/libxml.rb", "lib/roxml/xml/rexml.rb", "roxml.gemspec", "tasks/test.rake", "test/bugs/rexml_bugs.rb", "test/fixtures/book_malformed.xml", "test/fixtures/book_pair.xml", "test/fixtures/book_text_with_attribute.xml", "test/fixtures/book_valid.xml", "test/fixtures/book_with_authors.xml", "test/fixtures/book_with_contributions.xml", "test/fixtures/book_with_contributors.xml", "test/fixtures/book_with_contributors_attrs.xml", "test/fixtures/book_with_default_namespace.xml", "test/fixtures/book_with_depth.xml", "test/fixtures/book_with_octal_pages.xml", "test/fixtures/book_with_publisher.xml", "test/fixtures/book_with_wrapped_attr.xml", "test/fixtures/dictionary_of_attr_name_clashes.xml", "test/fixtures/dictionary_of_attrs.xml", "test/fixtures/dictionary_of_guarded_names.xml", "test/fixtures/dictionary_of_mixeds.xml", "test/fixtures/dictionary_of_name_clashes.xml", "test/fixtures/dictionary_of_names.xml", "test/fixtures/dictionary_of_texts.xml", "test/fixtures/library.xml", "test/fixtures/library_uppercase.xml", "test/fixtures/muffins.xml", "test/fixtures/nameless_ageless_youth.xml", "test/fixtures/node_with_attr_name_conflicts.xml", "test/fixtures/node_with_name_conflicts.xml", "test/fixtures/numerology.xml", "test/fixtures/person.xml", "test/fixtures/person_with_guarded_mothers.xml", "test/fixtures/person_with_mothers.xml", "test/mocks/dictionaries.rb", "test/mocks/mocks.rb", "test/release/dependencies_test.rb", "test/test_helper.rb", "test/unit/array_test.rb", "test/unit/freeze_test.rb", "test/unit/inheritance_test.rb", "test/unit/options_test.rb", "test/unit/overriden_output_test.rb", "test/unit/roxml_test.rb", "test/unit/string_test.rb", "test/unit/to_xml_test.rb", "test/unit/xml_attribute_test.rb", "test/unit/xml_block_test.rb", "test/unit/xml_bool_test.rb", "test/unit/xml_construct_test.rb", "test/unit/xml_convention_test.rb", "test/unit/xml_hash_test.rb", "test/unit/xml_initialize_test.rb", "test/unit/xml_name_test.rb", "test/unit/xml_namespace_test.rb", "test/unit/xml_object_test.rb", "test/unit/xml_required_test.rb", "test/unit/xml_text_test.rb", "vendor/override_rake_task/README", "vendor/override_rake_task/init.rb", "vendor/override_rake_task/install.rb", "vendor/override_rake_task/lib/override_rake_task.rb"]
   s.has_rdoc = true
-  s.description = <<EOF
-ROXML is a Ruby library designed to make it easier for Ruby developers to work with XML.
-Using simple annotations, it enables Ruby classes to be mapped to XML. ROXML takes care
-of the marshalling and unmarshalling of mapped attributes so that developers can focus on
-building first-class Ruby classes. As a result, ROXML simplifies the development of
-RESTful applications, Web Services, and XML-RPC.
-EOF
+  s.homepage = %q{http://roxml.rubyforge.org}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ROXML}
+  s.rubygems_version = %q{1.3.1.xported}
+  s.summary = %q{Ruby Object to XML mapping library}
+  s.test_files = ["test/unit/freeze_test.rb", "test/unit/array_test.rb", "test/unit/xml_convention_test.rb", "test/unit/xml_object_test.rb", "test/unit/xml_required_test.rb", "test/unit/xml_bool_test.rb", "test/unit/roxml_test.rb", "test/unit/xml_name_test.rb", "test/unit/xml_construct_test.rb", "test/unit/options_test.rb", "test/unit/string_test.rb", "test/unit/xml_namespace_test.rb", "test/unit/xml_text_test.rb", "test/unit/overriden_output_test.rb", "test/unit/xml_block_test.rb", "test/unit/xml_attribute_test.rb", "test/unit/inheritance_test.rb", "test/unit/xml_initialize_test.rb", "test/unit/xml_hash_test.rb", "test/unit/to_xml_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_runtime_dependency(%q<extensions>, [">= 0.6.0"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_dependency(%q<extensions>, [">= 0.6.0"])
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+    s.add_dependency(%q<extensions>, [">= 0.6.0"])
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
 end

data/tasks/test.rake

@@ -0,0 +1,42 @@
+# We need to override hoe's test task in order to support separate REXML & LibXML testing
+require  File.join(File.dirname(__FILE__), '../vendor/override_rake_task/lib/override_rake_task')
+
+Rake::TestTask.new(:bugs) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/bugs/*_bugs.rb']
+  t.verbose = true
+end
+
+remove_task :test
+desc "Test ROXML using the default parser selection behavior"
+task :test do
+  module ROXML
+    SILENCE_XML_NAME_WARNING = true
+  end
+  require 'lib/roxml'
+  require 'rake/runtest'
+  Rake.run_tests $hoe.test_globs
+end
+
+namespace :test do
+  desc "Test ROXML under the LibXML parser"
+  task :libxml do
+    module ROXML
+      XML_PARSER = 'libxml'
+    end
+    Rake::Task["test"].invoke
+  end
+
+  desc "Test ROXML under the REXML parser"
+  task :rexml do
+    module ROXML
+      XML_PARSER = 'rexml'
+    end
+    Rake::Task["test"].invoke
+  end
+
+  desc "Runs tests under RCOV"
+  task :rcov do
+    system "rcov -T --no-html -x '^/'  #{FileList[$hoe.test_globs]}"
+  end
+end

data/test/bugs/rexml_bugs.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class RexmlBugs < Test::Unit::TestCase
+  def test_that_some_illegal_chars_are_parsed_without_complaint
+    p "REXML ignores illegal ']]>' brackets in xml content"
+    assert_nothing_raised do
+      # The right angle bracket (>) may be represented using the string "&gt;", and MUST, for compatibility,
+      # be escaped using either "&gt;" or a character reference when it appears in the string "]]>" in content,
+      # when that string is not marking the end of a CDATA section.
+      # - http://www.w3.org/TR/xml11/#syntax
+      xml = "<title>The Big Book of ]]> everything more</title>"
+      assert_equal xml, REXML::Document.new(xml).to_s
+    end
+  end
+end

data/test/fixtures/book_with_octal_pages.xml

@@ -0,0 +1,4 @@
+<bookwithoctalpages>
+  <pages_with_to_xml_proc>0357</pages_with_to_xml_proc>
+  <pages_with_type>0357</pages_with_type>
+</bookwithoctalpages>

data/test/mocks/mocks.rb

@@ -105,10 +105,6 @@ class BookWithDepth
   xml_reader :depth, Measurement
 end
 
-class InheritedBookWithDepth < Book
-  xml_reader :depth, Measurement
-end
-
 class Author
   include ROXML
 

data/test/test_helper.rb

@@ -34,7 +34,7 @@ def remove_children(xml)
   xml = ROXML::XML::Parser.parse(xml).root if xml.is_a?(String)
   return unless xml.respond_to? :children
   xml.children.each do |child|
-    if child.blank?
+    if child.to_s.blank?
       child.remove!
     else
       remove_children(child)

data/test/unit/array_test.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class TestXmlArray < Test::Unit::TestCase
+  def test_as_array_with_auto_guard
+    result = BookWithContributors.from_xml(%{
+      <book isbn="0974514055">
+        <contributors>
+          <contributor role="author"><name>David Thomas</name></contributor>
+          <contributor role="supporting author"><name>Andrew Hunt</name></contributor>
+          <contributor role="supporting author"><name>Chad Fowler</name></contributor>
+        </contributors>
+      </book>
+    }).contributors.map(&:name).sort
+    assert_equal ["David Thomas","Andrew Hunt","Chad Fowler"].sort, result
+  end
+end

data/test/unit/freeze_test.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class DescriptionReadonly
+  include ROXML
+
+  xml_reader :writable, :content
+  xml_reader :readonly, :content, :frozen => true
+end
+
+class BookWithContributionsReadonly
+  include ROXML
+
+  xml_name :book
+  xml_reader :isbn, :attr, :frozen => true
+  xml_reader :title, :frozen => true
+  xml_reader :description, DescriptionReadonly, :frozen => true
+  xml_reader :contributions, [Contributor], :from => 'contributor', :in => "contributions", :frozen => true
+end
+
+class DictionaryOfGuardedNamesReadonly
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, {:key => :name,
+                            :value => :content}, :in => :definitions, :frozen => true
+end
+
+class TestFreeze < Test::Unit::TestCase
+  def setup
+    @writable = BookWithContributions.from_xml(fixture(:book_with_contributions))
+    @readonly = BookWithContributionsReadonly.from_xml(fixture(:book_with_contributions))
+    @dict_readonly = DictionaryOfGuardedNamesReadonly.from_xml(fixture(:dictionary_of_guarded_names))
+  end
+
+  def test_attr_is_unmodifiable
+    assert !@writable.isbn.frozen?
+    assert @readonly.isbn.frozen?
+  end
+
+  def test_text_is_unmodifiable
+    assert !@writable.title.frozen?
+    assert @readonly.title.frozen?
+  end
+
+  def test_objects_are_unmodifiable
+    assert @readonly.description.frozen?
+  end
+
+  def test_indirect_attrs_can_be_frozen_or_not
+    assert @readonly.description.readonly.frozen?
+    assert !@readonly.description.writable.frozen?
+  end
+
+  def test_arrays_are_unmodifiable
+    assert !@writable.contributions.frozen?
+    assert @readonly.contributions.frozen?
+  end
+
+  def test_array_elements_are_unmodifiable
+    assert @readonly.contributions.all?(&:frozen?)
+  end
+
+  def test_hashes_are_unmodifiable
+    assert @dict_readonly.definitions.frozen?
+  end
+
+  def test_hash_keys_and_values_are_unmodifiable
+    assert @dict_readonly.definitions.keys.all?(&:frozen?)
+    assert @dict_readonly.definitions.values.all?(&:frozen?)
+  end
+end

data/test/unit/inheritance_test.rb

@@ -1,11 +1,25 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
+class InheritedBookWithDepth < Book
+  xml_reader :depth, Measurement
+end
+
 class TestInheritance < Test::Unit::TestCase
   def setup
-    @b = InheritedBookWithDepth.from_xml(fixture(:book_with_depth))
+    @book_xml = %{
+      <book ISBN="0201710897">
+        <title>The PickAxe</title>
+        <description><![CDATA[Probably the best Ruby book out there]]></description>
+        <author>David Thomas, Andrew Hunt, Dave Thomas</author>
+        <depth units="hundredths-meters">1130</depth>
+        <publisher>Pragmattic Programmers</publisher>
+      </book>
+    }
+
+    @b = InheritedBookWithDepth.from_xml(@book_xml)
   end
 
-  def test_inherited_object_should_include_parents_attributes
+  def test_it_should_include_parents_attributes
     assert_equal '0201710897', @b.isbn
     assert_equal 'The PickAxe', @b.title
     assert_equal 'Probably the best Ruby book out there', @b.description
@@ -13,7 +27,16 @@ class TestInheritance < Test::Unit::TestCase
     assert_equal 0, @b.pages
   end
 
-  def test_inherited_object_should_include_its_own_attributes
+  def test_it_should_include_its_own_attributes
     assert_equal '11.3 meters', @b.depth.to_s
   end
+
+  def test_it_should_include_parent_attributes_added_after_the_childs_definition
+    Book.class_eval do
+      xml_reader :publisher, :require => true
+    end
+
+    book = InheritedBookWithDepth.from_xml(@book_xml)
+    assert_equal "Pragmattic Programmers", book.publisher
+  end
 end

data/test/unit/options_test.rb

@@ -1,6 +1,13 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
 class TestOptions < Test::Unit::TestCase
+  def assert_hash(opts, kvp)
+    assert opts.hash?
+    assert !opts.array?
+    assert_equal kvp, {opts.hash.key.type => opts.hash.key.name,
+                       opts.hash.value.type => opts.hash.value.name}
+  end
+
   def test_text_in_array_means_as_array_for_text
     opts = ROXML::Opts.new(:authors, [:text])
     assert opts.array?
@@ -33,44 +40,38 @@ class TestOptions < Test::Unit::TestCase
     assert_raise ArgumentError do
       ROXML::Opts.new(:author, :content, :required => true, :else => 'Johnny')
     end
-    ROXML::Opts.new(:author, :content, :required => false, :else => 'Johnny')
+    assert_nothing_raised do
+      ROXML::Opts.new(:author, :content, :required => false, :else => 'Johnny')
+    end
   end
 
   def test_hash_of_attrs
     opts = ROXML::Opts.new(:attributes, {:attrs => [:name, :value]})
-    assert opts.hash?
-    assert !opts.array?
-    assert_equal [ROXML::XMLAttributeRef, ROXML::XMLAttributeRef], opts.hash.types
-    assert_equal ['name', 'value'], opts.hash.names
+    assert_hash(opts, :attr => 'name', :attr => 'value')
   end
 
   def test_hash_with_attr_key_and_text_val
     opts = ROXML::Opts.new(:attributes, {:key => {:attr => :name},
                                          :value => :value})
-    assert opts.hash?
-    assert !opts.array?
-    assert_equal [ROXML::XMLAttributeRef, ROXML::XMLTextRef], opts.hash.types
-    assert_equal ['name', 'value'], opts.hash.names
+    assert_hash(opts, :attr => 'name', :text => 'value')
+  end
+
+  def test_hash_with_string_class_for_type
+    opts = ROXML::Opts.new(:attributes, {:key => {String => 'name'},
+                                         :value => {String => 'value'}})
+    assert_hash(opts, :text => 'name', :text => 'value')
   end
 
   def test_hash_with_attr_key_and_content_val
     opts = ROXML::Opts.new(:attributes, {:key => {:attr => :name},
                                          :value => :content})
-    assert opts.hash?
-    assert !opts.array?
-    assert opts.hash.value.content?
-    assert_equal [ROXML::XMLAttributeRef, ROXML::XMLTextRef], opts.hash.types
-    assert_equal ['name', ''], opts.hash.names
+    assert_hash(opts, :attr => 'name', :content => '')
   end
 
   def test_hash_with_options
     opts = ROXML::Opts.new(:definitions, {:attrs => [:dt, :dd]},
                            :in => :definitions)
-
-    assert opts.hash?
-    assert !opts.array?
-    assert_equal [ROXML::XMLAttributeRef, ROXML::XMLAttributeRef], opts.hash.types
-    assert_equal ['dt', 'dd'], opts.hash.names
+    assert_hash(opts, :attr => 'dt', :attr => 'dd')
   end
 
   def test_no_block_shorthand_means_no_block