xml-mapping 0.8.1 → 0.9.1

data/examples/documents_folders_usage.intout

@@ -0,0 +1,46 @@
+
+root = XML::Mapping.load_object_from_file "documents_folders.xml" 
+=> #<Folder:0x7f48766041e8 @name="home", @entries=[#<Document:0x7f4876600f70 @name="plan", @contents=" inhale, exhale">, #<Folder:0x7f48765febf8 @name="work", @entries=[#<Folder:0x7f48765fc1a0 @name="xml-mapping", @entries=[#<Document:0x7f48765fa6c0 @name="README", @contents="foo bar baz">]>]>]>
+root.name 
+=> "home"
+root.entries 
+=> [#<Document:0x7f4876600f70 @name="plan", @contents=" inhale, exhale">, #<Folder:0x7f48765febf8 @name="work", @entries=[#<Folder:0x7f48765fc1a0 @name="xml-mapping", @entries=[#<Document:0x7f48765fa6c0 @name="README", @contents="foo bar baz">]>]>]
+
+root.append "etc", Folder.new
+root["etc"].append "passwd", Document.new
+root["etc"]["passwd"].contents = "foo:x:2:2:/bin/sh"
+root["etc"].append "hosts", Document.new
+root["etc"]["hosts"].contents = "127.0.0.1 localhost"
+
+xml = root.save_to_xml 
+=> <folder name='home'> ... </>
+xml.write $stdout,2
+
+<folder name='home'>
+  <document name='plan'>
+    <contents>
+       inhale, exhale
+    </contents>
+  </document>
+  <folder name='work'>
+    <folder name='xml-mapping'>
+      <document name='README'>
+        <contents>
+          foo bar baz
+        </contents>
+      </document>
+    </folder>
+  </folder>
+  <folder name='etc'>
+    <document name='passwd'>
+      <contents>
+        foo:x:2:2:/bin/sh
+      </contents>
+    </document>
+    <document name='hosts'>
+      <contents>
+        127.0.0.1 localhost
+      </contents>
+    </document>
+  </folder>
+</folder>

data/examples/order_signature_enhanced_usage.intout

@@ -1,16 +1,26 @@
 s=Signature.load_from_file("order_signature_enhanced.xml") 
-=> #<Signature:0x1aed60 @signed_on=Sun Feb 13 00:00:00 MET 2005, @name="John Doe", @position="product manager">
+=> #<Signature:0x7f487642e850 @signed_on=Sun Feb 13 00:00:00 +0100 2005, @name="John Doe", @position="product manager">
 s.signed_on 
-=> Sun Feb 13 00:00:00 MET 2005
+=> Sun Feb 13 00:00:00 +0100 2005
 s.signed_on=Time.local(1976,12,18) 
-=> Sat Dec 18 00:00:00 MET 1976
+=> Sat Dec 18 00:00:00 +0100 1976
 s.save_to_xml.write($stdout,2) 
 <signature>
-      <Name>John Doe</Name>
-      <Position>product manager</Position>
-      <signed-on>
-        <year>1976</year>
-        <month>12</month>
-        <day>18</day>
-      </signed-on>
-    </signature>=> #<File:examples/order_signature_enhanced_usage.intout>
+  <Name>
+    John Doe
+  </Name>
+  <Position>
+    product manager
+  </Position>
+  <signed-on>
+    <year>
+      1976
+    </year>
+    <month>
+      12
+    </month>
+    <day>
+      18
+    </day>
+  </signed-on>
+</signature>=> #<File:examples/order_signature_enhanced_usage.intout>

data/examples/order_usage.intin.rb

@@ -4,7 +4,12 @@ begin
   Object.send(:remove_const, "Address")  # name clash with company_usage...
 rescue
 end
-require 'order' #<=
+require 'order'
+
+require 'xml/xxpath_methods'
+
+require 'test/unit/assertions'
+include Test::Unit::Assertions  #<=
 #:visible:
 ####read access
 o=Order.load_from_file("order.xml") #<=
@@ -20,6 +25,17 @@ o.signatures[2].position #<=
 
 o.total_price #<=
 
+#:invisible:
+assert_equal "12343-AHSHE-314159", o.reference
+assert_equal "Jean Smith", o.client.name
+assert_equal "San Francisco", o.client.work_address.city
+assert_equal "San Mateo", o.client.home_address.city
+assert_equal %w{RF-0001 RF-0034 RF-3341}, o.items.keys.sort
+assert_equal ['John Doe','Jill Smith','Miles O\'Brien'], o.signatures.map{|s|s.name}
+assert_equal 2575, (10 * o.total_price).round
+#<=
+#:visible:
+
 ####write access
 o.client.name="James T. Kirk"
 o.items['RF-4711'] = Item.new
@@ -34,8 +50,17 @@ o.signatures << s
 xml=o.save_to_xml #convert to REXML node; there's also o.save_to_file(name) #<=
 #:invisible_retval:
 xml.write($stdout,2) #<=
-#:visible_retval:
 
+#:invisible:
+assert_equal %w{RF-0001 RF-0034 RF-3341 RF-4711}, xml.all_xpath("Item/@reference").map{|x|x.text}.sort
+assert_equal ['John Doe','Jill Smith','Miles O\'Brien','Harry Smith'],
+             xml.all_xpath("Signed-By/Signature/Name").map{|x|x.text}
+#<=
+#:visible:
+
+
+#<=
+#:visible_retval:
 ####Starting a new order from scratch
 o = Order.new #<=
 ## attributes with default values (here: signatures) are set
@@ -63,11 +88,33 @@ o.items['XY-42'].quantity = 3
 o.items['XY-42'].unit_price = 299.95
 
 #:invisible_retval:
-o.save_to_xml.write($stdout,2)
+xml=o.save_to_xml
+xml.write($stdout,2)
 #<=
-#:visible_retval:
+#:invisible:
+assert_equal "order", xml.name
+assert_equal o.reference, xml.first_xpath("@reference").text
+assert_equal o.client.name, xml.first_xpath("Client/Name").text
+assert_equal o.client.home_address.street, xml.first_xpath("Client/Address[@where='home']/Street").text
+assert_equal o.client.home_address.city, xml.first_xpath("Client/Address[@where='home']/City").text
+assert_nil xml.first_xpath("Client/Address[@where='work']", :allow_nil=>true)
+assert_equal 1, xml.all_xpath("Client/Address").size
+
+o.client.work_address = Address.new
+o.client.work_address.street = 'milky way 2'
+o.client.work_address.city = 'Ursa Major'
+o.client.work_address.zip = 18293
+o.client.work_address.state = 'Magellan Cloud'
+xml=o.save_to_xml
+
+assert_equal o.client.work_address.street, xml.first_xpath("Client/Address[@where='work']/Street").text
+assert_equal o.client.work_address.city, xml.first_xpath("Client/Address[@where='work']/City").text
+assert_equal o.client.home_address.street, xml.first_xpath("Client/Address[@where='home']/Street").text
+assert_equal 2, xml.all_xpath("Client/Address").size
+#<=
+#:visible:
 
 ## the root element name when saving an object to XML will by default
 ## be derived from the class name (in this example, "Order" became
 ## "order"). This can be overridden on a per-class basis; see
-## XML::Mapping::ClassMethods#root_element_namefor details.
+## XML::Mapping::ClassMethods#root_element_name for details.

data/examples/order_usage.intout

@@ -1,10 +1,10 @@
 ####read access
 o=Order.load_from_file("order.xml") 
-=> #<Order:0x404730 @items={"RF-3341"=>#<Item:0x3f7fb0 @unit_price=0.85, @quantity=30, @descr="Cookie">, "RF-0034"=>#<Item:0x3faa70 @unit_price=28.5, @quantity=5, @descr="Chocolate">, "RF-0001"=>#<Item:0x3fcfa8 @unit_price=8.95, @quantity=10, @descr="Stuffed Penguin">}, @signatures=[#<Signature:0x3f4878 @name="John Doe", @position="product manager">, #<Signature:0x3f38d0 @name="Jill Smith", @position="clerk">, #<Signature:0x3f23a0 @name="Miles O'Brien", @position="Some Employee">], @client=#<Client:0x403a70 @work_address=#<Address:0x3ffbb8 @street="98765, Fulton Street", @state="CA", @zip=94102, @city="San Francisco">, @name="Jean Smith", @home_address=#<Address:0x402450 @street="2000, Alameda de las Pulgas", @state="CA", @zip=94403, @city="San Mateo">>, @reference="12343-AHSHE-314159">
+=> #<Order:0x7f4877650510 @reference="12343-AHSHE-314159", @signatures=[#<Signature:0x7f48776282b8 @name="John Doe", @position="product manager">, #<Signature:0x7f4877626d28 @name="Jill Smith", @position="clerk">, #<Signature:0x7f4877625798 @name="Miles O'Brien", @position="Some Employee">], @items={"RF-3341"=>#<Item:0x7f487762d290 @quantity=30, @descr="Cookie", @unit_price=0.85>, "RF-0034"=>#<Item:0x7f4877632808 @quantity=5, @descr="Chocolate", @unit_price=28.5>, "RF-0001"=>#<Item:0x7f487763a558 @quantity=10, @descr="Stuffed Penguin", @unit_price=8.95>}, @client=#<Client:0x7f487764d9c8 @name="Jean Smith", @work_address=#<Address:0x7f4877641588 @zip=94102, @street="98765, Fulton Street", @city="San Francisco", @state="CA">, @home_address=#<Address:0x7f4877645d40 @zip=94403, @street="2000, Alameda de las Pulgas", @city="San Mateo", @state="CA">>>
 o.reference 
 => "12343-AHSHE-314159"
 o.client 
-=> #<Client:0x403a70 @work_address=#<Address:0x3ffbb8 @street="98765, Fulton Street", @state="CA", @zip=94102, @city="San Francisco">, @name="Jean Smith", @home_address=#<Address:0x402450 @street="2000, Alameda de las Pulgas", @state="CA", @zip=94403, @city="San Mateo">>
+=> #<Client:0x7f487764d9c8 @name="Jean Smith", @work_address=#<Address:0x7f4877641588 @zip=94102, @street="98765, Fulton Street", @city="San Francisco", @state="CA">, @home_address=#<Address:0x7f4877645d40 @zip=94403, @street="2000, Alameda de las Pulgas", @city="San Mateo", @state="CA">>
 o.items.keys 
 => ["RF-3341", "RF-0034", "RF-0001"]
 o.items["RF-0034"].descr 
@@ -12,7 +12,7 @@ o.items["RF-0034"].descr
 o.items["RF-0034"].total_price 
 => 142.5
 o.signatures 
-=> [#<Signature:0x3f4878 @name="John Doe", @position="product manager">, #<Signature:0x3f38d0 @name="Jill Smith", @position="clerk">, #<Signature:0x3f23a0 @name="Miles O'Brien", @position="Some Employee">]
+=> [#<Signature:0x7f48776282b8 @name="John Doe", @position="product manager">, #<Signature:0x7f4877626d28 @name="Jill Smith", @position="clerk">, #<Signature:0x7f4877625798 @name="Miles O'Brien", @position="Some Employee">]
 o.signatures[2].name 
 => "Miles O'Brien"
 o.signatures[2].position 
@@ -37,72 +37,130 @@ xml=o.save_to_xml #convert to REXML node; there's also o.save_to_file(name)
 => <order reference='12343-AHSHE-314159'> ... </>
 xml.write($stdout,2) 
 <order reference='12343-AHSHE-314159'>
-      <Client>
-        <Name>James T. Kirk</Name>
-        <Address where='home'>
-          <City>San Mateo</City>
-          <State>CA</State>
-          <ZIP>94403</ZIP>
-          <Street>2000, Alameda de las Pulgas</Street>
-        </Address>
-        <Address where='work'>
-          <City>San Francisco</City>
-          <State>CA</State>
-          <ZIP>94102</ZIP>
-          <Street>98765, Fulton Street</Street>
-        </Address>
-      </Client>
-      <Item reference='RF-3341'>
-        <Description>Cookie</Description>
-        <Quantity>30</Quantity>
-        <UnitPrice>0.85</UnitPrice>
-      </Item>
-      <Item reference='RF-0034'>
-        <Description>Chocolate</Description>
-        <Quantity>5</Quantity>
-        <UnitPrice>28.5</UnitPrice>
-      </Item>
-      <Item reference='RF-0001'>
-        <Description>Stuffed Penguin</Description>
-        <Quantity>10</Quantity>
-        <UnitPrice>8.95</UnitPrice>
-      </Item>
-      <Item reference='RF-4711'>
-        <Description>power transfer grid</Description>
-        <Quantity>2</Quantity>
-        <UnitPrice>29.95</UnitPrice>
-      </Item>
-      <Signed-By>
-        <Signature>
-          <Name>John Doe</Name>
-          <Position>product manager</Position>
-        </Signature>
-        <Signature>
-          <Name>Jill Smith</Name>
-          <Position>clerk</Position>
-        </Signature>
-        <Signature>
-          <Name>Miles O&apos;Brien</Name>
-        </Signature>
-        <Signature>
-          <Name>Harry Smith</Name>
-          <Position>general manager</Position>
-        </Signature>
-      </Signed-By>
-    </order>
+  <Client>
+    <Name>
+      James T. Kirk
+    </Name>
+    <Address where='home'>
+      <City>
+        San Mateo
+      </City>
+      <State>
+        CA
+      </State>
+      <ZIP>
+        94403
+      </ZIP>
+      <Street>
+        2000, Alameda de las Pulgas
+      </Street>
+    </Address>
+    <Address where='work'>
+      <City>
+        San Francisco
+      </City>
+      <State>
+        CA
+      </State>
+      <ZIP>
+        94102
+      </ZIP>
+      <Street>
+        98765, Fulton Street
+      </Street>
+    </Address>
+  </Client>
+  <Item reference='RF-3341'>
+    <Description>
+      Cookie
+    </Description>
+    <Quantity>
+      30
+    </Quantity>
+    <UnitPrice>
+      0.85
+    </UnitPrice>
+  </Item>
+  <Item reference='RF-4711'>
+    <Description>
+      power transfer grid
+    </Description>
+    <Quantity>
+      2
+    </Quantity>
+    <UnitPrice>
+      29.95
+    </UnitPrice>
+  </Item>
+  <Item reference='RF-0034'>
+    <Description>
+      Chocolate
+    </Description>
+    <Quantity>
+      5
+    </Quantity>
+    <UnitPrice>
+      28.5
+    </UnitPrice>
+  </Item>
+  <Item reference='RF-0001'>
+    <Description>
+      Stuffed Penguin
+    </Description>
+    <Quantity>
+      10
+    </Quantity>
+    <UnitPrice>
+      8.95
+    </UnitPrice>
+  </Item>
+  <Signed-By>
+    <Signature>
+      <Name>
+        John Doe
+      </Name>
+      <Position>
+        product manager
+      </Position>
+    </Signature>
+    <Signature>
+      <Name>
+        Jill Smith
+      </Name>
+      <Position>
+        clerk
+      </Position>
+    </Signature>
+    <Signature>
+      <Name>
+        Miles O&apos;Brien
+      </Name>
+    </Signature>
+    <Signature>
+      <Name>
+        Harry Smith
+      </Name>
+      <Position>
+        general manager
+      </Position>
+    </Signature>
+  </Signed-By>
+</order>
+
+
 ####Starting a new order from scratch
 o = Order.new 
-=> #<Order:0x3b5500 @signatures=[]>
+=> #<Order:0x7f48766fc118 @signatures=[]>
 ## attributes with default values (here: signatures) are set
 ## automatically
 
 xml=o.save_to_xml 
 XML::MappingError: no value, and no default value, for attribute: reference
-	from ../lib/xml/../xml/mapping/base.rb:381:in `obj_to_xml'
-	from ../lib/xml/../xml/mapping/base.rb:157:in `fill_into_xml'
-	from ../lib/xml/../xml/mapping/base.rb:156:in `each'
-	from ../lib/xml/../xml/mapping/base.rb:156:in `fill_into_xml'
-	from ../lib/xml/../xml/mapping/base.rb:168:in `save_to_xml'
+	from ../lib/xml/../xml/mapping/base.rb:697:in `obj_to_xml'
+	from ../lib/xml/../xml/mapping/base.rb:218:in `fill_into_xml'
+	from ../lib/xml/../xml/mapping/base.rb:217:in `each'
+	from ../lib/xml/../xml/mapping/base.rb:217:in `fill_into_xml'
+	from ../lib/xml/../xml/mapping/base.rb:229:in `save_to_xml'
 ## can't save as long as there are still unset attributes without
 ## default values
 
@@ -121,27 +179,43 @@ o.items['XY-42'].descr = 'improbability drive'
 o.items['XY-42'].quantity = 3
 o.items['XY-42'].unit_price = 299.95
 
-o.save_to_xml.write($stdout,2)
+xml=o.save_to_xml
+xml.write($stdout,2)
 
 <order reference='FOOBAR-1234'>
-      <Client>
-        <Name>Ford Prefect</Name>
-        <Address where='home'>
-          <City>small planet</City>
-          <State>Betelgeuse system</State>
-          <ZIP>17263</ZIP>
-          <Street>42 Park Av.</Street>
-        </Address>
-      </Client>
-      <Item reference='XY-42'>
-        <Description>improbability drive</Description>
-        <Quantity>3</Quantity>
-        <UnitPrice>299.95</UnitPrice>
-      </Item>
-    </order>
+  <Client>
+    <Name>
+      Ford Prefect
+    </Name>
+    <Address where='home'>
+      <City>
+        small planet
+      </City>
+      <State>
+        Betelgeuse system
+      </State>
+      <ZIP>
+        17263
+      </ZIP>
+      <Street>
+        42 Park Av.
+      </Street>
+    </Address>
+  </Client>
+  <Item reference='XY-42'>
+    <Description>
+      improbability drive
+    </Description>
+    <Quantity>
+      3
+    </Quantity>
+    <UnitPrice>
+      299.95
+    </UnitPrice>
+  </Item>
+</order>
 ## the root element name when saving an object to XML will by default
 ## be derived from the class name (in this example, "Order" became
 ## "order"). This can be overridden on a per-class basis; see
-## XML::Mapping::ClassMethods#root_element_namefor details.
+## XML::Mapping::ClassMethods#root_element_name for details.
 
-=> nil

data/examples/person.intin.rb

@@ -0,0 +1,44 @@
+#:invisible:
+$:.unshift "../lib"
+require 'xml/mapping'
+require 'xml/xxpath_methods'
+#<=
+#:visible:
+
+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)#<=
+
+p2 = Person.load_from_xml(REXML::Document.new('<person><name>James</name></person>').root)#<=
+
+p3 = Person.load_from_xml(REXML::Document.new('<person>Suzy</person>').root)#<=
+
+
+#:invisible_retval:
+p1.save_to_xml.write($stdout)#<=
+
+p2.save_to_xml.write($stdout)#<=
+
+p3.save_to_xml.write($stdout)#<=
+
+#:invisible:
+require 'test/unit/assertions'
+include Test::Unit::Assertions
+
+assert_equal "Jim", p1.name
+assert_equal "James", p2.name
+assert_equal "Suzy", p3.name
+
+xml = p3.save_to_xml
+assert_equal "name", xml.elements[1].name
+assert_equal "Suzy", xml.elements[1].text
+
+#<=