ROXML 3.0.0

data/test/unit/xml_namespace_test.rb

@@ -0,0 +1,31 @@
+require 'test/test_helper'
+
+class TestDefaultXMLNamespaces < ActiveSupport::TestCase
+  def setup
+    @book = BookWithContributions.from_xml(fixture(:book_with_default_namespace))
+  end
+
+  def test_default_namespace_doesnt_interfere_with_normal_operation
+    assert_equal("Programming Ruby - 2nd Edition", @book.title)
+  end
+
+  def test_default_namespace_is_applied_to_in_element
+    expected_authors = ["David Thomas","Andrew Hunt","Chad Fowler"]
+    assert !@book.contributions.empty?
+    @book.contributions.each do |contributor|
+      assert expected_authors.include?(contributor.name)
+    end
+  end
+
+  def test_default_namespace_on_root_node_should_be_found
+    require 'libxml'
+    xml = LibXML::XML::Parser.string(
+      '<container xmlns="http://defaultnamespace.org"><node>Yeah, content</node><node><subnode>Another</subnode></node></container>').parse
+
+    assert_equal nil, xml.find_first('node')
+    assert_equal "Yeah, content", xml.find_first('ns:node', 'ns:http://defaultnamespace.org').content
+    assert_equal nil, xml.find_first('ns:node/subnode', 'ns:http://defaultnamespace.org')
+    assert_equal "Another", xml.find_first('ns:node/ns:subnode', 'ns:http://defaultnamespace.org').content
+  rescue LoadError
+  end
+end

data/test/unit/xml_object_test.rb

@@ -0,0 +1,207 @@
+require 'test/test_helper'
+
+class EmptyCart
+  include ROXML
+
+  xml_reader :id
+
+  def empty?
+    true
+  end
+end
+
+class CartHolder
+  include ROXML
+
+  xml_reader :cart, :as => EmptyCart, :required => true
+end
+
+class TestXMLObject < ActiveSupport::TestCase
+  # Test book with text and attribute
+  def test_book_author_text_attribute
+    book = BookWithAuthorTextAttribute.from_xml(fixture(:book_text_with_attribute))
+    assert_equal("primary",book.author.role)
+    assert_equal("David Thomas",book.author.text)
+  end
+
+  # Test XML object containing list of other XML objects (one-to-many)
+  # In this case, book with contibutions
+  def test_one_to_many_with_container
+    expected_authors = ["David Thomas","Andrew Hunt","Chad Fowler"]
+    book = BookWithContributions.from_xml(fixture(:book_with_contributions))
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    book.contributions.each do |contributor|
+      assert expected_authors.include?(contributor.name)
+    end
+  end
+
+  # Test XML object containing 1-n other XML objects without container (one-to-many)
+  # In this case, book with contibutions
+  def test_one_to_many_without_container
+    expected_contributors = ["David Thomas","Andrew Hunt","Chad Fowler"]
+    book = BookWithContributors.from_xml(fixture(:book_with_contributors))
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    book.contributors.each do |contributor|
+      assert(expected_contributors.include?(contributor.name))
+    end
+  end
+
+  # when building objects that contain arrays, the second object seems to
+  # inherit data from the first
+  #
+  def test_one_to_many_without_container_sequence
+    contrib = WriteableContributor.new
+    contrib.name = "David Thomas"
+
+    book_one = WriteableBookWithContributors.new
+    book_one.isbn = "9781843549161"
+    book_one.title = "Anathem"
+    book_one.description = "A new title from Neal Stephenson"
+    book_one.contributors = [contrib]
+
+    # this book should be completely empty
+    book_two = WriteableBookWithContributors.new
+
+    assert_equal(nil, book_two.isbn)
+    assert_equal(nil, book_two.title)
+    assert_equal(nil, book_two.description)
+    assert_equal(nil, book_two.contributors)
+  end
+
+  # Test XML object containing one other XML object (one-to-one)
+  # In this case, book with publisher
+  def test_one_to_one
+    book = BookWithPublisher.from_xml(fixture(:book_with_publisher))
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    assert_equal("Pragmatic Bookshelf", book.publisher.name)
+  end
+
+  # Test XML object containing type of self (self-reference)
+  def test_self_reference
+    book = BookPair.from_xml(fixture(:book_pair))
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    assert_equal("Agile Web Development with Rails", book.book.title)
+  end
+
+  # Test three-level composition (one-to-many-to-many)
+  def test_one_to_many_to_many
+    expected_contributors = ["David Thomas","Andrew Hunt","Chad Fowler", "David Heinemeier Hansson"]
+    expected_books = ["Programming Ruby - 2nd Edition", "Agile Web Development with Rails"]
+    library = Library.from_xml(fixture(:library))
+    assert_equal("Ruby library", library.name)
+    assert !library.books.empty?
+    library.books.each do |book|
+      assert expected_books.include?(book.title)
+      book.contributions.each do |contributor|
+        assert(expected_contributors.include?(contributor.name))
+      end
+    end
+  end
+
+  def test_without_needed_from
+    assert_equal [], UppercaseLibrary.from_xml(fixture(:library)).books
+    assert_equal [], Library.from_xml(fixture(:library_uppercase)).books
+  end
+
+  def test_with_needed_from
+    assert Library.from_xml(fixture(:library)).books
+    assert UppercaseLibrary.from_xml(fixture(:library_uppercase)).books
+  end
+
+  def test_with_recursion
+    p = PersonWithMother.from_xml(fixture(:person_with_mothers))
+    assert_equal 'Ben Franklin', p.name
+    assert_equal 'Abiah Folger', p.mother.name
+    assert_equal 'Madeup Mother', p.mother.mother.name
+    assert_equal nil, p.mother.mother.mother
+  end
+
+  class Node
+    include ROXML
+
+    xml_reader :name, :from => 'node_name'
+    xml_reader :nodes, :as => [Node]
+  end
+
+  class Taxonomy
+    include ROXML
+
+    xml_reader :name, :from => 'taxonomy_name'
+    xml_reader :nodes, :as => [Node]
+  end
+
+  class Taxonomies
+    include ROXML
+    xml_reader :taxonomies, :as => [Taxonomy]
+  end
+
+  def test_more_recursion
+    # quiet the error handler
+    ROXML::XML::Error.reset_handler if ROXML::XML::Error.respond_to?(:reset_handler)
+    taxonomies = Taxonomies.from_xml(<<HERE)
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE taxonomies SYSTEM "taxonomy.dtd">
+<taxonomies>
+	<taxonomy>
+		<taxonomy_name>World</taxonomy_name>
+		<node node_id="2" content_object_id="82534" object_type_id="2">
+			<node_name lang_iso="eng">Africa</node_name>
+			<node node_id="331" content_object_id="11" object_type_id="4">
+				<node_name lang_iso="eng">Algeria</node_name>
+				<node node_id="7271" content_object_id="117629" object_type_id="8">
+					<node_name lang_iso="eng">Algiers</node_name>
+				</node>
+				<node node_id="7272" content_object_id="117630" object_type_id="8">
+					<node_name lang_iso="eng">Gharda&#239;a</node_name>
+				</node>
+				<node node_id="7871" content_object_id="1000713999" object_type_id="8">
+					<node_name lang_iso="eng">El Oued</node_name>
+				</node>
+				<node node_id="7872" content_object_id="1000714008" object_type_id="8">
+					<node_name lang_iso="eng">Timimoun</node_name>
+				</node>
+				<node node_id="8903" content_object_id="1000565565" object_type_id="8">
+					<node_name lang_iso="eng">Annaba</node_name>
+				</node>
+			</node>
+		</node>
+	</taxonomy>
+</taxonomies>
+HERE
+    assert_equal 1, taxonomies.taxonomies.size
+    assert_equal 'World', taxonomies.taxonomies.first.name
+    node = taxonomies.taxonomies.first.nodes.first
+    assert_equal 'Africa', node.name
+    assert_equal 'Algeria', node.nodes.first.name
+    assert_equal ['Algiers', "Gharda\303\257a", 'El Oued', 'Timimoun', 'Annaba'],
+      node.nodes.first.nodes.map(&:name)
+  end
+
+  def test_with_guarded_recursion
+    p = PersonWithGuardedMother.from_xml(fixture(:person_with_guarded_mothers))
+    assert_equal 'Ben "Benji" Franklin', p.name
+    assert_equal 'Abiah \'Abby\' Folger', p.mother.name
+    assert_equal 'Madeup Mother < the third >', p.mother.mother.name
+    assert_equal nil, p.mother.mother.mother
+  end
+
+  def test_recursive_with_default_initialization
+    p = PersonWithMotherOrMissing.from_xml(fixture(:person_with_mothers))
+    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/test/unit/xml_required_test.rb

@@ -0,0 +1,94 @@
+require 'test/test_helper'
+
+class TestXMLRequired < ActiveSupport::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

data/test/unit/xml_text_test.rb

@@ -0,0 +1,71 @@
+require 'test/test_helper'
+
+class TestXMLText < ActiveSupport::TestCase
+  # Test a simple mapping with no composition
+  def test_valid_simple
+    book = Book.from_xml(fixture(:book_valid))
+    assert_equal("The PickAxe", book.title)
+    assert_equal("David Thomas, Andrew Hunt & Dave Thomas", book.author)
+
+    assert_equal xml_fixture(:book_valid).to_s.gsub("\n", ''), book.to_xml.to_s.gsub("\n", '')
+  end
+
+  def test_without_needed_from
+    assert !Library.from_xml(fixture(:library_uppercase)).name
+  end
+
+  def test_with_needed_from
+    assert_equal "Ruby library", Library.from_xml(fixture(:library)).name
+    assert_equal "Ruby library", UppercaseLibrary.from_xml(fixture(:library_uppercase)).name
+  end
+
+  def test_as_array
+    assert_equal ["David Thomas","Andrew Hunt","Dave Thomas"].sort,
+                 BookWithAuthors.from_xml(fixture(:book_with_authors)).authors.sort
+  end
+
+  def test_empty_array_result_returned_properly
+    empty_array = Class.new do
+      include ROXML
+
+      xml_reader :missing_array, :as => [], :from => 'missing'
+    end
+
+    obj = empty_array.from_xml('<empty_array></empty_array>')
+    assert_equal [], obj.missing_array
+  end
+
+  def test_text_modification
+    person = Person.from_xml(fixture(:person))
+    assert_equal("Ben Franklin", person.name)
+    person.name = "Fred"
+    xml=person.to_xml.to_s
+    assert(/Fred/=~xml)
+  end
+
+  def test_default_initialization
+    person = PersonWithMotherOrMissing.from_xml(fixture(:nameless_ageless_youth))
+    assert_equal "Anonymous", person.name
+  end
+
+  def test_default_initialization_of_content
+    person = Person.from_xml(fixture(:nameless_ageless_youth))
+    assert_equal "Unknown", person.name
+  end
+
+  def test_recursive_with_default_initialization
+    p = PersonWithMotherOrMissing.from_xml(fixture(:person_with_mothers))
+    assert_equal 'Unknown', p.mother.mother.mother.name
+  end
+
+  def test_get_with_block
+    p = Book.from_xml(fixture(:book_valid))
+    assert_equal 357, p.pages
+  end
+
+  def test_no_name_clashes
+    n = NodeWithNameConflicts.from_xml(fixture(:node_with_name_conflicts))
+    assert_equal "Just junk... really", n.content
+    assert_equal "Cartwheel", n.name
+  end
+end

data/website/index.html

@@ -0,0 +1,98 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+
+	<title>Empact/roxml @ GitHub</title>
+	
+	<style type="text/css">
+		body {
+  		margin-top: 1.0em;
+  		background-color: #baafdb;
+		  font-family: "helvetica"; 
+  		color: #000000;
+    }
+    #container {
+      margin: 0 auto;
+      width: 700px;
+    }
+		h1 { font-size: 3.8em; color: #455024; margin-bottom: 3px; }
+		h1 .small { font-size: 0.4em; }
+		h1 a { text-decoration: none }
+		h2 { font-size: 1.5em; color: #455024; }
+    h3 { text-align: center; color: #455024; }
+    a { color: #455024; }
+    .description { font-size: 1.2em; margin-bottom: 30px; margin-top: 30px; font-style: italic;}
+    .download { float: right; }
+		pre { background: #000; color: #fff; padding: 15px;}
+    hr { border: 0; width: 80%; border-bottom: 1px solid #aaa}
+    .footer { text-align:center; padding-top:30px; font-style: italic; }
+	</style>
+	
+</head>
+
+<body>
+  <a href="http://github.com/Empact/roxml"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
+  
+  <div id="container">
+
+    <div class="download">
+      <a href="http://github.com/Empact/roxml/zipball/master">
+        <img border="0" width="90" src="http://github.com/images/modules/download/zip.png"></a>
+      <a href="http://github.com/Empact/roxml/tarball/master">
+        <img border="0" width="90" src="http://github.com/images/modules/download/tar.png"></a>
+    </div>
+      
+    <h1><a href="http://github.com/Empact/roxml">roxml</a> 
+      <span class="small">by <a href="http://github.com/Empact">Empact</a></small></h1>
+
+    <div class="description">
+      ROXML is a module for binding Ruby classes to XML. It supports custom mapping and bidirectional marshaling between Ruby and XML using annotation-style class methods. ROXML supports the Nokogiri and LibXML XML processors.
+    </div>
+
+    <p>We may not want to work with XML, but we don't always get to pick just how our data comes.  If you do need to do serious work with XML, ROXML is here to make it nice.
+
+Use xpath-based xml declarations to map an XML response into an extensible object, use that object, and then ouput it back to xml as it came.
+
+Aside from the basics, ROXML has a lot of little goodies to make these definitions minimal and readable, which are worth digging in for.  See the 'xml_convention' method for easily referencing xml which uses other naming conventions.  See the handling of '?' in accessor names, the application of blocks and such for other manipulations.
+
+And finally, if you use this library, feel free to push code back my way.  I'll be looking forward to it.</p><h2>Dependencies</h2>
+<p>activesupport >= 2.1.0</p>
+<h2>Install</h2>
+<p>'gem install roxml' will install the latest stable <a href="http://rubyforge.org/frs/?group_id=305">rubyforge version</a></p>
+<h2>License</h2>
+<p>MIT License</p>
+<h2>Authors</h2>
+<p>Ben Woosley (ben.woosley@gmail.com)
+<br/>Anders Engström (anders.engstrom@gnejs.net)
+<br/>James Thompson (james@plainprograms.com)
+<br/>James Healy (jimmy@deefa.com)
+<br/>Zak Mandhro (mandhro@yahoo.com)
+<br/>Russ Olsen (russell.olsen@gmail.com)</p>
+<h2>Contact</h2>
+<p>Ben Woosley (Ben.Woosley@gmail.com)
+<br/>      </p>
+
+
+    <h2>Download</h2>
+    <p>
+      You can download this project in either
+      <a href="http://github.com/Empact/roxml/zipball/master">zip</a> or
+      <a href="http://github.com/Empact/roxml/tarball/master">tar</a> formats.
+    </p>
+    <p>You can also clone the project with <a href="http://git-scm.com">Git</a>
+      by running:
+      <pre>$ git clone git://github.com/Empact/roxml</pre>
+    </p>
+      
+    <div class="footer">
+      get the source code on GitHub : <a href="http://github.com/Empact/roxml">Empact/roxml</a>
+    </div>
+    
+  </div>
+
+  
+</body>
+</html>