badgerfish 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 949fb19dd5603d3ff35d87cc36fab906297e6e4f
+  data.tar.gz: 0964dae1408eeac8e2855bc8582f797a07dc1927
+SHA512:
+  metadata.gz: 843ebb8e5fe3a655f685276d54219ab62a59f1890457854818013fa3ba8f1a2377f13d602a2d1c19104b4401ba0e097e4e6ce215562133ad1d6bfbde10844b6d
+  data.tar.gz: f77052c028b60c635e5305d5b21097e823ad892c372201b216802ea1afa07235621ae9bf1f4ee660f30c6381226a606bce6affc285eb89735b103a563ac080fa

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in badgerfish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Sievers
+
+MIT License
+
+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.md

@@ -0,0 +1,56 @@
+# Badgerfish [![Build Status](https://travis-ci.org/msievers/badgerfish.png)](https://travis-ci.org/msievers/badgerfish) [![Dependency Status](https://gemnasium.com/msievers/badgerfish.png)](https://gemnasium.com/msievers/badgerfish)
+
+BadgerFish is a convention for translating an XML document into a JSON object.
+
+The rules
+
+* element names become object properties
+* text content of elements goes in the $ property of an object
+* nested elements become nested properties
+* multiple elements at the same level become array elements
+* attributes go in properties whose names begin with @
+* active namespaces for an element go in the element's @xmlns property
+* the default namespace URI goes in @xmlns.$
+* other namespaces go in other properties of @xmlns
+* elements with namespace prefixes become object properties, too
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'badgerfish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install badgerfish
+
+## Usage
+
+```ruby
+require 'badgerfish'
+
+parser = Badgerfish::Parser.new
+xml = '<alice charlie="david">bob</alice>'
+badgerfish_hash = parser.load(xml)
+```
+
+## Missing features
+
+Does not handle child node namespaces as suggested by http://badgerfish.ning.com (case 9).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Links
+
+* http://badgerfish.ning.com
+* http://wiki.open311.org/index.php?title=JSON_and_XML_Conversion#The_Badgerfish_Convention

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test_*.rb'
+end
+
+task :default => :test

data/badgerfish.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'badgerfish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'badgerfish'
+  spec.version       = Badgerfish::VERSION
+  spec.authors       = ['Michael Sievers']
+  spec.email         = ['michael_sievers@web.de']
+  spec.description   = %q{Badgerfish xml to json convention for ruby}
+  spec.summary       = %q{Badgerfish xml to json convention for ruby}
+  spec.homepage      = "https://github.com/msievers/badgerfish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ox',         '~> 2.0.8'
+
+  spec.add_development_dependency 'bundler',     '~> 1.3'
+  spec.add_development_dependency 'minitest',    '~> 5.0.6'
+  spec.add_development_dependency 'multi_json',  '~> 1.7.9'
+  spec.add_development_dependency 'oj',          '~> 2.1.4'
+  spec.add_development_dependency 'pry',         '~> 0.9.12.2'
+  spec.add_development_dependency 'pry-nav',     '~> 0.2.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/badgerfish.rb

@@ -0,0 +1,5 @@
+require 'badgerfish/from_xml'
+require 'badgerfish/version'
+
+module Badgerfish
+end

data/lib/badgerfish/from_xml.rb

@@ -0,0 +1,4 @@
+require 'badgerfish/parser'
+
+module Badgerfish
+end

data/lib/badgerfish/ox_sax_parser.rb

@@ -0,0 +1,54 @@
+require 'ox'
+require 'stringio'
+
+module Badgerfish
+  class OxSaxParser < Ox::Sax
+
+    def load(xml)
+      @result = @root = {}
+      @parents = []
+      Ox.sax_parse(self, StringIO.new(xml))
+      @result
+    end
+
+    #
+    # sax callbacks
+    #
+    def start_element(name)
+      new_element = {}
+
+      if @root[name].nil?
+        @root[name] = new_element
+      else
+        @root[name] = [@root[name]] unless @root[name].is_a?(Array)
+        @root[name].push new_element
+      end
+
+      @parents.push @root
+      @root = new_element
+    end
+
+    def end_element(name)
+      @root = @parents.pop
+    end
+
+    def attr(name, value)
+      unless name.to_s.start_with? 'xmlns'
+        @root["@#{name}"] = value
+      else
+        @root['@xmlns'] ||= {}
+
+        if name.to_s.start_with? 'xmlns:'
+          @root['@xmlns'][name[6, name.length]] = value
+        else
+          @root['@xmlns']['$'] = value
+        end
+      end
+    end
+
+    def text(value)
+      @root['$'] = value
+    end
+
+  end
+end

data/lib/badgerfish/parser.rb

@@ -0,0 +1,15 @@
+require 'badgerfish/ox_sax_parser'
+
+module Badgerfish
+  class Parser
+
+    def initialize()
+      @parser = Badgerfish::OxSaxParser.new
+    end
+
+    def load(xml)
+      @parser.load(xml)
+    end
+
+  end
+end

data/lib/badgerfish/version.rb

@@ -0,0 +1,3 @@
+module Badgerfish
+  VERSION = "0.0.1"
+end

data/test/test_badgerfish.rb

@@ -0,0 +1,146 @@
+require File.expand_path '../test_helper.rb', __FILE__
+
+class TestBadgerfish < Minitest::Test
+  def setup
+    @parser = Badgerfish::Parser.new
+  end
+
+  def test_badgerfish_ning_com_nr_2
+    xml = '<alice>bob</alice>'
+    expected_json = <<-json
+      {
+        "alice":{
+          "$":"bob"
+        }
+      }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+  def test_badgerfish_ning_com_nr_3
+    xml = '<alice><bob>charlie</bob><david>edgar</david></alice>'
+    expected_json = <<-json
+      {
+        "alice":{
+          "bob":{
+            "$":"charlie"
+          },
+          "david":{
+            "$":"edgar"
+          }
+        }
+      }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+  def test_badgerfish_ning_com_nr_4
+    xml = '<alice><bob>charlie</bob><bob>david</bob></alice>'
+    expected_json = <<-json
+      {
+        "alice":{
+          "bob":[
+            {
+              "$":"charlie"
+            },
+            {
+              "$":"david"
+            }
+          ]
+        }
+      }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+  def test_badgerfish_ning_com_nr_5
+    xml = '<alice charlie="david">bob</alice>'
+    expected_json = <<-json
+      {
+        "alice":{
+          "@charlie":"david",
+          "$":"bob"
+        }
+      }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+  def test_badgerfish_ning_com_nr_7
+    xml = '<alice xmlns="http://some-namespace">bob</alice>'
+    expected_json = <<-json
+      {
+        "alice":{
+          "@xmlns":{
+            "$":"http://some-namespace"
+          },
+          "$":"bob"
+        }
+      }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+  def test_badgerfish_ning_com_nr_8
+    xml = <<-xml
+      <alice xmlns="http://some-namespace" xmlns:charlie="http://some-other-namespace">bob</alice>
+    xml
+    expected_json = <<-json
+      {
+        "alice":{
+          "@xmlns":{
+            "$":"http://some-namespace",
+            "charlie":"http://some-other-namespace"
+          },
+          "$":"bob"
+        }
+      }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+  def test_badgerfish_ning_com_nr_9
+    skip("child node namespaces not supported yet")
+
+    xml = <<-xml
+      <alice xmlns="http://some-namespace" xmlns:charlie="http://some-other-namespace">
+        <bob>david</bob>
+        <charlie:edgar>frank</charlie:edgar>
+      </alice>
+    xml
+
+    expected_json = <<-json
+    {
+      "alice":{
+        "@xmlns":{
+          "$":"http://some-namespace",
+          "charlie":"http://some-other-namespace"
+        },
+        "bob":{
+          "@xmlns":{
+            "$":"http://some-namespace",
+            "charlie":"http://some-other-namespace"
+          },
+          "$":"david"
+        },
+        "charlie:edgar":{
+          "$":"frank",
+          "@xmlns":{
+            "$":"http://some-namespace",
+            "charlie":"http://some-other-namespace"
+          }
+        }
+      }
+    }
+    json
+
+    assert_badgerfish xml, expected_json
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+# silence that minitest related error about minitest/autorun (since minitest version >= 5)
+gem 'minitest'
+
+require 'badgerfish'
+require 'minitest/autorun'
+require 'multi_json'
+require 'pry'
+
+def assert_badgerfish(xml, json)
+  json = MultiJson.dump(MultiJson.load(json)) # sanitize json
+  badgerfish_json = MultiJson.dump(@parser.load(xml))
+
+  assert_equal(json, badgerfish_json)
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: badgerfish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !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: Badgerfish xml to json convention for ruby
+email:
+- michael_sievers@web.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- badgerfish.gemspec
+- lib/badgerfish.rb
+- lib/badgerfish/from_xml.rb
+- lib/badgerfish/ox_sax_parser.rb
+- lib/badgerfish/parser.rb
+- lib/badgerfish/version.rb
+- test/test_badgerfish.rb
+- test/test_helper.rb
+homepage: https://github.com/msievers/badgerfish
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Badgerfish xml to json convention for ruby
+test_files:
+- test/test_badgerfish.rb
+- test/test_helper.rb