xml-mapping 0.9.1 → 0.10.0

metadata

@@ -1,148 +1,136 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xml-mapping
-version: !ruby/object:Gem::Version 
-  version: 0.9.1
+version: !ruby/object:Gem::Version
+  version: 0.10.0
 platform: ruby
-authors: 
+authors:
 - Olaf Klischat
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-21 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: 
-email: olaf.klischat@sofd.de
+date: 2014-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy to use, extensible library for semi-automatically mapping Ruby
+  objects to XML and back. Includes an XPath interpreter.
+email: olaf.klischat@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-- README_XPATH
-- ChangeLog
+extra_rdoc_files:
+- user_manual.md
+- README.md
+- user_manual_xxpath.md
 - TODO.txt
 - doc/xpath_impl_notes.txt
-files: 
-- README
-- README_XPATH
-- ChangeLog
+files:
+- LICENSE
+- README.md
+- Rakefile
 - TODO.txt
 - doc/xpath_impl_notes.txt
-- lib/xml/xxpath.rb
-- lib/xml/xxpath_methods.rb
-- lib/xml/xxpath/steps.rb
-- lib/xml/mapping/standard_nodes.rb
-- lib/xml/mapping/core_classes_mapping.rb
-- lib/xml/mapping/version.rb
-- lib/xml/mapping/base.rb
-- lib/xml/rexml_ext.rb
-- lib/xml/mapping.rb
-- examples/xpath_create_new.intin.rb
-- examples/xpath_ensure_created.intout
-- examples/time_augm_loading.intout
-- examples/time_node_w_marshallers.intin.rb
-- examples/order.rb
 - examples/README
-- examples/time_augm.intin.rb
-- examples/stringarray_usage.intin.rb
-- examples/xpath_ensure_created.intin.rb
-- examples/time_augm.intout
-- examples/person_mm.intout
-- examples/person_mm.intin.rb
-- examples/order_signature_enhanced.rb
+- examples/cleanup.rb
+- examples/company.rb
 - examples/company.xml
-- examples/person.intout
-- examples/stringarray_usage.intout
+- examples/company_usage.intout
+- examples/documents_folders.rb
+- examples/documents_folders.xml
 - examples/documents_folders_usage.intout
-- examples/time_node.rb
-- examples/person.intin.rb
-- examples/time_node_w_marshallers.xml
-- examples/reader.intin.rb
-- examples/company_usage.intin.rb
-- examples/xpath_pathological.intin.rb
-- examples/xpath_pathological.intout
+- examples/order.rb
+- examples/order.xml
+- examples/order_signature_enhanced.rb
 - examples/order_signature_enhanced.xml
-- examples/time_augm_loading.intin.rb
-- examples/xpath_usage.intin.rb
-- examples/xpath_docvsroot.intin.rb
-- examples/stringarray.rb
-- examples/time_node.intin.rb
-- examples/publication.intin.rb
-- examples/documents_folders_usage.intin.rb
-- examples/xpath_usage.intout
-- examples/order_signature_enhanced_usage.intin.rb
-- examples/documents_folders.xml
-- examples/order_usage.intin.rb
-- examples/xpath_create_new.intout
-- examples/company.rb
 - examples/order_signature_enhanced_usage.intout
-- examples/order.xml
 - examples/order_usage.intout
+- examples/person.intout
+- examples/person_mm.intout
 - examples/publication.intout
-- examples/company_usage.intout
-- examples/time_node_w_marshallers.intout
 - examples/reader.intout
+- examples/stringarray.rb
 - examples/stringarray.xml
+- examples/stringarray_usage.intout
+- examples/time_augm.intout
+- examples/time_augm_loading.intout
+- examples/time_node.rb
+- examples/time_node_w_marshallers.intout
+- examples/time_node_w_marshallers.xml
+- examples/xpath_create_new.intout
 - examples/xpath_docvsroot.intout
-- examples/documents_folders.rb
-- test/xxpath_benchmark.rb
-- test/xxpath_methods_test.rb
+- examples/xpath_ensure_created.intout
+- examples/xpath_pathological.intout
+- examples/xpath_usage.intout
+- lib/xml/mapping.rb
+- lib/xml/mapping/base.rb
+- lib/xml/mapping/core_classes_mapping.rb
+- lib/xml/mapping/standard_nodes.rb
+- lib/xml/mapping/version.rb
+- lib/xml/rexml_ext.rb
+- lib/xml/xxpath.rb
+- lib/xml/xxpath/steps.rb
+- lib/xml/xxpath_methods.rb
+- test/all_tests.rb
+- test/benchmark_fixtures.rb
+- test/bookmarks.rb
+- test/company.rb
+- test/documents_folders.rb
 - test/examples_test.rb
-- test/fixtures/triangle_m2.xml
-- test/fixtures/company1.xml
-- test/fixtures/bookmarks1.xml
 - test/fixtures/benchmark.xml
-- test/fixtures/triangle_m1.xml
-- test/fixtures/documents_folders2.xml
+- test/fixtures/bookmarks1.xml
+- test/fixtures/company1.xml
 - test/fixtures/documents_folders.xml
-- test/xml_mapping_test.rb
-- test/triangle_mm.rb
-- test/xpath_test.rb
-- test/xxpath_benchmark.result1.txt
-- test/tests_init.rb
-- test/rexml_xpath_benchmark.rb
-- test/all_tests.rb
-- test/multiple_mappings_test.rb
+- test/fixtures/documents_folders2.xml
+- test/fixtures/triangle_m1.xml
+- test/fixtures/triangle_m2.xml
 - test/inheritance_test.rb
-- test/company.rb
+- test/multiple_mappings_test.rb
+- test/rexml_xpath_benchmark.rb
+- test/tests_init.rb
+- test/triangle_mm.rb
 - test/xml_mapping_adv_test.rb
-- test/bookmarks.rb
-- test/benchmark_fixtures.rb
-- test/documents_folders.rb
-- LICENSE
-- Rakefile
-- install.rb
-has_rdoc: true
-homepage: http://xml-mapping.rubyforge.org
-licenses: []
-
+- test/xml_mapping_test.rb
+- test/xpath_test.rb
+- test/xxpath_benchmark.rb
+- test/xxpath_methods_test.rb
+- user_manual.md
+- user_manual_xxpath.md
+homepage: https://github.com/multi-io/xml-mapping
+licenses:
+- Apache-2.0
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --include
+rdoc_options:
+- "--include"
 - examples
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: xml-mapping
-rubygems_version: 1.3.5
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: An easy to use, extensible library for mapping Ruby objects to XML and back. Includes an XPath interpreter.
-test_files: 
+specification_version: 4
+summary: XML-Object mapper for Ruby
+test_files:
 - test/all_tests.rb

data/ChangeLog

@@ -1,189 +0,0 @@
-2006/12/26  Olaf Klischat
-
-	* when creating a new instance of a mapping class from an XML
-	  input, call new if possible rather than allocate (patch by Fred
-	  Loney)
-
-2006/04/30  Olaf Klischat
-
-	* xml/xxpath: text() steps
-
-2006/03/31  Olaf Klischat
-
-	* SubObjectBaseNode: store marshaller/unmarshaller in
-	  @marshaller/@unmarshaller (general policy for node
-	  implementations is to set @options to
-	  originally supplied option arguments and never change it; then
-	  store "extracted" information in additional @attributes)
-
-2006/02/19  Olaf Klischat
-
-	* xml/xxpath: child::*[@attrname='attrvalue'] steps
-
-2006/02/19  Olaf Klischat
-
-	* xml/xxpath: .[@attrname='attrvalue'] steps
-
-2005/12/30  Olaf Klischat
-
-	* node initializers in node's initialize() method; initialize_impl
-	  deprecated (but retained for backward compatibility)
-
-2005/12/28  Olaf Klischat
-
-	* :reader/:writer options to node factory functions (for partially
-	  or completely overriding the node's functionality)
-
-2005/12/07  Olaf Klischat
-
-	* ChangeLog file
-
-2005/11/30  Olaf Klischat
-
-	* bugfix: clone default values to avoid external modifications
-
-2005/11/27  Olaf Klischat
-
-	* xml/xxpath: name1|name2|... steps
-
-2005/11/19  Olaf Klischat
-
-	* support for String and numeric types in :class attributes
-
-2005/11/16  Olaf Klischat
-
-	* choice_node
-
-2005/11/05  Olaf Klischat
-
-	* xml/xxpath: descendants ("//") axis
-
-2005/10/11  Olaf Klischat
-
-	* support for "." paths/path elements (map sub-objects to XML data
-	  from the parent object's XML element)
-
-2005/10/05  Olaf Klischat
-
-	* multiple distinct mappings per mapping class
-
-2005/09/30  Olaf Klischat
-
-	* @options moved from SingleAttributeNode to Node
-
-2005/07/07  Olaf Klischat
-
-	* release 0.8
-
-2005/07/04  Olaf Klischat
-
-	* xml/xpath / XML::XPath -> xml/xxpath / XML::XXPath, license ->
-	  Ruby's
-
-2005/06/29  Olaf Klischat
-
-	* when creating elt[@attr='value'] path elements, add a new
-	  element if one with @attr='value' already existed
-
-2005/03/30  Olaf Klischat
-
-	* add_accessor: check for existing accessors.
-
-2005/03/05  Olaf Klischat
-
-	* better support for inheritance among mapping
-	  classes
-
-2005/03/03  Olaf Klischat
-
-	* "polymorphic" nodes via root element
-	  name. SubObjectBaseNode-based nodes es use node polymorphy when
-	  no explicit node marshaller/unmarshaller has been sp ecified.
-	
-2005/02/28  Olaf Klischat
-
-	* mapping root elt name => mapping class;
-	  XML::Mapping::load_object_from_* implemented
-
-2005/02/13  Olaf Klischat
-
-	* IntNode renamed & generalized to NumericNode
-
-2005/02/12  Olaf Klischat
-
-	* renaming *_rexml => *_xml
-
-2005/01/27  Olaf Klischat
-
-	* special exception NoAttrValueSet for indicating absence of a
-	  specific attribute in an XML source
-
-2005/01/23  Olaf Klischat
-
-	* some more documentation, Node.obj_initializing, setting node
-	  values to defaults on initialization
-
-2005/01/10  Olaf Klischat
-
-	* root_element_name
-
-2005/01/07  Olaf Klischat
-
-	* refactoring:
-
-	  Made node types (classes) dynamically addable via
-	  XML::Mapping.add_node_class, xml/mapping.rb moved to
-	  xml/mapping/base.rb, node types moved to
-	  xml/mapping/standard_nodes.rb, xml/mapping.rb now requires base
-	  and standard_nodes and adds all standard node types to
-	  XML::Mapping.
-
-	* additional node class SingleAttributeNode < Node for nodes that
-	  map to a single attribute in their class (that's true for all
-	  nodes we have so far). Call to add_attribute moved from "core"
-	  to SingleAttributeNode.initialize.
-
-	* XML::Mapping: @nodes renamed to @xml_mapping_nodes to minimize
-	  chance of name clashes.
-	
-2004/12/30  Olaf Klischat
-
-	* array node writing, hash node writing
-
-
-2004/12/30  Olaf Klischat
-
-	* xpath: create_new flag, + convenience method
-
-2004/12/21  Olaf Klischat
-
-	* node classes
-	
-2004/12/20  Olaf Klischat
-
-	* hash_node
-	
-2004/12/08  Olaf Klischat
-
-	* xpath: attribute nodes
-
-	* xml_mapping: retargeted from REXML::XPath to XML::XPath
-
-2004/12/02  Olaf Klischat
-
-	* xpath: write accessors
-	
-2004/11/27  Olaf Klischat
-
-	* xpath: read access seems to work
-
-2004/11/25  Olaf Klischat
-
-	* array_node
-
-stone age   Olaf Klischat
-
-	* see http://rubygarden.org/ruby?XmlMapping
-	
-	
-

data/README_XPATH

@@ -1,202 +0,0 @@
-= XML-XXPATH
-
-== Overview, Motivation
-
-Xml-xxpath is an (incomplete) XPath interpreter that is at the moment
-bundled with xml-mapping. It is built on top of REXML. xml-mapping
-uses xml-xxpath extensively for implementing its node types -- see the
-README file and the reference documentation (and the source code) for
-details. xml-xxpath, however, does not depend on xml-mapping at all,
-and is useful in its own right -- maybe I'll later distribute it as a
-seperate library instead of bundling it. For the time being, if you
-want to use this XPath implementation stand-alone, you can just rip
-the files <tt>lib/xml/xxpath.rb</tt>,
-<tt>lib/xml/xxpath/steps.rb</tt>, and
-<tt>lib/xml/xxpath_methods.rb</tt> out of the xml-mapping distribution
-and use them on their own (they do not depend on anything else).
-
-xml-xxpath's XPath support is vastly incomplete (see below), but, in
-addition to the normal reading/matching functionality found in other
-XPath implementations (i.e. "find all elements in a given XML document
-matching a given XPath expression"), xml-xxpath supports <i>write
-access</i>. For example, when writing the XPath expression
-"/foo/bar[3]/baz[@key='hiho']" to the XML document
-
-  <foo>
-    <bar>
-      <baz key='ab'>hello</baz>
-      <baz key='xy'>goodbye</baz>
-    </bar>
-  </foo>
-
-, you'll get:
-
-  <foo>
-    <bar>
-      <baz key='ab'>hello</baz>
-      <baz key='xy'>goodbye</baz>
-    </bar>
-    <bar/>
-    <bar><baz key='hiho'/></bar>
-  </foo>
-
-This feature is used by xml-mapping when writing (marshalling) Ruby
-objects to XML, and is actually the reason why I couldn't just use any
-of the existing XPath implementations, e.g. the one that comes with
-REXML. Also, the whole xml-xxpath implementation is just 300 lines of
-Ruby code, it is quite fast (paths are precompiled), and xml-xxpath
-returns matched elements in the order they appeared in the source
-document -- I've heard REXML::XPath doesn't do that :)
-
-Some basic knowledge of XPath is helpful for reading this document.
-
-At the moment, xml-xxpath understands XPath expressions of the form
-[<tt>/</tt>]_pathelement_<tt>/[/]</tt>_pathelement_<tt>/[/]</tt>...,
-where each _pathelement_ must be one of these:
-
-- a simple element name _name_, e.g. +signature+
-
-- an attribute name, @_attr_name_, e.g. <tt>@key</tt>
-
-- a combination of an element name and an attribute name and
-  -value, in the form _elt_name_[@_attr_name_='_attr_value_']
-
-- an element name and an index, _elt_name_[_index_]
-
-- the "match-all" path element, <tt>*</tt>
-
-- .
-
-- name1|name2|...
-
-- .[@key='xy'] / self::*[@key='xy']
-
-- child::*[@key='xy']
-
-- text()
-
-
-
-Xml-xxpath only supports relative paths at this time, i.e. XPath
-expressions beginning with "/" or "//" will still only find nodes
-below the node the expression is applied to (as if you had written
-"./" or ".//", respectively).
-
-
-== Usage
-
-Xml-xxpath defines the class XML::XXPath. An instance of that class
-wraps an XPath expression, the string representation of which must be
-supplied when constructing the instance. You then call instance
-methods like _first_, _all_ or <i>create_new</i> on the instance,
-supplying the REXML Element the XPath expression should be applied to,
-and get the results, or, in the case of write access, the element is
-updated in-place.
-
-
-=== Read Access
-
-  :include: xpath_usage.intout
-
-The objects supplied to the <tt>all()</tt>, <tt>first()</tt>, and
-<tt>each()</tt> calls must be REXML element nodes, i.e. they must
-support messages like <tt>elements</tt>, <tt>attributes</tt> etc
-(instances of REXML::Element and its subclasses do this). The calls
-return the found elements as instances of REXML::Element or
-XML::XXPath::Accessors::Attribute. The latter is a wrapper around
-attribute nodes that is largely call-compatible to
-REXML::Element. This is so you can write things like
-<tt>path.each{|node|puts node.text}</tt> without having to
-special-case anything even if the path matches attributes, not just
-elements.
-
-As you can see, you can re-use path objects, applying them to
-different XML elements at will. You should do this because the XPath
-pattern is stored inside the XPath object in a pre-compiled form,
-which makes it more efficient.
-
-The path elements of the XPath pattern are applied to the
-<tt>.elements</tt> collection of the passed XML element and its
-sub-elements, starting with the first one. This is shown by the
-following code:
-
-  :include: xpath_docvsroot.intout
-
-A REXML +Document+ object is a REXML +Element+ object whose +elements+
-collection consists only of a single member -- the document's root
-node. The first path element of the XPath -- "foo" in the example --
-is matched against that. That is why the path "/bar" in the example
-doesn't match anything when matched against the document +d+ itself.
-
-An ordinary REXML +Element+ object that represents a node somewhere
-inside an XML tree has an +elements+ collection that consists of all
-the element's direct sub-elements. That is why XPath patterns matched
-against the +firstelt+ element in the example *must not* start with
-"/first" (unless there is a child node that is also named "first").
-
-
-=== Write Access
-
-You may pass an <tt>:ensure_created=>true</tt> option argument to
-_path_.first(_elt_)/_path_.all(_elt_) calls to make sure that _path_
-exists inside the passed XML element _elt_. If it existed before,
-nothing changes, and the call behaves just as it would without the
-option argument. If the path didn't exist before, the XML element is
-modified such that
-
-- the path exists afterwards
-
-- all paths that existed before still exist afterwards
-
-- the modification is as small as possible (i.e. as few elements as
-  possible are added, additional attributes are added to existing
-  elements if possible etc.)
-
-The created resp. previously existing, matching elements are returned.
-
-
-Examples:
-
-  :include: xpath_ensure_created.intout
-
-
-Alternatively, you may pass a <tt>:create_new=>true</tt> option
-argument or call <tt>create_new</tt> (_path_.create_new(_elt_) is
-equivalent to _path_.first(_elt_,:create_new=>true)). In that case, a
-new node is created in _elt_ for each path element of _path_ (or an
-exception raised if that wasn't possible for any path element).
-
-Examples:
-
-  :include: xpath_create_new.intout
-
-This feature is used in xml-mapping by node types like
-XML::Mapping::ArrayNode, which must create a new instance of the
-"per-array element path" for each element of the array to be stored in
-an XML tree.
-
-
-=== Pathological Cases
-
-What is created when the Path "*" is to be created inside an empty XML
-element? The name of the element to be created isn't known, but still
-some element must be created. The answer is that xml-xxpath creates a
-special "unspecified" element whose name must be set by the caller
-afterwards:
-
-  :include: xpath_pathological.intout
-
-The "newelt" object in the last example is an ordinary
-REXML::Element. xml-xxpath mixes the "unspecified" attribute into that
-class, as well as into the XML::XXPath::Accessors::Attribute class
-mentioned above.
-
-
-== Implentation notes
-
-<tt>doc/xpath_impl_notes.txt</tt> contains some documentation on the
-implementation of xml-xxpath.
-
-== License
-
-Ruby's.