pouch 0.2.0 → 0.3.0

data/lib/pouch/elements.rb

@@ -3,11 +3,14 @@ module Pouch
 
     def element tag, name, identifier, *args, &block
       define_method name do
+        timer { browser.element(tag, identifier).visible? }
         return browser.element tag, identifier unless block_given?
         block.call browser.send(:element, tag, identifier), *args
       end
-    end
 
+      define_waiting_methods tag, name, identifier, *args, &block
+    end
+                     
     def button name, identifier, *args, &block
       element :button, name, identifier, args, &block
     end
@@ -115,5 +118,49 @@ module Pouch
       element :ul, name, identifier, args, &block
     end
 
+    private
+
+    def define_waiting_methods tag, name, identifier, *args, &block
+      define_method "when_#{name}_not_visible" do
+        result = negative_timer { !browser.element(tag, identifier).visible? }
+        unless result
+          raise VisibilityError, "#{name} element is still visible"
+        end
+        self
+      end
+      
+      define_method "when_#{name}_present" do
+        timer { browser.element(tag, identifier).present? }
+        html_element = browser.element tag, identifier
+        return located_element unless block_given?
+        block.call located_element, *args
+      end
+
+      define_method "when_#{name}_not_present" do
+        result = negative_timer { !browser.element(tag, identifier).present? }
+        unless result
+          raise PresenceError, "#{name} element is still present"
+        end
+        self
+      end
+    end
+
+    def timer &block
+      timed_out = Time.now + timeout
+      until Time.now > timed_out
+        result = yield block rescue false
+        break if result
+      end
+    end
+
+    def negative_timer &block
+      timed_out = Time.now + timeout
+      until Time.now > timed_out
+        result = yield_block
+        return result if result
+      end
+      false
+    end
+
   end
 end

data/lib/pouch/version.rb

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

data/lib/pouch.rb

@@ -4,7 +4,10 @@ require "pouch/elements"
 module Pouch
   include Elements
 
-  class ContextualReplacementError < StandardError; end
+  class ContextArgumentError < StandardError; end
+  class ReplacementError < StandardError; end
+  class VisibilityError < StandardError; end
+  class PresenceError < StandardError; end
   
   def self.included base
     base.extend self
@@ -18,7 +21,11 @@ module Pouch
     
     @browser = browser
     @context = standardize opts[:context] if opts[:context]
+    @timeout = opts[:timeout] || 10
+
+    set_timer if self.respond_to? :set_timer
     visit if self.respond_to?(:visit) && start
+    
     contextualize_methods
   end
 
@@ -30,6 +37,10 @@ module Pouch
     @context
   end
 
+  def timeout
+    @timeout
+  end
+  
   def page_url= str
     define_method :visit do
       self.browser.goto str
@@ -53,7 +64,7 @@ module Pouch
   def get_match context
     methods.select{ |mthd| mthd.to_s.start_with? "#{context}_" }.each_with_object([]) do |mthd, array|
       unless respond_to? mthd.to_s.gsub("#{context}_", "")
-        raise ContextualReplacementError, "#{self.class} defined no standard method for replacement '#{mthd}'"
+        raise ReplacementError, "#{self.class} defined no standard method for replacement '#{mthd}'"
       end
       array << mthd
     end
@@ -69,7 +80,7 @@ module Pouch
     if [Array, String, Symbol].include? context.class
       [context].flatten.map(&:to_s)
     else
-      raise "Cannot define Pouch context as #{context.class}"
+      raise ContextArgumentError, "cannot define Pouch context with #{context.class}"
     end
   end
   

data/spec/elements_spec.rb

@@ -12,53 +12,93 @@ describe Pouch::Elements do
     element(:a, :what_replacement, id: 'no-match')
   end
 
-  let(:browser){ double 'webdriver' }
-  let(:element){ double 'html_link' }
+  let(:browser){ double 'webdriver', :element => element }
+  let(:element){ double 'html_link', :visible? => true }
   let(:page){ Page.new browser }
   let(:diff){ Page.new browser, context: 'different' }
   let(:what){ Page.new browser, context: 'what' }
 
   describe "#element" do
     it "returns the link element by default" do
-      expect(browser).to receive(:element).with(:a, id:'generic').and_return(element)
       expect(page.generic).to eq element
     end
 
-    it "returns an element that can be clicked" do
-      expect(browser).to receive(:element).with(:a, id:'generic').and_return(element)
-      expect(element).to receive(:click)
-      page.generic.click
-    end
-
     it "returns the result of the definition block" do
-      expect(browser).to receive(:element).with(:a, id:'blocked').and_return(element)
       expect(element).to receive(:href).and_return("www.test.com")
       expect(page.blocked).to eq "www.test.com"
     end
 
+    it "calls #timer to wait for visible element" do
+      expect(page).to receive(:timer)
+      page.generic
+    end
+
+    it "generates #when_generic_not_visible" do
+      expect(page).to respond_to :when_generic_not_visible
+    end
+
+    it "generates #when_generic_present method" do
+      expect(page).to respond_to :when_generic_present
+    end
+
+    it "generates #when_generic_not_present method" do
+      expect(page).to respond_to :when_generic_not_present
+    end
+
     context "with context" do
       it "uses the replacement method" do
-        expect(browser).to receive(:element).with(:a, id:'generic-diff').and_return(element)
+        expect(browser).to receive(:element).twice.with(:a, id:'generic-diff')
         expect(diff.generic).to eq element
       end
 
       it "uses the replacement method with definition block" do
-        expect(browser).to receive(:element).with(:a, id:'blocked-diff').and_return(element)
         expect(element).to receive(:href).and_return("www.diff.com")
         expect(diff.blocked).to eq "www.diff.com"
       end
 
       it "uses the standard method when context matches no replacement" do
-        expect(browser).to receive(:element).with(:a, id:'generic').and_return(element)
+        expect(browser).to receive(:element).twice.with(:a, id:'generic')
         expect(Page.new(browser, context: 'test').generic).to eq element
       end
 
       it "throws an error with replacement but no standard method" do
-        expect{ what.replacement }.to raise_error Pouch::ContextualReplacementError, /Page defined no standard method for replacement/
+        expect{ what.replacement }.to raise_error Pouch::ReplacementError, /Page defined no standard method for replacement/
       end
     end
   end
 
+  describe "#when_element_not_visible" do
+    Page.send(:link, :invisible, id:'hidden')
+
+    let(:page){ Page.new 'webdriver' }
+    
+    it "returns the page object instance if valid" do
+      expect(page).to receive(:negative_timer).and_return(true)
+      expect(page.when_invisible_not_visible).to eq page
+    end
+
+    it "raises an VisibilityError if invalid" do
+      expect(page).to receive(:negative_timer).and_return(false)
+      expect{ page.when_invisible_not_visible }.to raise_error Pouch::VisibilityError, /invisible element/
+    end
+  end
+
+  describe "#when_element_not_present" do
+    Page.send(:link, :gone, id:'not-here')
+
+    let(:page){ Page.new 'webdriver' }
+
+    it "returns the page object instance if valid" do
+      expect(page).to receive(:negative_timer).and_return(true)
+      expect(page.when_gone_not_present).to eq page
+    end
+
+    it "raises a PresenceError if invalid" do
+      expect(page).to receive(:negative_timer).and_return(false)
+      expect{ page.when_gone_not_present }.to raise_error Pouch::PresenceError, /gone element/
+    end
+  end
+
   describe "#button" do
     it "calls :element with :button tag" do
       expect(page).to receive(:element).with(:button, :button_name, {id: 'id'}, [])
@@ -67,7 +107,7 @@ describe Pouch::Elements do
   end
 
   describe "#checkbox" do
-    it "calls :element with :checkbox tag" do
+    it "calls :element with :input tag" do
       expect(page).to receive(:element).with(:input, :checkbox_name, {id: 'id', type: 'checkbox'}, [])
       page.send(:checkbox, :checkbox_name, id: 'id')
     end
@@ -81,7 +121,7 @@ describe Pouch::Elements do
   end
 
   describe "#file_field" do
-    it "calls :element with :file_field tag" do
+    it "calls :element with :input tag" do
       expect(page).to receive(:element).with(:input, :ff_name, {id: 'id', type: 'file'}, [])
       page.send(:file_field, :ff_name, id: 'id')
     end
@@ -172,7 +212,7 @@ describe Pouch::Elements do
   end
 
   describe "#radio_button" do
-    it "calls :element with :radio tag" do
+    it "calls :element with :input tag" do
       expect(page).to receive(:element).with(:input, :radio_name, {id: 'id', type: 'radio'}, [])
       page.send(:radio_button, :radio_name, id: 'id')
     end
@@ -221,7 +261,7 @@ describe Pouch::Elements do
   end
 
   describe "#text_area" do
-    it "calls :element with :input tag" do
+    it "calls :element with :textarea tag" do
       expect(page).to receive(:element).with(:textarea, :text_area_name, {id: 'id'}, [])
       page.send(:text_area, :text_area_name, id: 'id')
     end

data/spec/pouch_spec.rb

@@ -18,6 +18,18 @@ describe Pouch do
       obj = Page2.new 'webdriver'
       expect(obj.instance_variable_get :@browser).to eq 'webdriver'
     end
+
+    it "creates @timeout variable" do
+      obj = Page2.new 'webdriver'
+      expect(obj.instance_variable_get :@timeout).to eq 10
+    end
+
+    context "with :timeout option" do
+      it "creates @timeout variable" do
+        obj = Page2.new 'webdriver', timeout: 5
+        expect(obj.instance_variable_get :@timeout).to eq 5
+      end
+    end
         
     context "when instance does not respond to #visit" do
       it "doesn't navigate to page_url if start=true" do
@@ -86,11 +98,11 @@ describe Pouch do
       end
 
       it "raises StandardError with Hash argument" do
-        expect{ obj.call({}) }.to raise_error(StandardError, /Hash/)
+        expect{ obj.call({}) }.to raise_error(Pouch::ContextArgumentError, /Hash/)
       end
 
       it "raises StandardError if one argument is a Number" do
-        expect{ obj.call(['one', 2]) }.to raise_error(StandardError, /Fixnum/)
+        expect{ obj.call(['one', 2]) }.to raise_error(Pouch::ContextArgumentError, /Fixnum/)
       end
     end
   end
@@ -108,5 +120,21 @@ describe Pouch do
       expect(obj.context).to eq ['one', 'two', 'three']
     end
   end
+
+  describe "#timeout" do
+    context "without setting a custom timeout interval" do
+      it "returns the page object default timeout" do
+        obj = Page.new 'webdriver'
+        expect(obj.timeout).to eq 10
+      end
+    end
+
+    context "after passing :timeout option to #initialize" do
+      it "returns the custom timeout" do
+        obj = Page.new 'webdriver', timeout: 5
+        expect(obj.timeout).to eq 5
+      end
+    end
+  end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pouch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver