xml-mapping 0.9.1 → 0.10.0

data/examples/documents_folders_usage.intout

@@ -1,10 +1,10 @@
 
 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">]>]>]>
+=> #<Folder:0x007fb015437098 @entries=[#<Document:0x007fb015436148 @name="plan", @contents=" inhale, exhale">, #<Folder:0x007fb0154352c0 @entries=[#<Folder:0x007fb015434550 @entries=[#<Document:0x007fb015432e30 @name="README", @contents="foo bar baz">], @name="xml-mapping">], @name="work">], @name="home">
 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">]>]>]
+=> [#<Document:0x007fb015436148 @name="plan", @contents=" inhale, exhale">, #<Folder:0x007fb0154352c0 @entries=[#<Folder:0x007fb015434550 @entries=[#<Document:0x007fb015432e30 @name="README", @contents="foo bar baz">], @name="xml-mapping">], @name="work">]
 
 root.append "etc", Folder.new
 root["etc"].append "passwd", Document.new

data/examples/order_signature_enhanced_usage.intout

@@ -1,9 +1,9 @@
 s=Signature.load_from_file("order_signature_enhanced.xml") 
-=> #<Signature:0x7f487642e850 @signed_on=Sun Feb 13 00:00:00 +0100 2005, @name="John Doe", @position="product manager">
+=> #<Signature:0x007fb015310840 @position="product manager", @signed_on=2005-02-13 00:00:00 +0100, @name="John Doe">
 s.signed_on 
-=> Sun Feb 13 00:00:00 +0100 2005
+=> 2005-02-13 00:00:00 +0100
 s.signed_on=Time.local(1976,12,18) 
-=> Sat Dec 18 00:00:00 +0100 1976
+=> 1976-12-18 00:00:00 +0100
 s.save_to_xml.write($stdout,2) 
 <signature>
   <Name>

data/examples/order_usage.intout

@@ -1,18 +1,18 @@
 ####read access
 o=Order.load_from_file("order.xml") 
-=> #<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">>>
+=> #<Order:0x007fb01549d438 @signatures=[#<Signature:0x007fb015493b68 @position="product manager", @name="John Doe">, #<Signature:0x007fb015492c68 @position="clerk", @name="Jill Smith">, #<Signature:0x007fb015491a20 @position="Some Employee", @name="Miles O'Brien">], @reference="12343-AHSHE-314159", @client=#<Client:0x007fb01549c998 @work_address=#<Address:0x007fb01549a238 @city="San Francisco", @state="CA", @zip=94102, @street="98765, Fulton Street">, @name="Jean Smith", @home_address=#<Address:0x007fb01549bbb0 @city="San Mateo", @state="CA", @zip=94403, @street="2000, Alameda de las Pulgas">>, @items={"RF-0001"=>#<Item:0x007fb0154989b0 @descr="Stuffed Penguin", @quantity=10, @unit_price=8.95>, "RF-0034"=>#<Item:0x007fb015496638 @descr="Chocolate", @quantity=5, @unit_price=28.5>, "RF-3341"=>#<Item:0x007fb015495300 @descr="Cookie", @quantity=30, @unit_price=0.85>}>
 o.reference 
 => "12343-AHSHE-314159"
 o.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">>
+=> #<Client:0x007fb01549c998 @work_address=#<Address:0x007fb01549a238 @city="San Francisco", @state="CA", @zip=94102, @street="98765, Fulton Street">, @name="Jean Smith", @home_address=#<Address:0x007fb01549bbb0 @city="San Mateo", @state="CA", @zip=94403, @street="2000, Alameda de las Pulgas">>
 o.items.keys 
-=> ["RF-3341", "RF-0034", "RF-0001"]
+=> ["RF-0001", "RF-0034", "RF-3341"]
 o.items["RF-0034"].descr 
 => "Chocolate"
 o.items["RF-0034"].total_price 
 => 142.5
 o.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">]
+=> [#<Signature:0x007fb015493b68 @position="product manager", @name="John Doe">, #<Signature:0x007fb015492c68 @position="clerk", @name="Jill Smith">, #<Signature:0x007fb015491a20 @position="Some Employee", @name="Miles O'Brien">]
 o.signatures[2].name 
 => "Miles O'Brien"
 o.signatures[2].position 
@@ -70,48 +70,48 @@ xml.write($stdout,2)
       </Street>
     </Address>
   </Client>
-  <Item reference='RF-3341'>
+  <Item reference='RF-0001'>
     <Description>
-      Cookie
+      Stuffed Penguin
     </Description>
     <Quantity>
-      30
+      10
     </Quantity>
     <UnitPrice>
-      0.85
+      8.95
     </UnitPrice>
   </Item>
-  <Item reference='RF-4711'>
+  <Item reference='RF-0034'>
     <Description>
-      power transfer grid
+      Chocolate
     </Description>
     <Quantity>
-      2
+      5
     </Quantity>
     <UnitPrice>
-      29.95
+      28.5
     </UnitPrice>
   </Item>
-  <Item reference='RF-0034'>
+  <Item reference='RF-3341'>
     <Description>
-      Chocolate
+      Cookie
     </Description>
     <Quantity>
-      5
+      30
     </Quantity>
     <UnitPrice>
-      28.5
+      0.85
     </UnitPrice>
   </Item>
-  <Item reference='RF-0001'>
+  <Item reference='RF-4711'>
     <Description>
-      Stuffed Penguin
+      power transfer grid
     </Description>
     <Quantity>
-      10
+      2
     </Quantity>
     <UnitPrice>
-      8.95
+      29.95
     </UnitPrice>
   </Item>
   <Signed-By>
@@ -150,17 +150,17 @@ xml.write($stdout,2)
 
 ####Starting a new order from scratch
 o = Order.new 
-=> #<Order:0x7f48766fc118 @signatures=[]>
+=> #<Order:0x007fb0153bfef8 @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: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'
+	from /home/olaf/xml-mapping/lib/xml/mapping/base.rb:712:in `obj_to_xml'
+	from /home/olaf/xml-mapping/lib/xml/mapping/base.rb:218:in `block in fill_into_xml'
+	from /home/olaf/xml-mapping/lib/xml/mapping/base.rb:217:in `each'
+	from /home/olaf/xml-mapping/lib/xml/mapping/base.rb:217:in `fill_into_xml'
+	from /home/olaf/xml-mapping/lib/xml/mapping/base.rb:229:in `save_to_xml'
 ## can't save as long as there are still unset attributes without
 ## default values
 

data/examples/person.intout

@@ -10,13 +10,13 @@ end
 ### usage
 
 p1 = Person.load_from_xml(REXML::Document.new('<person name="Jim"/>').root)
-=> #<Person:0x7f48763d3360 @name="Jim">
+=> #<Person:0x007fb014e95298 @name="Jim">
 
 p2 = Person.load_from_xml(REXML::Document.new('<person><name>James</name></person>').root)
-=> #<Person:0x7f48763ce900 @name="James">
+=> #<Person:0x007fb014e847b8 @name="James">
 
 p3 = Person.load_from_xml(REXML::Document.new('<person>Suzy</person>').root)
-=> #<Person:0x7f48763c99f0 @name="Suzy">
+=> #<Person:0x007fb014e6c550 @name="Suzy">
 
 
 p1.save_to_xml.write($stdout)

data/examples/person_mm.intout

@@ -66,7 +66,7 @@ xml = REXML::Document.new('
 
 ## 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>
+=> #<Person:0x007fb015506640 @name="Suzy", @age=28, @address=#<Address:0x007fb015505a38 @street="Abbey Road", @number=72, @city="London", @zip=18827>>
 
 ## save using the default mapping
 xml2 = p.save_to_xml
@@ -109,6 +109,6 @@ other_xml.write $stdout,2
 </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>
+=> #<Person:0x007fb0154bad30 @name="Suzy", @age=28, @address=#<Address:0x007fb0154b98e0 @street="Abbey Road", @number=72, @city="London", @zip=18827>>
 
 ## p2 identical to p 

data/examples/publication.intout

@@ -9,7 +9,7 @@ end
 ### usage
 
 p1 = Publication.load_from_xml(REXML::Document.new('<publication author="Jim"/>').root)
-=> #<Publication:0x7f487656b308 @author="Jim">
+=> #<Publication:0x007fb01548e668 @author="Jim">
 
 p2 = Publication.load_from_xml(REXML::Document.new('
 <publication>
@@ -17,4 +17,4 @@ p2 = Publication.load_from_xml(REXML::Document.new('
   <contr>Mel</contr>
   <contr>Toby</contr>
 </publication>').root)
-=> #<Publication:0x7f48766be930 @contributors=["Chris", "Mel", "Toby"]>
+=> #<Publication:0x007fb01547ef38 @contributors=["Chris", "Mel", "Toby"]>

data/examples/reader.intout

@@ -12,7 +12,7 @@ class Foo
 end
 
 f = Foo.load_from_xml(REXML::Document.new('<foo name="Jim" more="XYZ"/>').root)
-=> #<Foo:0x7f48766cdef8 @name="JimXYZ">
+=> #<Foo:0x007fb015460c40 @name="JimXYZ">
 
 xml = f.save_to_xml 
 xml.write $stdout,2 

data/examples/stringarray_usage.intout

@@ -1,5 +1,5 @@
 ppl=People.load_from_file("stringarray.xml") 
-=> #<People:0x7f487665ecd8 @names=["Jim", "Susan", "Herbie", "Nancy"]>
+=> #<People:0x007fb015431a58 @names=["Jim", "Susan", "Herbie", "Nancy"]>
 ppl.names 
 => ["Jim", "Susan", "Herbie", "Nancy"]
 

data/examples/time_augm.intout

@@ -15,21 +15,21 @@ nowxml=Time.now.save_to_xml
 nowxml.write($stdout,2)
 <time>
   <year>
-    2010
+    2014
   </year>
   <month>
-    5
+    9
   </month>
   <mday>
-    21
+    19
   </mday>
   <hours>
-    16
+    14
   </hours>
   <minutes>
-    42
+    1
   </minutes>
   <seconds>
-    15
+    43
   </seconds>
 </time>

data/examples/xpath_create_new.intout

@@ -64,7 +64,7 @@ firstbazelt=XML::XXPath.new("/bar/baz").first(rootelt)
 path2=XML::XXPath.new("@key2")
 
 path2.create_new(firstbazelt)
-=> #<XML::XXPath::Accessors::Attribute:0x7f48764e8688 @name="key2", @parent=<baz key='work' key2='[unset]'> ... </>>
+=> #<XML::XXPath::Accessors::Attribute:0x007fb014e37210 @parent=<baz key='work' key2='[unset]'> ... </>, @name="key2">
 d.write($stdout,2)
  
 <foo>
@@ -87,12 +87,12 @@ d.write($stdout,2)
 ### same call again...
 path2.create_new(firstbazelt)
 XML::XXPathError: XPath (@key2): create_new and attribute already exists
-	from ../lib/xml/../xml/xxpath/steps.rb:215:in `create_on'
-	from ../lib/xml/../xml/xxpath/steps.rb:80:in `creator'
-	from ../lib/xml/xxpath.rb:91:in `call'
-	from ../lib/xml/xxpath.rb:91:in `all'
-	from ../lib/xml/xxpath.rb:70:in `first'
-	from ../lib/xml/xxpath.rb:112:in `create_new'
+	from /home/olaf/xml-mapping/lib/xml/xxpath/steps.rb:215:in `create_on'
+	from /home/olaf/xml-mapping/lib/xml/xxpath/steps.rb:80:in `block in creator'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:91:in `call'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:91:in `all'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:70:in `first'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:112:in `create_new'
 ### can't create that path anew again -- an element can't have more
 ### than one attribute with the same name
 
@@ -150,12 +150,12 @@ d.write($stdout,2)
 
 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/steps.rb:167:in `create_on'
-	from ../lib/xml/../xml/xxpath/steps.rb:80:in `creator'
-	from ../lib/xml/xxpath.rb:91:in `call'
-	from ../lib/xml/xxpath.rb:91:in `all'
-	from ../lib/xml/xxpath.rb:70:in `first'
-	from ../lib/xml/xxpath.rb:112:in `create_new'
+	from /home/olaf/xml-mapping/lib/xml/xxpath/steps.rb:167:in `create_on'
+	from /home/olaf/xml-mapping/lib/xml/xxpath/steps.rb:80:in `block in creator'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:91:in `call'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:91:in `all'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:70:in `first'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:112:in `create_new'
 ### yep, baz[6] already existed and thus couldn't be created once
 ### again
 

data/examples/xpath_ensure_created.intout

@@ -96,7 +96,7 @@ d.write($stdout,2)
 </foo>### no change
 
 XML::XXPath.new("/bar/baz[6]/@haha").first(rootelt,:ensure_created=>true)
-=> #<XML::XXPath::Accessors::Attribute:0x7f4876522658 @name="haha", @parent=<baz haha='[unset]'/>>
+=> #<XML::XXPath::Accessors::Attribute:0x007fb014a51d08 @parent=<baz haha='[unset]'/>, @name="haha">
 d.write($stdout,2)
  
 <foo>
@@ -115,7 +115,7 @@ d.write($stdout,2)
 </foo>### for there to be a 6th "baz" element, there must be 1st..5th "baz" elements
 
 XML::XXPath.new("/bar/baz[6]/@haha").first(rootelt,:ensure_created=>true)
-=> #<XML::XXPath::Accessors::Attribute:0x7f4876516bc8 @name="haha", @parent=<baz haha='[unset]'/>>
+=> #<XML::XXPath::Accessors::Attribute:0x007fb014a479c0 @parent=<baz haha='[unset]'/>, @name="haha">
 d.write($stdout,2)
  
 <foo>

data/examples/xpath_usage.intout

@@ -44,7 +44,7 @@ path2.all(d)
 ## "first" raises XML::XXPathError in such cases...
 path2.first(d)
 XML::XXPathError: path not found: /foo/bar[2]/baz[4]
-	from ../lib/xml/xxpath.rb:75:in `first'
+	from /home/olaf/xml-mapping/lib/xml/xxpath.rb:75:in `first'
 
 ##...unless we allow nil returns
 path2.first(d,:allow_nil=>true)

data/lib/xml/mapping.rb

@@ -1,8 +1,6 @@
 # xml-mapping -- bidirectional Ruby-XML mapper
 #  Copyright (C) 2004-2006 Olaf Klischat
 
-$:.unshift(File.dirname(__FILE__)+"/..")
-
 require 'xml/mapping/base'
 require 'xml/mapping/standard_nodes'
 

data/lib/xml/mapping/base.rb

@@ -301,16 +301,26 @@ module XML
       end
 
       # Add getter and setter methods for a new attribute named _name_
-      # to this class. This is a convenience method intended to be
-      # called from Node class initializers.
+      # (must be a symbol or a string) to this class, taking care not
+      # to replace existing getters/setters.  This is a convenience
+      # method intended to be called from Node class initializers.
       def add_accessor(name)
-        name = name.id2name if name.kind_of? Symbol
-        unless self.instance_methods.include?(name)
+        # existing methods search. Search for symbols and strings
+        #  to be compatible with Ruby 1.8 and 1.9.
+        methods = self.instance_methods
+        if methods[0].kind_of? Symbol
+          getter = :"#{name}"
+          setter = :"#{name}="
+        else
+          getter = "#{name}"
+          setter = "#{name}="
+        end
+        unless methods.include?(getter)
           self.module_eval <<-EOS
             attr_reader :#{name}
           EOS
         end
-        unless self.instance_methods.include?("#{name}=")
+        unless methods.include?(setter)
           self.module_eval <<-EOS
             attr_writer :#{name}
           EOS
@@ -337,6 +347,11 @@ module XML
         # doesn't work, try allocate, which bypasses the initializer.
         begin
           obj = self.new
+          #TODO: this will normally invoke our base XML::Mapping#initialize, which calls
+          #  obj.initialize_xml_mapping, which is called below again (with the correct :mapping parameter).
+          #  obj.initialize_xml_mapping calls obj_initializing on all nodes.
+          #  So obj_initializing may be called on the nodes twice for this initialization.
+          #  Maybe document this for node writers?
         rescue ArgumentError # TODO: this may hide real errors.
                              #   how to statically check whether
                              #   self self.new accepts an empty
@@ -538,9 +553,9 @@ module XML
             alias_method :default_xml_to_obj, :xml_to_obj
             def xml_to_obj(obj,xml)
               begin
-                @options[:reader].call(obj,xml)
-              rescue ArgumentError
                 @options[:reader].call(obj,xml,self.method(:default_xml_to_obj))
+              rescue ArgumentError  # thrown if @options[:reader] is a lambda (i.e. no Proc) with !=3 args (e.g. proc{...} in ruby1.8)
+                @options[:reader].call(obj,xml)
               end
             end
           end
@@ -552,9 +567,9 @@ module XML
             alias_method :default_obj_to_xml, :obj_to_xml
             def obj_to_xml(obj,xml)
               begin
-                @options[:writer].call(obj,xml)
-              rescue ArgumentError
                 @options[:writer].call(obj,xml,self.method(:default_obj_to_xml))
+              rescue ArgumentError # thrown if (see above)
+                @options[:writer].call(obj,xml)
               end
             end
           end

data/lib/xml/mapping/version.rb

@@ -3,6 +3,6 @@
 
 module XML
   module Mapping
-    VERSION = '0.9.1'
+    VERSION = '0.10.0'
   end
 end

data/test/company.rb

@@ -101,3 +101,46 @@ class WriterTest
                                         }
   text_node :bar, "bar"
 end
+
+
+class ReaderWriterProcVsLambdaTest
+  include XML::Mapping
+
+  attr_accessor :read, :written
+
+  text_node :proc_2args, "proc_2args", :reader=>Proc.new{|obj,xml|
+                                                            (obj.read||=[]) << :proc_2args
+                                                        },
+                                       :writer=>Proc.new{|obj,xml|
+                                                            (obj.written||=[]) << :proc_2args
+                                                        }
+
+  text_node :proc_3args, "proc_3args", :reader=>Proc.new{|obj,xml,default|
+                                                            (obj.read||=[]) << :proc_3args
+                                                            default.call(obj,xml)
+                                                        },
+                                       :writer=>Proc.new{|obj,xml,default|
+                                                            (obj.written||=[]) << :proc_3args
+                                                            default.call(obj,xml)
+                                                        }
+
+
+  text_node :lambda_2args, "lambda_2args", :reader=>lambda{|obj,xml|
+                                                              (obj.read||=[]) << :lambda_2args
+                                                          },
+                                           :writer=>lambda{|obj,xml|
+                                                              (obj.written||=[]) << :lambda_2args
+                                                          }
+
+
+  text_node :lambda_3args, "lambda_3args", :reader=>lambda{|obj,xml,default|
+                                                              (obj.read||=[]) << :lambda_3args
+                                                              default.call(obj,xml)
+                                                          },
+                                           :writer=>lambda{|obj,xml,default|
+                                                              (obj.written||=[]) << :lambda_3args
+                                                              default.call(obj,xml)
+                                                          }
+
+
+end

data/test/documents_folders.rb

@@ -4,6 +4,13 @@ class Entry
   include XML::Mapping
 
   text_node :name, "name"
+
+  def initialize(init_props={})
+    super()  #the super initialize (inherited from XML::Mapping) must be called
+    init_props.entries.each do |name,value|
+      self.send :"#{name}=", value
+    end
+  end
 end