xml-mapping 0.8.1 → 0.9.1

data/examples/person.intout

@@ -0,0 +1,27 @@
+
+class Person
+  include XML::Mapping
+
+  choice_node :if,    'name',  :then, (text_node :name, 'name'),
+              :elsif, '@name', :then, (text_node :name, '@name'),
+              :else,  (text_node :name, '.')
+end
+
+### usage
+
+p1 = Person.load_from_xml(REXML::Document.new('<person name="Jim"/>').root)
+=> #<Person:0x7f48763d3360 @name="Jim">
+
+p2 = Person.load_from_xml(REXML::Document.new('<person><name>James</name></person>').root)
+=> #<Person:0x7f48763ce900 @name="James">
+
+p3 = Person.load_from_xml(REXML::Document.new('<person>Suzy</person>').root)
+=> #<Person:0x7f48763c99f0 @name="Suzy">
+
+
+p1.save_to_xml.write($stdout)
+<person><name>Jim</name></person>
+p2.save_to_xml.write($stdout)
+<person><name>James</name></person>
+p3.save_to_xml.write($stdout)
+<person><name>Suzy</name></person>

data/examples/person_mm.intin.rb

@@ -0,0 +1,119 @@
+#:invisible:
+$:.unshift "../lib"
+begin
+  Object.send(:remove_const, "Address")  # remove any previous definitions
+  Object.send(:remove_const, "Person")  # remove any previous definitions
+rescue
+end
+#<=
+#:visible:
+require 'xml/mapping'
+
+class Address; end
+
+class Person
+  include XML::Mapping
+
+  # the default mapping. Stores the name and age in XML attributes,
+  # and the address in a sub-element "address".
+
+  text_node :name, "@name"
+  numeric_node :age, "@age"
+  object_node :address, "address", :class=>Address
+
+  use_mapping :other
+
+  # the ":other" mapping. Non-default root element name; name and age
+  # stored in XML elements; address stored in the person's element
+  # itself
+
+  root_element_name "individual"
+  text_node :name, "name"
+  numeric_node :age, "age"
+  object_node :address, ".", :class=>Address
+
+  # you could also specify the mapping on a per-node basis with the
+  # :mapping option, e.g.:
+  #
+  # numeric_node :age, "age", :mapping=>:other
+end
+
+
+class Address
+  include XML::Mapping
+
+  # the default mapping.
+
+  text_node :street, "street"
+  numeric_node :number, "number"
+  text_node :city, "city"
+  numeric_node :zip, "zip"
+
+  use_mapping :other
+
+  # the ":other" mapping.
+
+  text_node :street, "street-name"
+  numeric_node :number, "street-name/@number"
+  text_node :city, "city-name"
+  numeric_node :zip, "city-name/@zip-code"
+end
+
+
+### usage
+
+## XML representation of a person in the default mapping
+xml = REXML::Document.new('
+<person name="Suzy" age="28">
+  <address>
+    <street>Abbey Road</street>
+    <number>72</number>
+    <city>London</city>
+    <zip>18827</zip>
+  </address>
+</person>').root
+
+## load using the default mapping
+p = Person.load_from_xml xml #<=
+
+#:invisible_retval:
+## save using the default mapping
+xml2 = p.save_to_xml
+xml2.write $stdout,2 #<=
+
+## xml2 identical to xml
+
+
+## now, save the same person to XML using the :other mapping...
+other_xml = p.save_to_xml :mapping=>:other
+other_xml.write $stdout,2 #<=
+
+#:visible_retval:
+## load it again using the :other mapping
+p2 = Person.load_from_xml other_xml, :mapping=>:other #<=
+
+#:invisible_retval:
+## p2 identical to p #<=
+
+#:invisible:
+require 'test/unit/assertions'
+include Test::Unit::Assertions
+
+require 'xml/xxpath_methods'
+
+assert_equal "Suzy", p.name
+assert_equal 28, p.age
+assert_equal "Abbey Road", p.address.street
+assert_equal 72, p.address.number
+assert_equal "London", p.address.city
+assert_equal 18827, p.address.zip
+
+assert_equal "individual", other_xml.name
+assert_equal p.name, other_xml.first_xpath("name").text
+assert_equal p.age, other_xml.first_xpath("age").text.to_i
+assert_equal p.address.street, other_xml.first_xpath("street-name").text
+assert_equal p.address.number, other_xml.first_xpath("street-name/@number").text.to_i
+assert_equal p.address.city, other_xml.first_xpath("city-name").text
+assert_equal p.address.zip, other_xml.first_xpath("city-name/@zip-code").text.to_i
+
+#<=

data/examples/person_mm.intout

@@ -0,0 +1,114 @@
+require 'xml/mapping'
+
+class Address; end
+
+class Person
+  include XML::Mapping
+
+  # the default mapping. Stores the name and age in XML attributes,
+  # and the address in a sub-element "address".
+
+  text_node :name, "@name"
+  numeric_node :age, "@age"
+  object_node :address, "address", :class=>Address
+
+  use_mapping :other
+
+  # the ":other" mapping. Non-default root element name; name and age
+  # stored in XML elements; address stored in the person's element
+  # itself
+
+  root_element_name "individual"
+  text_node :name, "name"
+  numeric_node :age, "age"
+  object_node :address, ".", :class=>Address
+
+  # you could also specify the mapping on a per-node basis with the
+  # :mapping option, e.g.:
+  #
+  # numeric_node :age, "age", :mapping=>:other
+end
+
+
+class Address
+  include XML::Mapping
+
+  # the default mapping.
+
+  text_node :street, "street"
+  numeric_node :number, "number"
+  text_node :city, "city"
+  numeric_node :zip, "zip"
+
+  use_mapping :other
+
+  # the ":other" mapping.
+
+  text_node :street, "street-name"
+  numeric_node :number, "street-name/@number"
+  text_node :city, "city-name"
+  numeric_node :zip, "city-name/@zip-code"
+end
+
+
+### usage
+
+## XML representation of a person in the default mapping
+xml = REXML::Document.new('
+<person name="Suzy" age="28">
+  <address>
+    <street>Abbey Road</street>
+    <number>72</number>
+    <city>London</city>
+    <zip>18827</zip>
+  </address>
+</person>').root
+
+## load using the default mapping
+p = Person.load_from_xml xml 
+=> #<Person:0x7f487663af90 @address=#<Address:0x7f4876637250 @number=72, @zip=18827, @city="London", @street="Abbey Road">, @name="Suzy", @age=28>
+
+## save using the default mapping
+xml2 = p.save_to_xml
+xml2.write $stdout,2 
+<person name='Suzy' age='28'>
+  <address>
+    <street>
+      Abbey Road
+    </street>
+    <number>
+      72
+    </number>
+    <city>
+      London
+    </city>
+    <zip>
+      18827
+    </zip>
+  </address>
+</person>
+## xml2 identical to xml
+
+
+## now, save the same person to XML using the :other mapping...
+other_xml = p.save_to_xml :mapping=>:other
+other_xml.write $stdout,2 
+<individual>
+  <name>
+    Suzy
+  </name>
+  <age>
+    28
+  </age>
+  <street-name number='72'>
+    Abbey Road
+  </street-name>
+  <city-name zip-code='18827'>
+    London
+  </city-name>
+</individual>
+## load it again using the :other mapping
+p2 = Person.load_from_xml other_xml, :mapping=>:other 
+=> #<Person:0x7f4876600958 @address=#<Address:0x7f48765fdfc8 @number=72, @zip=18827, @city="London", @street="Abbey Road">, @name="Suzy", @age=28>
+
+## p2 identical to p 

data/examples/publication.intin.rb

@@ -0,0 +1,44 @@
+#:invisible:
+$:.unshift "../lib"
+require 'xml/mapping'
+require 'xml/xxpath_methods'
+#<=
+#:visible:
+
+class Publication
+  include XML::Mapping
+
+  choice_node :if,    '@author', :then, (text_node :author, '@author'),
+              :elsif, 'contr',   :then, (array_node :contributors, 'contr', :class=>String)
+end
+
+### usage
+
+p1 = Publication.load_from_xml(REXML::Document.new('<publication author="Jim"/>').root)#<=
+
+p2 = Publication.load_from_xml(REXML::Document.new('
+<publication>
+  <contr>Chris</contr>
+  <contr>Mel</contr>
+  <contr>Toby</contr>
+</publication>').root)#<=
+
+#:invisible:
+require 'test/unit/assertions'
+include Test::Unit::Assertions
+
+assert_equal "Jim", p1.author
+assert_nil p1.contributors
+
+assert_nil p2.author
+assert_equal ["Chris", "Mel", "Toby"], p2.contributors
+
+xml1 = p1.save_to_xml
+xml2 = p2.save_to_xml
+
+assert_equal p1.author, xml1.first_xpath("@author").text
+assert_nil xml1.first_xpath("contr", :allow_nil=>true)
+
+assert_nil xml2.first_xpath("@author", :allow_nil=>true)
+assert_equal p2.contributors, xml2.all_xpath("contr").map{|elt|elt.text}
+#<=

data/examples/publication.intout

@@ -0,0 +1,20 @@
+
+class Publication
+  include XML::Mapping
+
+  choice_node :if,    '@author', :then, (text_node :author, '@author'),
+              :elsif, 'contr',   :then, (array_node :contributors, 'contr', :class=>String)
+end
+
+### usage
+
+p1 = Publication.load_from_xml(REXML::Document.new('<publication author="Jim"/>').root)
+=> #<Publication:0x7f487656b308 @author="Jim">
+
+p2 = Publication.load_from_xml(REXML::Document.new('
+<publication>
+  <contr>Chris</contr>
+  <contr>Mel</contr>
+  <contr>Toby</contr>
+</publication>').root)
+=> #<Publication:0x7f48766be930 @contributors=["Chris", "Mel", "Toby"]>

data/examples/reader.intin.rb

@@ -0,0 +1,33 @@
+#:invisible:
+$:.unshift "../lib"
+require 'xml/mapping'
+require 'xml/xxpath_methods'
+#<=
+#:visible:
+
+class Foo
+  include XML::Mapping
+
+  text_node :name, "@name", :reader=>proc{|obj,xml,default_reader|
+                                       default_reader.call(obj,xml)
+                                       obj.name += xml.attributes['more']
+                                     },
+                            :writer=>proc{|obj,xml|
+                                       xml.attributes['bar'] = "hi #{obj.name} ho"
+                                     }
+end
+
+f = Foo.load_from_xml(REXML::Document.new('<foo name="Jim" more="XYZ"/>').root)#<=
+
+#:invisible_retval:
+xml = f.save_to_xml 
+xml.write $stdout,2 #<=
+
+#:invisible:
+require 'test/unit/assertions'
+include Test::Unit::Assertions
+
+assert_equal "JimXYZ", f.name
+assert_equal "hi JimXYZ ho", xml.attributes['bar']
+
+#<=

data/examples/reader.intout

@@ -0,0 +1,19 @@
+
+class Foo
+  include XML::Mapping
+
+  text_node :name, "@name", :reader=>proc{|obj,xml,default_reader|
+                                       default_reader.call(obj,xml)
+                                       obj.name += xml.attributes['more']
+                                     },
+                            :writer=>proc{|obj,xml|
+                                       xml.attributes['bar'] = "hi #{obj.name} ho"
+                                     }
+end
+
+f = Foo.load_from_xml(REXML::Document.new('<foo name="Jim" more="XYZ"/>').root)
+=> #<Foo:0x7f48766cdef8 @name="JimXYZ">
+
+xml = f.save_to_xml 
+xml.write $stdout,2 
+<foo bar='hi JimXYZ ho'/>

data/examples/stringarray.rb

@@ -0,0 +1,5 @@
+require 'xml/mapping'
+class People
+  include XML::Mapping
+  array_node :names, "names", "name", :class=>String
+end

data/examples/stringarray.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<people>
+  <names>
+    <name>Jim</name>
+    <name>Susan</name>
+    <name>Herbie</name>
+    <name>Nancy</name>
+  </names>
+</people>

data/examples/stringarray_usage.intin.rb

@@ -0,0 +1,11 @@
+#:invisible:
+$:.unshift "../lib"
+require 'stringarray' #<=
+#:visible:
+ppl=People.load_from_file("stringarray.xml") #<=
+ppl.names #<=
+
+ppl.names.concat ["Mary","Arnold"] #<=
+#:invisible_retval:
+ppl.save_to_xml.write $stdout,2
+#<=

data/examples/stringarray_usage.intout

@@ -0,0 +1,31 @@
+ppl=People.load_from_file("stringarray.xml") 
+=> #<People:0x7f487665ecd8 @names=["Jim", "Susan", "Herbie", "Nancy"]>
+ppl.names 
+=> ["Jim", "Susan", "Herbie", "Nancy"]
+
+ppl.names.concat ["Mary","Arnold"] 
+=> ["Jim", "Susan", "Herbie", "Nancy", "Mary", "Arnold"]
+ppl.save_to_xml.write $stdout,2
+
+<people>
+  <names>
+    <name>
+      Jim
+    </name>
+    <name>
+      Susan
+    </name>
+    <name>
+      Herbie
+    </name>
+    <name>
+      Nancy
+    </name>
+    <name>
+      Mary
+    </name>
+    <name>
+      Arnold
+    </name>
+  </names>
+</people>