rsxml 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Trampoline Systems Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,47 @@
+= rsxml
+
+A Ruby library to translate XML documents into an s-expression representation, and back again
+
+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"]]
+
+If present, namespaces and namespace prefixes are retained :
+
+ xml = Rsxml.to_xml(["foo:foofoo", {"xmlns"=>"http://bar.com/bar", "xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>1, "foo:baz"=>"baz"}])
+   => '<foo:foofoo foo:baz="baz" foo:bar="1" xmlns="http://bar.com/bar" xmlns:foo="http://foo.com/foo"></foo:foofoo>'
+
+
+ Rsxml.to_rsxml(xml)
+   => ["foo:foofoo", {"foo:baz"=>"baz", "foo:bar"=>"1", "xmlns:foo"=>"http://foo.com/foo", "xmlns"=>"http://bar.com/bar"}]
+
+== 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.
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rsxml"
+  gem.homepage = "http://github.com/trampoline/rsxml"
+  gem.license = "MIT"
+  gem.summary = %Q{an s-expression representation of XML documents in Ruby}
+  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"
+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
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rsxml #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rsxml.rb

@@ -0,0 +1,102 @@
+require 'nokogiri'
+require 'builder'
+
+module Rsxml
+  module_function
+
+  # convert an s-expression representation of an XML document to XML
+  #  Rsxml.to_xml(["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"] ["Baz"]])
+  #   => '<Foo foofoo="10"><Bar>barbar</Bar><Baz></Baz></Foo>' 
+  def to_xml(rsxml)
+    xml = Builder::XmlMarkup.new
+    Sexp.write_xml(xml, rsxml)
+    xml.target!
+  end
+
+  # convert an XML string to an s-expression representation
+  #  Rsxml.to_rsxml('<Foo foofoo="10"><Bar>barbar</Bar><Baz></Baz></Foo>')
+  #   => ["Foo", {"foofoo"=>"10"}, ["Bar", "barbar"], ["Baz"]] 
+  def to_rsxml(doc)
+    root = Nokogiri::XML(doc).children.first
+    Xml.read_xml(root, [])
+  end
+
+  module Sexp
+    module_function
+
+    def write_xml(xml, sexp)
+      tag, attrs, children = decompose_sexp(sexp)
+      
+      xml.__send__(tag, attrs) do
+        children.each do |child|
+          if child.is_a?(Array)
+            write_xml(xml, child)
+          else
+            xml << child
+          end
+        end
+      end
+    end
+
+    def decompose_sexp(sexp)
+      raise "invalid rsxml: #{rsxml.inspect}" if sexp.length<1
+      tag = sexp[0].to_s
+      if sexp[1].is_a?(Hash)
+        attrs = sexp[1]
+        children = sexp[2..-1]
+      else
+        attrs = {}
+        children = sexp[1..-1]
+      end
+      [tag, attrs, children]
+    end
+  end
+
+  module Xml
+    module_function
+
+    def read_xml(node, ns_stack)
+      prefix = node.namespace.prefix if node.namespace
+      tag = node.name
+      ns_tag = [prefix,tag].compact.join(":")
+
+      attrs = read_attributes(node.attributes)
+      attrs = attrs.merge(namespace_attributes(node.namespaces, ns_stack))
+      attrs = nil if attrs.empty?
+
+      children = node.children.map do |child|
+        if child.text?
+          child.text
+        else
+          begin
+            ns_stack.push(node.namespaces)
+            read_xml(child, ns_stack)
+          ensure
+            ns_stack.pop
+          end
+        end
+      end
+
+      [ns_tag, attrs, *children].compact
+    end
+
+    def read_attributes(attrs)
+      Hash[*attrs.map do |n, attr|
+             prefix = attr.namespace.prefix if attr.namespace
+             name = attr.name
+             ns_name = [prefix,name].compact.join(":")
+             [ns_name, attr.value]
+           end.flatten]
+    end
+
+    def namespace_attributes(namespaces, ns_stack)
+      Hash[*namespaces.map do |prefix,href|
+             [prefix, href] if !find_namespace(prefix, ns_stack)
+           end.compact.flatten]
+    end
+
+    def find_namespace(prefix, ns_stack)
+      ns_stack.reverse.find{ |nsh| nsh.has_key?(prefix)}
+    end
+  end
+end

data/spec/rsxml_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Rsxml do
+  describe "to_xml" do
+    it "should produce a single-element document" do
+      Rsxml.to_xml([:foo]).should == "<foo></foo>"
+    end
+
+    it "should produce a single-element doc with attrs" do
+      xml = Rsxml.to_xml([:foo, {:bar=>1, :baz=>"baz"}])
+      r = Nokogiri::XML(xml).children.first
+      r.name.should == "foo"
+      r["bar"].should == "1"
+      r["baz"].should == "baz"
+    end
+
+    it "should produce a doc with text content" do
+      xml = Rsxml.to_xml([:foo, "foofoo"])
+      r = Nokogiri::XML(xml).children.first
+      r.name.should == "foo"
+      r.children.size.should == 1
+      txt = r.children.first
+      txt.text?.should == true
+      txt.text.should == "foofoo"
+    end
+
+    it "should produce a doc with child elements" do
+      xml = Rsxml.to_xml([:foo, [:bar], [:baz]])
+      r = Nokogiri::XML(xml).children.first
+      r.name.should == "foo"
+      r.children.length.should == 2
+      bar = r.children.first
+      bar.name.should == "bar"
+      bar.children.length.should == 0
+      baz = r.children[1]
+      baz.name.should == "baz"
+      baz.children.length.should == 0
+    end
+
+    it "should produce a doc with child elements and attributes" do
+      xml = Rsxml.to_xml([:foo, [:bar, {:barbar=>"boo", :bazbaz=>"baz"}]])
+      r = Nokogiri::XML(xml).children.first
+      r.name.should == "foo"
+      r.children.length.should == 1
+      bar = r.children.first
+      bar.name.should == "bar"
+      bar.children.length.should == 0
+      bar["barbar"].should == "boo"
+      bar["bazbaz"].should == "baz"
+    end
+
+    it "should treat namespace prefixes reasonably" do
+      xml = Rsxml.to_xml(["foo:foofoo", {"xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>1, "foo:baz"=>"baz"}])
+
+      r = Nokogiri::XML(xml).children.first
+      r.namespaces["xmlns:foo"].should == "http://foo.com/foo"
+
+      r.name.should == "foofoo"
+      r.namespace.href.should == "http://foo.com/foo"
+      r.namespace.prefix.should == "foo"
+
+      r["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.attributes["baz"].namespace.href.should == "http://foo.com/foo"
+      r.attributes["baz"].namespace.prefix.should == "foo"
+    end
+  end
+
+  describe "to_rsxml" do
+    def test_roundtrip(org) 
+      xml = Rsxml.to_xml(org)
+      rsxml = Rsxml.to_rsxml(xml)
+      rsxml.should == org
+    end
+    
+    it "should parse a single-element doc" do
+      test_roundtrip(["foo"])
+    end
+
+    it "should parse a single-element doc with attributes" do
+      test_roundtrip(["foo", {"bar"=>"1", "baz"=>"bazbaz"}])
+    end
+
+    it "should parse a doc with child elements" do
+      test_roundtrip(["foo", ["bar"], ["baz", ["boo"]]])
+    end
+
+    it "should parse a doc with text content" do
+      test_roundtrip(["foo", "foofoo"])
+    end
+
+    it "should parse a doc with child elements and attributes" do
+      test_roundtrip(["foo", {"bar"=>"1", "baz"=>"bazbaz"}, ["foofoo", {"foobar"=>"3", "barbaz"=>"4"}, "foofoofoo"]])
+    end
+
+    it "should parse a doc with namespaces" do
+      test_roundtrip(["foo:foofoo", {"xmlns:foo"=>"http://foo.com/foo", "foo:bar"=>"1", "foo:baz"=>"baz"}])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$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'
+
+Spec::Runner.configure do |config|
+  config.mock_with RR::Adapters::Rspec
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: rsxml
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Trampoline Systems Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  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
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  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
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  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"
+  type: :development
+  version_requirements: *id005
+description: convert XML documents to an s-expression representation and back again in Ruby
+email: craig@trampolinesystems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rsxml.rb
+- spec/rsxml_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/trampoline/rsxml
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: an s-expression representation of XML documents in Ruby
+test_files: 
+- spec/rsxml_spec.rb
+- spec/spec_helper.rb