xml-mapping 0.8.1 → 0.9.1

data/lib/xml/xxpath_methods.rb

@@ -0,0 +1,96 @@
+# xxpath -- XPath implementation for Ruby, including write access
+#  Copyright (C) 2004-2010 Olaf Klischat
+
+require File.dirname(__FILE__) + "/xxpath"
+
+module XML
+
+  # set of convenience wrappers around XML::XPath's instance methods,
+  # for people who frequently use XML::XPath directly. This module is
+  # included into the REXML node classes and adds methods to them that
+  # enable you to write a call like
+  #
+  #   path.first(xml_element)
+  # 
+  # as the more pleasant-looking variant
+  #
+  #   xml_element.first_xpath(path)
+  #
+  # with the added bonus that _path_ may not only be an XML::XXPath
+  # instance, but also just a String containing the XPath expression.
+  #
+  # Please note that the names of all the added methods are suffixed
+  # with "_xpath" to avoid name clashes with REXML methods. Please
+  # note also that this was changed recently, so older versions of
+  # xml-mapping (version < 0.9) used method names without _xpath
+  # appended and thus would be incompatible with this one here.
+  #
+  # As a special convenience, if you're using an older version of
+  # REXML that doesn't have the new methods yet, methods without
+  # _xpath in their names will also (additionally) be added to the
+  # REXML classes. This will enable code that relied on the old names
+  # to keep on working as long as REXML isn't updated, at which point
+  # that code will fail and must be changed to used the methods
+  # suffixed with _xpath.
+  module XXPathMethods
+    # see XML::XXPath#each
+    def each_xpath(path,options={},&block)
+      to_xxpath(path).each self, options, &block
+    end
+
+    # see XML::XXPath#first
+    def first_xpath(path,options={})
+      to_xxpath(path).first self, options
+    end
+
+    # see XML::XXPath#all
+    def all_xpath(path,options={})
+      to_xxpath(path).all self, options
+    end
+
+    # see XML::XXPath#create_new
+    def create_new_xpath(path)
+      to_xxpath(path).create_new self
+    end
+
+    unless REXML::Element.new.respond_to? :first
+
+      # see XML::XXPath#first
+      def first_xpath(path,options={})
+        to_xxpath(path).first self, options
+      end
+
+      # see XML::XXPath#all
+      def all_xpath(path,options={})
+        to_xxpath(path).all self, options
+      end
+
+      # see XML::XXPath#create_new
+      def create_new_xpath(path)
+        to_xxpath(path).create_new self
+      end
+      
+    end
+
+    def to_xxpath(path)
+      if String===path
+        XXPath.new path
+      else
+        path
+      end
+    end
+  end
+
+end
+
+
+module REXML
+  class Child    # mix into nearly every REXML class -- maybe this is a bit too brutal
+    include XML::XXPathMethods
+  end
+end
+
+
+class XML::XXPath::Accessors::Attribute
+  include XML::XXPathMethods
+end

data/test/all_tests.rb

@@ -3,4 +3,7 @@ require File.dirname(__FILE__)+"/tests_init"
 require 'xpath_test'
 require 'xml_mapping_test'
 require 'xml_mapping_adv_test'
-
+require 'multiple_mappings_test'
+require 'xxpath_methods_test'
+require 'examples_test'
+require 'inheritance_test'

data/test/benchmark_fixtures.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__)+"/tests_init"
+
+require "rexml/document"
+include REXML
+
+@d = Document.new(File.new(File.dirname(__FILE__) + "/fixtures/benchmark.xml"))
+
+@path_by_name = "foo/bar/foo/bar"
+@path_by_idx = "foo/bar[5]"    # "bar6"
+@path_by_idx_idx = "foo/bar[3]/bar[4]"    # "bar4-6"
+@path_by_attr_idx = "foo/bar[@barkey='subtree']/bar[4]"    # "bar4-6"
+@path_by_attr = "@key"    # "xy"
+
+@count=500

data/test/company.rb

@@ -4,6 +4,7 @@ require 'xml/mapping'
 class Address; end
 class Office; end
 class Customer; end
+class Thing; end
 
 
 class Company
@@ -21,6 +22,7 @@ class Company
   text_node :ent3, "arrtest/entry[3]"
 
   array_node :stuff, "stuff", "*"
+  array_node :things, "stuff2", "thing", :class=>Thing
 
   object_node :test_default_value_identity, "dummy", :default_value => ["default"]
 end
@@ -54,3 +56,48 @@ class Customer
   text_node :uid, "@uid"
   text_node :name, "name"
 end
+
+
+class Thing
+  include XML::Mapping
+
+  choice_node 'name',  (text_node :name, 'name'),
+              '@name', (text_node :name, '@name'),
+              :else,   (text_node :name, '.')
+end
+
+
+class Names1
+  include XML::Mapping
+
+  choice_node :if,    'name',       :then, (text_node :name, 'name'),
+              :elsif, 'names/name', :then, (array_node :names, 'names', 'name', :class=>String)
+end
+
+
+class ReaderTest
+  include XML::Mapping
+
+  attr_accessor :read
+
+  text_node :foo, "foo"
+  text_node :foo2, "foo2", :reader=>proc{|obj,xml| (obj.read||=[]) << :foo2 }
+  text_node :foo3, "foo3", :reader=>proc{|obj,xml,default|
+                                            (obj.read||=[]) << :foo3
+                                            default.call(obj,xml)
+                                        }
+  text_node :bar, "bar"
+end
+
+
+class WriterTest
+  include XML::Mapping
+
+  text_node :foo, "foo"
+  text_node :foo2, "foo2", :writer=>proc{|obj,xml| e = xml.elements.add; e.name='quux'; e.text='dingdong2' }
+  text_node :foo3, "foo3", :writer=>proc{|obj,xml,default|
+                                            default.call(obj,xml)
+                                            e = xml.elements.add; e.name='quux'; e.text='dingdong3'
+                                        }
+  text_node :bar, "bar"
+end

data/test/documents_folders.rb

@@ -23,7 +23,17 @@ end
 class Folder <Entry
   include XML::Mapping
 
-  array_node :entries, "entries", "*"
+  array_node :entries, "document|folder", :default_value=>[]
+
+  def [](name)
+    entries.select{|e|e.name==name}[0]
+  end
+
+  def append(name,entry)
+    entries << entry
+    entry.name = name
+    entry
+  end
 
   def ==(other)
     Folder===other and

data/test/examples_test.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__)+"/tests_init"
+$:.unshift File.dirname(__FILE__)+"/../examples"
+
+require 'test/unit'
+require 'xml/xxpath_methods'
+
+require 'xml/mapping'
+
+# unit tests for some code in ../examples. Most of that code is
+# included in ../README and tested when regenerating the README, but
+# some things are better done outside.
+class ExamplesTest < Test::Unit::TestCase
+
+  def test_time_node
+    require 'time_node'
+    require 'order_signature_enhanced'
+
+    s = Signature.load_from_file File.dirname(__FILE__)+"/../examples/order_signature_enhanced.xml"
+    assert_equal Time.local(2005,2,13), s.signed_on
+
+    s.signed_on = Time.local(2006,6,15)
+    xml2 = s.save_to_xml
+
+    assert_equal "15", xml2.first_xpath("signed-on/day").text
+    assert_equal "6", xml2.first_xpath("signed-on/month").text
+    assert_equal "2006", xml2.first_xpath("signed-on/year").text
+  end
+
+end

data/test/fixtures/benchmark.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<bla rootkey='rootkeyval'>
+  <foo>x</foo>
+  <bar>bar1</bar>
+  <foo key='xy'>
+    y
+    <u/>
+    <bar barkey='hello'>
+      bar2
+    </bar>
+    <quux barkey='goodbye'>
+      quux1
+    </quux>
+    <bar>
+      bar3
+    </bar>
+    <bar barkey='subtree'>
+      bar4
+      <bar>
+        bar4-1
+      </bar>
+      <foo>
+        z
+        <bar>
+          bar4-2
+        </bar>
+        hello
+        <bar>
+          bar4-3
+        </bar>
+      </foo>
+      <bar>
+        bar4-4
+      </bar>
+      <bar>
+        bar4-5
+      </bar>
+      <quux barkey='hello'>
+        bar4-quux1
+      </quux>
+      <bar>
+        bar4-6
+      </bar>
+      <bar>
+        bar4-7
+      </bar>
+    </bar>
+    <quux barkey='hello'>
+      quux2
+    </quux>
+    This buffer is for notes you don't want to save, and for Lisp
+    evaluation.  If you want to create a file, first visit that file
+    with C-x C-f, then enter the text in that file's own buffer.
+    <bar>
+      bar5
+    </bar>
+    <bar>
+      bar6
+    </bar>
+    <quux>
+      quux3
+    </quux>
+    <quux barkey='hello'>
+      quux4
+    </quux>
+    <bar>
+      bar7
+    </bar>
+    <bar>
+      bar8
+    </bar>
+    <bar>
+      bar9
+    </bar>
+  </foo>
+</bla>

data/test/fixtures/company1.xml

@@ -82,4 +82,13 @@
         </address>
       </office>
     </stuff>
+
+    <stuff2>
+      <thing name="name1"/>
+      <thing>
+        <name>name2</name>
+      </thing>
+      <thing>name3</thing>
+      <thing name="name4-attr">name4-inline<name>name4-elt</name></thing>
+    </stuff2>
 </company>

data/test/fixtures/documents_folders.xml

@@ -4,7 +4,6 @@
 <folder>
   <name>home</name>
 
-  <entries>
     <document>
       <name>plan</name>
       <contents>
@@ -16,11 +15,9 @@
     <folder>
       <name>work</name>
 
-      <entries>
         <folder>
           <name>xml-mapping</name>
 
-          <entries>
             <document>
               <name>README</name>
               <contents>
@@ -34,7 +31,6 @@
                 rake away
               </contents>
             </document>
-          </entries>
         </folder>
 
         <document>
@@ -44,14 +40,12 @@
              4:00 PM appointment
           </contents>
         </document>
-      </entries>
     </folder>
 
 
     <folder>
       <name>books</name>
 
-      <entries>
         <document>
           <name>The Hitchhiker's Guide to the Galaxy</name>
           <contents>
@@ -64,8 +58,6 @@
             The Pragmatic Programmer's Guide
           </contents>
         </document>
-      </entries>
     </folder>
 
-  </entries>
 </folder>

data/test/fixtures/documents_folders2.xml

@@ -3,28 +3,22 @@
 <folder>
   <name>home</name>
 
-  <entries>
-    <document>
-      <name>plan</name>
-      <contents> inhale, exhale</contents>
-    </document>
+  <document>
+    <name>plan</name>
+    <contents> inhale, exhale</contents>
+  </document>
 
-    <folder>
-      <name>work</name>
+  <folder>
+    <name>work</name>
 
-      <entries>
-        <folder>
-          <name>xml-mapping</name>
+    <folder>
+      <name>xml-mapping</name>
 
-          <entries>
-            <document>
-              <name>README</name>
-              <contents>foo bar baz</contents>
-            </document>
-          </entries>
-        </folder>
-      </entries>
+      <document>
+        <name>README</name>
+        <contents>foo bar baz</contents>
+      </document>
     </folder>
+  </folder>
 
-  </entries>
 </folder>

data/test/fixtures/triangle_m1.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<triangle name="tri1" >
+  <pt1>
+    <x> 3 </x>
+    <y> 0 </y>
+  </pt1>
+  <pt2>
+    <x> 2 </x>
+    <y> 4 </y>
+  </pt2>
+  <pt3>
+    <x> 0 </x>
+    <y> 1 </y>
+  </pt3>
+  <color>green</color>
+</triangle>

data/test/fixtures/triangle_m2.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<triangle color="green">
+  <name>tri1</name>
+  <points>
+    <point>
+      <x> 3 </x>
+      <y> 0 </y>
+    </point>
+    <point>
+      <x> 2 </x>
+      <y> 4 </y>
+    </point>
+    <point>
+      <x> 0 </x>
+      <y> 1 </y>
+    </point>
+  </points>
+</triangle>