xmlcellent 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "nokogiri", "~> 1.5.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rcov (0.9.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri (~> 1.5.0)
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Zach Pendleton
+
+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.mdown

@@ -0,0 +1,86 @@
+# Xmlcellent
+
+_A more excellent way to parse XML into Ruby models and objects_
+
+## About
+
+Imagine you have some XML in your application that you need to turn into
+a collection of models. You could do it the way you've always done it
+– loop through some XML, creating models as you go – or you
+could use Xmlcellent and stop worrying. Xmlcellent: it's a more
+excellent way to turn XML into something you can use.
+
+## Getting started
+
+It's simple: include `gem "xmlcellent"` in your Gemfile, and take a
+look at this:
+
+    # Sample XML
+    <employees>
+      <employee company="Sterling Cooper">
+        <name>Don Draper</name>
+        <description>
+          <paragraph>Lorem ipsum dolor.</paragraph>
+          <paragraph>Sit amet consecteteur.</paragraph>
+          <paragraph>Adipiscing elit donec odio.</paragraph>
+        </description>
+        <hobby skill="excellent">Philandering</hobby>
+      </employee>
+    </employees>
+
+    # Xmlcellent
+    require "xmlcellent"
+    Xmlcellent::Parser.define_format :employees, Employee, {
+      :finder => "//employee"
+      :lexicon => {
+        :name => "name",
+        :description => "description",
+        :hobby => lambda { |obj|
+          obj.xpath("hobby").text + "Skill: #{obj.xpath("hobby/@skill")}"
+        }
+      }
+    }
+
+    Xmlcellent::Parser.parse(@xml_string)
+    puts Xmlcellent::Parser.results
+
+## How to use
+
+The parser does not need to be instantiated; it can be controlled
+through two class methods: `parse` and `define_format`. `define_format`
+is used to describe your XML structure to the Parser. It takes three
+arguments:
+
+1.  A descriptive name as a hash. e.g. `:employees`;
+2.  A model to map to. e.g. `Employee`; and
+3.  A hash with `:finder` and `:lexicon` keys.
+
+The `:finder` key is the XPath route to the object in the XML, and the
+`:lexicon` key is a hash with properties of the model as keys and xpath
+expressions as values. `:lexicon` will also accept a lambda as a value,
+which is passed the XML representation of the model and should return
+the value to set it to. This allows for some data manipulation,
+concatenation, etc. of the XML.
+
+`define_format` creates a new class method on `Xmlcellent::Parser`
+named `parse_format_name`, with `format_name` being the name you
+passed `define_format`. As a convenience, there is also an
+`Xmlcellent.parse` method that loops through the the parser's defined
+formats and runs the first format whose `:finder` returns a match
+on the given XML.
+
+## Contributing to xmlcellent
+ 
+*  Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+*  Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+*  Fork the project
+*  Start a feature/bugfix branch
+*  Commit and push until you are happy with your contribution
+*  Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+*  Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Zach Pendleton. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+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 = "xmlcellent"
+  gem.homepage = "http://github.com/zachpendleton/xmlcellent"
+  gem.license = "MIT"
+  gem.summary = %Q{A more xmlcellent way to parse XML into models}
+  gem.description = %Q{An XML parser that uses Nokogiri and dynamic methods to transform XML data into a given Ruby model}
+  gem.email = "zachpendleton@gmail.com"
+  gem.authors = ["Zach Pendleton"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xmlcellent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/xmlcellent.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__))) unless $:.include? File.expand_path(File.dirname(__FILE__))
+
+require "xmlcellent/format"
+require "xmlcellent/parser"

data/lib/xmlcellent/format.rb

@@ -0,0 +1,13 @@
+module Xmlcellent
+  # Given a hash with a :finder key and a
+  # :lexicon key, this model stores config
+  # information for a parser.
+  class Format
+    attr_reader :finder, :lexicon
+
+    def initialize(config)
+      @finder  = config[:finder]
+      @lexicon = config[:lexicon]
+    end
+  end
+end

data/lib/xmlcellent/parser.rb

@@ -0,0 +1,66 @@
+require "nokogiri"
+
+module Xmlcellent
+  # A shortcut method for Xmlcellent::Parser.parse()
+  def self.parse(doc)
+    Parser.parse(doc)
+  end
+
+  # Handles the parsing of XML data using Xmlcellent::Format
+  # objects.
+  class Parser
+    class << self
+      attr_accessor :formats
+
+      # Erases all existing formats
+      def delete_formats!
+        @formats = {}
+      end
+
+      # Given a string of XML, this method loops through the
+      # defined Formats and, if it finds a match, calls that
+      # method to parse the XML into objects.
+      def parse(doc)
+        document = Nokogiri::XML(doc).remove_namespaces!
+        @formats.each do |key, format|
+          if document.xpath(format.finder).length > 0
+            return self.send("parse_#{key}".to_sym, doc)
+          end
+        end
+        raise "Error: Parser not found!"
+      end
+
+      # Creates a format on the Xmlcellent::Parser object to
+      # be used to convert XML to models.
+      def define_format(name, model = nil, config = {})
+        @formats ||= {}
+        raise "Format already exists!" if @formats.has_key? name
+        @formats[name] = Format.new(config)
+
+        # This ugly piece of code is used to dynamically generate
+        # class methods in a way that Ruby 1.8 understands.
+        singleton = class << self; self; end
+        singleton.instance_eval do
+          define_method("parse_#{name.to_s}".to_sym) do |doc|
+            document = doc.class == Nokogiri::XML::Document ?
+              doc :
+              Nokogiri::XML(doc).remove_namespaces!
+            results  = []
+
+            document.xpath(@formats[name].finder).each do |obj|
+              m = model.new
+              @formats[name].lexicon.each do |key, path|
+                next if path.nil? # fail silently if given a bad path
+
+                value = path.class == Proc ? path.call(obj) : obj.xpath(path).text
+                m.send("#{key.to_s}=".to_sym, value)
+              end
+              results << m
+            end
+            results
+          end
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'xmlcellent'
+
+class Test::Unit::TestCase
+end

data/test/test_xmlcellent.rb

@@ -0,0 +1,143 @@
+require 'helper'
+
+class Item
+  attr_accessor :name, :summary, :color, :supplier
+end
+
+class TestXmlcellent < Test::Unit::TestCase
+  def setup
+    @xml ||= <<-END
+      <items>
+        <item supplier="Dunder Mifflin">
+          <name>Item one</name>
+          <description color="red">Lorem ipsum dolor</description>
+          <summary>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+          </summary>
+        </item>
+        <item supplier="Plainview Medical">
+          <name>Item two</name>
+          <description color="blue">Lorem ipsum dolor</description>
+          <summary>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+          </summary>
+        </item>
+        <item supplier="Bluth Company">
+          <name>Item three</name>
+          <description color="yellow">Lorem ipsum dolor</description>
+          <summary>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+            <paragraph>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</paragraph>
+          </summary>
+        </item>
+
+    END
+  end
+  def test_should_create_a_new_parser_on_call_to_define_parser
+    Xmlcellent::Parser.define_format :test_format
+    assert Xmlcellent::Parser.singleton_methods.include? :parse_test_format
+  end
+
+  def test_define_parser_should_create_a_new_format_object
+    Xmlcellent::Parser.define_format :test_format
+    assert Xmlcellent::Parser.formats[:test_format].class == Xmlcellent::Format
+  end
+
+  def test_define_parser_should_add_new_format_to_formats_variable
+    Xmlcellent::Parser.define_format :test_format
+    assert Xmlcellent::Parser.formats.has_key? :test_format
+  end
+
+  def test_define_parser_should_raise_an_error_on_duplicate_key
+    Xmlcellent::Parser.define_format :test_format
+    assert_raise(RuntimeError) do
+      Xmlcellent::Parser.define_format :test_format
+    end
+  end
+
+  def test_should_parse_xml_when_passed_a_string_of_xml
+    Xmlcellent::Parser.define_format :test_format, Item, {
+      :finder => "//item",
+      :lexicon => {
+        :name => "name"
+      }
+    }
+    result = Xmlcellent::Parser.parse_test_format(@xml)
+    assert_equal result.length, 3
+    assert_equal result[0].name, "Item one"
+  end
+
+  def test_should_parse_xml_by_applying_a_lambda
+    Xmlcellent::Parser.define_format :test_format, Item, {
+      :finder => "//item",
+      :lexicon => {
+        :summary => lambda { |obj|
+          obj.xpath("summary/paragraph").inject("") { |c, p| c + p.text }
+        }
+      }
+    }
+    result = Xmlcellent::Parser.parse_test_format(@xml)
+    assert_equal result[0].summary.scan(/Lorem/).length, 3
+  end
+
+  def test_should_parse_xml_by_reading_attributes
+    Xmlcellent::Parser.define_format :test_format, Item, {
+      :finder => "//item",
+      :lexicon => {
+        :color => "description/@color",
+        :supplier => "@supplier"
+      }
+    }
+
+    result = Xmlcellent::Parser.parse_test_format(@xml)
+    assert_equal result[0].color, "red"
+    assert_equal result[0].supplier, "Dunder Mifflin"
+  end
+
+  def test_should_delete_all_formats_on_call_to_delete_formats
+    Xmlcellent::Parser.define_format :test_format, Item, {}
+    Xmlcellent::Parser.delete_formats!
+    assert_equal Xmlcellent::Parser.formats.length, 0
+  end
+
+  def test_should_find_proper_format_using_the_finder_attribute
+    Xmlcellent::Parser.define_format :format_one, Item, {
+      :finder => "//item",
+      :lexicon => {
+        :name => "name"
+      }
+    }
+
+    Xmlcellent::Parser.define_format :format_two, Item, {
+      :finder => "//thing",
+      :lexicon => {
+        :name => "thing_name"
+      }
+    }
+
+    result = Xmlcellent::Parser.parse(@xml)
+    assert_equal result.length, 3
+    assert_equal result[0].name, "Item one"
+  end
+
+  def test_should_call_parser_parse_on_call_to_parse_shortcut
+    Xmlcellent::Parser.define_format :test_format, Item, {
+      :finder => "//item",
+      :lexicon => {
+        :name => "name"
+      }
+    }
+
+    result = Xmlcellent.parse(@xml)
+    assert_equal result.length, 3
+  end
+
+  def teardown
+    Xmlcellent::Parser.delete_formats!
+  end
+end

data/xmlcellent.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{xmlcellent}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Zach Pendleton}]
+  s.date = %q{2011-08-24}
+  s.description = %q{An XML parser that uses Nokogiri and dynamic methods to transform XML data into a given Ruby model}
+  s.email = %q{zachpendleton@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.mdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mdown",
+    "Rakefile",
+    "VERSION",
+    "lib/xmlcellent.rb",
+    "lib/xmlcellent/format.rb",
+    "lib/xmlcellent/parser.rb",
+    "test/helper.rb",
+    "test/test_xmlcellent.rb",
+    "vendor/cache/git-1.2.5.gem",
+    "vendor/cache/jeweler-1.6.4.gem",
+    "vendor/cache/nokogiri-1.5.0.gem",
+    "vendor/cache/rake-0.9.2.gem",
+    "vendor/cache/rcov-0.9.10.gem",
+    "xmlcellent.gemspec"
+  ]
+  s.homepage = %q{http://github.com/zachpendleton/xmlcellent}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
+  s.summary = %q{A more xmlcellent way to parse XML into models}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, ["~> 1.5.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, ["~> 1.5.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: xmlcellent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Zach Pendleton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70362671229000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70362671229000
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70362671227680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70362671227680
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70362671226540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70362671226540
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70362671225500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70362671225500
+description: An XML parser that uses Nokogiri and dynamic methods to transform XML
+  data into a given Ruby model
+email: zachpendleton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.mdown
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.mdown
+- Rakefile
+- VERSION
+- lib/xmlcellent.rb
+- lib/xmlcellent/format.rb
+- lib/xmlcellent/parser.rb
+- test/helper.rb
+- test/test_xmlcellent.rb
+- vendor/cache/git-1.2.5.gem
+- vendor/cache/jeweler-1.6.4.gem
+- vendor/cache/nokogiri-1.5.0.gem
+- vendor/cache/rake-0.9.2.gem
+- vendor/cache/rcov-0.9.10.gem
+- xmlcellent.gemspec
+homepage: http://github.com/zachpendleton/xmlcellent
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1709074531614176846
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: A more xmlcellent way to parse XML into models
+test_files: []