xml-mapping 0.9.1 → 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fc1ba6799b750d709b7ee01630bf670f8488854
+  data.tar.gz: be07c8311cce21655d28124edfed9d18378d4a71
+SHA512:
+  metadata.gz: fdec3b02611b85281ed21da509f57e04f4eb5516947ec6c42879fd7381cc020a960245ab9ab7ae683f07a218d24517488a8169c04af2958e94eaf1d647179b46
+  data.tar.gz: c13f9e1ccf415ffd0bc4fa7f0faef0c7e9c37f83f1b2916519212de729087a8abd606dcee5b40712ecad5c18e4b362c10504b532b7786c2c562c6f12f640a324

data/LICENSE

@@ -1,56 +1,13 @@
-Xml-mapping is copyrighted free software by Olaf Klischat
-<klischat@cs.tu-berlin.de>.  You can redistribute it and/or modify it
-under either the terms of the GPL, or the conditions below:
+Copyright 2014 Olaf Klischat
 
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
+    http://www.apache.org/licenses/LICENSE-2.0
 
-       a) place your modifications in the Public Domain or otherwise
-          make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
-
-       b) use the modified software only within your corporation or
-          organization.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  3. You may distribute the software in object code or binary form,
-     provided that you do at least ONE of the following:
-
-       a) distribute the binaries and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
-
-       b) accompany the distribution with the machine-readable source of
-	  the software.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under these terms.
-
-     For the list of those files and their copying conditions, see the
-     file LEGAL.
-
-  5. The scripts and library files supplied as input to or produced as 
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them, 
-     and may be sold commercially, and may be aggregated with this
-     software.
-
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+# XML-MAPPING: XML-to-object (and back) Mapper for Ruby, including XPath Interpreter
+
+Xml-mapping is an easy to use, extensible library that allows you to
+semi-automatically map Ruby objects to XML trees and vice versa.
+
+
+## Trivial Example
+
+### sample document
+
+    <?xml version="1.0" encoding="ISO-8859-1"?>
+
+    <item reference="RF-0001">
+        <Description>Stuffed Penguin</Description>
+        <Quantity>10</Quantity>
+        <UnitPrice>8.95</UnitPrice>
+    </item>
+
+### mapping class
+
+    class Item
+      include XML::Mapping
+
+      text_node :ref, "@reference"
+      text_node :descr, "Description"
+      numeric_node :quantity, "Quantity"
+      numeric_node :unit_price, "UnitPrice"
+
+      def total_price
+        quantity*unit_price
+      end
+    end
+
+
+### usage
+
+    i = Item.load_from_file("item.xml")
+    => #<Item:0xb7888c90 @ref="RF-0001" @quantity=10, @descr="Stuffed Penguin", @unit_price=8.95>
+
+    i.unit_price = 42.23
+    xml=i.save_to_xml #convert to REXML node; there's also o.save_to_file(name)
+    xml.write($stdout,2)
+
+    <item reference="RF-0001">
+        <Description>Stuffed Penguin</Description>
+        <Quantity>10</Quantity>
+        <UnitPrice>42.23</UnitPrice>
+    </item>
+
+
+
+This is the most trivial example -- the mapper supports arbitrary
+array and hash (map) nodes, object (reference) nodes and arrays/hashes
+of those, polymorphic mappings, multiple mappings per class, fully
+programmable mappings and arbitrary user-defined node types. Read the
+[project documentation](http://multi-io.github.io/xml-mapping/
+"Project Page") for more information.

data/Rakefile

@@ -1,67 +1,32 @@
 # -*- ruby -*-
 # adapted from active_record's Rakefile
 
-require 'build_lib/rdoc_ext'
+$:.unshift "."
 
 require 'rubygems'
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
-require 'build_lib/my_rdoctask'
+require 'rdoc/task'
 require 'rake/packagetask'
-require 'rake/gempackagetask'
-#require 'rake/contrib/rubyforgepublisher'
+require 'rubygems/package_task'
 require 'rake/contrib/sshpublisher'
 
 require File.dirname(__FILE__)+"/lib/xml/mapping/version"
 
-# yeah -- it's just stupid that these are private
-
-class Rake::PackageTask
-  public :tgz_file, :zip_file
-end
-
-class Rake::GemPackageTask
-  public :gem_file
-end
-
-
-FILES_RDOC_EXTRA=%w{README README_XPATH ChangeLog TODO.txt doc/xpath_impl_notes.txt}
-FILES_RDOC_INCLUDES=%w{examples/company.xml
-                       examples/company.rb
-                       examples/company_usage.intout
-                       examples/order.xml
-                       examples/order.rb
-                       examples/order_usage.intout
-                       examples/stringarray_usage.intout
-                       examples/stringarray.xml
-                       examples/documents_folders_usage.intout
-                       examples/documents_folders.xml
-                       examples/time_node_w_marshallers.intout
-                       examples/time_node_w_marshallers.xml
-                       examples/time_augm.intout
-                       examples/time_augm_loading.intout
-                       examples/xpath_usage.intout
-                       examples/xpath_ensure_created.intout
-                       examples/xpath_create_new.intout
-                       examples/xpath_pathological.intout
-                       examples/xpath_docvsroot.intout
-                       examples/order_signature_enhanced_usage.intout
-                       examples/order_signature_enhanced.xml
-                       examples/person.intout
-                       examples/publication.intout
-                       examples/reader.intout
-                       examples/person_mm.intout
-                      }
+FILE_RDOC_MAIN = 'user_manual.md'
+FILES_RDOC_EXTRA = [FILE_RDOC_MAIN] + %w{README.md user_manual_xxpath.md TODO.txt doc/xpath_impl_notes.txt}
+FILES_RDOC_INCLUDES=`git ls-files examples`.split("\n").map{|f| f.gsub(/.intin.rb$/, '.intout')}
 
 
 desc "Default Task"
 task :default => [ :test ]
 
-Rake::TestTask.new(:test) { |t|
+Rake::TestTask.new :test do |t|
   t.test_files = ["test/all_tests.rb"]
   t.verbose = true
 #  t.loader = :testrb
-}
+end
 
 # runs tests only if sources have changed since last succesful run of
 # tests
@@ -72,19 +37,51 @@ end
 
 
 
-MyRDocTask.new { |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'doc/api'
   rdoc.title    = "XML::Mapping -- Simple, extensible Ruby-to-XML (and back) mapper"
-  rdoc.options += %w{--line-numbers --inline-source --accessor cattr_accessor=object --include examples}
+  rdoc.options += %w{--line-numbers --include examples}
+  rdoc.main = FILE_RDOC_MAIN
   rdoc.rdoc_files.include(*FILES_RDOC_EXTRA)
   rdoc.rdoc_files.include('lib/**/*.rb')
 
   # additional file dependencies for the rdoc task
   #   this somewhat of a black art because RDocTask doesn't document the
   #   prerequisite of its rdoc task (<rdoc_dir>/index.html)
-  file rdoc.rdoc_target => FILES_RDOC_INCLUDES
-  file "#{rdoc.rdoc_dir}/index.html" => FileList.new("examples/**/*.rb")
-}
+  file "#{rdoc.rdoc_dir}/index.html" => (FileList.new("examples/**/*.rb") + FILES_RDOC_INCLUDES)
+end
+
+
+## need to process :include: statements manually so we can
+## have the resulting markdown in the gem
+### can't use a rule (recursion issues)
+%w{user_manual.md user_manual_xxpath.md}.each do |out_name|
+  in_name = "#{File.basename(out_name,'.md')}.in.md"
+  CLEAN << out_name
+  file out_name => in_name do
+    begin
+      File.open(out_name, "w") do |fout|
+        File.open(in_name, "r") do |fin|
+          fin.each_line do |l|
+            if m=l.match(/:include: (.*)/)
+              File.open("examples/#{m[1]}") do |fincluded|
+                fincluded.each_line do |linc|
+                  fout.puts "    #{linc}"
+                end
+              end
+            else
+              fout.write l
+            end
+          end
+        end
+      end
+    rescue Exception
+      File.delete out_name
+      raise
+    end
+  end
+end
+
 
 #rule '.intout' => ['.intin.rb', *FileList.new("lib/**/*.rb")] do |task|  # doesn't work -- see below
 rule '.intout' => ['.intin.rb'] do |task|
@@ -100,8 +97,8 @@ rule '.intout' => ['.intin.rb'] do |task|
         Dir.chdir File.dirname(task.name)
         fin.read.split("#<=\n").each do |snippet|
 
-          snippet.scan(/^#:(.*?):$/) do |(switch,)|
-            case switch
+          snippet.scan(/^#:(.*?):$/) do |switches|
+            case switches[0]
             when "visible"
               visible=true
             when "invisible"
@@ -153,6 +150,7 @@ end
 # have to add additional prerequisites manually because it appears
 # that rules can only define a single prerequisite :-\
 FILES_RDOC_INCLUDES.select{|f|f=~/.intout$/}.each do |f|
+  CLEAN << f
   file f => FileList.new("lib/**/*.rb")
   file f => FileList.new("examples/**/*.rb")
 end
@@ -168,58 +166,50 @@ spec = Gem::Specification.new do |s|
   s.name = 'xml-mapping'
   s.version = XML::Mapping::VERSION
   s.platform = Gem::Platform::RUBY
-  s.summary =
-    "An easy to use, extensible library for mapping Ruby objects to XML and back. Includes an XPath interpreter."
-
-  # Rubygems' RDoc support is incomplete... Can't seem to find a way
-  # to set the start page, or a set of files that should be includable
-  # but not processed by rdoc directly
+  s.summary = "XML-Object mapper for Ruby"
+  s.description =
+    "An easy to use, extensible library for semi-automatically mapping Ruby objects to XML and back. Includes an XPath interpreter."
   s.files += FILES_RDOC_EXTRA
-  s.files += Dir.glob("{lib,examples,test}/**/*").delete_if do |item|
-    item.include?("CVS") || item =~ /~$/
-  end
-  s.files += %w{LICENSE Rakefile install.rb}
+  s.files += FILES_RDOC_INCLUDES
+  s.files += `git ls-files lib test`.split("\n")
+  s.files += %w{LICENSE Rakefile}
   s.extra_rdoc_files = FILES_RDOC_EXTRA
   s.rdoc_options += %w{--include examples}
-
   s.require_path = 'lib'
-  # s.autorequire = 'xml/mapping'
-
-  # s.add_dependency 'rexml'
-
-  s.has_rdoc=true
-
+  s.add_development_dependency 'rake', '~> 0'
   s.test_file = 'test/all_tests.rb'
-
   s.author = 'Olaf Klischat'
-  s.email = 'olaf.klischat@sofd.de'
-  s.homepage = "http://xml-mapping.rubyforge.org"
+  s.email = 'olaf.klischat@gmail.com'
+  s.homepage = "https://github.com/multi-io/xml-mapping"
   s.rubyforge_project = "xml-mapping"
+  s.licenses = ['Apache-2.0']
 end
 
 
 
-Rake::GemPackageTask.new(spec) do |p|
+Gem::PackageTask.new(spec) do |p|
   p.gem_spec = spec
   p.need_tar = true
   p.need_zip = true
-
-  # (indirectly) add :rdoc, :test as prerequisites to :package task
-  # created by GemPackageTask
-  file "#{p.package_dir}/#{p.tgz_file}"  => [ "test_run", :rdoc ]
-  file "#{p.package_dir}/#{p.zip_file}" => [ "test_run", :rdoc ]
-  file "#{p.package_dir}/#{p.gem_file}" => [ "test_run", :rdoc ]
 end
 
 
 
-# run "rake package" to generate tgz, zip, gem in pkg/
-
+require 'tmpdir'
 
+def system_checked(*args)
+  system(*args) or raise "failed to run: #{args.inspect}"
+end
 
-task :rfpub_rdoc => [:rdoc] do
-  p=Rake::SshDirPublisher.new('rubyforge.org',
-                              '/var/www/gforge-projects/xml-mapping/',
-                              'doc/api')
-  p.upload
+desc "updates gh-pages branch in the git with the latest rdoc"
+task :ghpublish => [:rdoc] do
+  revision = `git rev-parse HEAD`.chomp
+  Dir.mktmpdir do |dir|
+    # --no-checkout also deletes all files in the target's index
+    system_checked("git clone --branch gh-pages --no-checkout . #{dir}")
+    cp_r FileList.new('doc/api/*'), dir
+    system_checked("cd #{dir} && git add . && git commit -m 'upgrade to #{revision}'")
+    system_checked("git fetch #{dir}")
+    system_checked("git branch -f gh-pages FETCH_HEAD")
+  end
 end

data/TODO.txt

@@ -31,12 +31,17 @@
 
 - documentation:
 
-  - README:
+  - consider switching to YARD
+
+    - reasons: parameter/return type metadata, (maybe) plugin for the
+      code snippet inclusion stuff
+
+  - user_manual:
 
     - document/show usage of default_when_xpath_err outside node type
       implementations
 
-  - README_XPATH:
+  - user_manual_xxpath:
 
     - mention new step types, new axes, xml/xpath_methods
 
@@ -50,6 +55,11 @@
   implementable for some more complicated XPaths -- raise meaningful
   exceptions in those cases.
 
+  - would need support in xxpath
+
+  - should probably be built on top of the Ruby 2.0 lazy enumeration
+    stuff
+
 - XML::XXPath/XML::Mapping: add XML text nodes (the sub-node of an
   element node that contains that element's text) first-class to
   XML::XXPath. Use it for things like text_node :contents, "text()".

data/examples/README

@@ -1,5 +1,5 @@
-This directory contains the example code snippets from the main README
+This directory contains the example code snippets from the user manual
 file (each time the documentation is regenerated, they're included in
-the README, executed, and their output is checked for correctness and
-included in the README as well). So, if you've read the README, you've
-already seen all the examples from this directory.
+the user manual, executed, and their output is checked for correctness
+and included in the manual as well). So, if you've read the user
+manual, you've already seen all the examples from this directory.

data/examples/cleanup.rb

@@ -0,0 +1,11 @@
+%w{Address Client Company Customer Document Entry Folder Foo Item Order People Person Publication Signature}.each do |cname|
+  begin
+    Object.send(:remove_const, cname)  # name clash with company_usage...
+  rescue
+  end
+end
+
+
+%w{company documents_folders order order_signature_enhanced stringarray time_node}.each do |mod|
+  $".delete_if{|f| f =~ %r{/#{mod}.rb$} }
+end

data/examples/company_usage.intout

@@ -1,11 +1,11 @@
 c = Company.load_from_file('company.xml') 
-=> #<Company:0x7f487635b068 @address=#<Address:0x7f487635a1e0 @zip=10113, @city="Berlin">, @name="ACME inc.", @customers=[#<Customer:0x7f48763584d0 @name="James Kirk", @id="jim">, #<Customer:0x7f4876356d88 @name="Ernie", @id="ernie">, #<Customer:0x7f4876355640 @name="Bert", @id="bert">]>
+=> #<Company:0x007fb015492e98 @name="ACME inc.", @address=#<Address:0x007fb015492380 @city="Berlin", @zip=10113>, @customers=[#<Customer:0x007fb015490030 @id="jim", @name="James Kirk">, #<Customer:0x007fb01548eeb0 @id="ernie", @name="Ernie">, #<Customer:0x007fb01548da38 @id="bert", @name="Bert">]>
 c.name 
 => "ACME inc."
 c.customers.size 
 => 3
 c.customers[1] 
-=> #<Customer:0x7f4876356d88 @name="Ernie", @id="ernie">
+=> #<Customer:0x007fb01548eeb0 @id="ernie", @name="Ernie">
 c.customers[1].name 
 => "Ernie"
 c.customers[0].name 
@@ -13,7 +13,7 @@ c.customers[0].name
 c.customers[0].name = 'James Tiberius Kirk' 
 => "James Tiberius Kirk"
 c.customers << Customer.new('cm','Cookie Monster') 
-=> [#<Customer:0x7f48763584d0 @name="James Tiberius Kirk", @id="jim">, #<Customer:0x7f4876356d88 @name="Ernie", @id="ernie">, #<Customer:0x7f4876355640 @name="Bert", @id="bert">, #<Customer:0x7f4876352b48 @name="Cookie Monster", @id="cm">]
+=> [#<Customer:0x007fb015490030 @id="jim", @name="James Tiberius Kirk">, #<Customer:0x007fb01548eeb0 @id="ernie", @name="Ernie">, #<Customer:0x007fb01548da38 @id="bert", @name="Bert">, #<Customer:0x007fb01547f1b8 @id="cm", @name="Cookie Monster">]
 xml2 = c.save_to_xml 
 => <company name='ACME inc.'> ... </>
 xml2.write($stdout,2) 
@@ -27,22 +27,22 @@ xml2.write($stdout,2)
     </zip>
   </address>
   <customers>
-    <customer id='69974598795880'>
+    <customer id='jim'>
       <name>
         James Tiberius Kirk
       </name>
     </customer>
-    <customer id='69974598792900'>
+    <customer id='ernie'>
       <name>
         Ernie
       </name>
     </customer>
-    <customer id='69974598789920'>
+    <customer id='bert'>
       <name>
         Bert
       </name>
     </customer>
-    <customer id='69974598784420'>
+    <customer id='cm'>
       <name>
         Cookie Monster
       </name>