xml_to_json 0.0.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'nokogiri'
+
+group :development do
+  gem 'yajl-ruby'
+  gem 'activesupport', "3.0.1"
+  gem 'builder'
+  
+  gem "rspec", "2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre6"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.0.pre6)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (= 3.0.1)
+  builder
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.0.pre6)
+  nokogiri
+  rcov
+  rspec (= 2.1.0)
+  yajl-ruby

data/Rakefile

@@ -0,0 +1,57 @@
+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'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "xml_to_json"
+  gem.homepage = "http://github.com/mtodd/xml_to_json"
+  gem.license = "MIT"
+  gem.summary = %Q{Transforms XML to JSON}
+  gem.description = %Q{Transforms a string of XML into a string of JSON}
+  gem.email = "chiology@gmail.com"
+  gem.authors = ["Matt Todd"]
+  
+  gem.add_runtime_dependency 'nokogiri', '1.4.3.1'
+  
+  gem.add_development_dependency 'yajl-ruby', '0.7.8'
+  gem.add_development_dependency 'activesupport', '3.0.1'
+  gem.add_development_dependency 'builder', '2.1.2'
+  
+  gem.add_development_dependency 'rspec', '2.1.0'
+  gem.add_development_dependency 'bundler', '~> 1.0.0'
+  gem.add_development_dependency 'jeweler', '~> 1.5.0.pre6'
+  gem.add_development_dependency 'rcov', '>= 0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xml_to_json #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Readme.textile

@@ -0,0 +1,89 @@
+h1. XML to JSON
+
+Transforms strings of XML to JSON using a simple XSLT.
+
+h2. Usage
+
+<pre>
+require 'xml_to_json'
+
+puts XmlToJson.transform(<<-XML)
+<items>
+  <item>
+    <id>1</id>
+    <name>Foo</name>
+  </item>
+  <item>
+    <id>2</id>
+    <name>Bar</name>
+  </item>
+</items>
+XML
+</pre>
+
+Transforms into:
+
+<pre>
+{"items":[
+  {
+    "id":1,
+    "name":"Foo"
+  },
+  {
+    "id":2,
+    "name":"Bar"
+  }
+]}
+</pre>
+
+Or:
+
+<pre>
+require 'xml_to_json/string'
+
+xml.to_json
+</pre>
+
+h2. TODO
+
+* Nokogiri::Document#to_json
+
+h2. Contributing to xml_to_json
+
+# Fork on GitHub
+# Write a failing spec
+# OPTIONAL: Make the failing spec pass
+# Send a pull request
+
+Bonus points for topic branches.
+
+If you prove something is broken, I'll be happy to try to fix it. A failing
+spec is sufficient!
+
+The Rakefile, version, and history files are generated by Jeweler. Don't modify
+them or I won't accept your patch. (Exceptions are made when the situation is
+exceptional.)
+
+h2. License
+
+The MIT License
+
+Copyright (c) 2010 Matt Todd.
+
+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/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/xml_to_json.rb

@@ -0,0 +1,17 @@
+require 'nokogiri'
+
+module XmlToJson
+  module_function
+  
+  def transform(xml)
+    stylesheet.transform(Nokogiri::XML(xml)).text
+  end
+  
+  def root
+    @root ||= Pathname.new(__FILE__).dirname.parent
+  end
+  
+  def stylesheet
+    @stylesheet ||= Nokogiri::XSLT(root.join('vendor', 'xml2json-xslt', 'xml2json-patched.xslt').read)
+  end
+end

data/lib/xml_to_json/string.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '..', 'xml_to_json')
+
+class String
+  def to_json
+    XmlToJson.transform(self)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+require 'rubygems'
+require 'bundler/setup'
+require 'xml_to_json'
+
+require 'rspec'
+
+require 'active_support/core_ext/array/conversions'
+require 'active_support/core_ext/hash/conversions'
+require 'yajl/json_gem'

data/spec/string_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'xml_to_json/string'
+
+describe "String#to_json" do
+  before :each do
+    @source = [
+      {
+        :id => 1,
+        :name => "Foo"
+      },
+      {
+        :id => 2,
+        :name => "Bar"
+      }
+    ]
+    @xml = @source.to_xml(:root => "items")
+  end
+  
+  it "should transform an XML string to JSON" do
+    @xml.to_json.should == {:items => @source}.to_json
+  end
+end

data/spec/xml_to_json_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "XmlToJson" do
+  before :each do
+    @source = [
+      {
+        :id => 1,
+        :name => "Foo"
+      },
+      {
+        :id => 2,
+        :name => "Bar"
+      }
+    ]
+    @xml = @source.to_xml(:root => "items")
+  end
+  
+  it "should transform an array of items into a hash of items" do
+    XmlToJson.transform(@xml).should == {:items => @source}.to_json
+  end
+end

data/vendor/xml2json-xslt/COPYRIGHT.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2006, Doeke Zanstra
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this 
+list of conditions and the following disclaimer. Redistributions in binary 
+form must reproduce the above copyright notice, this list of conditions and the 
+following disclaimer in the documentation and/or other materials provided with 
+the distribution.
+
+Neither the name of the dzLib nor the names of its contributors may be used to 
+endorse or promote products derived from this software without specific prior 
+written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
+THE POSSIBILITY OF SUCH DAMAGE.

data/vendor/xml2json-xslt/README.txt

@@ -0,0 +1,107 @@
+====== xml2json.xslt ======
+
+version 0.3, Copyright (c) 2006, Doeke Zanstra, see COPYRIGHT.txt
+
+xml2json.xslt is a XSLT 1.0 stylesheet to transform arbitrary XML to JSON. There is also a version for javascript. The workings are demonstrated with the accompanied xml files. The target of this library is to create javascript-like JSON, not XML-like JSON, like the BadgerFish convention (see Resources). 
+
+The downside is it won't translate all markup, and there's a chance the JSON is invalid. However, if you control the XML, you will enjoy the merits of javascript. Enjoy ;-)
+
+I will call this the Parker convention, after the comic Parker & Badger by Cuadrado. I can really recommend the comic, also in relation to this work and the BadgerFish convention.
+
+====== Using ====== 
+
+You can load the xml files in your browser (Firefox/Camino work, Safari doesn't, Internet Explorer 6 works, except test-js.xml). On windows, you can also try the commandline Msxsl utility (see resources). And of course you can fire up your favorite transformation engine.
+
+====== Translation JSON ====== 
+
+1. The root element will be absorbed, for there is only one
+<root>test</root>
+   becomes
+"test"
+
+2. Element names become object properties:
+<root><name>Xml</name><encoding>ASCII</encoding></root>
+   becomes
+{"name":"Xml","encoding":"ASCII"}
+
+3. Numbers are recognized (integers and decimals):
+<root><age>12</age><height>1.73</height></root>
+  becomes
+{"age":12,"height":1.73}
+
+4. Booleans are recognized case insensitive:
+<root><checked>True</checked><answer>FALSE</answer></root>
+  becomes
+{"checked":true,"answer":false}
+
+5. Strings are escaped:
+<root>Quote: &quot; New-line:
+</root>
+  becomes
+"Quote: \" New-line:\n"
+
+6. Empty elements will become null:
+<root><nil/><empty></empty></root>
+  becomes
+{"nil":null,"empty":null}
+
+7. If all sibling elements have the same name, they become an array
+<root><item>1</item><item>2</item><item>three</item></root>
+   becomes
+[1,2,"three"]
+
+8. Mixed mode text-nodes, comments and attributes get absorbed:
+<root version="1.0">testing<!--comment--><element test="true">1</element></root>
+  becomes
+{element:true}
+
+9. Namespaces get absorbed, and prefixes will just be part of the property name:
+<root xmlns:ding="http://zanstra.com/ding"><ding:dong>binnen</ding:dong></root>
+   becomes
+{"ding:dong":"binnen"}
+
+====== Translation JS extra ====== 
+
+All the same as the JSON translation, but with these extra's:
+
+1. Property names are only escaped when necessary
+<root><while>true</while><wend>false</wend><only-if/></root>
+   becomes
+{"while":true,wend:false,"only-if":null}
+
+2. Within a string, closing elements "</" are escaped as "<\/"
+<root><![CDATA[<script>alert("YES");</script>]]></root>
+   becomes
+{script:"<script>alert(\"YES\")<\/script>"}
+
+3. Dates are created as new Date() objects
+<root>2006-12-25</root>
+   becomes
+new Date(2006,12-1,25)
+
+4. Attributes and comments are shown as comments (for testing-purposes):
+<!--testing--><root><test version="1.0">123</test></root>
+   becomes
+/*testing*/{test/*@version="1.0"*/:123}
+
+5. A bit of indentation is done, to keep things ledgible
+
+====== Plans ====== 
+
+I don't really have much plans with this library. It was mere a result of learning XSLT and XPath better. However, I will perform bug-fixes. Issues I might address, if I can find a satisfactory solution:
+
+- convert attributes to properties in some way
+
+- handle siblings with duplicate names, when there are also other names:
+<root><item>1</item><item>2</item><name>test</name></root>
+  becomes (faulty JSON)
+{"item":1,"item":2,"name":"test"}
+
+====== Resources ====== 
+
+  * Xml: http://www.w3.org/TR/xml/
+  * Xslt: http://www.w3.org/TR/xslt
+  * XPath: http://www.w3.org/TR/xpath
+  * Json: http://www.json.org
+  * BadgerFish: http://badgerfish.ning.com/
+  * Msxsl: http://www.microsoft.com/downloads/details.aspx?FamilyId=2FB55371-C94E-4373-B0E9-DB4816552E41&displaylang=en

data/vendor/xml2json-xslt/test-js.xml

@@ -0,0 +1,53 @@
+<?xml-stylesheet type="text/xsl" href="xml2js.xslt"?>
+<!-- 
+Test XML markup for converting xml to JS using XSLT.
+By Doeke Zanstra, 2006 
+-->
+<root version="1.0" xmlns:ding="http://zanstra.com/ding">
+  this text should be ignored
+  <birthdate>2006-11-14</birthdate>
+  <appointment>2006-11-14T12:30</appointment>
+  <appointment>2006-11-14T12:30:00</appointment>
+  <script><![CDATA[<script>alert("YES")</script>]]></script>
+  <positive>123</positive>
+  <negative>-12</negative>
+  <zero>0</zero>
+  <fixed>10.25</fixed>
+  <fixed-neg>-10.25</fixed-neg>
+  <padded_zero>01</padded_zero>
+  <ding:dong-dang.dung>Namespaced element with dash and dot</ding:dong-dang.dung>
+  <yo123-ho456/>
+  <string>Zooi</string>
+  <string>Tab	Text</string>
+  <string>Quote "test"</string>
+  <string>Backslash \ test</string>
+  <string>Quote " en \ test</string>
+  <string>"Begin/end quote"</string>
+  <escape>Line one (één in Dutch)
+Line two:	tab
+He said: "Much fun with a €"
+More unicode&#8224;</escape>
+  <int>123</int>
+  <float>-12.123</float>
+  <exp>-1.234e5</exp>
+  <boolean>true</boolean>
+  <nil/>
+  <empty></empty>
+  <object test="true" attributes="are commented">
+    <zooi>jaja</zooi>
+    <zut>frot</zut>
+  </object>
+  <array>
+    <item/>
+    <item>true</item>
+    <item>2</item>
+    <item>3</item>
+    <item>4</item>
+    <item>5</item>
+    <item>six</item>
+    <item>
+      <key>item</key>
+      <value>7</value>
+    </item>
+  </array>
+</root>