dozuki 0.0.1

data/.autotest

@@ -0,0 +1,13 @@
+Autotest.add_hook :initialize do |at|
+  root = File.dirname(__FILE__)
+  at.add_mapping(%r%^lib/(.*)\.rb$%) { |_, m|
+    ["spec/#{m[1]}_spec.rb"]
+  }
+  at.add_mapping(%r%^spec/.*_spec\.rb$%) { |filename|
+    filename
+  }
+  at.add_mapping(%r%^spec/support/.*\.rb$%) { |_|
+    Dir[File.join(root, 'spec/**/*_spec.rb')]
+  }
+  nil
+end

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    dozuki (0.0.1)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    archive-tar-minitar (0.5.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    builder (3.0.0)
+    columnize (0.3.2)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
+    json (1.4.6)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    nokogiri (1.4.4)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  cucumber
+  dozuki!
+  nokogiri
+  rspec
+  ruby-debug19

data/README.rdoc

@@ -0,0 +1,116 @@
+= Dozuki
+
+A Nokogiri wrapper that simplifies commonly occurring tasks.
+
+== What does it do?
+
+Dozuki removes the repetitive tasks from parsing XML documents with XPaths such as:
+
+* extracting ints, floats, strings etc.
+* accessing single nodes
+* checking whether an element exists
+* iterating through nodes
+* iterating nodes and extracting ints, floats and strings etc.
+
+It's mainly sugar for reducing the amount of chaining on calls like:
+
+  doc.xpath('/my/xpath').first.to_i
+
+== How do I use it?
+
+Parsing XML (currently only supports strings):
+
+  doc = Dozuki::XML.parse(xml_string)
+
+This documents supports the Dozuki extensions for:
+
+=== Extracting a single node
+
+The get methods takes an xpath and returns the first node that matches the xpath:
+
+  doc.get('/my/xpath')
+
+If the node can't be found then an exception is raised.
+
+=== Extracting a single node of a certain type
+
+The following methods take the first node that matches the xpath and returns the formatted result:
+
+  doc.string('/my/xpath') # surrounding whitespace stripped
+  doc.float('/my/xpath')
+  doc.int('/my/xpath')
+
+These functions are to replace calls using plain Nokogiri such as:
+
+  doc.xpath('/my/xpath').first.to_i
+
+=== Checking whether an element exists
+
+  doc.exists?('/my/xpath')
+
+=== Iterating through nodes
+
+Dozuki also provides a slightly more succinct way to 'each' an xpath:
+
+  doc.each('/my/xpath') do |node|
+    # do something
+  end
+
+=== Iterating through node text and parsing
+
+There are also simple ways to extract formatted text of a series of nodes with an each
+
+  doc.each('/my/xpath').as_string do |node|
+    # string with surrounding whitespace stripped
+  end
+  
+  doc.each('/my/xpath').as_int do |node|
+    # int
+  end
+  
+  doc.each('/my/xpath').as_float do |node|
+    # float
+  end
+
+== Playing nicely with Nokogiri
+
+Dozuki will proxy any calls not recognised onto the underlying Nokogiri structure, including responds_to?, allowing you to treat it like any other Nokogiri document.
+
+== More documentation
+
+More features are described in the.. {features}[https://github.com/jamesalmond/dozuki/tree/master/features]
+
+== Contributing to Dozuki
+ 
+* Fork the project.
+* Add tests that cover the new feature or bug fix.
+* Make your feature addition or bug fix.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010:
+
+* {James Almond}[http://jamesalmond.com]
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/dozuki.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dozuki/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dozuki"
+  s.version     = Dozuki::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["James Almond"]
+  s.email       = ["james@jamesalmond.com"]
+  s.homepage    = "https://github.com/jamesalmond/dozuki"
+  s.summary     = %q{An XPath syntactic sugar wrapper for Nokogiri}
+  s.description = %q{A simple way of extracting various elements from an XML document using XPaths}
+
+  s.rubyforge_project = "dozuki"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/* .autotest`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("nokogiri")
+  
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("cucumber")
+  s.add_development_dependency("ruby-debug19")
+  s.add_development_dependency("autotest")
+  
+end

data/features/each_accessor.feature

@@ -0,0 +1,72 @@
+Feature: Iterating through nodes
+  In order to provide simpler way of accessing groups of nods
+  As a traverser
+  I want to access nodes using the each method and an xpath
+  
+  Scenario: using each to traverse a document
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>SINGLE</room>
+            <room>Double</room>
+          </rooms>
+        </root>
+      """
+    And I call "each('/root/rooms/room')" on the document and collect the results
+    Then the results should contain a node with the text "SINGLE"
+    And the results should contain a node with the text "Double"
+  
+  Scenario: using each to traverse a document and getting the string elements
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>SINGLE</room>
+            <room>Double</room>
+          </rooms>
+        </root>
+      """
+    And I call "each('/root/rooms/room').as_string" on the document and collect the results
+    Then the results should contain "SINGLE"
+    And the results should contain "Double"
+  
+  Scenario: using each to traverse a document and getting the integer elements
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>5</room>
+            <room>7</room>
+          </rooms>
+        </root>
+      """
+    And I call "each('/root/rooms/room').as_int" on the document and collect the results
+    Then the results should contain 5
+    And the results should contain 5
+  
+  Scenario: using each to traverse a document and getting the float elements
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>53.50</room>
+            <room>799.78</room>
+          </rooms>
+        </root>
+      """
+    And I call "each('/root/rooms/room').as_float" on the document and collect the results
+    Then the results should contain 53.50
+    And the results should contain 799.78

data/features/exists_accessor.feature

@@ -0,0 +1,29 @@
+Feature: Exists accessor
+  In order to easily determine whether a node exists in a document
+  As a traverser
+  I want to check whether a node exists
+  
+  
+  Scenario: the node exists
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+        </root>
+      """
+    And I call "exists?('/root/number_of_beers')" on the document
+    Then the result should be true
+    
+  Scenario: the node doesn't exist
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+        </root>
+      """
+    And I call "exists?('/root/food')" on the document
+    Then the result should be false

data/features/float_accessor.feature

@@ -0,0 +1,44 @@
+Feature: Getting floats from the document
+  In order to provide simpler way of getting floats from a node
+  As a traverser
+  I want to access nodes using the float method and an xpath
+  
+  Scenario: getting the float of a single node
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+        </root>
+      """
+    And I call "float('/root/average_price')" on the document
+    Then the result should be 20.32
+    
+  Scenario: getting the float of a single node with whitespace
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>
+            20.32
+          </average_price>
+          <number_of_beers>2</number_of_beers>
+        </root>
+      """
+    And I call "float('/root/average_price')" on the document
+    Then the result should be 20.32
+    
+  Scenario: getting a non-existent node
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+        </root>
+      """
+    Then calling "float('//something/missing')" on the document should raise a "NotFound" error
+    And the error should have the xpath "//something/missing"
+    And the error should have a stored node
+    

data/features/get_accessor.feature

@@ -0,0 +1,68 @@
+Feature: Getting nodes from the document
+  In order to provide a unified interface to the xml objects
+  As a traverser
+  I want to access nodes using the get method and an xpath
+  
+  Scenario: getting a single node
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>SINGLE</room>
+            <room>Double</room>
+          </rooms>
+        </root>
+      """
+    And I call "get('//rooms')" on the document
+    Then the result should be a "Dozuki::XML::Node"
+    And the result should have 2 elements
+
+  Scenario: getting a single node but accessing it with a block
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>SINGLE</room>
+            <room>Double</room>
+          </rooms>
+        </root>
+      """
+    And I call "get('//rooms')" on the document with a block
+    Then the block parameter should be a "Dozuki::XML::Node"
+    And the parameter should have 2 elements
+    
+  Scenario: getting the first of multiple nodes
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+          <rooms>
+            <room>SINGLE</room>
+            <room>Double</room>
+          </rooms>
+        </root>
+      """
+    And I call "get('//rooms/room')" on the document
+    Then the result should have the text "SINGLE"
+    
+  Scenario: getting a non-existent node
+    When I parse the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <average_price>20.32</average_price>
+          <number_of_beers>2</number_of_beers>
+        </root>
+      """
+    Then calling "get('//something/missing')" on the document should raise a "NotFound" error
+    And the error should have the xpath "//something/missing"
+    And the error should have a stored node
+    And the error should have a stored node