badgerhash 0.0.1

data/spec/badgerhash/xml_stream_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path "../../spec_helper.rb", __FILE__
+
+module Badgerhash
+  describe XmlStream do
+    let(:io) { double(:io) }
+
+    describe ".create" do
+      it "creates a new XmlStream" do
+        expect(XmlStream).to receive(:new)
+        XmlStream.create(io)
+      end
+    end
+
+    describe "#to_badgerfish" do
+      let(:result) { { "foo" => { "$" => "bar"} } }
+      let(:handler) { double(:handler, node: result) }
+      let(:parser) { double(:parser) }
+      subject(:xml_stream) { XmlStream.new(handler, parser, io) }
+
+      it "parses io using the given parser and handler" do
+        expect(parser).to receive(:parse).with(handler, io)
+        expect(xml_stream.to_badgerfish).to eq(result)
+      end
+    end
+  end
+end

data/spec/badgerhash_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path "../spec_helper.rb", __FILE__
+
+describe Badgerhash do
+  describe ".sax_parser=" do
+    let(:parser) { double(:parser) }
+
+    after :each do
+      reset_instance_variables Badgerhash
+    end
+
+    it "sets the parser" do
+      Badgerhash.sax_parser = parser
+      expect(Badgerhash.sax_parser).to eq(parser)
+    end
+  end
+
+  describe ".sax_parser" do
+    it "uses the nokogiri parser as default" do
+      expect(Badgerhash.sax_parser)
+        .to eq(Badgerhash::Parsers::REXML::SaxDocument)
+    end
+  end
+end

data/spec/integration/stream_parser_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path "../../spec_helper.rb", __FILE__
+
+describe "Parsing XML Stream", integration: true do
+  subject(:badgerfish) { Badgerhash::XmlStream.create(xml).to_badgerfish }
+
+  context "with simple document" do
+    let(:xml) { StringIO.new("<alice>bob</alice>") }
+
+    it "parses document correctly" do
+      expect(badgerfish).to eq({"alice" => {"\$" => "bob"}})
+    end
+  end
+
+  context "with whitespace in nodes" do
+    let(:xml_str) {
+      <<-XML
+      <alice>
+        bob
+      </alice>
+      XML
+    }
+    let(:xml) { StringIO.new(xml_str) }
+
+    it "compresses the whitespace" do
+      expect(badgerfish).to eq({"alice" => {"\$" => "bob"}})
+    end
+  end
+
+  context "with nested elements" do
+    let(:xml_str) { "<alice><bob>charlie</bob><david>edgar</david></alice>" }
+    let(:xml) { StringIO.new(xml_str) }
+    let(:expected) { {"alice" => {"bob" => {"\$" => "charlie" },
+          "david" => { "\$" => "edgar"}}} }
+
+    it "parses document correctly" do
+      expect(badgerfish).to eq(expected)
+    end
+  end
+
+  context "with multiple elements at the same level" do
+    let(:xml_str) { "<alice><bob>charlie</bob><bob>david</bob></alice>" }
+    let(:xml) { StringIO.new(xml_str) }
+    let(:expected) { { "alice" => {"bob" =>  [{"\$" => "charlie"},
+            {"\$" => "david" }]}} }
+
+    it "parses document correctly" do
+      expect(badgerfish).to eq(expected)
+    end
+  end
+
+  context "with attributes on elements" do
+    let(:xml) { StringIO.new("<alice charlie=\"david\">bob</alice>") }
+    let(:expected) { {"alice" => { "\$" => "bob", "@charlie" => "david" } } }
+
+    it "add attribute as properties begining with '@'" do
+      expect(badgerfish).to eq(expected)
+    end
+  end
+
+  context "with a default namespace" do
+    let(:xml) { StringIO.new("<alice xmlns=\"http://some-namespace\">bob</alice>") }
+    let(:expected) { {"alice" => {"\$" => "bob", "@xmlns" => {
+            "\$" => "http:\/\/some-namespace"}} } }
+
+    it "places it in the @xmlns.$ property" do
+      expect(badgerfish).to eq(expected)
+    end
+  end
+
+  context "with other namespaces" do
+    let(:xml_str) { "<alice xmlns=\"http:\/\/some-namespace\" xmlns:charlie=\"http:\/\/some-other-namespace\">bob</alice>" }
+    let(:xml) { StringIO.new(xml_str) }
+    let(:expected) { {"alice" => {"\$" => "bob", "@xmlns" => {
+            "\$" => "http:\/\/some-namespace",
+            "charlie" => "http:\/\/some-other-namespace" }}} }
+
+    it "places them in properties of @xmlns" do
+      expect(badgerfish).to eq(expected)
+    end
+  end
+
+  context "with elements containing namespace prefixes" do
+    let(:xml_str) {
+      "<alice xmlns=\"http://some-namespace\" xmlns:charlie=\"http://some-other-namespace\"><bob>david</bob><charlie:edgar>frank</charlie:edgar></alice>"
+    }
+    let(:xml) { StringIO.new(xml_str) }
+    let(:expected) { {"alice" => {"bob" => {"\$" => "david" ,
+            "@xmlns" => {"charlie" => "http:\/\/some-other-namespace",
+              "\$" => "http:\/\/some-namespace"}},
+          "charlie:edgar" => {"\$" => "frank",
+            "@xmlns" => {"charlie" => "http:\/\/some-other-namespace",
+              "\$" => "http:\/\/some-namespace"}},
+          "@xmlns" => {"charlie" => "http:\/\/some-other-namespace", 
+            "\$" => "http:\/\/some-namespace"}}} }
+
+    it "add them as properties" do
+      expect(badgerfish).to eq(expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "badgerhash"
+
+def reset_instance_variables(cl)
+  cl.instance_variables.each do |var|
+    cl.instance_variable_set var, nil
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: badgerhash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- George F. Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+description: 
+email:
+- gmurphy@epublishing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- badgerhash.gemspec
+- lib/badgerhash.rb
+- lib/badgerhash/handlers/sax_handler.rb
+- lib/badgerhash/parsers/rexml.rb
+- lib/badgerhash/version.rb
+- lib/badgerhash/xml_stream.rb
+- spec/badgerhash/handlers/sax_handler_spec.rb
+- spec/badgerhash/parsers/rexml_spec.rb
+- spec/badgerhash/xml_stream_spec.rb
+- spec/badgerhash_spec.rb
+- spec/integration/stream_parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gfmurphy/badgerhash
+licenses:
+- GNU LGPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4557748935909300667
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Parse XML as IO into hash using badgerfish convention.
+test_files:
+- spec/badgerhash/handlers/sax_handler_spec.rb
+- spec/badgerhash/parsers/rexml_spec.rb
+- spec/badgerhash/xml_stream_spec.rb
+- spec/badgerhash_spec.rb
+- spec/integration/stream_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: