dozuki 0.3.0 → 0.4.0

data/README.markdown

@@ -2,7 +2,7 @@
 
 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?
 

data/features/boolean_accessor.feature

@@ -0,0 +1,43 @@
+Feature: Getting booleans from the document
+  In order to provide simpler way of getting booleans from a node
+  As a traverser
+  I want to access nodes using the boolean method and an xpath
+
+  Background:
+    Given I have parsed the XML:
+      """
+        <root>
+          <name>St. George's Arms</name>
+          <open>1</open>
+          <licensed>
+            0
+          </licensed>
+          <clean>
+            true
+          </clean>
+          <worth_visiting>false</worth_visiting>
+        </root>
+      """
+
+  Scenario: getting the boolean of a 1 single node
+    When I call "boolean('/root/open')" on the document
+    Then the result should be true
+
+  Scenario: getting the boolean of a 0 single node with whitespace
+    When I call "boolean('/root/licensed')" on the document
+    Then the result should be false
+
+  Scenario: getting the boolean of a true single node with whitespace
+    When I call "boolean('/root/clean')" on the document
+    Then the result should be true
+
+  Scenario: getting the boolean of a false single node with whitespace
+    When I call "boolean('/root/worth_visiting')" on the document
+    Then the result should be false
+
+  Scenario: getting a non-existent node
+    When I call "float('//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

@@ -24,6 +24,10 @@ Feature: Iterating through nodes
             <day>2011-05-03</day>
             <day>2013-07-09</day>
           </available>
+          <open>
+            <day>true</day>
+            <day>0</day>
+          </open>
         </root>
       """
 
@@ -51,3 +55,8 @@ Feature: Iterating through nodes
     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
+
+  Scenario: using each to traverse a document and getting the boolean elements
+    When I call "each('/root/open/day').as_boolean" on the document and collect the results
+    Then the results should contain true
+    And the results should contain false

data/features/steps/collection_steps.rb

@@ -13,4 +13,11 @@ 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
+Then /^the results should contain true$/ do
+  @results.should include true
+end
+
+Then /^the results should contain false$/ do
+  @results.should include false
+end
 

data/lib/dozuki/node.rb

@@ -31,10 +31,15 @@ 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 boolean(xpath)
+      Parsers::Boolean.parse(get_first_node(xpath))
+    end
+
     def get(xpath)
       node = Node.new(get_first_node(xpath))
       yield node if block_given?

data/lib/dozuki/node_collection.rb

@@ -11,18 +11,28 @@ module Dozuki
     end
 
     def as_string(&blk)
-      collection.each{|item| blk.call(Parsers::String.parse(item))}
+      each_as(Parsers::String, &blk)
     end
 
     def as_int(&blk)
-      collection.each{|item| blk.call(Parsers::Integer.parse(item))}
+      each_as(Parsers::Integer, &blk)
     end
 
     def as_float(&blk)
-      collection.each{|item| blk.call(Parsers::Float.parse(item))}
+      each_as(Parsers::Float, &blk)
     end
+
     def as_date(&blk)
-      collection.each{|item| blk.call(Parsers::Date.parse(item))}
+      each_as(Parsers::Date, &blk)
+    end
+
+    def as_boolean(&blk)
+      each_as(Parsers::Boolean, &blk)
     end
+
+    private
+      def each_as(parser, &blk)
+        collection.each{|item| blk.call(parser.parse(item))}
+      end
   end
 end

data/lib/dozuki/parsers.rb

@@ -35,5 +35,13 @@ module Dozuki
         end
       end
     end
+    module Boolean
+      def self.parse(node)
+        true_values.include? String.parse(node)
+      end
+      def self.true_values
+        ['1', 'true']
+      end
+    end
   end
 end

data/lib/dozuki/version.rb

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

data/spec/dozuki/node_collection_spec.rb

@@ -85,7 +85,7 @@ module Dozuki
         @block_called_with.should == a_float
       end
     end
-    
+
     describe "as_date" do
 
       let(:a_date){Date.civil(2012, 2,5)}
@@ -105,6 +105,25 @@ module Dozuki
         @block_called_with.should == a_date
       end
     end
+    describe "as_boolean" do
+
+      let(:a_boolean){true}
+
+      before(:each) do
+        Dozuki::Parsers::Boolean.stub(:parse).and_return(a_boolean)
+      end
+
+      subject{node_collection.as_boolean{|arg| @block_called_with = arg}}
+
+      it "should parse the node to a boolean"  do
+        Dozuki::Parsers::Boolean.should_receive(:parse).with(collection_item).and_return(a_boolean)
+        subject
+      end
+      it "should call the block with the boolean" do
+        subject
+        @block_called_with.should == a_boolean
+      end
+    end
 
   end
 end

data/spec/dozuki/node_spec.rb

@@ -226,6 +226,41 @@ module Dozuki
       end
     end
 
+    describe "boolean" do
+      let(:nokogiri_node)   { mock("nokogiri_node") }
+      let(:xpath)           { "/some/xpath" }
+      let(:node)            { Node.new(nokogiri_node) }
+      let(:boolean_node)    { mock "some node" }
+      let(:parsed)   { mock "parsed result" }
+
+      before(:each) do
+        nokogiri_node.stub(:xpath).and_return([boolean_node])
+        Dozuki::Parsers::Boolean.stub(:parse).and_return(parsed)
+      end
+
+      subject{ node.boolean(xpath) }
+
+      it "should get the collection from the nokogiri node" do
+        nokogiri_node.should_receive(:xpath).with(xpath).and_return([boolean_node])
+        subject
+      end
+      it "should parse the node to a date" do
+        Dozuki::Parsers::Boolean.should_receive(:parse).with(boolean_node).and_return(parsed)
+        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

@@ -101,5 +101,38 @@ module Dozuki
         end
       end
     end
+
+    describe Boolean do
+      let(:node) {mock :node, :text => string}
+      subject{ Boolean.parse(node)}
+      context "where string is 0" do
+        let(:string){"0"}
+        it{should be_false}
+        context "and there is whitespace" do
+          let(:string){"\n0"}
+          it{should be_false}
+        end
+      end
+      context "where string is 1" do
+        let(:string){"1"}
+        it{should be_true}
+        context "and there is whitespace" do
+          let(:string){"\n1"}
+          it{should be_true}
+        end
+      end
+      context "where string is true" do
+        let(:string){ "true" }
+        it {should be_true}
+        context "and there is whitespace" do
+          let(:string){"\ntrue"}
+          it{should be_true}
+        end
+      end
+      context "where string is false" do
+        let(:string){ "false"}
+        it{ should be_false }
+      end
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: dozuki
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - James Almond
@@ -10,11 +10,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-09 00:00:00 +01:00
+date: 2011-05-10 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: 
@@ -22,10 +23,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: 
@@ -33,10 +34,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: 
@@ -44,10 +45,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: autotest
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -55,10 +56,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rake
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -66,7 +67,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id005
 description: A simple way of extracting various elements from an Nokogiri document using XPaths
 email: 
@@ -87,6 +87,7 @@ files:
 - README.markdown
 - Rakefile
 - dozuki.gemspec
+- features/boolean_accessor.feature
 - features/date_accessor.feature
 - features/each_accessor.feature
 - features/exists_accessor.feature
@@ -128,18 +129,12 @@ 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: []
 
@@ -150,6 +145,7 @@ specification_version: 3
 summary: A syntactic sugar wrapper for Nokogiri
 test_files: 
 - .autotest
+- features/boolean_accessor.feature
 - features/date_accessor.feature
 - features/each_accessor.feature
 - features/exists_accessor.feature