xml_hate 0.8.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.idea

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.8.7-p352@xml_hate"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
+

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in xml_hate.gemspec
+gemspec
+
+gem 'xml-simple'
+gem 'hashie'
+gem 'activesupport'
+
+gem 'minitest'
+group :development do
+  gem 'guard'
+  gem 'guard-minitest', :git => 'git://github.com/aspiers/guard-minitest.git'
+  gem 'ruby_gntp'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'minitest' do
+  watch(%r|^test/test_(.*)\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+  watch(%r|^lib/(.*)\.rb|)            { |m| "test/test_#{m[1]}.rb" }
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/xml_hate/(.+)\.rb$})         { |m| "spec/xml_hate/#{m[1]}_spec.rb" }
+  watch(%r{^spec/models/.+\.rb$})   { ["spec/models", "spec/acceptance"] }
+  watch('spec/spec_helper.rb')      { "spec" }
+end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/xml_hate/document.rb

@@ -0,0 +1,83 @@
+require 'hashie'
+require 'active_support/inflector'
+
+module XmlHate
+  class Document
+    def initialize(xml)
+      @document = XmlSimple.xml_in(xml)
+    end
+
+    def method_missing(meth, *args, &blk)
+      return "" if @document.has_key?(meth.to_s) == false 
+      objects = pull_the_objects_from_the_xml_document(meth)
+      objects.count == 1 ? objects[0] : objects
+    end
+
+    private
+
+    def pull_the_objects_from_the_xml_document(meth)
+      nodes = read_the_matching_nodes_from_the_xml_document(meth)
+      convert_the_hashes_to_objects(nodes)
+    end
+
+    def read_the_matching_nodes_from_the_xml_document(meth)
+      @document[meth.to_s].map { |n| process_this_top_level_node(n) }
+    end
+
+    def convert_the_hashes_to_objects(objects)
+      objects.map do |v|
+        v.class == Hashie::Mash ? Node.new(v) : v
+      end
+    end
+
+    def process_this_top_level_node(node)
+      return node if node.class == String
+      new_object = Hashie::Mash.new(node)
+      process_this_inner_node(new_object)
+    end
+
+    def process_this_inner_node(node)
+      # get the values to pluralize before modifying the node
+      values_to_pluralize = get_values_to_pluralize(node)
+
+      # this may modify the values checked to be pluralized
+      bring_up_single_elements_as_properties(node)
+
+      # now "pluralize" by setting the pluralized key
+      values_to_pluralize.each { |key, value| node[key] = value }
+
+      node
+    end
+
+    def bring_up_single_elements_as_properties(node)
+      get_properties_with_multiple_elements(node).each do |key, value|
+        value.each { |v| process_this_inner_node(v) }
+        node[key] = value[0] if get_the_number_of_elements(value) == 1 
+      end
+    end
+
+    def get_values_to_pluralize(node)
+      values_to_pluralize = {}
+      get_properties_with_multiple_elements(node).each do |key, value|
+        values_to_pluralize[key.pluralize] = value if key.pluralize != key
+      end
+      values_to_pluralize
+    end
+
+    def get_properties_with_multiple_elements(node)
+      begin
+        node.select{|k,v| get_the_number_of_elements(v) >= 1}
+      rescue
+        []
+      end
+    end
+
+    def get_the_number_of_elements(value)
+      begin
+        value.count
+      rescue
+        0
+      end
+    end
+  end
+end

data/lib/xml_hate/node.rb

@@ -0,0 +1,31 @@
+module XmlHate
+  class Node
+    def initialize(hash)
+      hash.each { |k,v| create_accessor_for k, convert_the_value_to_the_appropriate_form(v) }
+    end
+
+    def method_missing(meth, *args, &blk)
+      an_empty_array_for_plurals_or_empty_string_for_singulars meth
+    end
+
+    private
+
+    def an_empty_array_for_plurals_or_empty_string_for_singulars(meth)
+      meth.to_s == meth.to_s.pluralize ? [] : ""
+    end
+
+    def create_accessor_for(k, v)
+      self.instance_variable_set("@#{k}", v)
+      self.instance_eval("
+      class << self
+        attr_accessor :#{k.to_sym}
+      end")
+    end
+
+    def convert_the_value_to_the_appropriate_form(value)
+      return Node.new(value) if value.class == Hashie::Mash 
+      return value.map {|i| i.class == Hashie::Mash ? Node.new(i) : i} if value.class == Array
+      value
+    end
+  end
+end

data/lib/xml_hate/version.rb

@@ -0,0 +1,3 @@
+module XmlHate
+  VERSION = "0.8.0"
+end

data/lib/xml_hate.rb

@@ -0,0 +1,7 @@
+require "xml_hate/version"
+require "xml_hate/node"
+require "xml_hate/document"
+require "xmlsimple"
+
+module XmlHate
+end

data/readme.md

@@ -0,0 +1,55 @@
+# XML Hate
+
+## Reading XML with my own ten-foot poll.
+
+xml_hate is a small gem that describes my feelings for XML imports.  I've written a billion of them, yet each time I start another I feel like I'm writing Assembler. Shouldn't it be easier?  Shouldn't the code look nicer?  Shouldn't this be more fun?
+
+I've also noticed a number of things that I always tend to do.  I always convert the XML to objects, I parse through the hierarchy to find child objects, I put in defensive checks for data that might-or-might-not exist, etc.
+
+This gem is where I'm going to put these conventions and processes of mine.  My goal is to take a XML document and immediately get it in the form that I need to use it.
+
+### Example
+
+``` xml
+<root>
+  <directory>
+    <employee lastname="Galt">
+      <address>123 W St</address>
+      <address>456 S Blvd</address>
+      <firstname>John</firstname>
+    </employee>
+    <employee lastname="Roark" firstname="Howard">
+      <address>789 S</address>
+    </employee>
+    <employee lastname="Rearden" />
+  </directory>
+</root>
+```
+
+```ruby
+document = XmlHate::Document.new(xml)
+
+document.directory.employees.count # 3, note pluralization happened automatically
+
+john_galt = document.directory.employees[0]
+
+# note how I treat the single-value element and attribute the same
+john_galt.lastname # Galt
+john_galt.firstname # John
+
+john_galt.addresses.count # 2, notice pluralization again
+
+howard_roark = document.directory.employees[1]
+
+howard_roark.firstname # Howard
+howard_roark.lastname # Roark
+howard_roark.addresses.count # 1
+howard_roark.address # 789 S
+
+rearden = document.directory.employees[2]
+rearden.lastname # Rearden
+rearden.firstname # "", defaults to empty string if the value cannot be found
+rearden.whatever_i_want # "", see above
+rearden.addresses.count # 0, returns [] by assuming you want the plural version
+
+```

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require './lib/xml_hate.rb'

data/spec/xml_hate/document_spec.rb

@@ -0,0 +1,236 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe XmlHate::Document do
+
+  describe "with a simple car xml block" do
+    before do
+      xml = <<DOC
+<root>
+<car>a car</car>
+</root>
+DOC
+      @document = XmlHate::Document.new(xml)
+    end
+  
+    it "should return an object for car" do
+      @document.car.wont_be_nil  
+    end
+
+    it "should return empty string for anything else" do
+      @document.blah.must_equal ""
+      @document.something.must_equal ""
+      @document.else.must_equal ""
+    end
+  end
+
+  describe "with a simple truck xml block" do
+    before do
+      xml = <<DOC
+<root>
+<truck>a truck</truck>
+</root>
+DOC
+      @document = XmlHate::Document.new(xml)
+    end
+  
+    it "should return an object for car" do
+      @document.truck.wont_be_nil  
+    end
+
+    it "should return empty string for anything else" do
+      @document.car.must_equal ""
+      @document.blah.must_equal ""
+      @document.something.must_equal ""
+      @document.else.must_equal ""
+    end
+  end
+  
+  describe "with a more complex boat xml block" do
+    before do
+      xml = <<DOC
+<root>
+<boat name="Bulstrode" type="Cargo">
+  <attitude>grumpy</attitude>
+  <location>The ocean</location>
+  <episode>ep 10</episode>
+  <episode>ep 11</episode>
+  <narrator firstname="George" lastname="Carlin" />
+</boat>
+</root>
+DOC
+      @document = XmlHate::Document.new(xml)
+    end
+
+    it "should return a node object for boat" do
+      @document.boat.class.must_equal XmlHate::Node  
+    end
+  
+    it "should return Bulstrode as the name" do
+      @document.boat.name.must_equal "Bulstrode"  
+    end
+
+    it "should return Cargo as the type" do
+      @document.boat.type.must_equal "Cargo"  
+    end
+
+    it "should return attitude as grumpy" do
+      @document.boat.attitude.must_equal "grumpy"  
+    end
+
+    it "should return location as the ocean" do
+      @document.boat.locations.count.must_equal 1  
+    end
+    
+    it "should return locations" do
+      @document.boat.location.must_equal "The ocean"  
+    end
+
+    it "should return both episodes" do
+      @document.boat.episode.count.must_equal 2
+      @document.boat.episode[0].must_equal "ep 10"
+      @document.boat.episode[1].must_equal "ep 11"
+    end
+
+    it "should return all information about the narrator" do
+      @document.boat.narrator.firstname.must_equal "George"
+      @document.boat.narrator.lastname.must_equal "Carlin"
+    end
+
+    it "should set the narrator to an empty object" do
+      @document.boat.narrator.class.must_equal XmlHate::Node
+    end
+
+  end
+
+  describe "with an even more complex movie xml block" do
+    before do
+      xml = <<DOC
+<root>
+  <movie name="Deep Impact">
+    <actor name="Morgan Freeman" gender="Male" />
+    <actor name="Tea Leoni" gender="Female" />
+    <actor name="Elijah Wood" gender="Male">
+      <movie name="Lord of the Rings 1" />
+      <movie name="Lord of the Rings 2">
+        <actor name="Sean Astin" />
+        <year>2004</year>
+      </movie>
+    </actor>
+  </movie>
+</root>
+DOC
+      @document = XmlHate::Document.new(xml)
+    end
+
+    it "should have a movie element" do
+      @document.movie.nil?.must_equal false 
+    end
+
+    it "should have three actors" do
+      @document.movie.actor.count.must_equal 3
+    end
+
+    it "should be able to pull acotrs out with plural property" do
+      @document.movie.actors.count.must_equal 3 
+    end
+
+    it "should have two other movies on the third actor" do
+      @document.movie.actor[2].movie.count.must_equal 2  
+    end
+
+    it "should be able to pull the actor deep down the chain" do
+      @document.movie.actor[2].movie[1].actor.name.must_equal "Sean Astin"
+    end
+
+    it "should be able to pull the year deep down the chain" do
+      @document.movie.actor[2].movie[1].year.must_equal "2004"
+    end
+
+    it "should maintain years as an array deep down the list" do
+      @document.movie.actor[2].movie[1].years.count.must_equal 1
+      @document.movie.actor[2].movie[1].years[0].must_equal "2004" 
+    end
+  end
+
+
+  describe "another xml example" do
+    before do
+      xml = <<DOC
+<root>
+  <product_group>
+    <name>A product group</name>
+    <listofgroup></listofgroup>
+    <listofgroup>
+      <product_group id="100"></product_group>
+      <product_group id="3">
+        <name>Another product group</name>
+      </product_group>
+    </listofgroup>
+  </product_group>
+</root>
+DOC
+      @document = XmlHate::Document.new(xml)
+    end
+
+    it "should have data" do
+      @document.product_group.listofgroups[1].product_groups[1].name.must_equal "Another product group"
+    end
+  end
+
+  describe "another xml example with plurals after the root" do
+    before do
+      xml = <<DOC
+<root>
+  <product_group />
+  <product_group>
+    <name>A product group</name>
+    <listofgroup></listofgroup>
+    <listofgroup>
+      <product_group id="100"></product_group>
+      <product_group id="3">
+        <name>Another product group</name>
+      </product_group>
+    </listofgroup>
+  </product_group>
+</root>
+DOC
+      @document = XmlHate::Document.new(xml)
+    end
+
+    it "should have data" do
+      @document.product_group[1].listofgroups[1].product_groups[1].name.must_equal "Another product group"
+    end
+  end
+
+  describe "an example from the readme file" do
+    before do
+      xml = <<DOC
+<root>
+  <directory>
+    <employee lastname="Galt">
+      <address>123 W St</address>
+      <address>456 S Blvd</address>
+      <firstname>John</firstname>
+    </employee>
+    <employee lastname="Roark" firstname="Howard">
+      <address>789 S</address>
+    </employee>
+    <employee lastname="Rearden" />
+  </directory>
+</root>
+DOC
+      @document = XmlHate::Document.new xml
+    end
+
+    it "should return directory as a Node" do
+      @document.directory.class.must_equal XmlHate::Node 
+    end
+
+    it "should return the employees as Nodes" do
+      @document.directory.employees.each do |e|
+        e.class.must_equal XmlHate::Node
+      end
+    end
+
+  end
+end

data/spec/xml_hate/node_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe XmlHate::Node do
+  describe "creating a node with a simple node" do
+    before do
+      @object = XmlHate::Node.new({:firstname => "John", :lastname => "Carter" })
+    end
+
+    it "should respond to first name" do
+      @object.respond_to?(:firstname).must_equal true 
+    end
+
+    it "should respond to last name" do
+      @object.respond_to?(:lastname).must_equal true 
+    end
+
+    it "should not respond to other things" do
+      @object.respond_to?(:something).must_equal false 
+      @object.respond_to?(:else).must_equal false 
+    end
+
+    it "should return the first name" do
+      @object.firstname.must_equal "John" 
+    end
+  
+    it "should return the last name" do
+      @object.lastname.must_equal "Carter" 
+    end
+
+    it "should return an empty string for a singular name" do
+      @object.cat.must_equal "" 
+      @object.dog.must_equal ""
+    end
+
+    it "should return an empty array for plural names" do
+      @object.cats.must_equal []
+      @object.dogs.must_equal []
+    end
+  end
+
+  describe "creating a node with a child Hashie::Match" do
+    before do
+      @object = XmlHate::Node.new({:thing => Hashie::Mash.new({:firstname => "John", :lastname => "Carter" })})
+    end
+
+    it "should return a node object for thing" do
+      @object.thing.class.must_equal XmlHate::Node 
+    end
+
+  end
+
+  describe "creating a node with an Array" do
+    before do
+      @object = XmlHate::Node.new({:thing => [Hashie::Mash.new(), "test"]})
+    end
+
+    it "should return a node object for the first item" do
+      @object.thing[0].class.must_equal XmlHate::Node 
+    end
+
+    it "should return a string for the second item" do
+      @object.thing[1].class.must_equal String 
+    end
+  end
+
+  describe "creating a node will create attributes for single instances of node" do
+    before do
+      @object1 = XmlHate::Node.new({:first_name => "Tyrone", :last_name => "Groves"})
+      @object2 = XmlHate::Node.new({:customer_id => 23})
+    end
+
+    it "should not respond to first name" do
+      @object2.respond_to?(:first_name).must_equal false
+    end
+
+    it "should not respond to last name" do
+      @object2.respond_to?(:last_name).must_equal false
+    end
+  end
+end

data/xml_hate.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "xml_hate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "xml_hate"
+  s.version     = XmlHate::VERSION
+  s.authors     = ["Darren Cauthon"]
+  s.email       = ["darren@cauthon.com"]
+  s.homepage    = ""
+  s.summary     = %q{Handling xml with my own ten-foot poll.}
+  s.description = %q{I hate xml.}
+
+  s.rubyforge_project = "xml_hate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency 'xml-simple'
+  s.add_runtime_dependency 'hashie'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: xml_hate
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
+platform: ruby
+authors:
+- Darren Cauthon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &70214612517320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70214612517320
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70214612533220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70214612533220
+description: I hate xml.
+email:
+- darren@cauthon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- Rakefile
+- lib/xml_hate.rb
+- lib/xml_hate/document.rb
+- lib/xml_hate/node.rb
+- lib/xml_hate/version.rb
+- readme.md
+- spec/spec_helper.rb
+- spec/xml_hate/document_spec.rb
+- spec/xml_hate/node_spec.rb
+- xml_hate.gemspec
+homepage: ''
+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: xml_hate
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Handling xml with my own ten-foot poll.
+test_files:
+- spec/spec_helper.rb
+- spec/xml_hate/document_spec.rb
+- spec/xml_hate/node_spec.rb