representable 0.0.1.alpha1

data/spec/xml/parser_spec.rb

@@ -0,0 +1,21 @@
+require_relative './../spec_helper.rb'
+
+describe ROXML::XML do
+  it "should raise on malformed xml" do
+    if ROXML::XML_PARSER == 'libxml' # nokogiri is less strict and auto-closes for some reason
+      proc { Book.from_xml(fixture(:book_malformed)) }.should raise_error(LibXML::XML::Error)
+    end
+  end
+
+  it "should escape invalid characters on output to text node" do
+    node = ROXML::XML.new_node("entities")
+    ROXML::XML.set_content(node, " < > ' \" & ")
+    node.to_s.should == "<entities> &lt; &gt; ' \" &amp; </entities>"
+  end
+
+  it "should esape invalid characters for attribute name" do
+    node = ROXML::XML.new_node("attr_holder")
+    ROXML::XML.set_attribute(node, "entities", "\"'<>&")
+    node.to_s.should == %{<attr_holder entities="&quot;'&lt;&gt;&amp;"/>}
+  end
+end

data/spec/xml/text_spec.rb

@@ -0,0 +1,71 @@
+require_relative './../spec_helper'
+
+describe ROXML::XMLTextRef do
+  before do
+    @xml = ROXML::XML.parse_string %(
+<myxml>
+  <node>
+    <name>first</name>
+    <name>second</name>
+    <name>third</name>
+  </node>
+</myxml>)
+  end
+
+  context "plain vanilla" do
+    before do
+      @ref = ROXML::XMLTextRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => false), RoxmlObject.new)
+    end
+
+    it "should return one instance" do
+      @ref.value_in(@xml).should == "first"
+    end
+    it "should output one instance"
+  end
+  
+  context "with :as => []" do
+    before do
+      @ref = ROXML::XMLTextRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true), RoxmlObject.new)
+    end
+
+    it "should collect all instances" do
+      @ref.value_in(@xml).should == ["first", "second", "third"]
+    end
+
+    it "should output all instances" do
+      xml = ROXML::XML.new_node('myxml')
+      @ref.update_xml(xml, ["first", "second", "third"])
+      xml.to_s.squeeze(' ').should == @xml.root.to_s.squeeze(' ')
+    end
+  end
+  
+  context "when the namespaces are different" do
+    before do
+      @xml = ROXML::XML.parse_string %(
+      <myxml xmlns="http://example.com/three" xmlns:one="http://example.com/one" xmlns:two="http://example.com/two">
+        <node>
+          <one:name>first</one:name>
+          <two:name>second</two:name>
+          <name>third</name>
+        </node>
+      </myxml>)
+    end
+
+    context "with :namespace => '*'" do
+      before do
+        @ref = ROXML::XMLTextRef.new(OpenStruct.new(:name => 'name', :wrapper => 'node', :array? => true, :namespace => '*'), RoxmlObject.new)
+      end
+
+      it "should collect all instances" do
+        @ref.value_in(@xml).should == ["first", "second", "third"]
+      end
+
+      it "should output all instances with namespaces" do
+        pending "Full namespace write support"
+        xml = ROXML::XML.new_node('myxml')
+        @ref.update_xml(xml, ["first", "second", "third"])
+        xml.should == @xml.root
+      end
+    end
+  end
+end

data/test/fixtures/book_malformed.xml

@@ -0,0 +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>
+</book>

data/test/fixtures/book_pair.xml

@@ -0,0 +1,8 @@
+<book isbn="0974514055">
+  <title>Programming Ruby - 2nd Edition</title>
+  <description>Second edition of the great book out there</description>
+	<book isbn="0974514055">
+	  <title>Agile Web Development with Rails</title>
+	  <description>Jolt winning original Ruby on Rails book</description>
+	</book>
+</book>

data/test/fixtures/book_text_with_attribute.xml

@@ -0,0 +1,5 @@
+<book ISBN="0201710897">
+  <title>The PickAxe</title>
+  <description><![CDATA[Probably the best Ruby book out there]]></description>
+  <author role="primary">David Thomas</author>
+</book>

data/test/fixtures/book_valid.xml

@@ -0,0 +1,5 @@
+<book ISBN="0201710897">
+  <title>The PickAxe</title>
+  <description><![CDATA[Probably the best Ruby book out there]]></description>
+  <author>David Thomas, Andrew Hunt &amp; Dave Thomas</author>
+  <pagecount>357</pagecount></book>

data/test/fixtures/book_with_authors.xml

@@ -0,0 +1,7 @@
+<book ISBN="0201710897">
+  <title>The PickAxe</title>
+  <description><![CDATA[Probably the best Ruby book out there]]></description>
+  <author>David Thomas</author>
+  <author>Andrew Hunt</author>
+  <author>Dave Thomas</author>
+</book>

data/test/fixtures/book_with_contributions.xml

@@ -0,0 +1,9 @@
+<book isbn="0974514055">
+  <title>Programming Ruby - 2nd Edition</title>
+  <description>Second edition of the great book out there</description>
+  <contributions>
+  	<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>
+  </contributions>
+</book>

data/test/fixtures/book_with_contributors.xml

@@ -0,0 +1,7 @@
+<book isbn="0974514055">
+  <title>Programming Ruby - 2nd Edition</title>
+  <description>Second edition of the great book out there</description>
+  	<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>

data/test/fixtures/book_with_contributors_attrs.xml

@@ -0,0 +1,7 @@
+<book isbn="0974514055">
+  <title>Programming Ruby - 2nd Edition</title>
+  <description>Second edition of the great book out there</description>
+  	<contributor role="author" name="David Thomas" />
+  	<contributor role="supporting author" name="Andrew Hunt" />
+  	<contributor role="supporting author" name="Chad Fowler" />
+</book>

data/test/fixtures/book_with_default_namespace.xml

@@ -0,0 +1,9 @@
+<book xmlns="http://booknamespace.org" isbn="0974514055">
+  <title>Programming Ruby - 2nd Edition</title>
+  <description>Second edition of the great book out there</description>
+  <contributions>
+    <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>
+  </contributions>
+</book>

data/test/fixtures/book_with_depth.xml

@@ -0,0 +1,6 @@
+<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>
+</book>

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/fixtures/book_with_publisher.xml

@@ -0,0 +1,7 @@
+<book isbn="0974514055">
+  <title>Programming Ruby - 2nd Edition</title>
+  <description>Second edition of the great book out there</description>
+  <publisher>
+  	<name>Pragmatic Bookshelf</name>
+  </publisher>
+</book>

data/test/fixtures/book_with_wrapped_attr.xml

@@ -0,0 +1,3 @@
+<book>
+  <ids ISBN="0974514055" />
+</book>

data/test/fixtures/dictionary_of_attr_name_clashes.xml

@@ -0,0 +1,8 @@
+<dictionary>
+  <definition name="quaquaversally">
+    <content>adjective: (of a geological formation) sloping downward from the center in all directions.</content>
+  </definition>
+  <definition name="tergiversate">
+    <content>To use evasions or ambiguities; equivocate.</content>
+  </definition>
+</dictionary>

data/test/fixtures/dictionary_of_attrs.xml

@@ -0,0 +1,6 @@
+<dictionary>
+  <definitions>
+    <definition dt="quaquaversally" dd="adjective: (of a geological formation) sloping downward from the center in all directions." />
+    <definition dt="tergiversate" dd="To use evasions or ambiguities; equivocate." />
+  </definitions>
+</dictionary>

data/test/fixtures/dictionary_of_guarded_names.xml

@@ -0,0 +1,6 @@
+<dictionary>
+  <definitions>
+    <quaquaversally>adjective: (of a geological formation) sloping downward from the center in all directions.</quaquaversally>
+    <tergiversate>To use evasions or ambiguities; equivocate.</tergiversate>
+  </definitions>
+</dictionary>

data/test/fixtures/dictionary_of_mixeds.xml

@@ -0,0 +1,4 @@
+<dictionary>
+  <definition word="quaquaversally">adjective: (of a geological formation) sloping downward from the center in all directions.</definition>
+  <definition word="tergiversate">To use evasions or ambiguities; equivocate.</definition>
+</dictionary>

data/test/fixtures/dictionary_of_name_clashes.xml

@@ -0,0 +1,10 @@
+<dictionary>
+  <definition>
+    <name>quaquaversally</name>
+    <content>adjective: (of a geological formation) sloping downward from the center in all directions.</content>
+  </definition>
+  <definition>
+    <name>tergiversate</name>
+    <content>To use evasions or ambiguities; equivocate.</content>
+  </definition>
+</dictionary>

data/test/fixtures/dictionary_of_names.xml

@@ -0,0 +1,4 @@
+<dictionary>
+  <quaquaversally>adjective: (of a geological formation) sloping downward from the center in all directions.</quaquaversally>
+  <tergiversate>To use evasions or ambiguities; equivocate.</tergiversate>
+</dictionary>

data/test/fixtures/dictionary_of_texts.xml

@@ -0,0 +1,10 @@
+<dictionary>
+  <definition>
+    <word>quaquaversally</word>
+    <meaning>adjective: (of a geological formation) sloping downward from the center in all directions.</meaning>
+  </definition>
+  <definition>
+    <word>tergiversate</word>
+    <meaning>To use evasions or ambiguities; equivocate.</meaning>
+  </definition>
+</dictionary>

data/test/fixtures/library.xml

@@ -0,0 +1,30 @@
+<library>
+  <name>Ruby library</name>
+  <book isbn="0974514055">
+    <title>Programming Ruby - 2nd Edition</title>
+    <description>Second edition of the great book out there</description>
+    <contributions>
+      <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>
+    </contributions>
+  </book>
+  <book isbn="0974514055">
+    <title>Agile Web Development with Rails</title>
+    <description>Jolt winning original Ruby on Rails book</description>
+    <contributions>
+      <contributor role="author">
+        <name>David Thomas</name>
+      </contributor>
+      <contributor role="author">
+        <name>David Heinemeier Hansson</name>
+      </contributor>
+    </contributions>
+  </book>
+</library>

data/test/fixtures/library_uppercase.xml

@@ -0,0 +1,30 @@
+<library>
+  <NAME>Ruby library</NAME>
+  <BOOK isbn="0974514055">
+    <title>Programming Ruby - 2nd Edition</title>
+    <description>Second edition of the great book out there</description>
+    <contributions>
+      <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>
+    </contributions>
+  </BOOK>
+  <BOOK isbn="0974514055">
+    <title>Agile Web Development with Rails</title>
+    <description>Jolt winning original Ruby on Rails book</description>
+    <contributions>
+      <contributor role="author">
+        <name>David Thomas</name>
+      </contributor>
+      <contributor role="author">
+        <name>David Heinemeier Hansson</name>
+      </contributor>
+    </contributions>
+  </BOOK>
+</library>

data/test/fixtures/muffins.xml

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

data/test/fixtures/nameless_ageless_youth.xml

@@ -0,0 +1,2 @@
+<person>
+</person>

data/test/fixtures/node_with_attr_name_conflicts.xml

@@ -0,0 +1 @@
+<node content="Just junk... really" name="Cartwheel" />

data/test/fixtures/node_with_name_conflicts.xml

@@ -0,0 +1,4 @@
+<node>
+  <content>Just junk... really</content>
+  <name>Cartwheel</name>
+</node>

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/fixtures/person.xml

@@ -0,0 +1 @@
+<person>Ben Franklin</person>

data/test/fixtures/person_with_guarded_mothers.xml

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

data/test/fixtures/person_with_mothers.xml

@@ -0,0 +1,10 @@
+<person>
+  <name>Ben Franklin</name>
+  <mother>
+    <name>Abiah Folger</name>
+    <mother>
+      <name>Madeup Mother</name>
+    </mother>
+  </mother>
+</person>
+

data/test/mocks/dictionaries.rb

@@ -0,0 +1,57 @@
+require_relative "./../../lib/roxml"
+
+class DictionaryOfAttrs
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => '@dt',
+                                   :value => '@dd'}, :in => :definitions
+end
+
+class DictionaryOfTexts
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => :word,
+                            :value => :meaning}
+end
+
+class DictionaryOfMixeds
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => '@word',
+                            :value => :content}
+end
+
+class DictionaryOfNames
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => :name,
+                            :value => :content}
+end
+
+class DictionaryOfGuardedNames
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => :name,
+                            :value => :content}, :in => :definitions
+end
+
+class DictionaryOfNameClashes
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => 'name',
+                            :value => 'content'}, :from => :definition
+end
+
+class DictionaryOfAttrNameClashes
+  include ROXML
+
+  xml_name :dictionary
+  xml_reader :definitions, :as => {:key => '@name',
+                            :value => 'content'}, :from => :definition
+end

data/test/mocks/mocks.rb

@@ -0,0 +1,279 @@
+require_relative "./../../lib/roxml"
+
+class Muffins
+  include ROXML
+
+  xml_reader(:count, :from => 'bakers_dozens') {|val| val.to_i * 13 }
+end
+
+class MuffinsWithStackedBlocks
+  include ROXML
+
+  xml_reader(:count, :from => 'bakers_dozens', :as => Integer) {|val| val * 13 }
+end
+
+class Numerology
+  include ROXML
+
+  xml_reader :predictions, :as => {:key => '@number', :value => '@meaning'} do |k, v|
+    [Integer(k), v]
+  end
+end
+
+class Contributor
+  include ROXML
+
+  xml_reader :role, :from => :attr
+  xml_reader :name
+end
+
+class WriteableContributor
+  include ROXML
+
+  xml_accessor :role, :from => :attr
+  xml_accessor :name
+end
+
+class Book
+  include ROXML
+
+  xml_accessor :isbn, :from => '@ISBN'
+  xml_reader :title
+  xml_reader :description, :cdata => true
+  xml_reader :author
+  xml_accessor :pages, :from => 'pagecount', :as => Integer
+end
+
+class BookWithRequired
+  include ROXML
+
+  xml_accessor :isbn, :from => '@ISBN', :required => true
+  xml_reader :title, :required => true
+  xml_reader :contributors, :as => [Contributor], :in => 'contributor_array', :required => true
+  xml_reader :contributor_hash, :as => {:key => '@role', :value => '@name'},
+                                :from => 'contributor', :in => 'contributor_hash', :required => true
+end
+
+class BookWithAttrFrom
+  include ROXML
+
+  xml_accessor :isbn, :from => '@ISBN'
+end
+
+class BookWithWrappedAttr
+  include ROXML
+
+  xml_name :book
+  xml_accessor :isbn, :from => '@ISBN', :in => 'ids'
+end
+
+class Measurement
+  include ROXML
+
+  xml_reader :units, :from => :attr
+  xml_reader :value, :from => :content, :as => Float
+
+  def initialize(value = 0, units = 'pixels')
+    @value = Float(value)
+    @units = units.to_s
+    normalize_hundredths
+  end
+
+  def to_s
+    "#{value} #{units}"
+  end
+
+  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, :from => '@ISBN'
+  xml_reader :title
+  xml_reader :description, :cdata => true
+  xml_reader :author
+  xml_reader :depth, :as => Measurement
+end
+
+class Author
+  include ROXML
+
+  xml_reader :role, :from => :attr
+  xml_reader :text, :from => :content
+end
+
+class BookWithAuthors
+  include ROXML
+
+  xml_name :book
+  xml_reader :isbn, :from => '@ISBN'
+  xml_reader :title
+  xml_reader :description, :cdata => true
+  xml_reader :authors, :as => []
+end
+
+class BookWithAuthorTextAttribute
+  include ROXML
+
+  xml_name :book
+  xml_reader :isbn, :from => '@ISBN'
+  xml_reader :title
+  xml_reader :description, :cdata => true
+  xml_reader :author, :as => Author
+end
+
+class BookWithContributions
+  include ROXML
+
+  xml_name :book
+  xml_reader :isbn, :from => :attr
+  xml_reader :title
+  xml_reader :description
+  xml_reader :contributions, :as => [Contributor], :from => 'contributor', :in => "contributions"
+end
+
+class BookWithContributors
+  include ROXML
+
+  xml_name :book
+  xml_reader :isbn, :from => :attr
+  xml_reader :title
+  xml_reader :description
+  xml_reader :contributors, :as => [Contributor]
+end
+
+class WriteableBookWithContributors
+  include ROXML
+
+  xml_name :book
+  xml_accessor :isbn, :from => :attr
+  xml_accessor :title
+  xml_accessor :description
+  xml_accessor :contributors, :as => [Contributor]
+end
+
+class NamelessBook
+  include ROXML
+
+  xml_reader :isbn, :from => :attr
+  xml_reader :title
+  xml_reader :description
+  xml_reader :contributors, :as => [Contributor]
+end
+
+class Publisher
+  include ROXML
+
+  xml_reader :name
+end
+
+class BookWithPublisher
+  include ROXML
+
+  xml_reader :book
+  xml_reader :isbn, :from => :attr
+  xml_reader :title
+  xml_reader :description
+  xml_reader :publisher, :as => Publisher
+end
+
+class BookPair
+  include ROXML
+
+  xml_reader :isbn, :from => :attr
+  xml_reader :title
+  xml_reader :description
+  xml_reader :author
+  xml_reader :book, :as => Book
+end
+
+class Library
+  include ROXML
+
+  xml_reader :name
+  xml_reader :books, :as => [BookWithContributions]
+end
+
+class UppercaseLibrary
+  include ROXML
+
+  xml_name :library
+  xml_reader :name, :from => 'NAME'
+  xml_reader :books, :as => [BookWithContributions], :from => 'BOOK'
+end
+
+class LibraryWithBooksOfUnderivableName
+  include ROXML
+
+  xml_accessor :name
+  xml_reader :novels, :as => [NamelessBook]
+end
+
+class NodeWithNameConflicts
+  include ROXML
+
+  xml_name :node
+  xml_reader :content
+  xml_reader :name
+end
+
+class NodeWithAttrNameConflicts
+  include ROXML
+
+  xml_name :node
+  xml_reader :content, :from => '@content'
+  xml_reader :name, :from => '@name'
+end
+
+class Person
+  include ROXML
+
+  xml_accessor :age, :from => :attr, :else => 21
+  xml_accessor :name, :from => :content, :else => 'Unknown'
+
+  def self.blank
+    new.tap do |instance|
+      instance.age = 21
+      instance.name = 'Unknown'
+    end
+  end
+end
+
+class PersonWithMother
+  include ROXML
+
+  xml_name :person
+  xml_reader :name
+  xml_reader :mother, :as => PersonWithMother, :from => 'mother'
+end
+
+class PersonWithGuardedMother
+  include ROXML
+
+  xml_name :person
+  xml_reader :name
+  xml_reader :mother, :as => PersonWithGuardedMother, :from => :person, :in => :mother
+end
+
+class PersonWithMotherOrMissing
+  include ROXML
+
+  xml_reader :age, :from => :attr, :else => 21
+  xml_reader :name, :else => 'Anonymous'
+  xml_reader :mother,:as => PersonWithMotherOrMissing, :else => Person.blank
+end