watir 6.0.0.beta5 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 935a787298648718688deca84d844924d69dc5b0
-  data.tar.gz: d6e4f016435c83c21ab6045eac35365c2fb0b370
+  metadata.gz: fc26b04deabc014544f4768c6477d930ae316b9d
+  data.tar.gz: e3e954cff4868448b49735ab2e7e04018a601bc2
 SHA512:
-  metadata.gz: 7e215494da9556e98fe9542a042ff80a64bedbef8071bc920a9653806b629e4876a0708f0b06cb318f69b8cdbc16855dc0704b630df0de83fac3b36225f406a5
-  data.tar.gz: 4b77b7a781336fc2534b5a91051e1b66e590eabdc85162dd8ee6aebf4ba1cecb79d29a766d284d0bc849b42b82e025c51e627b543d59981a0756f5e0c31d8065
+  metadata.gz: 53b68b0ca306783b02910bc0152e8ccbc064262e7b9fe22792ee32b84c436f4232a782c4e5db387ce0b1168ebc0a322b5a5d15434c83b2b43063733784a06836
+  data.tar.gz: e2233b72dd59430fe9a49fcdf210188916719ee818724e65c9c25dc6588e9b47ddf57a97b796e54af68aca92df08203b861af946f2418c6b938395acbb467e5b

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 rvm:
-  - 2.1
-  - 2.2
+  - 2.1.9
+  - 2.2.5
   - 2.3.1
 addons:
   firefox: latest
@@ -24,6 +24,9 @@ before_script:
 script: bundle exec rake $RAKE_TASK
 env:
   - RAKE_TASK=spec:firefox
+  - RAKE_TASK=spec:firefox RELAXED_LOCATE=false
   - RAKE_TASK=spec:chrome
+  - RAKE_TASK=spec:chrome RELAXED_LOCATE=false
   - RAKE_TASK=spec:phantomjs
+  - RAKE_TASK=spec:phantomjs RELAXED_LOCATE=false
   - RAKE_TASK=yard:doctest

data/CHANGES.md

@@ -1,7 +1,16 @@
+### 6.0.0 (2016-11-08)
+
+* Add `#Watir#relaxed_locate` to enable automatic waiting for elements to be ready for a specified action
+* Remove `when_present` method
+* Update `wait_until` and `wait_while` to return `self` to allow chaining
+* Support keywords for wait methods
+* `Element#text_field` no longer locates textareas - use `Element#textarea` instead.
+* Use `Process.clock_gettime` when available for waiting (#486)
+
 ### 6.0.0.beta5 (2016-09-25)
 
 * Elements in collections can now be relocated after going stale
-* Added visible locator to filter out matching elements that are hidden 
+* Added visible locator to filter out matching elements that are hidden
 * Element not found error messages now include selector information from parent elements
 
 ### 6.0.0.beta4 (2016-09-12)

data/Gemfile

@@ -8,5 +8,9 @@ if ENV['LOCAL_WEBIDL']
   gem 'webidl', path: File.expand_path('../webidl')
 end
 
+if ENV['LOCAL_SELENIUM']
+  gem 'selenium-webdriver', path: File.expand_path('../selenium/build/rb')
+end
+
 # Specify your gem's dependencies in watir.gemspec
 gemspec

data/README.md

@@ -1,16 +1,15 @@
-watir
-===============
+# watir
 
 Watir Powered By Selenium!
 
 [![Gem Version](https://badge.fury.io/rb/watir.svg)](http://badge.fury.io/rb/watir)
-[![Build Status](https://travis-ci.org/watir/watir.svg?branch=master)](https://travis-ci.org/watir/watir)
+[![Travis Status](https://travis-ci.org/watir/watir.svg?branch=master)](https://travis-ci.org/watir/watir)
+[![AppVeyor status](https://ci.appveyor.com/api/projects/status/9vbb7pp5p4uyoott/branch/master?svg=true)](https://ci.appveyor.com/project/p0deje/watir)
 [![Code Climate](https://codeclimate.com/github/watir/watir.svg)](https://codeclimate.com/github/watir/watir)
 [![Dependency Status](https://gemnasium.com/watir/watir.svg)](https://gemnasium.com/watir/watir)
 [![Coverage Status](https://coveralls.io/repos/watir/watir/badge.svg?branch=master)](https://coveralls.io/r/watir/watir)
 
-Example
--------
+## Example
 
 ```ruby
 require 'watir'
@@ -25,8 +24,7 @@ puts browser.title
 browser.close
 ```
 
-Description
------------
+## Description
 
 The majority of element methods Watir provides with is autogenerated from specifications.
 This is done by extracting the IDL parts from the spec and processing them with the WebIDL gem (link below).
@@ -35,19 +33,39 @@ Currently supported specifications are:
 * [HTML](https://www.whatwg.org/specs/web-apps/current-work/) (`lib/watir/elements/html_generated.rb`)
 * [SVG](http://www.w3.org/TR/SVG2/single-page.html) (`lib/watir/elements/svg_generated.rb`)
 
-Specs
------
+## Specs
 
-Watir uses [watirspec](http://github.com/watir/watirspec) for testing. After cloning, you should fetch the submodule:
+### WatirSpec
+
+Watir uses WatirSpec for testing - an executable specification of Watir API.
+
+#### Using In Other Gems
+
+When developing Watir extension, you might want to make sure it's fully compatible with
+existing API. To achieve that, you can run WatirSpec against your own extension. Assuming
+your gem depends on Watir, you should do next:
+
+First, add WatirSpec Rake tasks to your gem:
+
+```ruby
+# Rakefile
+require 'watirspec/rake_tasks'
+WatirSpec::RakeTasks.new
+```
+
+Second, initialize WatirSpec for your gem:
 
 ```bash
-git submodule init && git submodule update
+$ bundle exec rake watirspec:init
 ```
 
+After initialized, just follow the instructions to customize Watir implementation in use.
+
+### Watir-specific Specs
+
 Specs specific to Watir are found in `spec/*_spec.rb`, with watirspec in `spec/watirspec/`.
 
-Doctests
---------
+## Doctests
 
 Watir uses [yard-doctest](https://github.com/p0deje/yard-doctest) for testing documentation examples.
 
@@ -55,26 +73,23 @@ Watir uses [yard-doctest](https://github.com/p0deje/yard-doctest) for testing do
 rake yard:doctest
 ```
 
-API docs
---------
+## API Documentation
 
 * http://rdoc.info/gems/watir/ (updated on every release)
 
-See also
---------
+## See Also
 
 * http://watir.github.io
 * http://github.com/jarib/webidl
 * http://github.com/watir/watirspec
 * https://github.com/seleniumhq/selenium
 
-Dependencies
-------------
+## Dependencies
 
 * selenium-webdriver
+* rack (for watirspec)
 
-Note on Patches/Pull Requests
------------------------------
+## Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -84,8 +99,7 @@ Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-Copyright
----------
+## Copyright
 
 Copyright (c) 2009-2015 Jari Bakken
 Copyright (c) 2015-2016 Alex Rodionov, Titus Fortner

data/Rakefile

@@ -5,14 +5,12 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.ruby_opts = "-I lib:spec"
   spec.rspec_opts = %w[--color --require fuubar --format Fuubar]
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
 namespace :spec do
   RSpec::Core::RakeTask.new(:html) do |spec|
-    spec.ruby_opts = "-I lib:spec"
     spec.rspec_opts = "--format html --out #{ENV["SPEC_REPORT"] || "specs.html"}"
     spec.pattern = 'spec/**/*_spec.rb'
   end
@@ -116,8 +114,6 @@ namespace :changes do
   end
 end
 
-load "spec/watirspec/watirspec.rake" if File.exist?("spec/watirspec/watirspec.rake")
-
 task default: [:spec, 'yard:doctest']
 
 namespace :spec do
@@ -131,18 +127,18 @@ namespace :spec do
                   :firefox,
                   :ff_legacy,
                   :phantomjs,
-                  (:safari if Selenium::WebDriver::Platform.os == :macosx),
-                  (:ie if Selenium::WebDriver::Platform.os == :windows),
-                  (:edge if Selenium::WebDriver::Platform.os == :windows)].compact
+                  (:safari if Selenium::WebDriver::Platform.mac?),
+                  (:ie if Selenium::WebDriver::Platform.windows?),
+                  (:edge if Selenium::WebDriver::Platform.windows?)].compact
 
   desc 'Run specs remotely for all browsers'
   task remote_browsers: [:remote_chrome,
                          :remote_firefox,
                          :remote_ff_legacy,
                          :remote_phantomjs,
-                         (:remote_safari if Selenium::WebDriver::Platform.os == :macosx),
-                         (:remote_ie if Selenium::WebDriver::Platform.os == :windows),
-                         (:remote_edge if Selenium::WebDriver::Platform.os == :windows)].compact
+                         (:remote_safari if Selenium::WebDriver::Platform.mac?),
+                         (:remote_ie if Selenium::WebDriver::Platform.windows?),
+                         (:remote_edge if Selenium::WebDriver::Platform.windows?)].compact
 
   %w(firefox ff_legacy chrome safari phantomjs ie edge).each do |browser|
     desc "Run specs in #{browser}"

data/appveyor.yml

@@ -0,0 +1,13 @@
+version: "#{build}"
+build: off
+clone_depth: 100
+install:
+  - set PATH=C:\Ruby23\bin;%PATH%
+  - bundle install
+  - support/appveyor.cmd
+test_script:
+  - bundle exec rake %RAKE_TASK%
+environment:
+  matrix:
+    - RAKE_TASK: spec:chrome
+    - RAKE_TASK: spec:firefox

data/lib/watir.rb

@@ -1,5 +1,6 @@
 require 'selenium-webdriver'
 
+require 'watir/legacy_wait'
 require 'watir/wait'
 require 'watir/exception'
 require 'watir/xpath_support'
@@ -15,8 +16,22 @@ require 'watir/after_hooks'
 
 module Watir
 
+  @relaxed_locate = true
+
   class << self
 
+    attr_writer :relaxed_locate, :always_locate, :default_timeout, :prefer_css, :locator_namespace
+
+    #
+    # Whether or not Watir should wait for an element to be found or present
+    # before taking an action.
+    # Defaults to true.
+    #
+
+    def relaxed_locate?
+      @relaxed_locate
+    end
+
     #
     # Whether or not Watir should re-locate a stale Element on use.
     #
@@ -26,15 +41,11 @@ module Watir
       true
     end
 
-    def always_locate=(_bool)
-      always_locate_message
-    end
-
     def always_locate_message
       warn <<-EOS
 Watir#always_locate is deprecated; elements are always cached and will always
 be re-located if they go stale before use.
-Use Element#stale? or Element#wait_until_stale if needed for flow control.
+Use Element#stale? or Element#wait_until(&:stale?) if needed for flow control.
       EOS
     end
 
@@ -47,10 +58,6 @@ Use Element#stale? or Element#wait_until_stale if needed for flow control.
       false
     end
 
-    def prefer_css=(_bool)
-      prefer_css_message
-    end
-
     def prefer_css_message
       warn <<-EOS
 Watir#prefer_css is deprecated; all elements that can not be passed directly
@@ -59,20 +66,12 @@ require the watir_css gem - https://github.com/watir/watir_css
       EOS
     end
 
-    def default_timeout
-      @default_timeout ||= 30
-    end
-
     #
     # Default wait time for wait methods.
     #
 
-    def default_timeout=(value)
-      @default_timeout = value
-    end
-
-    def locator_namespace
-      @locator_namespace ||= Watir::Locators
+    def default_timeout
+      @default_timeout ||= 30
     end
 
     #
@@ -80,8 +79,8 @@ require the watir_css gem - https://github.com/watir/watir_css
     # Defaults to Watir::Locators.
     #
 
-    def locator_namespace=(mod)
-      @locator_namespace = mod
+    def locator_namespace
+      @locator_namespace ||= Watir::Locators
     end
 
     #

data/lib/watir/alert.rb

@@ -1,7 +1,7 @@
 module Watir
   class Alert
-
     include EventuallyPresent
+    include Waitable
 
     def initialize(browser)
       @browser = browser
@@ -19,7 +19,7 @@ module Watir
     #
 
     def text
-      assert_exists
+      wait_for_exists
       @alert.text
     end
 
@@ -33,7 +33,7 @@ module Watir
     #
 
     def ok
-      assert_exists
+      wait_for_exists
       @alert.accept
       @browser.after_hooks.run
     end
@@ -48,7 +48,7 @@ module Watir
     #
 
     def close
-      assert_exists
+      wait_for_exists
       @alert.dismiss
       @browser.after_hooks.run
     end
@@ -64,7 +64,7 @@ module Watir
     #
 
     def set(value)
-      assert_exists
+      wait_for_exists
       @alert.send_keys(value)
     end
 
@@ -100,5 +100,21 @@ module Watir
       raise Exception::UnknownObjectException, 'unable to locate alert'
     end
 
+    def wait_for_exists
+      return assert_exists unless Watir.relaxed_locate?
+
+      begin
+        wait_until(&:exists?)
+      rescue Wait::TimeoutError
+        unless Watir.default_timeout == 0
+          message = "This code has slept for the duration of the default timeout "
+          message << "waiting for an Alert to exist. If the test is still passing, "
+          message << "consider using Alert#exists? instead of rescuing UnknownObjectException"
+          warn message
+        end
+        raise Exception::UnknownObjectException, 'unable to locate alert'
+      end
+    end
+
   end # Alert
 end # Watir

data/lib/watir/browser.rb

@@ -60,6 +60,7 @@ module Watir
     rescue
       '#<%s:0x%x closed=%s>' % [self.class, hash*2, @closed.to_s]
     end
+    alias selector_string inspect
 
     #
     # Goes to the given URL.
@@ -152,9 +153,9 @@ module Watir
     # Returns browser name.
     #
     # @example
-    #   browser = Watir::Browser.new :phantomjs
+    #   browser = Watir::Browser.new :chrome
     #   browser.name
-    #   #=> :phantomjs
+    #   #=> :chrome
     #
     # @return [Symbol]
     #
@@ -206,12 +207,15 @@ module Watir
     #
     # Waits until readyState of document is complete.
     #
+    # @example
+    #   browser.wait
+    #
     # @param [Fixnum] timeout
     # @raise [Watir::Wait::TimeoutError] if timeout is exceeded
     #
 
     def wait(timeout = 5)
-      wait_until(timeout, "waiting for document.readyState == 'complete'") do
+      wait_until(timeout: timeout, message: "waiting for document.readyState == 'complete'") do
         ready_state == "complete"
       end
     end
@@ -311,6 +315,8 @@ module Watir
         true
       end
     end
+    alias_method :wait_for_exists, :assert_exists
+    alias_method :wait_for_present, :assert_exists
 
     def browser
       self

data/lib/watir/elements/checkbox.rb

@@ -25,7 +25,6 @@ module Watir
     #
 
     def set?
-      assert_exists
       element_call { @element.selected? }
     end