dozuki 0.2.0 → 0.3.0

data/.gitignore

@@ -1,4 +1,5 @@
 pkg/*
 *.gem
 .bundle
-.rvmrc
+.rvmrc
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+script: "rake"
+rvm:
+  - 1.8.7
+  - 1.9.2

data/README.markdown

@@ -2,13 +2,13 @@
 
 A Nokogiri wrapper that simplifies commonly occurring tasks.
 
-[![Build Status](http://travis-ci.org/JamesAlmond/dozuki.png)](http://travis-ci.org/JamesAlmond/dozuki)
+[![Build Status](http://travis-ci.org/jamesalmond/dozuki.png)](http://travis-ci.org/JamesAlmond/dozuki)
 
 ## What does it do?
 
 Dozuki removes the repetitive tasks from parsing XML documents with XPaths such as:
 
-* extracting ints, floats, strings etc.
+* extracting ints, floats, strings, dates etc.
 * accessing single nodes
 * checking whether an element exists
 * iterating through nodes
@@ -52,17 +52,18 @@ The get methods takes an xpath and returns the first node that matches the xpath
 
 If the node can't be found then an exception is raised.
 
-### Extracting a single node of a certain type
+### Extracting and parsing the value of a single node
 
 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')
+    doc.date('/my/xpath') # format yyyy-mm-dd
 
 These functions are to replace calls using plain Nokogiri such as:
 
-  doc.xpath('/my/xpath').first.to_i
+    doc.xpath('/my/xpath').first.to_i
 
 ### Checking whether an element exists
 
@@ -84,14 +85,18 @@ There are also simple ways to extract formatted text of a series of nodes with a
       # string with surrounding whitespace stripped
     end
 
-    doc.each('/my/xpath').as_int do |node|
+    doc.each('/my/xpath').as_int do |int|
       # int
     end
 
-    doc.each('/my/xpath').as_float do |node|
+    doc.each('/my/xpath').as_float do |float|
       # float
     end
 
+    doc.each('/my/xpath').as_date do |date|
+      # date
+    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.

data/dozuki.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("rspec")
   s.add_development_dependency("cucumber")
-  s.add_development_dependency("ruby-debug19")
   s.add_development_dependency("autotest")
   s.add_development_dependency("rake")
 

data/features/date_accessor.feature

@@ -0,0 +1,36 @@
+Feature: Getting dates from the document
+  In order to provide simpler way of getting dates from a node
+  As a traverser
+  I want to access nodes using the date method and an xpath
+
+  Background:
+    Given I have parsed the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <previous_event>2011-12-02</previous_event>
+          <next_event>
+            2013-01-12
+          </next_event>
+        </root>
+      """
+
+  Scenario: getting the date of a single node
+    When I call "date('/root/previous_event')" on the document
+    Then the result should be 02/12/2011
+
+  Scenario: getting the  of a single node with whitespace
+    When I call "date('/root/next_event')" on the document
+    Then the result should be 12/01/2013
+
+  Scenario: getting the int of a node that doesn't contain a date
+    When I call "date('/root/name')" on the document
+    Then it should raise an "InvalidFormat" error
+    And the error should have the value "St. George's Arms"
+    And the error should have the format "date"
+
+  Scenario: getting the date of a non-existent node
+    When I call "date('//something/missing')" on the document
+    Then it should raise a "NotFound" error
+    And the error should have the xpath "//something/missing"
+    And the error should have a stored node

data/features/each_accessor.feature

@@ -20,6 +20,10 @@ Feature: Iterating through nodes
             <price>53.50</price>
             <price>799.78</price>
           </prices>
+          <available>
+            <day>2011-05-03</day>
+            <day>2013-07-09</day>
+          </available>
         </root>
       """
 
@@ -42,3 +46,8 @@ Feature: Iterating through nodes
     When I call "each('/root/prices/price').as_float" on the document and collect the results
     Then the results should contain 53.50
     And the results should contain 799.78
+
+  Scenario: using each to traverse a document and getting the date elements
+    When I call "each('/root/available/day').as_date" on the document and collect the results
+    Then the results should contain 03/05/2011
+    And the results should contain 09/07/2013

data/features/steps/collection_steps.rb

@@ -9,3 +9,8 @@ end
 Then /^the results should contain (\d+\.\d+)$/ do |float|
   @results.should include(float.to_f)
 end
+
+Then /^the results should contain (\d+)\/(\d+)\/(\d+)$/ do |day, month, year|
+  @results.should include(Date.civil(year.to_i, month.to_i, day.to_i))
+end
+

data/features/steps/format_steps.rb

@@ -17,3 +17,8 @@ end
 Then /^the result should be false$/ do
   @result.should == false
 end
+
+Then /^the result should be (\d+)\/(\d+)\/(\d+)$/ do |day, month, year|
+  @result.should == Date.civil(year.to_i, month.to_i, day.to_i)
+end
+

data/lib/dozuki/node.rb

@@ -31,6 +31,9 @@ module Dozuki
     def float(xpath)
       Parsers::Float.parse(get_first_node(xpath))
     end
+    def date(xpath)
+      Parsers::Date.parse(get_first_node(xpath))
+    end
 
     def get(xpath)
       node = Node.new(get_first_node(xpath))

data/lib/dozuki/node_collection.rb

@@ -21,5 +21,8 @@ module Dozuki
     def as_float(&blk)
       collection.each{|item| blk.call(Parsers::Float.parse(item))}
     end
+    def as_date(&blk)
+      collection.each{|item| blk.call(Parsers::Date.parse(item))}
+    end
   end
 end

data/lib/dozuki/parsers.rb

@@ -25,5 +25,15 @@ module Dozuki
         end
       end
     end
+    module Date
+      def self.parse(node)
+        string = String.parse(node)
+        begin
+          ::Date.parse(string)
+        rescue ArgumentError
+          raise InvalidFormat.new(:node => node, :value => string, :format => "date")
+        end
+      end
+    end
   end
 end

data/lib/dozuki/version.rb

@@ -1,3 +1,3 @@
 module Dozuki
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/dozuki/node_collection_spec.rb

@@ -2,111 +2,107 @@ require 'spec_helper'
 module Dozuki
   describe NodeCollection do
 
+    let(:collection_item){mock "collection item"}
+    let(:collection){ [collection_item] }
+    let(:node_collection){NodeCollection.new(collection)}
+
+
     describe "as_node" do
-      let(:collection){mock "some_nodes"}
-      let(:blk){Proc.new{}}
-      let(:node_collection){NodeCollection.new(collection)}
-      let(:collection_item){mock "collection item"}
-      let(:new_node){mock "new node"}
+      let(:a_dozuki_node){mock "a dozuki node"}
+
       before(:each) do
-        collection.stub(:each).and_yield(collection_item)
-        Node.stub(:new).and_return(new_node)
+        Node.stub(:new).and_return(a_dozuki_node)
       end
 
-      subject{node_collection.as_node(&blk)}
+      subject{ node_collection.as_node{|arg| @block_called_with = arg} }
 
-      it "should iterate through the collection" do
-        collection.should_receive(:each)
-        subject
-      end
       it "should create a new Node with the yielded collection item"  do
-        Node.should_receive(:new).with(collection_item)
+        Node.should_receive(:new).with(collection_item).and_return(a_dozuki_node)
         subject
       end
-      it "should call the bloc with the node" do
-        blk.should_receive(:call).with(new_node)
+      it "should call the block with the wrapped dozuki node" do
         subject
+        @block_called_with.should == a_dozuki_node
       end
     end
 
     describe "as_string" do
-      let(:collection){mock "some_nodes"}
-      let(:blk){Proc.new{}}
-      let(:node_collection){NodeCollection.new(collection)}
-      let(:collection_item){mock "collection item"}
-      let(:string){"string"}
+
+      let(:a_string){"string"}
+
       before(:each) do
-        collection.stub(:each).and_yield(collection_item)
-        Dozuki::Parsers::String.stub(:parse).and_return(string)
+        Dozuki::Parsers::String.stub(:parse).and_return(a_string)
       end
 
-      subject{node_collection.as_string(&blk)}
+      subject{ node_collection.as_string{|arg| @block_called_with = arg} }
 
-      it "should iterate through the collection" do
-        collection.should_receive(:each)
+      it "should parse the node to a string"  do
+        Dozuki::Parsers::String.should_receive(:parse).with(collection_item).and_return(a_string)
         subject
       end
-      it "should create a new Node with the yielded collection item"  do
-        Dozuki::Parsers::String.should_receive(:parse).with(collection_item)
-        subject
-      end
-      it "should call the bloc with the node" do
-        blk.should_receive(:call).with("string")
+      it "should call the block with the string" do
         subject
+        @block_called_with.should == a_string
       end
     end
 
     describe "as_int" do
-      let(:collection){mock "some_nodes"}
-      let(:blk){Proc.new{}}
-      let(:node_collection){NodeCollection.new(collection)}
-      let(:collection_item){mock "collection item"}
-      let(:int){39}
+
+      let(:an_int){39}
+
       before(:each) do
-        collection.stub(:each).and_yield(collection_item)
-        Dozuki::Parsers::Integer.stub(:parse).and_return(int)
+        Dozuki::Parsers::Integer.stub(:parse).and_return(an_int)
       end
 
-      subject{node_collection.as_int(&blk)}
+      subject{ node_collection.as_int{|arg| @block_called_with = arg} }
 
-      it "should iterate through the collection" do
-        collection.should_receive(:each)
+      it "should parse the node to an integer"  do
+        Dozuki::Parsers::Integer.should_receive(:parse).with(collection_item).and_return(an_int)
         subject
       end
-      it "should create a new Node with the yielded collection item"  do
-        Dozuki::Parsers::Integer.should_receive(:parse).with(collection_item)
-        subject
-      end
-      it "should call the bloc with the node" do
-        blk.should_receive(:call).with(int)
+      it "should call the block with the integer" do
         subject
+        @block_called_with.should == an_int
       end
     end
 
     describe "as_float" do
-      let(:collection){mock "some_nodes"}
-      let(:blk){Proc.new{}}
-      let(:node_collection){NodeCollection.new(collection)}
-      let(:collection_item){mock "collection item"}
-      let(:float){39.50}
+
+      let(:a_float){39.50}
+
       before(:each) do
-        collection.stub(:each).and_yield(collection_item)
-        Dozuki::Parsers::Float.stub(:parse).and_return(float)
+        Dozuki::Parsers::Float.stub(:parse).and_return(a_float)
       end
 
-      subject{node_collection.as_float(&blk)}
+      subject{node_collection.as_float{|arg| @block_called_with = arg}}
 
-      it "should iterate through the collection" do
-        collection.should_receive(:each)
+      it "should parse the node to a float"  do
+        Dozuki::Parsers::Float.should_receive(:parse).with(collection_item).and_return(a_float)
         subject
       end
-      it "should create a new Node with the yielded collection item"  do
-        Dozuki::Parsers::Float.should_receive(:parse).with(collection_item)
+      it "should call the block with the float" do
+        subject
+        @block_called_with.should == a_float
+      end
+    end
+    
+    describe "as_date" do
+
+      let(:a_date){Date.civil(2012, 2,5)}
+
+      before(:each) do
+        Dozuki::Parsers::Date.stub(:parse).and_return(a_date)
+      end
+
+      subject{node_collection.as_date{|arg| @block_called_with = arg}}
+
+      it "should parse the node to a date"  do
+        Dozuki::Parsers::Date.should_receive(:parse).with(collection_item).and_return(a_date)
         subject
       end
-      it "should call the bloc with the node" do
-        blk.should_receive(:call).with(float)
+      it "should call the block with the date" do
         subject
+        @block_called_with.should == a_date
       end
     end
 

data/spec/dozuki/node_spec.rb

@@ -191,6 +191,41 @@ module Dozuki
       end
     end
 
+    describe "date" do
+      let(:nokogiri_node)   { mock("nokogiri_node") }
+      let(:xpath)           { "/some/xpath" }
+      let(:node)            { Node.new(nokogiri_node) }
+      let(:date_node)       { mock "some node" }
+      let(:parsed)   { mock "parsed result" }
+
+      before(:each) do
+        nokogiri_node.stub(:xpath).and_return([date_node])
+        Dozuki::Parsers::Date.stub(:parse).and_return(parsed)
+      end
+
+      subject{ node.date(xpath) }
+
+      it "should get the collection from the nokogiri node" do
+        nokogiri_node.should_receive(:xpath).with(xpath)
+        subject
+      end
+      it "should parse the node to a date" do
+        Dozuki::Parsers::Date.should_receive(:parse).with(date_node)
+        subject
+      end
+      it "should return the parsed result" do
+        subject.should == parsed
+      end
+      context "where the xpath returns no node" do
+        before(:each) do
+          nokogiri_node.should_receive(:xpath).and_return([])
+        end
+        it "should raise a NotFound error" do
+          expect{subject}.to raise_error(Dozuki::NotFound)
+        end
+      end
+    end
+
     describe "get" do
       let(:nokogiri_node)   { mock("nokogiri_node") }
       let(:xpath)           { "/some/xpath" }

data/spec/dozuki/parsers_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Dozuki
   module Parsers
-    
+
     describe String do
       describe ".parse" do
         let(:string){"something"}
@@ -80,7 +80,26 @@ module Dozuki
           end
         end
       end
+    end
+
+    describe Date do
+      describe ".parse" do
+        let(:string){"2011-01-03"}
+        let(:node) { mock :node , :text => string }
+
+        subject { Date.parse(node) }
 
+        it{ should == ::Date.civil(2011, 1, 3)}
+
+        context "where the string has whitespace" do
+          let(:string){"\n\n2011-04-01"}
+          it{ should == ::Date.civil(2011, 4, 1)}
+        end
+        context "where the string is not a valid date" do
+          let(:string){ "dhjklfsjkfjkds" }
+          specify { expect{ subject}.to raise_error(InvalidFormat)}
+        end
+      end
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: dozuki
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - James Almond
@@ -10,12 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-21 00:00:00 +01:00
+date: 2011-05-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -23,10 +22,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -34,10 +33,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,10 +44,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug19
-  prerelease: false
+  name: autotest
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -56,10 +55,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: autotest
-  prerelease: false
+  name: rake
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -67,18 +66,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 description: A simple way of extracting various elements from an Nokogiri document using XPaths
 email: 
 - james@jamesalmond.com
@@ -92,12 +81,13 @@ files:
 - .autotest
 - .gitignore
 - .rspec
+- .travis.yml
 - CI
 - Gemfile
-- Gemfile.lock
 - README.markdown
 - Rakefile
 - dozuki.gemspec
+- features/date_accessor.feature
 - features/each_accessor.feature
 - features/exists_accessor.feature
 - features/float_accessor.feature
@@ -138,12 +128,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -990796854414031921
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -990796854414031921
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
@@ -154,6 +150,7 @@ specification_version: 3
 summary: A syntactic sugar wrapper for Nokogiri
 test_files: 
 - .autotest
+- features/date_accessor.feature
 - features/each_accessor.feature
 - features/exists_accessor.feature
 - features/float_accessor.feature

data/Gemfile.lock

@@ -1,59 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dozuki (0.1.0)
-      nokogiri
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    ZenTest (4.5.0)
-    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.2)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (>= 2.3.5)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.5)
-    diff-lcs (1.1.2)
-    gherkin (2.3.6)
-      json (>= 1.4.6)
-    json (1.5.1)
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
-    nokogiri (1.4.4)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    ruby-debug-base19 (0.11.25)
-      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.5)
-      archive-tar-minitar (>= 0.5.2)
-    term-ansicolor (1.0.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autotest
-  cucumber
-  dozuki!
-  rake
-  rspec
-  ruby-debug19