xml-mapping 0.8

data/examples/time_augm.intout

@@ -0,0 +1,23 @@
+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 
+=> <time> ... </>
+nowxml.write($stdout,2)
+<time>
+      <year>2005</year>
+      <month>7</month>
+      <mday>7</mday>
+      <hours>6</hours>
+      <minutes>10</minutes>
+      <seconds>49</seconds>
+    </time>

data/examples/time_node.rb

@@ -0,0 +1,27 @@
+require 'xml/mapping/base'
+
+class TimeNode < XML::Mapping::SingleAttributeNode
+  def initialize_impl(path)
+    @y_path = XML::XXPath.new(path+"/year")
+    @m_path = XML::XXPath.new(path+"/month")
+    @d_path = XML::XXPath.new(path+"/day")
+  end
+
+  def extract_attr_value(xml)
+    y,m,d = default_when_xpath_err{ [@y_path.first(xml).text.to_i,
+                                     @m_path.first(xml).text.to_i,
+                                     @d_path.first(xml).text.to_i]
+                                  }
+    Time.local(y,m,d)
+  end
+
+  def set_attr_value(xml, value)
+    raise "Not a Time: #{value}" unless Time===value
+    @y_path.first(xml,:ensure_created=>true).text = value.year
+    @m_path.first(xml,:ensure_created=>true).text = value.month
+    @d_path.first(xml,:ensure_created=>true).text = value.day
+  end
+end
+
+
+XML::Mapping.add_node_class TimeNode

data/examples/xpath_create_new.intin.rb

@@ -0,0 +1,85 @@
+#:invisible:
+$:.unshift "../lib" #<=
+#:visible:
+require 'xml/xxpath'
+
+d=REXML::Document.new <<EOS
+  <foo>
+    <bar>
+      <baz key="work">Java</baz>
+      <baz key="play">Ruby</baz>
+    </bar>
+  </foo>
+EOS
+
+
+rootelt=d.root
+
+#:invisible_retval:
+path1=XML::XXPath.new("/bar/baz[@key='work']")
+
+#:visible_retval:
+path1.create_new(rootelt)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### a new element is created for *each* path element, regardless of
+### what existed before. So a new "bar" element was added, with a new
+### "baz" element inside it
+
+### same call again...
+#:visible_retval:
+path1.create_new(rootelt)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### same procedure -- new elements added for each path element
+
+
+#:visible_retval:
+## get reference to 1st "baz" element
+firstbazelt=XML::XXPath.new("/bar/baz").first(rootelt)#<=
+
+#:invisible_retval:
+path2=XML::XXPath.new("@key2")
+
+#:visible_retval:
+path2.create_new(firstbazelt)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### ok, new attribute node added
+
+### same call again...
+#:visible_retval:
+#:handle_exceptions:
+path2.create_new(firstbazelt)#<=
+#:no_exceptions:
+### can't create that path anew again -- an element can't have more
+### than one attribute with the same name
+
+#:invisible_retval:
+### the document hasn't changed
+d.write($stdout,2)#<=
+
+
+
+### create_new the same path as in the ensure_created example
+#:visible_retval:
+baz6elt=XML::XXPath.new("/bar/baz[6]").create_new(rootelt)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### ok, new "bar" element and 6th "baz" element inside it created
+
+
+#:visible_retval:
+#:handle_exceptions:
+XML::XXPath.new("baz[6]").create_new(baz6elt.parent)#<=
+#:no_exceptions:
+#:invisible_retval:
+### yep, baz[6] already existed and thus couldn't be created once
+### again
+
+### but of course...
+#:visible_retval:
+XML::XXPath.new("/bar/baz[6]").create_new(rootelt)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### this works because *all* path elements are newly created

data/examples/xpath_create_new.intout

@@ -0,0 +1,181 @@
+require 'xml/xxpath'
+
+d=REXML::Document.new <<EOS
+  <foo>
+    <bar>
+      <baz key="work">Java</baz>
+      <baz key="play">Ruby</baz>
+    </bar>
+  </foo>
+EOS
+
+
+rootelt=d.root
+
+path1=XML::XXPath.new("/bar/baz[@key='work']")
+
+path1.create_new(rootelt)
+=> <baz key='work'/>
+d.write($stdout,2)
+    <foo>
+    <bar>
+      <baz key='work'>Java</baz>
+      <baz key='play'>Ruby</baz>
+    </bar>
+  <bar>
+        <baz key='work'/>
+      </bar>
+    </foo>
+
+### a new element is created for *each* path element, regardless of
+### what existed before. So a new "bar" element was added, with a new
+### "baz" element inside it
+
+### same call again...
+path1.create_new(rootelt)
+=> <baz key='work'/>
+d.write($stdout,2)
+    <foo>
+    <bar>
+      <baz key='work'>Java</baz>
+      <baz key='play'>Ruby</baz>
+    </bar>
+  <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz key='work'/>
+      </bar>
+    </foo>
+
+### same procedure -- new elements added for each path element
+
+
+## get reference to 1st "baz" element
+firstbazelt=XML::XXPath.new("/bar/baz").first(rootelt)
+=> <baz key='work'> ... </>
+
+path2=XML::XXPath.new("@key2")
+
+path2.create_new(firstbazelt)
+=> #<XML::XXPath::Accessors::Attribute:0x404b0c4c @name="key2", @parent=<baz key2='[unset]' key='work'> ... </>>
+d.write($stdout,2)
+    <foo>
+    <bar>
+      <baz key2='[unset]' key='work'>Java</baz>
+      <baz key='play'>Ruby</baz>
+    </bar>
+  <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz key='work'/>
+      </bar>
+    </foo>
+
+### ok, new attribute node added
+
+### same call again...
+path2.create_new(firstbazelt)
+XML::XXPathError: XPath (): @key2: create_new and attribute already exists
+	from ../lib/xml/../xml/xxpath.rb:341:in `create_subnode_by_attr_name'
+	from ../lib/xml/../xml/xxpath.rb:68:in `initialize'
+	from ../lib/xml/../xml/xxpath.rb:67:in `call'
+	from ../lib/xml/../xml/xxpath.rb:146:in `all'
+	from ../lib/xml/../xml/xxpath.rb:125:in `first'
+	from ../lib/xml/../xml/xxpath.rb:167:in `create_new'
+### can't create that path anew again -- an element can't have more
+### than one attribute with the same name
+
+### the document hasn't changed
+d.write($stdout,2)
+    <foo>
+    <bar>
+      <baz key2='[unset]' key='work'>Java</baz>
+      <baz key='play'>Ruby</baz>
+    </bar>
+  <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz key='work'/>
+      </bar>
+    </foo>
+
+
+
+
+### create_new the same path as in the ensure_created example
+baz6elt=XML::XXPath.new("/bar/baz[6]").create_new(rootelt)
+=> <baz/>
+d.write($stdout,2)
+    <foo>
+    <bar>
+      <baz key2='[unset]' key='work'>Java</baz>
+      <baz key='play'>Ruby</baz>
+    </bar>
+  <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+      </bar>
+    </foo>
+
+### ok, new "bar" element and 6th "baz" element inside it created
+
+
+XML::XXPath.new("baz[6]").create_new(baz6elt.parent)
+XML::XXPathError: XPath (): baz[6]: create_new and element already exists
+	from ../lib/xml/../xml/xxpath.rb:330:in `create_subnode_by_name_and_index'
+	from ../lib/xml/../xml/xxpath.rb:52:in `initialize'
+	from ../lib/xml/../xml/xxpath.rb:51:in `call'
+	from ../lib/xml/../xml/xxpath.rb:146:in `all'
+	from ../lib/xml/../xml/xxpath.rb:125:in `first'
+	from ../lib/xml/../xml/xxpath.rb:167:in `create_new'
+### yep, baz[6] already existed and thus couldn't be created once
+### again
+
+### but of course...
+XML::XXPath.new("/bar/baz[6]").create_new(rootelt)
+=> <baz/>
+d.write($stdout,2)
+    <foo>
+    <bar>
+      <baz key2='[unset]' key='work'>Java</baz>
+      <baz key='play'>Ruby</baz>
+    </bar>
+  <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz key='work'/>
+      </bar>
+      <bar>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+      </bar>
+      <bar>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+        <baz/>
+      </bar>
+    </foo>
+
+### this works because *all* path elements are newly created
+

data/examples/xpath_docvsroot.intin.rb

@@ -0,0 +1,30 @@
+#:invisible:
+$:.unshift "../lib" #<=
+#:visible:
+require 'xml/xxpath'
+
+d=REXML::Document.new <<EOS
+  <foo>
+    <bar x="hello">
+      <first>
+        <second>pingpong</second>
+      </first>
+    </bar>
+    <bar x="goodbye"/>
+  </foo>
+EOS
+
+XML::XXPath.new("/foo/bar").all(d)#<=
+
+XML::XXPath.new("/bar").all(d)#<=
+
+XML::XXPath.new("/foo/bar").all(d.root)#<=
+
+XML::XXPath.new("/bar").all(d.root)#<=
+
+
+firstelt = XML::XXPath.new("/foo/bar/first").first(d)#<=
+
+XML::XXPath.new("/first/second").all(firstelt)#<=
+
+XML::XXPath.new("/second").all(firstelt)#<=

data/examples/xpath_docvsroot.intout

@@ -0,0 +1,34 @@
+require 'xml/xxpath'
+
+d=REXML::Document.new <<EOS
+  <foo>
+    <bar x="hello">
+      <first>
+        <second>pingpong</second>
+      </first>
+    </bar>
+    <bar x="goodbye"/>
+  </foo>
+EOS
+
+XML::XXPath.new("/foo/bar").all(d)
+=> [<bar x='hello'> ... </>, <bar x='goodbye'/>]
+
+XML::XXPath.new("/bar").all(d)
+=> []
+
+XML::XXPath.new("/foo/bar").all(d.root)
+=> []
+
+XML::XXPath.new("/bar").all(d.root)
+=> [<bar x='hello'> ... </>, <bar x='goodbye'/>]
+
+
+firstelt = XML::XXPath.new("/foo/bar/first").first(d)
+=> <first> ... </>
+
+XML::XXPath.new("/first/second").all(firstelt)
+=> []
+
+XML::XXPath.new("/second").all(firstelt)
+=> [<second> ... </>]

data/examples/xpath_ensure_created.intin.rb

@@ -0,0 +1,62 @@
+#:invisible:
+$:.unshift "../lib" #<=
+#:visible:
+require 'xml/xxpath'
+
+d=REXML::Document.new <<EOS
+  <foo>
+    <bar>
+      <baz key="work">Java</baz>
+      <baz key="play">Ruby</baz>
+    </bar>
+  </foo>
+EOS
+
+
+rootelt=d.root
+
+#### ensuring that a specific path exists inside the document
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[@key='work']").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### no change (path existed before)
+
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[@key='42']").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### path was added
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[@key='42']").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### no change this time
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[@key2='hello']").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### this fit in the 1st "baz" element since
+### there was no "key2" attribute there before.
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[2]").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### no change
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[6]/@haha").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### for there to be a 6th "baz" element, there must be 1st..5th "baz" elements
+
+#:visible_retval:
+XML::XXPath.new("/bar/baz[6]/@haha").first(rootelt,:ensure_created=>true)#<=
+#:invisible_retval:
+d.write($stdout,2)#<=
+### no change this time