webdriver_utils 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 381c15c8d99140ca2165e6ad96bc1aaac869d7d9
-  data.tar.gz: ba596b1a4188d4dc9cf8bfab1d27c004d6a2a002
+  metadata.gz: 72a8bce6e0af6fdcd715074d606523077408e6be
+  data.tar.gz: c836cc054701dee05717a29dd3a0d93f41216ef8
 SHA512:
-  metadata.gz: 72da354ff6fc94ba224d63a45ffbd5765180963ab5b141f2763b2b9c6a4860b3132ee8e160636748cc418c407fabd3164e985484f06873c2f7eaa7887d6389ee
-  data.tar.gz: 1288327033651a809d838003485ba2f74ae66a0cbb0a9b2167cabd0fa359e5a8fb975125364977acf4502d63a2389ee5dcbb655c5b406cfd0a5ca0629fba99ae
+  metadata.gz: b42927a3975d2e72bb4d4b265a15b70228736d3491cbacc2a4e4647bf4ae81b9a9bd69fb65dc09acdf767ff5d4d697512f6359891638f0b75a98f39db260cd84
+  data.tar.gz: 5568553d8b64f6cd2b95d9abcdc4910617cf15db456fdd362b7e9952d8a52eb979fca393130fe30c037e0c563dd28a8dbbd67c014047137e3d6b1c35f199312f

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec thor spec
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'thor' # enables: bundle exec thor spec

data/lib/webdriver_utils/version.rb

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

data/lib/webdriver_utils/wait.rb

@@ -1,111 +1,108 @@
-# https://github.com/SeleniumHQ/selenium/blob/b12ff650686cd88a0709f6181a015dad1062591e/rb/lib/selenium/webdriver/common/wait.rb
-#
-# Licensed to the Software Freedom Conservancy (SFC) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The SFC licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License.  You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied.  See the License for the
-# specific language governing permissions and limitations
-# under the License.
-
+# wait code from my appium ruby gem:
+# https://github.com/appium/ruby_lib/blob/252e83806318df7df28e9060d3f8e1e56dc732ba/lib/appium_lib/common/wait.rb
 module WebDriverUtils
-  class Wait
-
-    DEFAULT_TIMEOUT  = 5
-    DEFAULT_INTERVAL = 0.2
-
-    #
-    # Create a new Wait instance
-    #
-    # @param [Hash] opts Options for this instance
-    # @option opts [Numeric] :timeout (5) Seconds to wait before timing out.
-    # @option opts [Numeric] :interval (0.2) Seconds to sleep between polls.
-    # @option opts [String] :message Exception mesage if timed out.
-    # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Error::NoSuchElementError)
-    #
-
-    def initialize(opts = {})
-      # Validate all options to prevent typos such as 'ignored'
-      # instead of 'ignore'
-
-      # code from my appium gem
-      # https://github.com/appium/ruby_lib/blob/252e83806318df7df28e9060d3f8e1e56dc732ba/lib/appium_lib/common/wait.rb#L10
-      valid_keys   = [:timeout, :interval, :message, :ignore]
+  class << self
+    # http://mudge.name/2011/01/26/passing-blocks-in-ruby-without-block.html
+    # Note that the Ruby timeout module is avoided. timeout has problems.
+    # https://coderwall.com/p/1novga
+
+    # 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]
       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?
 
-      @timeout  = opts.fetch(:timeout, DEFAULT_TIMEOUT)
-      @interval = opts.fetch(:interval, DEFAULT_INTERVAL)
-      @message  = opts[:message]
-      @ignored  = Array(opts[:ignore] || ::Selenium::WebDriver::Error::NoSuchElementError)
-    end
-
-    #
-    # Wait until the given block returns a true value.
-    #
-    # @raise [Error::TimeOutError]
-    # @return [Object] the result of the block
-    #
+      timeout        = opts.fetch(:timeout, 30)
+      interval       = opts.fetch(:interval, 0.2)
+      message        = opts[:message]
+      ignored        = Array(opts[:ignore] || ::Exception)
+      return_if_true = opts[:return_if_true]
 
-    def until(&blk)
-      end_time   = Time.now + @timeout
+      start_time = Time.now
+      end_time   = start_time + timeout
       last_error = nil
 
       until Time.now > end_time
         begin
-          result = yield
-          return result if result
-        rescue *@ignored => last_error
+          if return_if_true
+            result = block.call
+            return result if result
+          else
+            return block.call
+          end
+        rescue ::Errno::ECONNREFUSED => e
+          raise e
+        rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
           # swallowed
         end
 
-        sleep @interval
+        sleep interval
       end
 
-
-      if @message
-        msg = @message.dup
+      if message
+        msg = message.dup
       else
-        msg = "timed out after #{@timeout} seconds"
+        elapsed_time = (Time.now - start_time).round
+        msg = "timed out after #{elapsed_time} seconds (timeout: #{timeout})"
       end
 
       msg << " (#{last_error.message})" if last_error
 
-      raise ::Selenium::WebDriver::Error::TimeOutError, msg
+      fail Selenium::WebDriver::Error::TimeOutError, msg
     end
 
-  end # class Wait
+    # process opts before calling _generic_wait
+    def _process_wait_opts(opts)
+      opts = { timeout: opts } if opts.is_a?(Numeric)
+      fail 'opts must be a hash' unless opts.is_a? Hash
+      opts
+    end
+  end # class << self
 end # module WebDriverUtils
 
+# Check every interval seconds to see if block.call returns a truthy value.
+# Note this isn't a strict boolean true, any truthy value is accepted.
+# false and nil are considered failures.
+# Give up after timeout seconds.
 #
-# Define generic top level wait method
+# Wait code from the selenium Ruby gem
+# https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
 #
-# Wait until the block returns a truthy value.
-#
-# See wait class above for docs
+# If only a number is provided then it's treated as the timeout value.
 #
+# @param [Hash] opts Options
+# @option opts [Numeric] :timeout (30) Seconds to wait before timing out.
+# @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
+# @option opts [String] :message Exception message if timed out.
+# @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
+def wait_true(opts = {}, &block)
+  opts = WebDriverUtils._process_wait_opts(opts).merge(return_if_true: true)
+  WebDriverUtils._generic_wait opts, &block
+end
 
-def wait opts={}, &block
-  timeout        = opts.fetch(:timeout, 30)
-  interval       = opts.fetch(:interval, 0.2)
-  message        = opts[:message]
-  ignored        = Array(opts[:ignore])
-  default_ignore = [Exception, RSpec::Expectations::ExpectationNotMetError]
-  ignored        = default_ignore if ignored.empty?
+# Check every interval seconds to see if block.call doesn't raise an exception.
+# Give up after timeout seconds.
+#
+# Wait code from the selenium Ruby gem
+# https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
+#
+# If only a number is provided then it's treated as the timeout value.
+#
+# @param [Hash] opts Options
+# @option opts [Numeric] :timeout (30) Seconds to wait before timing out.
+# @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
+# @option opts [String] :message Exception message if timed out.
+# @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
+def wait(opts = {}, &block)
+  opts = WebDriverUtils._process_wait_opts(opts).merge(return_if_true: false)
+  WebDriverUtils._generic_wait opts, &block
+end
 
-  WebDriverUtils::Wait.new(timeout:  timeout,
-                           interval: interval,
-                           message:  message,
-                           ignore:   ignored).until &block
+# Return block.call and ignore any exceptions.
+def ignore(&block)
+  block.call
+rescue Exception # rubocop:disable Lint/HandleExceptions, Lint/RescueException
 end

data/lib/webdriver_utils.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'selenium-webdriver'
 
 require_relative 'webdriver_utils/page'
 require_relative 'webdriver_utils/sauce'

data/readme.md

@@ -1,4 +1,4 @@
-# webdriver_utils [![Gem Version](https://badge.fury.io/rb/webdriver_utils.svg)](https://rubygems.org/gems/webdriver_utils)
+# webdriver_utils [![Gem Version](https://badge.fury.io/rb/webdriver_utils.svg)](https://rubygems.org/gems/webdriver_utils) [![Build Status](https://travis-ci.org/bootstraponline/webdriver_utils.svg?branch=master)](https://travis-ci.org/bootstraponline/webdriver_utils)
 
 WebDriver utility methods.
 

data/webdriver_utils.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'selenium-webdriver', '>= 2.45.0'
+
   spec.add_development_dependency 'pry', '~> 0.10.1'
   spec.add_development_dependency 'appium_thor', '~> 0.0.7'
   spec.add_development_dependency 'rspec', '~> 3.2.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: webdriver_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.45.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.45.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - Rakefile