Empact-roxml 2.3.0 → 2.3.1

data/lib/roxml/extensions/active_support.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'active_support/core_ext/symbol'
 require 'active_support/core_ext/blank'
 require 'active_support/core_ext/duplicable'
 require 'active_support/core_ext/array/extract_options'
@@ -10,6 +11,7 @@ require 'active_support/inflector'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/string/starts_ends_with'
 
+require 'extensions/enumerable'
 require 'extensions/array'
 
 class Module

data/roxml.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "roxml"
   s.summary = "Ruby Object to XML mapping library"
-  s.version = "2.3.0"
+  s.version = "2.3.1"
   s.homepage = "http://roxml.rubyforge.org"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Ben Woosley", "Zak Mandhro", "Anders Engstrom", "Russ Olsen"]
@@ -45,41 +45,54 @@ Gem::Specification.new do |s|
     '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.has_rdoc = true
   s.description = <<EOF

data/test/fixtures/muffins.xml

@@ -0,0 +1,3 @@
+<muffins>
+  <bakers_dozens>3</bakers_dozens>
+</muffins>

data/test/fixtures/numerology.xml

@@ -0,0 +1,4 @@
+<numerology>
+  <prediction number="13" meaning="A bad number" />
+  <prediction number="7"  meaning="A good number" />
+</numerology>

data/test/release/dependencies_test.rb

@@ -0,0 +1,32 @@
+require 'test/unit'
+
+class TestDependencies < Test::Unit::TestCase
+  def assert_dependency_included(*args)
+    # assert methods are removed
+    args.each do |type, method, source|
+      type.send(:remove_method, method) if type.instance_methods.include?(method.to_s)
+      assert !type.instance_methods.include?(method.to_s)
+    end
+
+    load File.join(File.dirname(__FILE__), '../../lib/roxml.rb')
+
+    # assert_instance_methods returned to their rightful positions
+    args.each do |type, method, source|
+      assert type.instance_methods.include?(method.to_s)
+    end
+
+    #assert ROXML has what it needs
+    assert_nothing_raised do
+      Class.new do
+        include ROXML
+
+        xml_reader :deps
+      end
+    end
+  end
+
+  def test_symbol_to_proc_is_added_by_roxml
+    assert_dependency_included([Symbol, :to_proc, 'active_support/core_ext/symbol.rb'],
+                               [Enumerable, :one?, 'extensions/enumerable.rb'])
+  end
+end

data/test/unit/inheritance_test.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class TestInheritance < Test::Unit::TestCase
+  def setup
+    @b = InheritedBookWithDepth.from_xml(fixture(:book_with_depth))
+  end
+
+  def test_inherited_object_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
+    assert_equal 'David Thomas, Andrew Hunt, Dave Thomas', @b.author
+    assert_equal 0, @b.pages
+  end
+
+  def test_inherited_object_should_include_its_own_attributes
+    assert_equal '11.3 meters', @b.depth.to_s
+  end
+end

data/test/unit/xml_block_test.rb

@@ -0,0 +1,81 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class ArrayWithBlockShorthand
+  include ROXML
+
+  xml_reader :array, [:text], :from => 'number', :as => Integer
+end
+
+class ArrayWithBlock
+  include ROXML
+
+  xml_reader :array, [:text], :from => 'number' do |arr|
+    arr.map(&:to_i).reverse
+  end
+end
+
+class TestXMLBlocks < Test::Unit::TestCase
+  def test_block_is_applied
+    muffins = Muffins.from_xml(fixture(:muffins))
+
+    assert muffins.count > 0
+    assert_equal 0, muffins.count % 13
+  end
+
+  def test_block_is_applied_to_hash
+    numerology = Numerology.from_xml(fixture(:numerology))
+
+    assert !numerology.predictions.keys.empty?
+    assert numerology.predictions.keys.all? {|k| k.is_a? Integer }
+    assert numerology.predictions.values.all? {|k| k.is_a? String }
+  end
+
+  def test_stacked_blocks_are_applied
+    muffins = MuffinsWithStackedBlocks.from_xml(fixture(:muffins))
+
+    assert muffins.count > 0
+    assert_equal 0, muffins.count % 13
+  end
+
+  def test_block_shorthand_applied_properly_to_array
+    obj = ArrayWithBlockShorthand.from_xml(%{
+      <array_with_block_shorthand>
+        <number>1</number>
+        <number>2</number>
+        <number>3</number>
+      </array_with_block_shorthand>
+    })
+
+    assert_equal [1, 2, 3], obj.array
+  end
+
+  def test_block_applied_properly_to_array
+    obj = ArrayWithBlock.from_xml(%{
+      <array_with_block>
+        <number>1</number>
+        <number>2</number>
+        <number>3</number>
+      </array_with_block>
+    })
+
+    assert_equal [3, 2, 1], obj.array
+  end
+
+  def test_block_shorthand_applied_properly_to_empty_array
+    obj = ArrayWithBlockShorthand.from_xml(%{
+      <array_with_block_shorthand>
+      </array_with_block_shorthand>
+    })
+
+    assert_equal [], obj.array
+  end
+
+  def test_block_applied_properly_to_empty_array
+    obj = ArrayWithBlock.from_xml(%{
+      <array_with_block>
+      </array_with_block>
+    })
+
+    assert_equal [], obj.array
+  end
+end

data/test/unit/xml_bool_test.rb

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class XmlBool
+  include ROXML
+
+  xml_reader :true_from_TRUE?
+  xml_reader :false_from_FALSE?, :text => 'text_for_FALSE'
+  xml_reader :true_from_one?, :attr => 'attr_for_one'
+  xml_reader :false_from_zero?, :text => 'text_for_zero', :in => 'container'
+  xml_reader :true_from_True?, :attr => 'attr_for_True', :in => 'container'
+  xml_reader :false_from_False?, :text => 'false_from_cdata_False', :as => :cdata
+  xml_reader :true_from_true?
+  xml_reader :false_from_false?
+  xml_reader :missing?
+end
+
+class XmlBoolRequired
+  include ROXML
+
+  xml_reader :required?, :required => true
+end
+
+class XmlBoolUnexpected
+  include ROXML
+
+  xml_reader :unexpected?
+end
+
+class XmlBoolUnexpectedWithBlock
+  include ROXML
+
+  xml_reader :unexpected? do |val|
+    val
+  end
+end
+
+class TestXMLBool < Test::Unit::TestCase
+  def setup
+    @bool_xml = %{
+      <xml_bool attr_for_one="1">
+        <true_from_TRUE>TRUE</true_from_TRUE>
+        <text_for_FALSE>FALSE</text_for_FALSE>
+        <container attr_for_True="True">
+          <text_for_zero>0</text_for_zero>
+        </container>
+        <false_from_cdata_False><![CDATA[False]]></false_from_cdata_False>
+        <true_from_true>true</true_from_true>
+        <false_from_false>false</false_from_false>
+        <present_and_required>true</present_and_required>
+      </xml_bool>
+    }
+    @present = %{
+      <xml_bool_required>
+        <required>true</required>
+      </xml_bool_required>
+    }
+    @absent = %{
+      <xml_bool_required>
+      </xml_bool_required>
+    }
+    @unexpected_value_xml = %{
+      <xml_bool_unexpected>
+        <unexpected>Unexpected Value</unexpected>
+      </xml_bool_unexpected>
+    }
+  end
+
+  def test_bool_results_for_various_inputs
+    x = XmlBool.from_xml(@bool_xml)
+    assert_equal true, x.true_from_TRUE?
+    assert_equal false, x.false_from_FALSE?
+    assert_equal true, x.true_from_one?
+    assert_equal false, x.false_from_zero?
+    assert_equal true, x.true_from_True?
+    assert_equal false, x.false_from_False?
+    assert_equal true, x.true_from_true?
+    assert_equal false, x.false_from_false?
+  end
+
+  def test_missing_results_in_nil
+    x = XmlBool.from_xml(@bool_xml)
+    assert_equal nil, x.missing?
+  end
+
+  def test_unexpected_value_results_in_nil
+    x = XmlBoolUnexpected.from_xml(@unexpected_value_xml)
+    assert_equal nil, x.unexpected?
+  end
+
+  def test_block_recieves_unexpected_value_rather_than_nil
+    x = XmlBoolUnexpectedWithBlock.from_xml(@unexpected_value_xml)
+    assert_equal "Unexpected Value", x.unexpected?
+  end
+
+  def test_required_raises_on_missing
+    assert_nothing_raised do
+      XmlBoolRequired.from_xml(@present)
+    end
+
+    assert_raises(ROXML::RequiredElementMissing) do
+      XmlBoolRequired.from_xml(@absent)
+    end
+  end
+end

data/test/unit/xml_initialize_test.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class BookWithXmlInitialize < BookWithDepth
+  attr_reader :created_at, :creator
+
+  def initialize(created_at, creator = "Unknown")
+    @created_at = created_at
+    @creator = creator
+  end
+  alias_method :xml_initialize, :initialize
+end
+
+class TestXMLInitialize < Test::Unit::TestCase
+  def test_xml_construct_not_in_use
+    assert Measurement.xml_construction_args_without_deprecation.empty?
+  end
+
+  def test_initialize_is_run
+    m = Measurement.from_xml('<measurement units="hundredths-meters">1130</measurement>')
+    assert_equal 11.3, m.value
+    assert_equal 'meters', m.units
+  end
+
+  def test_initialize_is_run_for_nested_type
+    b = BookWithDepth.from_xml(fixture(:book_with_depth))
+    assert_equal Measurement.new(11.3, 'meters'), b.depth
+  end
+
+  def test_initialize_is_run_for_nested_type_with_inheritance
+    b = InheritedBookWithDepth.from_xml(fixture(:book_with_depth))
+    assert_equal Measurement.new(11.3, 'meters'), b.depth
+  end
+
+  def test_initialize_fails_on_missing_required_arg
+    assert_raises(ArgumentError) do
+      b = BookWithXmlInitialize.from_xml(fixture(:book_with_depth))
+    end
+  end
+
+  def test_initialize_with_extra_args
+    now = Time.now
+    b = BookWithXmlInitialize.from_xml(fixture(:book_with_depth), now)
+    assert_equal now, b.created_at
+    assert_equal "Unknown", b.creator
+
+    b = BookWithXmlInitialize.from_xml(fixture(:book_with_depth), Time.now, "Joe Librarian")
+    assert now < b.created_at
+    assert_equal "Joe Librarian", b.creator
+  end
+end

data/test/unit/xml_required_test.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class TestXMLRequired < Test::Unit::TestCase
+  def setup
+    @full_book = <<BOOK
+  <book ISBN="1234">
+    <title>This &amp; that</title>
+    <contributor_array>
+      <contributor role="Author">
+        <name>Johnny</name>
+      </contributor>
+    </contributor_array>
+    <contributor_hash>
+      <contributor role="Author" name="Johnny" />
+    </contributor_hash>
+  </book>
+BOOK
+
+    @book_missing_attr = <<BOOK
+  <book>
+    <title>This &amp; that</title>
+    <contributor_array>
+      <contributor role="Author">
+        <name>Johnny</name>
+      </contributor>
+    </contributor_array>
+    <contributor_hash>
+      <contributor role="Author" name="Johnny" />
+    </contributor_hash>
+  </book>
+BOOK
+
+    @book_missing_text = <<BOOK
+  <book ISBN="1234">
+    <contributor_array>
+      <contributor role="Author">
+        <name>Johnny</name>
+      </contributor>
+    </contributor_array>
+    <contributor_hash>
+      <contributor role="Author" name="Johnny" />
+    </contributor_hash>
+  </book>
+BOOK
+
+    @book_missing_array = <<BOOK
+  <book ISBN="1234">
+    <title>This &amp; that</title>
+    <contributor_hash>
+      <contributor role="Author" name="Johnny" />
+    </contributor_hash>
+  </book>
+BOOK
+
+    @book_missing_hash = <<BOOK
+  <book ISBN="1234">
+    <title>This &amp; that</title>
+    <contributor_array>
+      <contributor role="Author">
+        <name>Johnny</name>
+      </contributor>
+    </contributor_array>
+  </book>
+BOOK
+  end
+
+  def test_required_passes_on_prescence
+    BookWithRequired.from_xml(@full_book)
+  end
+
+  def test_required_throws_on_attr_absence
+    assert_raise ROXML::RequiredElementMissing do
+      BookWithRequired.from_xml(@book_missing_attr)
    end
+  end
+
+  def test_required_throws_on_text_absence
+    assert_raise ROXML::RequiredElementMissing do
+      BookWithRequired.from_xml(@book_missing_text)
+    end
+  end
+
+  def test_required_throws_on_array_absence
+    assert_raise ROXML::RequiredElementMissing do
+      BookWithRequired.from_xml(@book_missing_array)
+    end
+  end
+
+  def test_required_throws_on_hash_absence
+    assert_raise ROXML::RequiredElementMissing do
+      BookWithRequired.from_xml(@book_missing_hash)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Empact-roxml
 version: !ruby/object:Gem::Version 
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors: 
 - Ben Woosley
@@ -79,25 +79,33 @@ files:
 - 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
 has_rdoc: true
 homepage: http://roxml.rubyforge.org
@@ -126,14 +134,19 @@ signing_key:
 specification_version: 2
 summary: Ruby Object to XML mapping library
 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