rsxml 0.3.0 → 0.4.0

data/.travis.yml

@@ -0,0 +1,5 @@
+script: "JRUBY_OPTS=-J-Djruby.objectspace.enabled=true rake"
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "nokogiri",  "~> 1.5.8"
+gem "builder", "~> 3.2.0"
+
+group :development do
+  gem "rake", "~> 10.0.3"
+  gem "rspec", "~> 2.13.0"
+  gem "rdoc", "~> 4.0.0"
+  gem "bundler", "~> 1.3.2"
+  gem "jeweler", "~> 1.8.4"
+#  gem "rcov", ">= 0"
+ gem 'rr', ">= 1.0.4"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.2.0)
+    diff-lcs (1.2.1)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    nokogiri (1.5.8)
+    rake (10.0.3)
+    rdoc (4.0.0)
+      json (~> 1.4)
+    rr (1.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  builder (~> 3.2.0)
+  bundler (~> 1.3.2)
+  jeweler (~> 1.8.4)
+  nokogiri (~> 1.5.8)
+  rake (~> 10.0.3)
+  rdoc (~> 4.0.0)
+  rr (>= 1.0.4)
+  rspec (~> 2.13.0)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Trampoline Systems Ltd
+Copyright (c) 2011 mccraigmccraig of the clan mccraig
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,122 @@
+rsxml [![Build Status](https://travis-ci.org/mccraigmccraig/rsxml.png?branch=master)](https://travis-ci.org/mccraigmccraig/rsxml)
+=====
+
+Ruby literal representation of XML documents in the style of [SXML](http://en.wikipedia.org/wiki/SXML)
+
+Installation
+------------
+
+    $ gem install rsxml
+
+
+Background
+----------
+
+Rsxml is a Ruby library to translate XML documents into an s-expression style Ruby literal representation, using Array and Hash literals, and back again
+
+Why would you want to do this ? Ruby literals :
+
+* can be == compared natively
+* are easy to read
+* can be indented nicely by editors
+* can be syntax checked and balanced by editors
+
+These features make them nice for writing readable XML generation code and readable tests for XML generating code
+
+Rsxml uses [Nokogiri](http://nokogiri.org/) for parsing XML, and [Builder](http://builder.rubyforge.org/) for generating it. Rsxml is not a feature complete XML processor : It does not attempt to process PIs, CDATA etc, but it does make it very easy to use and generate straightforward XML documents from Ruby
+
+Use
+---
+
+Rsxml represents XML documents as s-expressions comprised of Ruby Array and Hash literals, thus :
+
+     ["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"], ["Baz"]]
+
+represents the XML document :
+
+     <Foo foofoo="10"><Bar>barbar</Bar><Baz></Baz></Foo>
+
+It is easy to convert XML docuemnts to Rsxml representation and back again :
+
+     xml = Rsxml.to_xml(["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"]])
+       => '<Foo foofoo="10"><Bar>barbar</Bar></Foo>'
+
+     Rsxml.to_rsxml(xml)
+       => ["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"]]
+
+### Namespaces
+
+XML namespaces are dealt with straightforwardly. When an XML document is converted to Rsxml, namespaces are preserved, and you can specify namespaces in an Rsxml structure in two ways, which can be freely mixed
+
+* using QName prefixes and declarative attributes, exactly as with XML
+* using exploded QNames consisting of <tt>[local_part, prefix, uri]</tt> triples and <tt>[local_part, prefix]</tt> pairs
+
+### Converting to Rsxml
+
+
+When you convert an XML document to Rsxml you can choose either <tt>:xml</tt> or <tt>:exploded</tt> style
+
+#### <tt>:xml</tt> style
+
+In <tt>:xml</tt> style namespaces are declared using attributes, and namespaces are referenced using
+`prefix:LocalPart` QNames, as in XML
+
+     Rsxml.to_rsxml('<foo:foofoo xmlns:foo="http://foo.com/foo" foo:bar="barbar"/>', :style=>:xml)
+       => ["foo:foofoo", {"foo:bar"=>"barbar", "xmlns:foo"=>"http://foo.com/foo"}]
+
+#### <tt>:exploded</tt> style
+
+In <tt>:exploded</tt> style namespaces are not declared using attributes, and QNames are specified
+using <tt>[local_part, prefix, uri]</tt> triples
+
+     Rsxml.to_rsxml('<foo:foofoo xmlns:foo="http://foo.com/foo" foo:bar="barbar"/>', :style=>:exploded)
+       => [["foofoo", "foo", "http://foo.com/foo"], {["bar", "foo", "http://foo.com/foo"]=>"barbar"}]
+
+### Converting to XML
+
+Rsxml styles can be mixed, and replicated namespace references can be skipped (i.e. `[local_part,prefix]` pairs can be used instead of `[local_part, prefix, uri]` triples) for readability
+
+     Rsxml.to_xml([["foofoo", "foo", "http://foo.com/foo"], {"foo:bar"=>"1", ["baz", "foo"]=>"2"}])
+       => '<foo:foofoo foo:baz="2" foo:bar="1" xmlns:foo="http://foo.com/foo"></foo:foofoo>'
+
+### Fragments
+
+XML Fragments, without proper namespace declarations, can be parsed by passing a Hash of namespace
+prefix bindings
+
+     Rsxml.to_rsxml('<foo:foofoo foo:bar="barbar"/>', :ns=>{"foo"=>"http://foo.com/foo"}, :style=>:xml)
+       => ["foo:foofoo", {"foo:bar"=>"barbar"}]
+
+Fragments can be generated similarly :
+
+     Rsxml.to_xml(["foo:foofoo", {"foo:bar"=>"barbar"}], :ns=>{"foo"=>"http://foo.com/foo"})
+       => '<foo:foofoo foo:bar="barbar"></foo:foofoo>'
+
+### Visitors
+
+<tt>Rsxml.to_rsxml</tt> and <tt>Rsxml.to_xml</tt> are implemented with a simple Visitor pattern over the XML document structure. <tt>Rsxml::Sexp.traverse()</tt> traverses a Rsxml s-expression representation of an XML document and <tt>Rsxml::Xml.traverse()</tt> traverses a Nokogiri Node tree. The Visitor receives a
+
+     text(context, text)
+
+invocation for each text node, and an
+
+     element(context, name, attrs, ns_decls)
+
+method invocation for each element. If namespaces are used, element and attribute names in the <tt>element</tt> method invocations are exploded <tt>[local_part, prefix, uri]</tt> triples. The attributes are presented as a <tt>{name=>value}</tt> `Hash` which contains no namespace-related attributes. Any namespace declarations for the element are provided as the <tt>{prefix=>uri}</tt> `ns_decls` `Hash`. Namespace prefixes, URIs and declaration attributes are cleanly separated in this API, so it is easy for Visitor implementations to correctly process XML documents with namespaces
+
+Contributing to rsxml
+---------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2012 mccraigmccraig of the clan mccraig. See LICENSE.txt for
+further details.

data/Rakefile

@@ -1,4 +1,14 @@
+# encoding: utf-8
+
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
 
 require 'jeweler'
@@ -11,38 +21,29 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{convert XML documents to an s-expression representation and back again in Ruby}
   gem.email = "craig@trampolinesystems.com"
   gem.authors = ["Trampoline Systems Ltd"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_runtime_dependency "nokogiri", ">= 1.4.4"
-  gem.add_development_dependency "rspec", "~> 1.3.1"
-  gem.add_development_dependency "rr", ">= 0.10.5"
-  gem.add_development_dependency "jeweler", "~> 1.5.2"
-  gem.add_development_dependency "rcov", ">= 0"
+  # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :spec => :check_dependencies
+# RSpec::Core::RakeTask.new(:rcov) do |spec|
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
 
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rsxml #{version}"
+  rdoc.title = "mdquery #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/rsxml.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rsxml"
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Trampoline Systems Ltd"]
+  s.date = "2013-03-21"
+  s.description = "convert XML documents to an s-expression representation and back again in Ruby"
+  s.email = "craig@trampolinesystems.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/rsxml.rb",
+    "lib/rsxml/namespace.rb",
+    "lib/rsxml/sexp.rb",
+    "lib/rsxml/util.rb",
+    "lib/rsxml/visitor.rb",
+    "lib/rsxml/xml.rb",
+    "rsxml.gemspec",
+    "spec/rsxml/mock_visitor.rb",
+    "spec/rsxml/namespace_spec.rb",
+    "spec/rsxml/sexp_spec.rb",
+    "spec/rsxml/util_spec.rb",
+    "spec/rsxml/visitor_spec.rb",
+    "spec/rsxml/xml_spec.rb",
+    "spec/rsxml_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/trampoline/rsxml"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "an s-expression representation of XML documents in Ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.8"])
+      s.add_runtime_dependency(%q<builder>, ["~> 3.2.0"])
+      s.add_development_dependency(%q<rake>, ["~> 10.0.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rr>, [">= 1.0.4"])
+    else
+      s.add_dependency(%q<nokogiri>, ["~> 1.5.8"])
+      s.add_dependency(%q<builder>, ["~> 3.2.0"])
+      s.add_dependency(%q<rake>, ["~> 10.0.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.3.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rr>, [">= 1.0.4"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, ["~> 1.5.8"])
+    s.add_dependency(%q<builder>, ["~> 3.2.0"])
+    s.add_dependency(%q<rake>, ["~> 10.0.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.3.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rr>, [">= 1.0.4"])
+  end
+end
+

data/spec/rsxml/namespace_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path("../../spec_helper", __FILE__)
+require 'rsxml/namespace'
 
 module Rsxml
   describe "find_namespace_uri" do
@@ -60,7 +61,7 @@ module Rsxml
     end
 
     it "should unqualify an unprefixed name in the default namespace" do
-      Namespace.explode_qname([{""=>"http://foo.com/foo"}], "bar").should == 
+      Namespace.explode_qname([{""=>"http://foo.com/foo"}], "bar").should ==
         ["bar", "", "http://foo.com/foo"]
     end
 
@@ -123,20 +124,20 @@ module Rsxml
 
   describe "compact_qname" do
     it "should produce a qname from a pair or triple" do
-      Namespace.compact_qname([{"foo"=>"http://foo.com/foo"}], 
+      Namespace.compact_qname([{"foo"=>"http://foo.com/foo"}],
                               ["bar", "foo"]).should ==
         "foo:bar"
-      Namespace.compact_qname([{"foo"=>"http://foo.com/foo"}], 
+      Namespace.compact_qname([{"foo"=>"http://foo.com/foo"}],
                               ["bar", "foo", "http://foo.com/foo"]).should ==
         "foo:bar"
     end
 
     it "should produce a qname with default namespace" do
-      Namespace.compact_qname([{""=>"http://foo.com/foo"}], 
+      Namespace.compact_qname([{""=>"http://foo.com/foo"}],
                               ["bar", ""]).should ==
         "bar"
 
-      Namespace.compact_qname([{""=>"http://foo.com/foo"}], 
+      Namespace.compact_qname([{""=>"http://foo.com/foo"}],
                               ["bar", "", "http://foo.com/foo"]).should ==
         "bar"
     end
@@ -153,21 +154,21 @@ module Rsxml
 
     it "should raise an error if a prefix is not bound" do
       lambda {
-        Namespace.compact_qname([], 
+        Namespace.compact_qname([],
                                 ["bar", "foo", "http://foo.com/foo"])
       }.should raise_error(/not bound/)
     end
 
     it "should raise an error if a prefix binding clashes" do
       lambda {
-        Namespace.compact_qname([{"foo"=>"http://foo.com/foo"}], 
+        Namespace.compact_qname([{"foo"=>"http://foo.com/foo"}],
                                 ["bar", "foo", "http://bar.com/bar"])
       }.should raise_error(/'foo' is bound/)
     end
 
     it "should raise an error if default namespace binding clashes" do
       lambda {
-        Namespace.compact_qname([{""=>"http://foo.com/foo"}], 
+        Namespace.compact_qname([{""=>"http://foo.com/foo"}],
                                 ["bar", "", "http://bar.com/bar"])
       }.should raise_error(/'' is bound/)
     end
@@ -235,22 +236,22 @@ module Rsxml
 
   describe "exploded_namespace_declarations" do
     it "should produce unqalified namespaces declarations" do
-      Namespace.exploded_namespace_declarations({""=>"http://default.com/default", "foo"=>"http://foo.com/foo"}).should == 
+      Namespace.exploded_namespace_declarations({""=>"http://default.com/default", "foo"=>"http://foo.com/foo"}).should ==
         {"xmlns"=>"http://default.com/default", ["foo", "xmlns"]=>"http://foo.com/foo"}
     end
   end
 
   describe "namespace_attributes" do
     it "should produce a Hash of namespace declaration attributes" do
-      Namespace.namespace_attributes({""=>"http://default.com/default", "foo"=>"http://foo.com/foo"}).should == 
+      Namespace.namespace_attributes({""=>"http://default.com/default", "foo"=>"http://foo.com/foo"}).should ==
         {"xmlns"=>"http://default.com/default", "xmlns:foo"=>"http://foo.com/foo"}
     end
   end
 
   describe "non_ns_attrs_ns_bindings" do
     it "should extract non-ns attributes and explicit namespace bindings" do
-      Namespace.non_ns_attrs_ns_bindings([{"foo"=>"http://foo.com/foo"}], 
-                                         [:bar, "foo", "http://foo.com/foo"], 
+      Namespace.non_ns_attrs_ns_bindings([{"foo"=>"http://foo.com/foo"}],
+                                         [:bar, "foo", "http://foo.com/foo"],
                                          { "xmlns:boo"=>"http://boo.com/boo",
                                            [:b, "bar", "http://bar.com/bar"]=>"barbar",
                                            [:c, "baz", "http://baz.com/baz"]=>"bazbaz",
@@ -258,20 +259,20 @@ module Rsxml
         [{[:b, "bar", "http://bar.com/bar"]=>"barbar",
            [:c, "baz", "http://baz.com/baz"]=>"bazbaz",
            [:d, "foo"]=>"booboo"},
-         { "baz"=>"http://baz.com/baz", 
+         { "baz"=>"http://baz.com/baz",
            "bar"=>"http://bar.com/bar",
            "boo"=>"http://boo.com/boo"}]
     end
 
     it "should extract explicit default namespace bindings" do
-      Namespace.non_ns_attrs_ns_bindings([{"foo"=>"http://foo.com/foo"}], 
-                                         [:bar, "", "http://default.com/default"], 
+      Namespace.non_ns_attrs_ns_bindings([{"foo"=>"http://foo.com/foo"}],
+                                         [:bar, "", "http://default.com/default"],
                                          { [:d, "foo"]=>"booboo"}).should ==
         [{ [:d, "foo"]=>"booboo"},
          { ""=>"http://default.com/default"}]
     end
 
-    
+
   end
 
 end

data/spec/rsxml/sexp_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path("../../spec_helper", __FILE__)
+require 'rsxml/sexp'
 
 module Rsxml
   describe "traverse" do

data/spec/rsxml/util_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path("../../spec_helper", __FILE__)
+require 'rsxml/util'
 
 module Rsxml
   describe Util do

data/spec/rsxml/visitor_spec.rb

@@ -1,4 +1,6 @@
 require File.expand_path("../../spec_helper", __FILE__)
+require 'rsxml/visitor'
+require 'rsxml/mock_visitor'
 
 module Rsxml
   # tests traverse methods on both Xml and Sexp together : they should produce identical visitation
@@ -9,7 +11,7 @@ module Rsxml
       xml_root = Nokogiri::XML(xml).children.first
       Xml.traverse(xml_root, xml_visitor)
       xml_visitor.__finalize__
-      
+
       sexp_visitor = Visitor::MockVisitor.new(expectations)
       Sexp.traverse(sexp, sexp_visitor)
       sexp_visitor.__finalize__
@@ -22,18 +24,18 @@ module Rsxml
     end
 
     it "should call the element function on the visitor with exploded element and attributes qnames" do
-      check_traverse([[:element, :_, 
-                       ["foofoo", "foo", "http://foo.com/foo"], 
-                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"}, 
+      check_traverse([[:element, :_,
+                       ["foofoo", "foo", "http://foo.com/foo"],
+                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"},
                        {"foo"=>"http://foo.com/foo"}]],
                      '<foo:foofoo foo:bar="barbar" xmlns:foo="http://foo.com/foo"/>',
                      [["foofoo", "foo"], {["bar", "foo", "http://foo.com/foo"]=>"barbar"}])
     end
 
     it "should call the test function on the visitor with textual content" do
-      check_traverse([[:element, :_, 
-                       ["foofoo", "foo", "http://foo.com/foo"], 
-                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"}, 
+      check_traverse([[:element, :_,
+                       ["foofoo", "foo", "http://foo.com/foo"],
+                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"},
                        {"foo"=>"http://foo.com/foo"}],
                       [:text, :_, "boohoo"]],
                      '<foo:foofoo foo:bar="barbar" xmlns:foo="http://foo.com/foo">boohoo</foo:foofoo>',
@@ -41,9 +43,9 @@ module Rsxml
     end
 
     it "should call the element function in document order for each element in a hierarchic doc" do
-      check_traverse([[:element, :_, 
-                       ["foofoo", "foo", "http://foo.com/foo"], 
-                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"}, 
+      check_traverse([[:element, :_,
+                       ["foofoo", "foo", "http://foo.com/foo"],
+                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"},
                        {"foo"=>"http://foo.com/foo"}],
                       [:element, :_,
                        ["barbar", "foo", "http://foo.com/foo"],
@@ -55,9 +57,9 @@ module Rsxml
     end
 
     it "should call the element/text functions in a mixed document in document order" do
-      check_traverse([[:element, :_, 
-                       ["foofoo", "foo", "http://foo.com/foo"], 
-                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"}, 
+      check_traverse([[:element, :_,
+                       ["foofoo", "foo", "http://foo.com/foo"],
+                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"},
                        {"foo"=>"http://foo.com/foo"}],
                       [:element, :_,
                        ["barbar", "foo", "http://foo.com/foo"],
@@ -76,9 +78,9 @@ module Rsxml
     end
 
     it "should work the same with compact sexp representations" do
-      check_traverse([[:element, :_, 
-                       ["foofoo", "foo", "http://foo.com/foo"], 
-                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"}, 
+      check_traverse([[:element, :_,
+                       ["foofoo", "foo", "http://foo.com/foo"],
+                       {["bar", "foo", "http://foo.com/foo"]=>"barbar"},
                        {"foo"=>"http://foo.com/foo"}],
                       [:element, :_,
                        ["barbar", "foo", "http://foo.com/foo"],
@@ -181,7 +183,7 @@ module Rsxml
                                       cattrs = Hash[attrs.map{|n,v| [capitalize_local_part(n), v]}]
                                       [celement_name, cattrs]
                                     end ).sexp
-                                        
+
         rsxml.should ==
           ["Foo", {"Bar"=>"10", "Baz"=>"20"}]
 
@@ -191,7 +193,7 @@ module Rsxml
                                       cattrs = Hash[attrs.map{|n,v| [capitalize_local_part(n), v]}]
                                       [celement_name, cattrs]
                                     end ).sexp
-                                        
+
         rsxml.should ==
           [["Foo", "a", "http://a.com/a"], {"Bar"=>"10", "Baz"=>"20"}]
 

data/spec/rsxml/xml_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path("../../spec_helper", __FILE__)
+require 'rsxml/xml'
 
 module Rsxml
   describe "wrap_fragment" do
@@ -64,7 +65,7 @@ module Rsxml
 
       eelement, eattrs = Rsxml::Xml.explode_element(root)
       eelement.should == ["bar", "foo", "http://foo.com/foo"]
-      eattrs.should == {"a"=>"aa", 
+      eattrs.should == {"a"=>"aa",
         ["b", "foo", "http://foo.com/foo"]=>"bb"}
     end
   end

data/spec/rsxml_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'rsxml'
 
 describe Rsxml do
   describe "to_xml" do
@@ -7,7 +8,7 @@ describe Rsxml do
     end
 
     it "should produce a single-element doc with namespaces" do
-      Rsxml.to_xml([[:bar, :foo, "http://foo.com/foo"]]).should == 
+      Rsxml.to_xml([[:bar, :foo, "http://foo.com/foo"]]).should ==
         '<foo:bar xmlns:foo="http://foo.com/foo"></foo:bar>'
     end
 
@@ -30,7 +31,7 @@ describe Rsxml do
       r.name.should == "bar"
       r.namespace.href.should == "http://foo.com/foo"
       r.namespace.prefix.should == "foo"
-      
+
       r.attributes["bar"].namespace.should == nil
       r["bar"].should == "1"
 
@@ -39,11 +40,11 @@ describe Rsxml do
     end
 
     it "should produce a single-element doc with namespace and attr namespaces" do
-      xml = Rsxml.to_xml([[:bar, :foo, "http://foo.com/foo"], 
-                          {[:barbar, :bar, "http://bar.com/bar"]=>1, 
+      xml = Rsxml.to_xml([[:bar, :foo, "http://foo.com/foo"],
+                          {[:barbar, :bar, "http://bar.com/bar"]=>1,
                             :baz=>"baz"}])
       r = Nokogiri::XML(xml).children.first
-      
+
       r.name.should == "bar"
       r.namespace.prefix.should == "foo"
       r.namespace.href.should == "http://foo.com/foo"
@@ -59,11 +60,11 @@ describe Rsxml do
     end
 
     it "should produce a single-element doc with default namespace and attr namespaces" do
-      xml = Rsxml.to_xml([[:bar, "", "http://foo.com/foo"], 
-                          {[:barbar, :bar, "http://bar.com/bar"]=>1, 
+      xml = Rsxml.to_xml([[:bar, "", "http://foo.com/foo"],
+                          {[:barbar, :bar, "http://bar.com/bar"]=>1,
                             :baz=>"baz"}])
       r = Nokogiri::XML(xml).children.first
-      
+
       r.name.should == "bar"
       r.namespace.prefix.should == nil
       r.namespace.href.should == "http://foo.com/foo"
@@ -123,11 +124,11 @@ describe Rsxml do
       r.namespace.href.should == "http://foo.com/foo"
       r.namespace.prefix.should == "foo"
 
-      r["bar"].should == "1"
+      r["foo:bar"].should == "1"
       r.attributes["bar"].namespace.href.should == "http://foo.com/foo"
       r.attributes["bar"].namespace.prefix.should == "foo"
 
-      r["baz"].should == "baz"
+      r["foo:baz"].should == "baz"
       r.attributes["baz"].namespace.href.should == "http://foo.com/foo"
       r.attributes["baz"].namespace.prefix.should == "foo"
     end
@@ -135,12 +136,12 @@ describe Rsxml do
 
   describe "to_rsxml" do
 
-    def test_roundtrip(org) 
+    def test_roundtrip(org)
       xml = Rsxml.to_xml(org)
       rsxml = Rsxml.to_rsxml(xml, :style=>:xml)
       rsxml.should == org
     end
-    
+
     it "should parse a single-element doc" do
       test_roundtrip(["foo"])
     end

data/spec/spec_helper.rb

@@ -1,13 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rubygems'
-require 'spec'
-require 'spec/autorun'
-require 'rr'
-require 'nokogiri'
-require 'rsxml'
-require 'rsxml/mock_visitor'
+require 'rspec'
 
-Spec::Runner.configure do |config|
-  config.mock_with RR::Adapters::Rspec
+RSpec.configure do |config|
+  config.mock_with :rr
 end

metadata

@@ -1,115 +1,160 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rsxml
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Trampoline Systems Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-27 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.8
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 4
-        - 4
-        version: 1.4.4
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.8
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 1
-        - 3
-        - 1
-        version: 1.3.1
+      - !ruby/object:Gem::Version
+        version: 4.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rr
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 10
-        - 5
-        version: 0.10.5
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
   type: :development
-  version_requirements: *id005
-description: convert XML documents to an s-expression representation and back again in Ruby
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: convert XML documents to an s-expression representation and back again
+  in Ruby
 email: craig@trampolinesystems.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.md
+files:
 - .document
 - .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/rsxml.rb
@@ -118,6 +163,7 @@ files:
 - lib/rsxml/util.rb
 - lib/rsxml/visitor.rb
 - lib/rsxml/xml.rb
+- rsxml.gemspec
 - spec/rsxml/mock_visitor.rb
 - spec/rsxml/namespace_spec.rb
 - spec/rsxml/sexp_spec.rb
@@ -126,46 +172,32 @@ files:
 - spec/rsxml/xml_spec.rb
 - spec/rsxml_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/trampoline/rsxml
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -348830186680735748
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: an s-expression representation of XML documents in Ruby
-test_files: 
-- spec/rsxml/mock_visitor.rb
-- spec/rsxml/namespace_spec.rb
-- spec/rsxml/sexp_spec.rb
-- spec/rsxml/util_spec.rb
-- spec/rsxml/visitor_spec.rb
-- spec/rsxml/xml_spec.rb
-- spec/rsxml_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/README.rdoc

@@ -1,102 +0,0 @@
-= rsxml
-
-A Ruby library to translate XML documents into an s-expression representation, and back again, in the style of SXML[http://en.wikipedia.org/wiki/SXML]
-
-Why would you want to do this ? Well, s-expressions can be == compared natively in Ruby, are easy to read
-and editors indent them nicely when embedded in code. These features make them very suitable for writing readable
-XML generation code and readable tests for XML generating code
-
-Rsxml uses Nokogiri[http://nokogiri.org/] for parsing XML, and Builder[http://builder.rubyforge.org/] to generate it. Rsxml is not intended to be a feature complete XML processor : It does not attempt to process PIs, CDATA etc, but it does make it very easy to use and generate straightforward XML documents from Ruby
-
-Rsxml represents XML documents as s-expressions thus :
-
- ["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"], ["Baz"]]
-
-represents the XML document :
- <Foo foofoo="10"><Bar>barbar</Bar><Baz></Baz></Foo>
-
-It is easy to convert XML docuemnts to Rsxml representation and back again :
-
- xml = Rsxml.to_xml(["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"]])
-   => '<Foo foofoo="10"><Bar>barbar</Bar></Foo>'
-
- Rsxml.to_rsxml(xml)
-   => ["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"]]
-
-=== Namespaces
-
-XML namespaces are dealt with straightforwardly. When an XML document is converted to Rsxml, namespaces are preserved, and you can specify namespaces in an Rsxml structure in two ways, which can be freely mixed
-* using QName prefixes and declarative attributes, exactly as with XML
-* using exploded QNames consisting of <tt>[local_part, prefix, uri]</tt> triples and <tt>[local_part, prefix]</tt> pairs
-
-=== Converting to Rsxml
-
-When you convert an XML document to Rsxml you can choose either <tt>:xml</tt> or <tt>:exploded</tt> style
-
-==== <tt>:xml</tt> style
-
-In <tt>:xml</tt> style namespaces are declared using attributes, and namespaces are referenced using
-prefixed QNames, just as in XML
-
- Rsxml.to_rsxml('<foo:foofoo xmlns:foo="http://foo.com/foo" foo:bar="barbar"/>', :style=>:xml)
-   => ["foo:foofoo", {"foo:bar"=>"barbar", "xmlns:foo"=>"http://foo.com/foo"}] 
-
-==== <tt>:exploded</tt> style
-
-In <tt>:exploded</tt> style namespaces are not declared using attributes, and QNames are specified
-using <tt>[local_part, prefix, uri]</tt> triples
-
- Rsxml.to_rsxml('<foo:foofoo xmlns:foo="http://foo.com/foo" foo:bar="barbar"/>', :style=>:exploded)
-   => [["foofoo", "foo", "http://foo.com/foo"], {["bar", "foo", "http://foo.com/foo"]=>"barbar"}]
-
-=== Converting to XML
-
-Rsxml styles can be mixed, and unnecessary namespace references can be skipped for readability
-
- Rsxml.to_xml([["foofoo", "foo", "http://foo.com/foo"], {"foo:bar"=>"1", ["baz", "foo"]=>"2"}])
-   => '<foo:foofoo foo:baz="2" foo:bar="1" xmlns:foo="http://foo.com/foo"></foo:foofoo>'
-
-=== Fragments
-
-XML Fragments, without proper namespace declarations, can be parsed by passing a Hash of namespace
-prefix bindings
-
- Rsxml.to_rsxml('<foo:foofoo foo:bar="barbar"/>', :ns=>{"foo"=>"http://foo.com/foo"}, :style=>:xml)
-   => ["foo:foofoo", {"foo:bar"=>"barbar"}] 
-
-Fragments can be generated similarly :
-
- Rsxml.to_xml(["foo:foofoo", {"foo:bar"=>"barbar"}], :ns=>{"foo"=>"http://foo.com/foo"})
-   => '<foo:foofoo foo:bar="barbar"></foo:foofoo>'
-
-== Visitors
-
-<tt>Rsxml.to_rsxml</tt> and <tt>Rsxml.to_xml</tt> are implemented with a simple Visitor pattern over the XML document structure. <tt>Rsxml::Sexp.traverse()</tt> traverses a Rsxml s-expression representation of an XML document and <tt>Rsxml::Xml.traverse()</tt> traverses a Nokogiri Node tree. The Visitor receives a
-
- text(context, text)
-
-invocation for each text node, and an
-
- element(context, name, attrs, ns_decls)
-
-method invocation for each element. If namespaces are used, element and attribute names in the <tt>element</tt> method invocations are exploded <tt>[local_part, prefix, uri]</tt> triples. The attributes are presented as a <tt>{name=>value}</tt> +Hash+ which contains no namespace-related attributes. Any namespace declarations for the element are provided as the <tt>{prefix=>uri}</tt> +ns_decls+ +Hash+. Namespace prefixes, URIs and declaration attributes are cleanly separated in this API, so it is easy for Visitor implementations to correctly process XML documents with namespaces
-
-== Install
-
- gem install rsxml
-
-== Contributing to rsxml
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Trampoline Systems Ltd. See LICENSE.txt for
-further details.
-