xml-mapping 0.8

data/examples/company_usage.intout

@@ -0,0 +1,39 @@
+c = Company.load_from_file('company.xml') 
+=> #<Company:0x40471c18 @address=#<Address:0x40471344 @zip=10113, @city="Berlin">, @name="ACME inc.", @customers=[#<Customer:0x4046fe90 @name="James Kirk", @id="jim">, #<Customer:0x4046f51c @name="Ernie", @id="ernie">, #<Customer:0x4046eba8 @name="Bert", @id="bert">]>
+c.name 
+=> "ACME inc."
+c.customers.size 
+=> 3
+c.customers[1] 
+=> #<Customer:0x4046f51c @name="Ernie", @id="ernie">
+c.customers[1].name 
+=> "Ernie"
+c.customers[0].name 
+=> "James Kirk"
+c.customers[0].name = 'James Tiberius Kirk' 
+=> "James Tiberius Kirk"
+c.customers << Customer.new('cm','Cookie Monster') 
+=> [#<Customer:0x4046fe90 @name="James Tiberius Kirk", @id="jim">, #<Customer:0x4046f51c @name="Ernie", @id="ernie">, #<Customer:0x4046eba8 @name="Bert", @id="bert">, #<Customer:0x4046d7a8 @name="Cookie Monster", @id="cm">]
+xml2 = c.save_to_xml 
+=> <company name='ACME inc.'> ... </>
+xml2.write($stdout,2) 
+<company name='ACME inc.'>
+      <address>
+        <city>Berlin</city>
+        <zip>10113</zip>
+      </address>
+      <customers>
+        <customer id='539197256'>
+          <name>James Tiberius Kirk</name>
+        </customer>
+        <customer id='539196046'>
+          <name>Ernie</name>
+        </customer>
+        <customer id='539194836'>
+          <name>Bert</name>
+        </customer>
+        <customer id='539192276'>
+          <name>Cookie Monster</name>
+        </customer>
+      </customers>
+    </company>

data/examples/order.rb

@@ -0,0 +1,61 @@
+require 'xml/mapping'
+
+## forward declarations
+class Client; end
+class Address; end
+class Item; end
+class Signature; end
+
+
+class Order
+  include XML::Mapping
+
+  text_node :reference, "@reference"
+  object_node :client, "Client", :class=>Client
+  hash_node :items, "Item", "@reference", :class=>Item
+  array_node :signatures, "Signed-By", "Signature", :class=>Signature, :default_value=>[]
+
+  def total_price
+    items.values.map{|i| i.total_price}.inject(0){|x,y|x+y}
+  end
+end
+
+
+class Client
+  include XML::Mapping
+
+  text_node :name, "Name"
+  object_node :home_address, "Address[@where='home']", :class=>Address
+  object_node :work_address, "Address[@where='work']", :class=>Address, :default_value=>nil
+end
+
+
+class Address
+  include XML::Mapping
+
+  text_node :city, "City"
+  text_node :state, "State"
+  numeric_node :zip, "ZIP"
+  text_node :street, "Street"
+end
+
+
+class Item
+  include XML::Mapping
+
+  text_node :descr, "Description"
+  numeric_node :quantity, "Quantity"
+  numeric_node :unit_price, "UnitPrice"
+
+  def total_price
+    quantity*unit_price
+  end
+end
+
+
+class Signature
+  include XML::Mapping
+
+  text_node :name, "Name"
+  text_node :position, "Position", :default_value=>"Some Employee"
+end

data/examples/order.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<Order reference="12343-AHSHE-314159">
+  <Client>
+    <Name>Jean Smith</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-0001">
+    <Description>Stuffed Penguin</Description>
+    <Quantity>10</Quantity>
+    <UnitPrice>8.95</UnitPrice>
+  </Item>
+
+  <Item reference="RF-0034">
+    <Description>Chocolate</Description>
+    <Quantity>5</Quantity>
+    <UnitPrice>28.50</UnitPrice>
+  </Item>
+
+  <Item reference="RF-3341">
+    <Description>Cookie</Description>
+    <Quantity>30</Quantity>
+    <UnitPrice>0.85</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'Brien</Name>
+    </Signature>
+  </Signed-By>
+
+</Order>

data/examples/order_signature_enhanced.rb

@@ -0,0 +1,7 @@
+class Signature
+  include XML::Mapping
+
+  text_node :name, "Name"
+  text_node :position, "Position", :default_value=>"Some Employee"
+  time_node :signed_on, "signed-on", :default_value=>Time.now
+end

data/examples/order_signature_enhanced.xml

@@ -0,0 +1,9 @@
+<Signature>
+  <Name>John Doe</Name>
+  <Position>product manager</Position>
+  <signed-on>
+    <day>13</day>
+    <month>2</month>
+    <year>2005</year>
+  </signed-on>
+</Signature>

data/examples/order_signature_enhanced_usage.intin.rb

@@ -0,0 +1,12 @@
+#:invisible:
+$:.unshift "../lib"
+require 'xml/mapping'
+require 'time_node.rb'
+require 'order'
+require 'order_signature_enhanced'
+#<=
+#:visible:
+s=Signature.load_from_file("order_signature_enhanced.xml") #<=
+s.signed_on #<=
+s.signed_on=Time.local(1976,12,18) #<=
+s.save_to_xml.write($stdout,2) #<=

data/examples/order_signature_enhanced_usage.intout

@@ -0,0 +1,16 @@
+s=Signature.load_from_file("order_signature_enhanced.xml") 
+=> #<Signature:0x40476344 @name="John Doe", @signed_on=Sun Feb 13 00:00:00 CET 2005, @position="product manager">
+s.signed_on 
+=> Sun Feb 13 00:00:00 CET 2005
+s.signed_on=Time.local(1976,12,18) 
+=> Sat Dec 18 00:00:00 CET 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>

data/examples/order_usage.intin.rb

@@ -0,0 +1,73 @@
+#:invisible:
+$:.unshift "../lib"
+begin
+  Object.send(:remove_const, "Address")  # name clash with company_usage...
+rescue
+end
+require 'order' #<=
+#:visible:
+####read access
+o=Order.load_from_file("order.xml") #<=
+o.reference #<=
+o.client #<=
+o.items.keys #<=
+o.items["RF-0034"].descr #<=
+o.items["RF-0034"].total_price #<=
+o.signatures #<=
+o.signatures[2].name #<=
+o.signatures[2].position #<=
+## default value was set
+
+o.total_price #<=
+
+####write access
+o.client.name="James T. Kirk"
+o.items['RF-4711'] = Item.new
+o.items['RF-4711'].descr = 'power transfer grid'
+o.items['RF-4711'].quantity = 2
+o.items['RF-4711'].unit_price = 29.95
+
+s=Signature.new
+s.name='Harry Smith'
+s.position='general manager'
+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:
+
+####Starting a new order from scratch
+o = Order.new #<=
+## attributes with default values (here: signatures) are set
+## automatically
+
+#:handle_exceptions:
+xml=o.save_to_xml #<=
+#:no_exceptions:
+## can't save as long as there are still unset attributes without
+## default values
+
+o.reference = "FOOBAR-1234"
+
+o.client = Client.new
+o.client.name = 'Ford Prefect'
+o.client.home_address = Address.new
+o.client.home_address.street = '42 Park Av.'
+o.client.home_address.city = 'small planet'
+o.client.home_address.zip = 17263
+o.client.home_address.state = 'Betelgeuse system'
+
+o.items={'XY-42' => Item.new}
+o.items['XY-42'].descr = 'improbability drive'
+o.items['XY-42'].quantity = 3
+o.items['XY-42'].unit_price = 299.95
+
+#:invisible_retval:
+o.save_to_xml.write($stdout,2)
+#<=
+#:visible_retval:
+
+## 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.

data/examples/order_usage.intout

@@ -0,0 +1,147 @@
+####read access
+o=Order.load_from_file("order.xml") 
+=> #<Order:0x40441590 @signatures=[#<Signature:0x40436fc8 @name="John Doe", @position="product manager">, #<Signature:0x404363ac @name="Jill Smith", @position="clerk">, #<Signature:0x40435790 @name="Miles O'Brien", @position="Some Employee">], @items={"RF-3341"=>#<Item:0x40438f58 @unit_price=0.85, @quantity=30, @descr="Cookie">, "RF-0034"=>#<Item:0x4043a7a4 @unit_price=28.5, @quantity=5, @descr="Chocolate">, "RF-0001"=>#<Item:0x4043bff0 @unit_price=8.95, @quantity=10, @descr="Stuffed Penguin">}, @client=#<Client:0x40440be0 @name="Jean Smith", @work_address=#<Address:0x4043e05c @street="98765, Fulton Street", @zip=94102, @state="CA", @city="San Francisco">, @home_address=#<Address:0x4043ff10 @street="2000, Alameda de las Pulgas", @zip=94403, @state="CA", @city="San Mateo">>, @reference="12343-AHSHE-314159">
+o.reference 
+=> "12343-AHSHE-314159"
+o.client 
+=> #<Client:0x40440be0 @name="Jean Smith", @work_address=#<Address:0x4043e05c @street="98765, Fulton Street", @zip=94102, @state="CA", @city="San Francisco">, @home_address=#<Address:0x4043ff10 @street="2000, Alameda de las Pulgas", @zip=94403, @state="CA", @city="San Mateo">>
+o.items.keys 
+=> ["RF-3341", "RF-0034", "RF-0001"]
+o.items["RF-0034"].descr 
+=> "Chocolate"
+o.items["RF-0034"].total_price 
+=> 142.5
+o.signatures 
+=> [#<Signature:0x40436fc8 @name="John Doe", @position="product manager">, #<Signature:0x404363ac @name="Jill Smith", @position="clerk">, #<Signature:0x40435790 @name="Miles O'Brien", @position="Some Employee">]
+o.signatures[2].name 
+=> "Miles O'Brien"
+o.signatures[2].position 
+=> "Some Employee"
+## default value was set
+
+o.total_price 
+=> 257.5
+
+####write access
+o.client.name="James T. Kirk"
+o.items['RF-4711'] = Item.new
+o.items['RF-4711'].descr = 'power transfer grid'
+o.items['RF-4711'].quantity = 2
+o.items['RF-4711'].unit_price = 29.95
+
+s=Signature.new
+s.name='Harry Smith'
+s.position='general manager'
+o.signatures << s
+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>
+####Starting a new order from scratch
+o = Order.new 
+=> #<Order:0x4053a014 @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:377: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'
+## can't save as long as there are still unset attributes without
+## default values
+
+o.reference = "FOOBAR-1234"
+
+o.client = Client.new
+o.client.name = 'Ford Prefect'
+o.client.home_address = Address.new
+o.client.home_address.street = '42 Park Av.'
+o.client.home_address.city = 'small planet'
+o.client.home_address.zip = 17263
+o.client.home_address.state = 'Betelgeuse system'
+
+o.items={'XY-42' => Item.new}
+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)
+
+<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>
+## 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.
+
+=> nil

data/examples/time_augm.intin.rb

@@ -0,0 +1,19 @@
+#:invisible:
+$:.unshift "../lib"
+require 'order' #<=
+#:visible:
+class Time
+  include XML::Mapping
+
+  numeric_node :year, "year"
+  numeric_node :month, "month"
+  numeric_node :day, "mday"
+  numeric_node :hour, "hours"
+  numeric_node :min, "minutes"
+  numeric_node :sec, "seconds"
+end
+
+
+nowxml=Time.now.save_to_xml #<=
+#:invisible_retval:
+nowxml.write($stdout,2)#<=