watir-wait_with_refresh 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Justin Ko
+
+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.md

@@ -0,0 +1,51 @@
+Watir::WaitWithRefresh
+==============
+
+Watir::WaitWithRefresh extends Watir to include methods that will refresh the page until or while an element is present or a block is true.
+
+Installation
+-----------
+
+```ruby
+gem install watir-wait_with_refresh
+```
+
+Usage
+-----------
+
+The wait methods can be added after requiring Watir:
+
+```ruby
+require 'watir' #or 'watir-classic' or 'watir-webdriver'
+require 'watir/wait_with_refresh'
+```
+
+Refresh the page until an element is present:
+
+```ruby
+ element.refresh_until_present
+```
+
+Refresh the page while an element is present:
+
+```ruby
+element.refresh_while_present
+```
+
+Do something after refreshing the page makes the element present:
+
+```ruby
+element.when_present_after_refresh.text
+```
+
+Refresh the page until a block evaluates as true:
+
+```ruby
+browser.refresh_until{ browser.div.present? }
+```
+
+Refresh the page while a block evaluates as true:
+
+```ruby
+browser.refresh_while{ browser.div.present? }
+```

data/lib/watir/wait_with_refresh.rb

@@ -0,0 +1,43 @@
+module Watir
+  module WaitWithRefresh
+  
+    #
+    # Due to the difference in implementation between watir-classic
+    # and watir-webdriver, the browser class is different - "Browser"
+    # vs "IE". Monkey patch based on the gem loaded.
+    #
+  
+    def self.load()
+      if Gem.loaded_specs.keys.include?('watir-classic')
+        require_relative 'wait_with_refresh/ie'
+      elsif Gem.loaded_specs.keys.include?('watir-webdriver')
+        require_relative 'wait_with_refresh/browser'
+      else
+        raise LoadError, "Watir must be required before Watir::WaitWithRefresh"        
+      end
+        require_relative 'wait_with_refresh/wait'      
+        require_relative 'wait_with_refresh/element'
+    end
+  end
+end
+
+
+if Gem.loaded_specs.keys.include?('watir')
+  # Watir was loaded. Override Watir.load_driver to include 
+  # WaitWithRefresh based on the watir driver loaded.
+  module Watir
+    class << self
+      def load_driver
+        require "watir-#{driver}"
+        Watir::WaitWithRefresh.load
+      end
+    end # self
+  end # Watir
+
+else
+  # Watir-classic or watir-webdriver was directly loaded.
+  # Therefore, we can already determine the class to monkey patch.
+  Watir::WaitWithRefresh.load
+
+end
+

data/lib/watir/wait_with_refresh/browser.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Watir
+  class Browser
+    
+    def refresh_until(*args, &blk)
+      Watir::WaitWithRefresh.refresh_until(browser, *args, &blk)
+    end
+
+    def refresh_while(*args, &blk)
+      Watir::WaitWithRefresh.refresh_while(browser, *args, &blk)
+    end
+
+  end # Browser
+end # Watir

data/lib/watir/wait_with_refresh/element.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+module Watir
+  class Element
+    
+    #
+    # Refresh the page until the element is present.
+    #
+    # @example
+    #   browser.button(:id => 'foo').refresh_until_present
+    #
+    # @param [Fixnum] timeout seconds to wait before timing out
+    #
+    # @see Watir::WaitWithRefresh
+    # @see Watir::Element#present?
+    #
+
+    def refresh_until_present(timeout = 30)
+      message = "waiting for #{@selector.inspect} to become present"
+      Watir::WaitWithRefresh.refresh_until(browser, timeout, message) { present? }
+    end
+
+    #
+    # Refresh the page while the element is present.
+    #
+    # @example
+    #   browser.button(:id => 'foo').refresh_while_present
+    #
+    # @param [Integer] timeout seconds to wait before timing out
+    #
+    # @see Watir::WaitWithRefresh
+    # @see Watir::Element#present?
+    #
+
+    def refresh_while_present(timeout = 30)
+      message = "waiting for #{@selector.inspect} to disappear"
+      Watir::WaitWithRefresh.refresh_while(browser, timeout, message) { present? }
+    end
+
+    #
+    # Refreshes the page until the element is present.
+    #
+    # @example
+    #   browser.button(:id => 'foo').when_present_after_refresh.click
+    #   browser.div(:id => 'bar').when_present_after_refresh { |div| ... }
+    #   browser.p(:id => 'baz').when_present_after_refresh(60).text
+    #
+    # @param [Fixnum] timeout seconds to wait before timing out
+    #
+    # @see Watir::WaitWithRefresh
+    # @see Watir::Element#present?
+    #
+
+    def when_present_after_refresh(timeout = 30)
+      message = "waiting for #{@selector.inspect} to become present"
+
+      if block_given?
+        Watir::WaitWithRefresh.refresh_until(browser, timeout, message) { present? }
+        yield self
+      else
+        WhenPresentAfterRefreshDecorator.new(self, timeout, message)
+      end
+    end
+
+  end # Element
+  
+  #
+  # Wraps an Element so that any subsequent method calls are
+  # put on hold until the element is present (exists and is visible) on the page.
+  #
+
+  class WhenPresentAfterRefreshDecorator
+    def initialize(element, timeout, message = nil)
+      @element = element
+      @timeout = timeout
+      @message = message
+    end
+
+    def respond_to?(*args)
+      @element.respond_to?(*args)
+    end
+
+    def method_missing(m, *args, &block)
+      unless @element.respond_to?(m)
+        raise NoMethodError, "undefined method `#{m}' for #{@element.inspect}:#{@element.class}"
+      end
+
+      Watir::WaitWithRefresh.refresh_until(@element.browser, @timeout, @message) { @element.present? }
+
+      @element.__send__(m, *args, &block)
+    end
+  end # WhenPresentAfterRefreshDecorator  
+end # Watir

data/lib/watir/wait_with_refresh/ie.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Watir
+  class IE
+    
+    def refresh_until(*args, &blk)
+      Watir::WaitWithRefresh.refresh_until(browser, *args, &blk)
+    end
+
+    def refresh_while(*args, &blk)
+      Watir::WaitWithRefresh.refresh_while(browser, *args, &blk)
+    end
+
+  end # IE
+end # Watir

data/lib/watir/wait_with_refresh/version.rb

@@ -0,0 +1,5 @@
+module Watir
+  module WaitWithRefresh
+    VERSION = "0.0.1"
+  end
+end

data/lib/watir/wait_with_refresh/wait.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+module Watir
+  module WaitWithRefresh
+  
+    class TimeoutError < StandardError ; end
+
+    INTERVAL = 0.1
+
+    class << self
+      
+      #
+      # Refresh the browser until the block evaluates to true or times out.
+      #
+      # @example
+      #   Watir::WaitWithRefresh.refresh_until(browser){ browser.a(:id => "ajaxed").visible? }
+      #
+      # @param [Watir::Browser] browser
+      # @param [Fixnum] timeout How long to wait in seconds
+      # @param [String] message Message to raise if timeout is exceeded
+      # @raise [TimeoutError] if timeout is exceeded
+      #
+
+      def refresh_until(browser, timeout = 30, message = nil, &block)
+        end_time = ::Time.now + timeout
+
+        until ::Time.now > end_time
+          result = yield(self)
+          return result if result
+          sleep INTERVAL
+          browser.refresh
+        end
+
+        raise TimeoutError, message_for(timeout, message)
+      end
+
+      #
+      # Refresh the browser while the block evaluates to true or times out.
+      #
+      # @example
+      #   Watir::WaitWithRefresh.refresh(browser){ browser.a(:id => "ajaxed").visible? }
+      #
+      # @param [Watir::Browser] browser
+      # @param [Fixnum] timeout How long to wait in seconds
+      # @param [String] message Message to raise if timeout is exceeded
+      # @raise [TimeoutError] if timeout is exceeded
+      #
+
+      def refresh_while(browser, timeout = 30, message = nil, &block)
+        end_time = ::Time.now + timeout
+
+        until ::Time.now > end_time
+          return unless yield(self)
+          sleep INTERVAL
+          browser.refresh
+        end
+
+        raise TimeoutError, message_for(timeout, message)
+      end
+
+      def message_for(timeout, message)
+        err = "timed out after #{timeout} seconds"
+        err << ", #{message}" if message
+
+        err
+      end
+
+    end #self
+  end # WaitWithRefresh
+end # Watir

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: watir-wait_with_refresh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Ko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Watir::WaitWithRefresh extends Watir to include methods that will refresh
+  the page until or while an element is present or a block is true. Adds Element#refresh_until_present,
+  Element#refresh_while_present, Element#when_present_after_refresh, Browser#refresh_until
+  and Browser#refresh_while.
+email: jkotests@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/watir/wait_with_refresh/browser.rb
+- lib/watir/wait_with_refresh/element.rb
+- lib/watir/wait_with_refresh/ie.rb
+- lib/watir/wait_with_refresh/version.rb
+- lib/watir/wait_with_refresh/wait.rb
+- lib/watir/wait_with_refresh.rb
+- LICENSE
+- README.md
+homepage: https://github.com/jkotests/watir-wait_with_refresh
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extend Watir to wait with page refreshes.
+test_files: []