eggnog 0.0.1

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/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@eggnog

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Closner
+
+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,73 @@
+#Eggnog
+
+[![travis](https://secure.travis-ci.org/rclosner/eggnog.png)](http://travis-ci.org/rclosner/eggnog)
+
+<img src="https://github.com/rclosner/eggnog/raw/master/eggnog.jpg" width="200px" />
+
+Eggnog is a Nokogiri XML Node Class mixin that implements Node#to_hash
+
+## Installation
+
+```ruby
+  gem install eggnog
+```
+
+## Usage
+
+
+# XML
+
+
+```
+  <root>
+    <foo bar='baz'>Some text value</foo>
+  </root>
+```
+    
+```ruby
+  node = Nokogiri::XML(xml)
+```
+
+# Default Behavior
+
+```ruby
+  node.to_hash
+```
+
+returns:
+
+```ruby
+  {
+    "root" => {
+      "foo" => "Some text value" 
+    } 
+  }
+```
+
+# With Options
+
+Preserve XML attributes:
+
+```ruby
+  node.to_hash(:preserve_attributes => true)
+```
+returns:
+
+```ruby
+  { 
+    "root" => {
+      "foo" => { 
+        "__content__" => "Some text value", 
+        "bar" => "baz" 
+      } 
+    } 
+  }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/eggnog.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/eggnog/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryan Closner"]
+  gem.email         = ["ryan@ryanclosner.com"]
+  gem.description   = %q{Nokogiri Mixin - Converts Nodes to a Hash}
+  gem.summary       = %q{Nokogiri Mixin - Converts Nodes to a Hash}
+  gem.homepage      = "http://github.com/rclosner/eggnog"
+
+  runtime_dependencies = {
+    "nokogiri"   => "~> 1.5.5"
+  }
+
+  runtime_dependencies.each {|lib, version| gem.add_runtime_dependency(lib, version) }
+
+  development_dependencies = {
+    "rake"     => "~> 0.9.2",
+    "rspec"    => "~> 2.7.0"
+  }
+
+  development_dependencies.each {|lib, version| gem.add_development_dependency(lib, version) }
+
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "eggnog"
+  gem.require_paths = ["lib"]
+  gem.version       = Eggnog::VERSION
+end

data/lib/eggnog/node_decorator.rb

@@ -0,0 +1,77 @@
+class Eggnog::NodeDecorator < Struct.new(:node, :options)
+
+  CONTENT_ROOT = "__content__".freeze
+
+  def self.to_hash(node, options = {})
+    new(node, options).to_hash
+  end
+
+  def to_hash(parent_hash = {})
+    insert_into_parent_hash(parent_hash, collect_nodes)
+  end
+
+  private
+
+  def insert_into_parent_hash(hash, content)
+    case hash[name]
+    when NilClass then hash[name] = content
+    when Hash     then hash[name] = [hash[name], content]
+    when Array    then hash[name] << content
+    end
+    hash
+  end
+
+  def collect_nodes
+    case node
+    when Nokogiri::XML::Document
+      self.class.to_hash(node.root, options)
+    else
+      if preserve_attributes?
+        output = collect_attributes
+
+        if output.empty?
+          output = collect_children
+        else
+          output[CONTENT_ROOT] = collect_children
+        end
+
+        output
+      else
+        collect_children
+      end
+    end
+  end
+
+  def collect_attributes
+    ({}).tap do |output|
+      attribute_nodes.each {|a| output[a.name] = a.value }
+    end
+  end
+
+  def collect_children
+    if element_children.empty?
+      self.content
+    else
+      output = {}
+
+      element_children.each do |child|
+        child.to_hash(output)
+      end
+
+      output
+    end
+  end
+
+  def element_children
+    @element_children ||= node.element_children.map {|c| self.class.new(c, options)}
+  end
+
+  def preserve_attributes?
+    !!options.fetch(:preserve_attributes) { false }
+  end
+
+  def method_missing(m, *args, &block)
+    node.send(m, *args, &block)
+  end
+
+end

data/lib/eggnog/version.rb

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

data/lib/eggnog.rb

@@ -0,0 +1,6 @@
+module Eggnog
+end
+
+require "eggnog/version"
+require "eggnog/node_decorator"
+require "node"

data/lib/node.rb

@@ -0,0 +1,5 @@
+class Nokogiri::XML::Node
+  def to_hash(options = {})
+    Eggnog::NodeDecorator.to_hash(self, options)
+  end
+end

data/spec/eggnog/node_decorator_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Eggnog::NodeDecorator do
+  subject { described_class.new(node, options) }
+
+  let(:node)    { Nokogiri::XML(xml).root }
+  let(:xml)     { "<foo boo='baz'>bar</foo>"}
+  let(:options) { {} }
+
+  describe "#to_hash" do
+    it "returns a Hash" do
+      subject.to_hash.should be_a(Hash)
+    end
+
+    it "converts xml node into a hash" do
+      subject.to_hash.should eql({"foo" => "bar"})
+    end
+
+    context "preserve_attributes => true" do
+      let(:options) { { :preserve_attributes => true } }
+
+      it "preserves xml attributes" do
+        subject.to_hash.should eql({"foo" => {"__content__" => "bar", "boo" => "baz" } })
+      end
+    end
+  end
+
+  describe ".to_hash" do
+    it "returns a hash" do
+      described_class.to_hash(node, options).should be_a(Hash)
+    end
+  end
+end

data/spec/node_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Nokogiri::XML::Node do
+  subject { Nokogiri::XML(xml) }
+
+  let(:xml) {"<root><foo>bar</foo></root>"}
+
+  describe "#to_hash" do
+    let(:options) { {} }
+
+    it "delegates to NodeDecorator" do
+      Eggnog::NodeDecorator.should_receive(:to_hash).with(subject, options)
+      subject.to_hash(options)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler/setup"
+require "rspec"
+
+require "nokogiri"
+require File.expand_path('../../lib/eggnog', __FILE__)
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+def fixture_file(filename)
+  File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: eggnog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Closner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-04 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.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: Nokogiri Mixin - Converts Nodes to a Hash
+email:
+- ryan@ryanclosner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- eggnog.gemspec
+- eggnog.jpg
+- lib/eggnog.rb
+- lib/eggnog/node_decorator.rb
+- lib/eggnog/version.rb
+- lib/node.rb
+- spec/eggnog/node_decorator_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rclosner/eggnog
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Nokogiri Mixin - Converts Nodes to a Hash
+test_files:
+- spec/eggnog/node_decorator_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb