tylerhunt-relief 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tyler Hunt
+
+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.rdoc

@@ -0,0 +1,7 @@
+= Relief
+
+An XML to Hash Ruby parser DSL.
+
+== Copyright
+
+Copyright (c) 2009 Tyler Hunt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "relief"
+    gem.summary = %Q{An XML to Hash Ruby parser DSL.}
+    gem.email = "tyler@tylerhunt.com"
+    gem.homepage = "http://github.com/tylerhunt/relief"
+    gem.authors = ["Tyler Hunt"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "relief #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1

data/lib/relief/element.rb

@@ -0,0 +1,61 @@
+module Relief
+  class Element
+    attr_reader :name, :options, :children
+
+    def initialize(name, options, &block)
+      @name = name
+      @options = options
+      @children = {}
+
+      instance_eval(&block) if block_given?
+    end
+
+    def parse(document)
+      @children.inject({}) do |values, child|
+        name, element = child
+
+        values[name] = begin
+          target = (document / element.xpath)
+
+          parse_node = lambda { |target|
+            element.children.any? ? element.parse(target) : target.to_s
+          }
+
+          if element.options[:collection]
+            target.collect { |child| parse_node.call(child) }
+          else
+            parse_node.call(target)
+          end
+        end
+
+        values
+      end
+    end
+
+    def element(name, options={}, &block)
+      options[:xpath] ||= name if name =~ %r([/.])
+      name = options[:as].to_sym if options.has_key?(:as)
+      @children[name] ||= self.class.new(name, options, &block)
+    end
+
+    def elements(name, options={}, &block)
+      element(name, options.merge(:collection => true), &block)
+    end
+
+    def attribute(name, options={}, &block)
+      element(name, options.merge(:attribute => true), &block)
+    end
+
+    def xpath
+      if options.has_key?(:xpath)
+        options[:xpath]
+      elsif @children.empty?
+        attribute = @options[:attribute]
+        attribute = name if attribute == true
+        !attribute ? "#{name}/text()" : "@#{attribute}"
+      else
+        name.to_s
+      end
+    end
+  end
+end

data/lib/relief/parser.rb

@@ -0,0 +1,20 @@
+gem 'nokogiri', '~> 1.2.3'
+require 'nokogiri'
+
+module Relief
+  class Parser
+    attr_reader :root
+
+    def initialize(name, options={}, &block)
+      @root = Element.new(name, options, &block)
+    end
+
+    def parse(document)
+      unless document.is_a?(Nokogiri::XML::NodeSet)
+        document = Nokogiri::XML(document)
+      end
+
+      @root.parse(document)
+    end
+  end
+end

data/lib/relief.rb

@@ -0,0 +1,4 @@
+module Relief
+  autoload :Parser, 'lib/relief/parser'
+  autoload :Element, 'lib/relief/element'
+end

data/spec/parser_spec.rb

@@ -0,0 +1,126 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Relief::Parser do
+  it "parses elements" do
+    parser = Relief::Parser.new(:photo) do
+      element :name
+      element :url
+    end
+
+    photo = parser.parse(<<-XML)
+      <?xml version="1.0" encoding="UTF-8"?>
+      <photo>
+        <name>Cucumbers</name>
+        <url>/photos/cucumbers.jpg</url>
+      </photo>
+    XML
+
+    photo.should == { :name => 'Cucumbers', :url => '/photos/cucumbers.jpg' }
+  end
+
+  it "parses collections of elements" do
+    parser = Relief::Parser.new(:photos) do
+      elements :photo do
+        element :name
+        element :url
+      end
+    end
+
+    photos = parser.parse(<<-XML)
+      <?xml version="1.0" encoding="UTF-8"?>
+      <photos>
+        <photo>
+          <name>Cucumbers</name>
+          <url>/photos/cucumbers.jpg</url>
+        </photo>
+        <photo>
+          <name>Lemons</name>
+          <url>/photos/lemons.jpg</url>
+        </photo>
+      </photos>
+    XML
+
+    photos.should == {
+      :photo => [
+        { :name => 'Cucumbers', :url => '/photos/cucumbers.jpg' },
+        { :name => 'Lemons', :url => '/photos/lemons.jpg' }
+      ]
+    }
+  end
+
+  it "parses attributes" do
+    parser = Relief::Parser.new(:photos) do
+      elements :photo do
+        attribute :name
+        attribute :url
+      end
+    end
+
+    photos = parser.parse(<<-XML)
+      <?xml version="1.0" encoding="UTF-8"?>
+      <photos>
+        <photo name="Cucumbers" url="/photos/cucumbers.jpg" />
+        <photo name="Lemons" url="/photos/lemons.jpg" />
+      </photos>
+    XML
+
+    photos.should == {
+      :photo => [
+        { :name => 'Cucumbers', :url => '/photos/cucumbers.jpg' },
+        { :name => 'Lemons', :url => '/photos/lemons.jpg' }
+      ]
+    }
+  end
+
+  it "parses elements by XPath" do
+    parser = Relief::Parser.new(:photos) do
+      elements '//photo', :as => :photo do
+        element 'name/text()', :as => :name
+        element 'url/text()', :as => :url
+      end
+    end
+
+    photos = parser.parse(<<-XML)
+      <?xml version="1.0" encoding="UTF-8"?>
+      <photos>
+        <photo>
+          <name>Cucumbers</name>
+          <url>/photos/cucumbers.jpg</url>
+        </photo>
+        <photo>
+          <name>Lemons</name>
+          <url>/photos/lemons.jpg</url>
+        </photo>
+      </photos>
+    XML
+
+    photos.should == {
+      :photo => [
+        { :name => 'Cucumbers', :url => '/photos/cucumbers.jpg' },
+        { :name => 'Lemons', :url => '/photos/lemons.jpg' }
+      ]
+    }
+  end
+
+  it "parses elements by nested XPath" do
+    parser = Relief::Parser.new(:photos) do
+      elements '//name/text()', :as => :name
+    end
+
+    photos = parser.parse(<<-XML)
+      <?xml version="1.0" encoding="UTF-8"?>
+      <photos>
+        <photo>
+          <name>Cucumbers</name>
+          <url>/photos/cucumbers.jpg</url>
+        </photo>
+        <photo>
+          <name>Lemons</name>
+          <url>/photos/lemons.jpg</url>
+        </photo>
+      </photos>
+    XML
+
+    photos.should == { :name => ['Cucumbers', 'Lemons'] }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+
+gem 'rspec', '~> 1.2.4'
+require 'spec'
+
+require 'relief'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: tylerhunt-relief
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tyler Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tyler@tylerhunt.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/relief.rb
+- lib/relief/element.rb
+- lib/relief/parser.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tylerhunt/relief
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An XML to Hash Ruby parser DSL.
+test_files: 
+- spec/parser_spec.rb
+- spec/spec_helper.rb