webdriver_utils 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72a8bce6e0af6fdcd715074d606523077408e6be
-  data.tar.gz: c836cc054701dee05717a29dd3a0d93f41216ef8
+  metadata.gz: b543262ea87886ef0de254e527866bc26096e6a8
+  data.tar.gz: 7ab995596496a179980dee6fca730a48f63d5e95
 SHA512:
-  metadata.gz: b42927a3975d2e72bb4d4b265a15b70228736d3491cbacc2a4e4647bf4ae81b9a9bd69fb65dc09acdf767ff5d4d697512f6359891638f0b75a98f39db260cd84
-  data.tar.gz: 5568553d8b64f6cd2b95d9abcdc4910617cf15db456fdd362b7e9952d8a52eb979fca393130fe30c037e0c563dd28a8dbbd67c014047137e3d6b1c35f199312f
+  metadata.gz: a14a74004015a133b2b3e5d878bdd99e792c300f3a61fb4c9b1cdc54f5a4cf1d7f369b24b0a2580fd72d8fc6cb0fe8857e155145b48f25c6ee4e7f6a401bc7bf
+  data.tar.gz: e96bb755e81eb1a1acede0a444c339a451fa8cc4c188ee38588af517c937629ce19a6fc639dfd1ff9fe5a77daf2f6e29c63b6f924c5146d256a25bb6de9f94a2

data/lib/webdriver_utils/version.rb

@@ -1,4 +1,4 @@
 module WebDriverUtils
-  VERSION = '0.0.3' unless defined? ::WebDriverUtils::VERSION
-  DATE    = '2015-05-12' unless defined? ::WebDriverUtils::DATE
+  VERSION = '0.0.4' unless defined? ::WebDriverUtils::VERSION
+  DATE    = '2015-05-23' unless defined? ::WebDriverUtils::DATE
 end

data/lib/webdriver_utils/wait.rb

@@ -6,26 +6,38 @@ module WebDriverUtils
     # Note that the Ruby timeout module is avoided. timeout has problems.
     # https://coderwall.com/p/1novga
 
+    # bubble - if set, the last exception will be raised if it exists
     # Wait code from the selenium Ruby gem
     # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
     def _generic_wait(opts = {}, &block)
-      valid_keys   = [:timeout, :interval, :message, :ignore, :return_if_true]
+      valid_keys   = [:timeout, :interval, :message, :ignore, :return_if_true, :bubble]
       invalid_keys = []
       opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
       # [:one, :two] => :one, :two
       fail "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
 
+      # ensure negative timeout and interval are set to zero.
       timeout        = opts.fetch(:timeout, 30)
+      timeout        = timeout < 0 ? 0 : timeout
       interval       = opts.fetch(:interval, 0.2)
+      interval       = interval < 0 ? 0 : interval
       message        = opts[:message]
       ignored        = Array(opts[:ignore] || ::Exception)
       return_if_true = opts[:return_if_true]
+      bubble         = !!opts.fetch(:bubble, false)
 
       start_time = Time.now
       end_time   = start_time + timeout
       last_error = nil
 
-      until Time.now > end_time
+      # design note,  ::TypeError, ::NameError, ::NoMethodError are not
+      # rescued then raised like ECONNREFUSED because they can legitimately
+      # occur inside a block and self correct depending on the method return
+      # value. This is unlike ECONNREFUSED which will always fail.
+
+      # use do..while format to ensure the block always executes at least once
+      # even if timeout is zero.
+      begin
         begin
           if return_if_true
             result = block.call
@@ -40,18 +52,23 @@ module WebDriverUtils
         end
 
         sleep interval
-      end
+      end until Time.now > end_time
+
+      elapsed_time    = (Time.now - start_time).round
+      default_message = "timed out after #{elapsed_time} seconds (timeout: #{timeout})"
 
       if message
-        msg = message.dup
+        msg = "#{message.dup} [#{default_message}]"
       else
-        elapsed_time = (Time.now - start_time).round
-        msg = "timed out after #{elapsed_time} seconds (timeout: #{timeout})"
+        msg = default_message
       end
 
       msg << " (#{last_error.message})" if last_error
 
-      fail Selenium::WebDriver::Error::TimeOutError, msg
+      fail_error = last_error if bubble
+      fail_error ||= Selenium::WebDriver::Error::TimeOutError
+
+      fail fail_error, msg
     end
 
     # process opts before calling _generic_wait

data/readme.md

@@ -4,6 +4,12 @@ WebDriver utility methods.
 
 - `require 'webdriver_utils'`
 
+#### example
+
+[Example tests that use webdriver_utils](https://github.com/bootstraponline/sauce_connect_ruby). This repo is part of a larger [angular_automation](https://github.com/bootstraponline/angular_automation) effort although it can be used standalone.
+
+#### methods
+
 method | description
    --- | ---
 **sauce_user**                         | returns ENV['SAUCE_USERNAME']

data/release_notes.md

@@ -0,0 +1,26 @@
+#### v0.0.4 2015-05-23
+
+- [9c8cc07](https://github.com/bootstraponline/webdriver_utils/commit/9c8cc07043fdd5de3b1e8159cee36987c6d88787) Release 0.0.4
+- [02b7f46](https://github.com/bootstraponline/webdriver_utils/commit/02b7f465a7736f3eb1c9e6df4dd96f4dfaff4358) Test wait edge cases
+- [4994bf5](https://github.com/bootstraponline/webdriver_utils/commit/4994bf57b483b79b58da7a368a6ed8fa3728de67) Ensure block executes at least once
+- [fec9983](https://github.com/bootstraponline/webdriver_utils/commit/fec99832b43c59c23ef1c7795267a0fa85f7d4f5) Restore old rescue behavior
+- [5ec2baf](https://github.com/bootstraponline/webdriver_utils/commit/5ec2baf01bffc54a9b626afbd25667acc691c7b6) Test wait bubble
+- [7c60a42](https://github.com/bootstraponline/webdriver_utils/commit/7c60a428dffc9587b2b956c97186a5e5e01846d9) Update wait error and add bubble option
+- [02aa9a3](https://github.com/bootstraponline/webdriver_utils/commit/02aa9a38d7a087866427f08903e8667e2f233668) Link example
+
+
+#### v0.0.3 2015-05-12
+
+- [00d66ad](https://github.com/bootstraponline/webdriver_utils/commit/00d66adafe1b979ab1228b73bb6887cea71ceaf4) Add Travis badge
+- [5eb6ac0](https://github.com/bootstraponline/webdriver_utils/commit/5eb6ac036c7494dc4132917ba8d17777cce9e3e8) Fix bundle exec thor spec
+- [88f7a2f](https://github.com/bootstraponline/webdriver_utils/commit/88f7a2fda6b099374e51f2a02c86433b08914ae0) Bump version to 0.0.3
+- [d4acd77](https://github.com/bootstraponline/webdriver_utils/commit/d4acd77567ec2e92ee2cff013e928a67a9da9d59) Create .travis.yml
+- [ca7eaa7](https://github.com/bootstraponline/webdriver_utils/commit/ca7eaa79c45109e81785f70dad41c7b62eb0f05e) Update timeout error message
+- [a18d651](https://github.com/bootstraponline/webdriver_utils/commit/a18d65144981cd57eb22fceb9602d6e4be438b9e) Port wait from appium_lib gem
+
+
+#### v0.0.2 2015-05-10
+
+- [c6becae](https://github.com/bootstraponline/webdriver_utils/commit/c6becae39ed81a634246e8e6492e7c625cdeb15f) Release 0.0.2
+- [058247a](https://github.com/bootstraponline/webdriver_utils/commit/058247af673e5137f53dfccc9b4c8a1cb1aa21ae) Fix sauce? method
+- [45239de](https://github.com/bootstraponline/webdriver_utils/commit/45239de7f80949265f6d4ba3eb89f4f422384371) Add gem badge

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webdriver_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -114,6 +114,7 @@ files:
 - lib/webdriver_utils/version.rb
 - lib/webdriver_utils/wait.rb
 - readme.md
+- release_notes.md
 - webdriver_utils.gemspec
 homepage: https://github.com/bootstraponline/webdriver_utils
 licenses: