roxml 2.4.3 → 2.5.0

data/spec/string_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe String do
+  describe "#to_latin" do
+    it "should be accessible" do
+      "".should respond_to(:to_latin)
+    end
+  end
+
+  describe "#to_utf" do
+    it "should be accessible" do
+      "".should respond_to(:to_utf)
+    end
+  end
+end

data/spec/xml/parser_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe ROXML::XML::Parser do
+  before do
+    # quiet the error handler
+    ROXML::XML::Error.reset_handler
+  end
+  
+  it "should raise on malformed xml" do
+    proc { Book.from_xml(fixture(:book_malformed)) }.should raise_error(ROXML::XML::Error)
+  end
+
+  it "should escape invalid characters on output to text node" do
+    ROXML::XML::Node.new("entities", " < > ' \" & ").to_s.should == "<entities> &lt; &gt; ' \" &amp; </entities>"
+  end
+
+  it "should esape invalid characters for attribute name" do
+    node = ROXML::XML::Node.new("attr_holder")
+    node.attributes["entities"] = "\"'<>&"
+    node.to_s.should == %{<attr_holder entities="&quot;'&lt;&gt;&amp;"/>}
+  end
+end

data/test/fixtures/book_valid.xml

@@ -1,5 +1,5 @@
 <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>
+  <author>David Thomas, Andrew Hunt &amp; Dave Thomas</author>
   <pagecount>357</pagecount></book>

data/test/fixtures/person_with_guarded_mothers.xml

@@ -1,11 +1,11 @@
 <person>
-  <name>Ben Franklin</name>
+  <name>Ben &quot;Benji&quot; Franklin</name>
   <mother>
     <person>
-      <name>Abiah Folger</name>
+      <name>Abiah &apos;Abby&apos; Folger</name>
       <mother>
         <person>
-          <name>Madeup Mother</name>
+          <name>Madeup Mother &lt; the third &gt;</name>
         </person>
       </mother>
     </person>

data/test/mocks/mocks.rb

@@ -23,23 +23,23 @@ end
 class Contributor
   include ROXML
 
-  xml_reader :role, :attr
+  xml_reader :role, :from => :attr
   xml_reader :name
 end
 
 class WriteableContributor
   include ROXML
 
-  xml_accessor :role, :attr
+  xml_accessor :role, :from => :attr
   xml_accessor :name
 end
 
 class Book
   include ROXML
 
-  xml_accessor :isbn, :attr => 'ISBN'
+  xml_accessor :isbn, :from => '@ISBN'
   xml_reader :title
-  xml_reader :description, :as => :cdata
+  xml_reader :description, :cdata => true
   xml_reader :author
   xml_accessor :pages, :text => 'pagecount', :as => Integer
 end
@@ -47,7 +47,7 @@ end
 class BookWithRequired
   include ROXML
 
-  xml_accessor :isbn, :attr => 'ISBN', :required => true
+  xml_accessor :isbn, :from => '@ISBN', :required => true
   xml_reader :title, :required => true
   xml_reader :contributors, [Contributor], :in => 'contributor_array', :required => true
   xml_reader :contributor_hash, {:attrs => ['role', 'name']},
@@ -57,33 +57,26 @@ end
 class BookWithAttrFrom
   include ROXML
 
-  xml_accessor :isbn, :attr, :from => 'ISBN'
+  xml_accessor :isbn, :from => '@ISBN'
 end
 
 class BookWithWrappedAttr
   include ROXML
 
   xml_name :book
-  xml_accessor :isbn, :attr => 'ISBN', :in => 'ids'
+  xml_accessor :isbn, :from => '@ISBN', :in => 'ids'
 end
 
 class Measurement
   include ROXML
 
-  xml_reader :units, :attr
-  xml_reader :value, :content
+  xml_reader :units, :from => :attr
+  xml_reader :value, :from => :content, :as => Float
 
-  def xml_initialize
-    initialize(value, units)
-  end
-
-  def initialize(value, units = 'pixels')
+  def initialize(value = 0, units = 'pixels')
     @value = Float(value)
     @units = units.to_s
-    if @units.starts_with? 'hundredths-'
-      @value /= 100
-      @units = @units.split('hundredths-')[1]
-    end
+    normalize_hundredths
   end
 
   def to_s
@@ -93,14 +86,26 @@ class Measurement
   def ==(other)
     other.units == @units && other.value == @value
   end
+
+private
+  def after_parse
+    normalize_hundredths
+  end
+
+  def normalize_hundredths
+    if @units.starts_with? 'hundredths-'
+      @value /= 100
+      @units = @units.split('hundredths-')[1]
+    end
+  end
 end
 
 class BookWithDepth
   include ROXML
 
-  xml_reader :isbn, :attr => 'ISBN'
+  xml_reader :isbn, :from => '@ISBN'
   xml_reader :title
-  xml_reader :description, :as => :cdata
+  xml_reader :description, :cdata => true
   xml_reader :author
   xml_reader :depth, Measurement
 end
@@ -108,27 +113,27 @@ end
 class Author
   include ROXML
 
-  xml_reader :role, :attr
-  xml_reader :text, :content
+  xml_reader :role, :from => :attr
+  xml_reader :text, :from => :content
 end
 
 class BookWithAuthors
   include ROXML
 
   xml_name :book
-  xml_reader :isbn, :attr, :from => 'ISBN'
+  xml_reader :isbn, :from => '@ISBN'
   xml_reader :title
-  xml_reader :description, :as => :cdata
-  xml_reader :authors, :as => :array
+  xml_reader :description, :cdata => true
+  xml_reader :authors, []
 end
 
 class BookWithAuthorTextAttribute
   include ROXML
 
   xml_name :book
-  xml_reader :isbn, :attr, :from => 'ISBN'
+  xml_reader :isbn, :from => '@ISBN'
   xml_reader :title
-  xml_reader :description, :as => :cdata
+  xml_reader :description, :cdata => true
   xml_reader :author, Author
 end
 
@@ -136,7 +141,7 @@ class BookWithContributions
   include ROXML
 
   xml_name :book
-  xml_reader :isbn, :attr
+  xml_reader :isbn, :from => :attr
   xml_reader :title
   xml_reader :description
   xml_reader :contributions, [Contributor], :from => 'contributor', :in => "contributions"
@@ -146,29 +151,29 @@ class BookWithContributors
   include ROXML
 
   xml_name :book
-  xml_reader :isbn, :attr
+  xml_reader :isbn, :from => :attr
   xml_reader :title
   xml_reader :description
-  xml_reader :contributors, Contributor, :as => :array
+  xml_reader :contributors, [Contributor]
 end
 
 class WriteableBookWithContributors
   include ROXML
 
   xml_name :book
-  xml_accessor :isbn, :attr
+  xml_accessor :isbn, :from => :attr
   xml_accessor :title
   xml_accessor :description
-  xml_accessor :contributors, Contributor, :as => :array
+  xml_accessor :contributors, [Contributor]
 end
 
 class NamelessBook
   include ROXML
 
-  xml_reader :isbn, :attr
+  xml_reader :isbn, :from => :attr
   xml_reader :title
   xml_reader :description
-  xml_reader :contributors, Contributor, :as => :array
+  xml_reader :contributors, [Contributor]
 end
 
 class Publisher
@@ -181,7 +186,7 @@ class BookWithPublisher
   include ROXML
 
   xml_reader :book
-  xml_reader :isbn, :attr
+  xml_reader :isbn, :from => :attr
   xml_reader :title
   xml_reader :description
   xml_reader :publisher, Publisher
@@ -190,7 +195,7 @@ end
 class BookPair
   include ROXML
 
-  xml_reader :isbn, :attr
+  xml_reader :isbn, :from => :attr
   xml_reader :title
   xml_reader :description
   xml_reader :author
@@ -201,7 +206,7 @@ class Library
   include ROXML
 
   xml_reader :name
-  xml_reader :books, BookWithContributions, :as => :array
+  xml_reader :books, [BookWithContributions]
 end
 
 class UppercaseLibrary
@@ -215,8 +220,8 @@ end
 class LibraryWithBooksOfUnderivableName
   include ROXML
 
-  xml_reference true, :name
-  xml_reader :novels, NamelessBook, :as => :array
+  xml_accessor :name
+  xml_reader :novels, [NamelessBook]
 end
 
 class NodeWithNameConflicts
@@ -231,15 +236,22 @@ class NodeWithAttrNameConflicts
   include ROXML
 
   xml_name :node
-  xml_reader :content, :attr => :content
-  xml_reader :name, :attr => :name
+  xml_reader :content, :from => '@content'
+  xml_reader :name, :from => '@name'
 end
 
 class Person
   include ROXML
 
-  xml_reader :age, :attr, :else => 21
-  xml_accessor :name, :content, :else => 'Unknown'
+  xml_accessor :age, :from => :attr, :else => 21
+  xml_accessor :name, :from => :content, :else => 'Unknown'
+
+  def self.blank
+    returning new do |instance|
+      instance.age = 21
+      instance.name = 'Unknown'
+    end
+  end
 end
 
 class PersonWithMother
@@ -261,7 +273,7 @@ end
 class PersonWithMotherOrMissing
   include ROXML
 
-  xml_reader :age, :attr, :else => 21
+  xml_reader :age, :from => :attr, :else => 21
   xml_reader :name, :else => 'Anonymous'
-  xml_reader :mother, PersonWithMotherOrMissing, :else => Person.new
+  xml_reader :mother, PersonWithMotherOrMissing, :else => Person.blank
 end

data/test/unit/definition_test.rb

@@ -14,6 +14,12 @@ class TestDefinition < Test::Unit::TestCase
     assert_equal :text, opts.type
   end
 
+  def test_empty_array_means_as_array_for_text
+    opts = ROXML::Definition.new(:authors, [])
+    assert opts.array?
+    assert_equal :text, opts.type
+  end
+
   def test_attr_in_array_means_as_array_for_attr
     opts = ROXML::Definition.new(:authors, [:attr])
     assert opts.array?
@@ -26,22 +32,31 @@ class TestDefinition < Test::Unit::TestCase
     assert_equal Hash, opts.type
   end
 
-  def test_content_is_a_recognized_type
-    assert ROXML::Definition.new(:author, :content).content?
+  def test_literal_as_array_is_deprecated
+    assert_deprecated do
+      assert ROXML::Definition.new(:authors, :as => :array).array?
+    end
+  end
+
+  def test_block_shorthand_in_array_means_array
+    opts = ROXML::Definition.new(:intarray, :as => [Integer])
+    assert opts.array?
+    assert_equal :text, opts.type
+    assert 1, opts.blocks.size
   end
 
   def test_required
-    assert !ROXML::Definition.new(:author, :content).required?
-    assert ROXML::Definition.new(:author, :content, :required => true).required?
-    assert !ROXML::Definition.new(:author, :content, :required => false).required?
+    assert !ROXML::Definition.new(:author).required?
+    assert ROXML::Definition.new(:author, :required => true).required?
+    assert !ROXML::Definition.new(:author, :required => false).required?
   end
 
   def test_required_conflicts_with_else
     assert_raise ArgumentError do
-      ROXML::Definition.new(:author, :content, :required => true, :else => 'Johnny')
+      ROXML::Definition.new(:author, :required => true, :else => 'Johnny')
     end
     assert_nothing_raised do
-      ROXML::Definition.new(:author, :content, :required => false, :else => 'Johnny')
+      ROXML::Definition.new(:author, :required => false, :else => 'Johnny')
     end
   end
 
@@ -65,19 +80,24 @@ class TestDefinition < Test::Unit::TestCase
   def test_hash_with_attr_key_and_content_val
     opts = ROXML::Definition.new(:attributes, {:key => {:attr => :name},
                                          :value => :content})
-    assert_hash(opts, :attr => 'name', :content => '')
+    assert_hash(opts, :attr => 'name', :text => '.')
   end
 
   def test_hash_with_options
     opts = ROXML::Definition.new(:definitions, {:attrs => [:dt, :dd]},
-                           :in => :definitions)
+                           :in => :definitions, :from => 'definition')
     assert_hash(opts, :attr => 'dt', :attr => 'dd')
+    assert_equal 'definition', opts.hash.wrapper
   end
 
   def test_no_block_shorthand_means_no_block
     assert ROXML::Definition.new(:count).blocks.empty?
-    assert ROXML::Definition.new(:count, :as => :intager).blocks.empty?
-    assert ROXML::Definition.new(:count, :as => :foat).blocks.empty?
+    assert_deprecated do
+      assert ROXML::Definition.new(:count, :as => :intager).blocks.empty?
+    end
+    assert_deprecated do
+      assert ROXML::Definition.new(:count, :as => :foat).blocks.empty?
+    end
   end
 
   def test_block_integer_shorthand
@@ -88,9 +108,23 @@ class TestDefinition < Test::Unit::TestCase
     assert_equal 3.1, ROXML::Definition.new(:count, :as => Float).blocks.first['3.1']
   end
 
+  def test_from_attr_is_supported
+    opts = ROXML::Definition.new(:count, :from => :attr)
+    assert_equal "count", opts.name
+    assert_equal :attr, opts.type
+  end
+
+  def test_from_at_name_is_supported
+    opts = ROXML::Definition.new(:count, :from => "@COUNT")
+    assert_equal "COUNT", opts.name
+    assert_equal :attr, opts.type
+  end
+
   def test_multiple_shorthands_raises
     assert_raise ArgumentError do
-      ROXML::Definition.new(:count, :as => [Float, Integer])
+      assert_deprecated do
+        ROXML::Definition.new(:count, :as => [Float, Integer])
+      end
     end
   end
 
@@ -157,4 +191,119 @@ class TestDefinition < Test::Unit::TestCase
     assert_equal "manufacturer", opts.name
     assert_equal "./", opts.wrapper
   end
+
+  def test_cdata_is_specifiable
+    assert ROXML::Definition.new(:manufacturer, :cdata => true).cdata?
+  end
+
+  def test_as_cdata_is_deprecated
+    assert_deprecated do
+      assert ROXML::Definition.new(:manufacturer, :as => :cdata).cdata?
+    end
+    assert_deprecated do
+      assert ROXML::Definition.new(:manufacturer, :as => [Integer, :cdata]).cdata?
+    end
+  end
+
+  def test_as_supports_generic_roxml_types
+    assert_equal RoxmlObject, ROXML::Definition.new(:type, :as => RoxmlObject).type
+    assert_deprecated do
+      assert_equal RoxmlObject, ROXML::Definition.new(:type, RoxmlObject).type
+    end
+  end
+
+  def test_as_supports_generic_roxml_types_in_arrays
+    assert_equal RoxmlObject, ROXML::Definition.new(:types, :as => [RoxmlObject]).type
+    assert_deprecated do
+      assert_equal RoxmlObject, ROXML::Definition.new(:types, [RoxmlObject]).type
+    end
+  end
+
+  def test_default_works
+    opts = ROXML::Definition.new(:missing, :else => true)
+    assert_equal true, opts.to_ref(RoxmlObject.new).value_in(ROXML::XML::Parser.parse('<xml></xml>'))
+  end
+
+  def test_default_works_for_arrays
+    opts = ROXML::Definition.new(:missing, :as => [])
+    assert_equal [], opts.to_ref(RoxmlObject.new).value_in(ROXML::XML::Parser.parse('<xml></xml>'))
+    assert_deprecated do
+      opts = ROXML::Definition.new(:missing, [])
+      assert_equal [], opts.to_ref(RoxmlObject.new).value_in(ROXML::XML::Parser.parse('<xml></xml>'))
+    end
+    assert_deprecated do
+      opts = ROXML::Definition.new(:missing, :as => :array)
+      assert_equal [], opts.to_ref(RoxmlObject.new).value_in(ROXML::XML::Parser.parse('<xml></xml>'))
+    end
+  end
+
+  def test_default_works_for_recursive_objects
+    opts = ROXML::Definition.new(:missing, :as => RecursiveObject, :else => false)
+    assert_equal false, opts.to_ref(RoxmlObject.new).value_in(ROXML::XML::Parser.parse('<xml></xml>'))
+  end
+
+  def test_content_is_accepted_as_from
+    assert ROXML::Definition.new(:author, :from => :content).content?
+    assert ROXML::Definition.new(:author, :from => '.').content?
+  end
+
+  def test_content_is_a_recognized_type
+    assert_deprecated do
+      opts = ROXML::Definition.new(:author, :content)
+      assert opts.content?
+      assert_equal '.', opts.name
+      assert_equal :text, opts.type
+    end
+  end
+
+  def test_content_symbol_as_target_is_translated_to_string
+    assert_deprecated do
+      opts = ROXML::Definition.new(:content, :attr => :content)
+      assert_equal 'content', opts.name
+      assert_equal :attr, opts.type
+    end
+  end
+
+  def test_attr_is_accepted_as_from
+    assert_equal :attr, ROXML::Definition.new(:author, :from => :attr).type
+    assert_equal :attr, ROXML::Definition.new(:author, :from => '@author').type
+  end
+
+  def test_attr_is_a_recognized_type
+    assert_deprecated do
+      opts = ROXML::Definition.new(:author, :attr)
+      assert_equal 'author', opts.name
+      assert_equal :attr, opts.type
+    end
+  end
+
+  def test_name_ending_with_on_warns_of_coming_date_default
+    assert_deprecated do
+      assert_equal :text, ROXML::Definition.new(:created_at).type
+    end
+  end
+
+  def test_name_ending_with_at_warns_of_coming_datetime_default
+    assert_deprecated do
+      assert_equal :text, ROXML::Definition.new(:created_on).type
+    end
+  end
+end
+
+class RecursiveObject
+  include ROXML
+
+  xml_reader :next, RecursiveObject, :else => true
+end
+
+class RoxmlObject
+  include ROXML
+end
+
+class HashDefinitionTest < Test::Unit::TestCase
+  def test_content_detected_as_from
+    opts = ROXML::Definition.new(:hash, {:key => :content, :value => :name})
+    assert_equal '.', opts.hash.key.name
+    assert_equal :text, opts.hash.key.type
+  end
 end