roxml 2.3.2 → 2.4.0

data/test/unit/overriden_output_test.rb

@@ -0,0 +1,33 @@
+class OctalInteger
+  def self.from_xml(val)
+    new(Integer(val.content))
+  end
+
+  def initialize(value)
+    @val = value
+  end
+
+  def ==(other)
+    @val == other
+  end
+
+  def to_xml
+    sprintf("%#o", @val)
+  end
+end
+
+class BookWithOctalPages
+  include ROXML
+
+  xml_accessor :pages_with_to_xml_proc, :as => Integer, :to_xml => proc {|val| sprintf("%#o", val) }, :required => true
+  xml_accessor :pages_with_type, OctalInteger, :required => true
+end
+
+class TestToXmlWithOverriddenOutput < Test::Unit::TestCase
+  to_xml_test :book_with_octal_pages
+  def test_padded_numbers_read_properly
+    b = BookWithOctalPages.from_xml(fixture(:book_with_octal_pages))
+    assert_equal 239, b.pages_with_type
+    assert_equal 239, b.pages_with_to_xml_proc
+  end
+end

data/test/unit/roxml_test.rb

@@ -21,4 +21,11 @@ class TestROXML < Test::Unit::TestCase
       end
     end
   end
+
+  def test_tag_refs_is_deprecated
+    assert_deprecated do
+      Class.new do
+        include ROXML
      end.tag_refs
+    end
+  end
 end

data/test/unit/xml_bool_test.rb

@@ -1,16 +1,22 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
+PROC_TRUE = proc {|val| val ? 'TRUE' : 'FALSE'}
+PROC_True = proc {|val| val ? 'True' : 'False'}
+PROC_true = proc {|val| val.to_s}
+PROC_1    = proc {|val| val ? 1 : 0}
+
 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_name 'xml_bool'
+  xml_reader :true_from_TRUE?, :to_xml => PROC_TRUE
+  xml_reader :false_from_FALSE?, :text => 'text_for_FALSE', :to_xml => PROC_TRUE
+  xml_reader :true_from_one?, :attr => 'attr_for_one', :to_xml => PROC_1
+  xml_reader :false_from_zero?, :text => 'text_for_zero', :in => 'container', :to_xml => PROC_1
+  xml_reader :true_from_True?, :attr => 'attr_for_True', :in => 'container', :to_xml => PROC_True
+  xml_reader :false_from_False?, :text => 'false_from_cdata_False', :as => :cdata, :to_xml => PROC_True
+  xml_reader :true_from_true?, :to_xml => PROC_true
+  xml_reader :false_from_false?, :to_xml => PROC_true
   xml_reader :missing?
 end
 
@@ -44,7 +50,6 @@ BOOL_XML = %{
     <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 = %{
@@ -96,10 +101,10 @@ class TestXMLBool < Test::Unit::TestCase
       XmlBoolRequired.from_xml(PRESENT)
     end
 
-    assert_raises(ROXML::RequiredElementMissing) do
+    assert_raise ROXML::RequiredElementMissing do
       XmlBoolRequired.from_xml(ABSENT)
     end
   end
 
-#  to_xml_test XmlBool => BOOL_XML
+  to_xml_test XmlBool => BOOL_XML
 end

data/test/unit/xml_convention_test.rb

@@ -0,0 +1,150 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+XML_CAMELLOWER = %{
+  <bookCase name="Jonas' Books">
+    <bookCount>12</bookCount>
+    <bigBooks>
+      <bigBook>GED</bigBook>
+      <bigBook>House of Leaves</bigBook>
+    </bigBooks>
+  </bookCase>
+}
+
+XML_CAMELCASE = %{
+  <BookCase Name="Jonas' Books">
+    <BookCount>12</BookCount>
+    <BigBooks>
+      <BigBook>GED</BigBook>
+      <BigBook>House of Leaves</BigBook>
+    </BigBooks>
+  </BookCase>
+}
+
+XML_UNDERSCORE = %{
+  <book_case name="Jonas' Books">
+    <book_count>12</book_count>
+    <big_books>
+      <big_book>GED</big_book>
+      <big_book>House of Leaves</big_book>
+    </big_books>
+  </book_case>
+}
+
+XML_DASHES = %{
+  <book-case name="Jonas' Books">
+    <book-count>12</book-count>
+    <big-books>
+      <big-book>GED</big-book>
+      <big-book>House of Leaves</big-book>
+    </big-books>
+  </book-case>
+}
+
+XML_UPCASE = %{
+  <BOOKCASE NAME="Jonas' Books">
+    <BOOKCOUNT>12</BOOKCOUNT>
+    <BIGBOOKS>
+      <BIGBOOK>GED</BIGBOOK>
+      <BIGBOOK>House of Leaves</BIGBOOK>
+    </BIGBOOKS>
+  </BOOKCASE>
+}
+
+class BookCase
+  include ROXML
+
+  xml_reader :book_count, :as => Integer, :required => true
+  xml_reader :big_books, [:text], :required => true
+end
+
+class BookCaseCamelCase < BookCase
+  xml_convention :camelcase
+end
+
+class BookCaseUnderScore < BookCase
+  xml_convention :underscore
+end
+
+class BookCaseDashes < BookCase
+  xml_convention &:dasherize
+end
+
+class BookCaseCamelLower < BookCase
+  xml_convention {|val| val.camelcase(:lower) }
+end
+
+class BookCaseUpCase < BookCase
+  xml_convention {|val| val.gsub('_', '').upcase }
+end
+
+class InheritedBookCaseCamelCase < BookCaseCamelCase
+end
+
+class InheritedBookCaseUpCase < BookCaseUpCase
+end
+
+# Same as BookCase.  Needed to keep BookCase clean for other tests
+class ParentBookCaseDefault
+  include ROXML
+
+  xml_reader :book_count, :as => Integer, :required => true
+  xml_reader :big_books, [:text], :required => true
+end
+
+class InheritedBookCaseDefault < ParentBookCaseDefault
+end
+
+class TestXMLConstruct < Test::Unit::TestCase
+  # TODO: Test convention applies to xml_name as well...
+
+  def test_default_convention_is_underscore
+    bc = BookCase.from_xml(XML_UNDERSCORE)
+    assert_has_book_case_info(bc)
+  end
+
+  [BookCaseUpCase, BookCaseCamelLower, BookCaseDashes, BookCaseUnderScore, BookCaseCamelCase].each do |klass|
+    define_method(:"test_xml_convention_#{klass.to_s.underscore}") do
+      data = :"XML_#{klass.to_s.sub('BookCase', '').upcase}"
+      assert_equal Proc, klass.roxml_naming_convention.class
+
+      bc = klass.from_xml(Object.const_get(data))
+      assert_has_book_case_info(bc)
+    end
+  end
+
+  def test_child_should_inherit_convention_if_it_doesnt_declare_one
+    [InheritedBookCaseUpCase, InheritedBookCaseCamelCase].each do |klass|
+      data = :"XML_#{klass.to_s.sub('InheritedBookCase', '').upcase}"
+      assert_equal Proc, klass.roxml_naming_convention.class
+
+      bc = klass.from_xml(Object.const_get(data))
+      assert_has_book_case_info(bc)
+    end
+  end
+
+  def test_child_should_inherit_convention_even_if_it_is_added_after_child_declaration
+    bc = InheritedBookCaseDefault.from_xml(XML_UNDERSCORE)
+    assert_has_book_case_info(bc)
+
+    ParentBookCaseDefault.class_eval do
+      xml_convention :dasherize
+    end
+
+    bc = InheritedBookCaseDefault.from_xml(XML_DASHES)
+    assert_has_book_case_info(bc)
+    assert_raise ROXML::RequiredElementMissing do
+      InheritedBookCaseDefault.from_xml(XML_UNDERSCORE)
+    end
+  end
+
+  def test_tag_name_should_get_convention_treatment_as_well
+    assert_equal "book-case-dashes", BookCaseDashes.tag_name
+    assert_equal "INHERITEDBOOKCASEUPCASE", InheritedBookCaseUpCase.tag_name
+    assert_equal "InheritedBookCaseCamelCase", InheritedBookCaseCamelCase.tag_name
+  end
+
+  def assert_has_book_case_info(bc)
+    assert_equal 12, bc.book_count
+    assert_equal ['GED', 'House of Leaves'], bc.big_books
+  end
+end

data/test/unit/xml_hash_test.rb

@@ -1,11 +1,52 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
+class BookWithContributorHash
+  include ROXML
+
+  xml_reader :contributors, {:key => {:attr => 'role'},
+                             :value => 'name'}
+end
+
 class TestXMLHash < Test::Unit::TestCase
   def setup
     @contents = {'quaquaversally' => 'adjective: (of a geological formation) sloping downward from the center in all directions.',
                  'tergiversate' => 'To use evasions or ambiguities; equivocate.'}
   end
 
+  def test_hash_preserves_data
+    b = BookWithContributorHash.from_xml(%{
+      <book isbn="0974514055">
+        <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>
+      </book>
+    })
+    assert_equal({'author' => 'David Thomas', 'supporting author' => ['Andrew Hunt', 'Chad Fowler']},
+      b.contributors)
+  end
+
+  def test_hash_with_object_key_fails
+    assert_raise ArgumentError do
+      Class.new do
+        include ROXML
+
+        xml_reader :object_key_to_text, {:key => BookWithContributorHash,
+                                         :value => 'text_node'}
+      end
+    end
+  end
+
+  def test_hash_with_object_value_fails
+    assert_raise ArgumentError do
+      Class.new do
+        include ROXML
+
+        xml_reader :key_to_object_value, {:key => {:attr => 'text_node'},
+                                          :value => BookWithContributorHash}
+      end
+    end
+  end
+
   def test_attrs_hash
     dict = DictionaryOfAttrs.from_xml(fixture(:dictionary_of_attrs))
     assert_equal Hash, dict.definitions.class

data/test/unit/xml_name_test.rb

@@ -75,6 +75,16 @@ class TestXMLName < Test::Unit::TestCase
     assert_equal "<parent><child_accessor_name/></parent>", parent.to_xml.to_s.gsub(/[\n ]/, '')
   end
 
+  def test_it_should_be_inherited
+    class_with_inherited_name = Class.new(ParentOfNamedChild)
+    assert_equal :parent, class_with_inherited_name.tag_name
+  end
+
+  def test_it_should_be_inherited_over_multiple_levels
+    class_with_inherited_name = Class.new(Class.new(ParentOfNamedChild))
+    assert_equal :parent, class_with_inherited_name.tag_name
+  end
+
   def test_named_books_picked_up
     named = Library.from_xml(fixture(:library))
     assert named.books
@@ -95,14 +105,27 @@ class TestXMLName < Test::Unit::TestCase
   end
 
   def test_tag_refs
-    assert_equal 'definition', DictionaryOfTexts.tag_refs.only.name
-    assert_equal 'word', DictionaryOfTexts.tag_refs.only.hash.key.name
-    assert_equal 'meaning', DictionaryOfTexts.tag_refs.only.hash.value.name
+    assert_equal 'definition', DictionaryOfTexts.tag_refs_without_deprecation.only.name
+    assert_equal 'word', DictionaryOfTexts.tag_refs_without_deprecation.only.hash.key.name
+    assert_equal 'meaning', DictionaryOfTexts.tag_refs_without_deprecation.only.hash.value.name
 
     dict = DictionaryOfTexts.from_xml(fixture(:dictionary_of_texts))
 
-    assert_equal 'definition', dict.tag_refs.only.name
-    assert_equal 'word', dict.tag_refs.only.hash.key.name
-    assert_equal 'meaning', dict.tag_refs.only.hash.value.name
+    assert_equal 'definition', dict.tag_refs_without_deprecation.only.name
+    assert_equal 'word', dict.tag_refs_without_deprecation.only.hash.key.name
+    assert_equal 'meaning', dict.tag_refs_without_deprecation.only.hash.value.name
+  end
+
+  def test_roxml_attrs
+    assert_equal 'definition', DictionaryOfTexts.roxml_attrs.only.name
+    assert_equal 'word', DictionaryOfTexts.roxml_attrs.only.hash.key.name
+    assert_equal 'meaning', DictionaryOfTexts.roxml_attrs.only.hash.value.name
+  end
+
+  def test_xml_name_query_is_deprecated
+    # This query should go when the XML_NAME_WARNING stuff goes
+    assert_deprecated do
+      NamedChild.xml_name?
+    end
   end
 end

data/test/unit/xml_object_test.rb

@@ -1,5 +1,21 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
+class EmptyCart
+  include ROXML
+
+  xml_reader :id
+
+  def empty?
+    true
+  end
+end
+
+class CartHolder
+  include ROXML
+
+  xml_reader :cart, EmptyCart, :required => true
+end
+
 class TestXMLObject < Test::Unit::TestCase
   # Test book with text and attribute
   def test_book_author_text_attribute
@@ -113,4 +129,18 @@ class TestXMLObject < Test::Unit::TestCase
     assert_equal 'Unknown', p.mother.mother.mother.name
     assert_equal Person, p.mother.mother.mother.class
   end
+
+  def test_defining_empty_on_object_doesnt_cause_it_to_be_seen_as_absent
+    # absent means defaulting, failing required
+
+    holder = CartHolder.from_xml(%{
+      <cartholder>
+        <cart>
+          <id>111111</id>
+        </cart>
+      </cartholder>
+    })
+
+    assert_equal "111111", holder.cart.id
+  end
 end

data/vendor/override_rake_task/README

@@ -0,0 +1,30 @@
+OverrideRakeTask plugin by Eugene Bolshakov, eugene.bolshakov@gmail.com, http://www.taknado.com
+
+This plugin is based on the Matthew Bass's idea described here:
+http://matthewbass.com/2007/03/07/overriding-existing-rake-tasks/
+
+The installation script is based on the one found in the app_config plugin
+by Daniel Owsianski, http://jarmark.org/projects/app-config/
+
+When using rake with rails it loads the task in the following order:
+
+1. Default rails tasks (like db:migrate)
+2. The tasks in your app's lib/tasks directory
+3. The tasks in your vendor/plugins directory
+
+This plugin will allow to override rake tasks that were defined earlier. It means that 
+you'll be able to override default rails tasks with lib/tasks & plugins tasks and 
+override the taksks in lib/tasks with the tasks defined in plugins.
+
+In order to override a task you need to define it as usual, but using "override_task" 
+method instead of "task":
+
+namespace :db do
+	override_task :migrate do
+		...
+	end
+end
+
+In order to make this work the plugin should be loaded before the tasks and the install script
+supplied with the plugin adds a line to load itself to the Rakefile. If it won't be able to 
+modify your Rakefile, it will let you know and you'll have to modify it manually.

data/vendor/override_rake_task/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/vendor/override_rake_task/install.rb

@@ -0,0 +1,46 @@
+# Insert line: [require "#{RAILS_ROOT}/vendor/plugins/override_rake_task/lib/override_rake_task.rb"]
+# before "require 'rake'" in Rakefile
+# stolen from app_confing plugin :) http://jarmark.org/projects/app-config/ 
+
+file = File.join(File.dirname(__FILE__), '../../../Rakefile')
+unless File.exists?(file)
+    STDERR.puts("ERROR: Could not locate Rakefile") 
+    exit(1)
+end
+
+# Tip from http://pleac.sourceforge.net/pleac_ruby/fileaccess.html
+# 'Modifying a File in Place Without a Temporary File'
+output= ""
+inserted = false
+line_to_insert = %q{require "#{RAILS_ROOT}/vendor/plugins/override_rake_task/lib/override_rake_task.rb"}
+line_to_find = "require 'rake'"
+
+File.open(file, 'r+') do |f|   # open file for update
+    # read into array of lines and iterate through lines
+    f.readlines.each do |line| 
+        unless inserted 
+            if line.gsub(/#.*/, '').include?(line_to_insert)
+                inserted = true
+            elsif line.gsub(/#.*/, '').include?(line_to_find)
+                output << line_to_insert
+                output << "\n\n"
+                inserted = true
+            end
+        end     
+        output << line
+    end
+    f.pos = 0                     # back to start
+    f.print output                # write out modified lines
+    f.truncate(f.pos)             # truncate to new length
+end   
+
+unless inserted
+    STDERR.puts <<END 
+ERROR: Could not update Rakefile
+To finish installation please add the following line to 
+Rakefile manually: 
+\t#{line_to_insert}
+NOTE: line must be inserted before #{line_to_find}
+END
+    exit(1)
+end