watir 6.17.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c587621e41c1ab878d2e9ff3cfd6c5166c5df9dc66cd02c0719d492aaba48d1e
-  data.tar.gz: 509ba43afa0272d7b154eb5885e403578e2bc3956ab93803123b519093e7b430
+  metadata.gz: e8a3f59dcd9f56e63cf532cc2ba8c9605e8ffad78bd59d3f104e6677c9f5e20c
+  data.tar.gz: 1f1cb55a4270ebdce957f4a8dc33e76403eef391ed59e3179f4f6772595d3f59
 SHA512:
-  metadata.gz: 5215ff9fc1cfce6fa050532583167e6ed16be6f74b0d305b8d186b83361162c711ae9b63689a00882bf60d559783508ea2369ed9e8d5e25b504688eb2914db01
-  data.tar.gz: 1b0ba276ea5c83f217151c125b0f645aab7011d86d9049ea7850ea83af4fbeeb9bdfa14ca60d7205c55bee3c0d6f817143bd9f979c7dc5adc368af446367ab8a
+  metadata.gz: 488c6b2f0a93a20390350da8b95025f9e33d2be9bb7bd84b130808906bca067860b3db6908c59961ef3914ccbb682d2d15d2418656749f8916a1416fa8c6cbb5
+  data.tar.gz: 64bc4a7b36c294a75ceb86c3fea21809dbefc158cbca08ba72dc6bf7b3b64d76f04b5c02130a8cce15e78d5156659cb317ee397e27d93d06e537e804695e425b

data/.github/actions/enable-safari/action.yml

@@ -0,0 +1,11 @@
+name: 'Enable Safari Driver'
+description: 'Set safaridriver to run in automation mode'
+runs:
+  using: composite
+  steps:
+    - run: |
+        defaults write com.apple.Safari IncludeDevelopMenu YES
+        defaults write com.apple.Safari AllowRemoteAutomation 1
+        sudo safaridriver --enable
+        safaridriver -p 0 &
+      shell: bash

data/.github/actions/install-chrome/action.yml

@@ -0,0 +1,12 @@
+name: 'Install Chrome'
+description: 'Install Chrome Stable'
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+        echo "deb http://dl.google.com/linux/chrome/deb/ stable main" | sudo tee -a /etc/apt/sources.list.d/google-chrome.list
+        sudo apt-get update -qqy
+        sudo apt-get -qqy install google-chrome-stable
+        sudo rm /etc/apt/sources.list.d/google-chrome.list
+      shell: bash

data/.github/actions/setup-linux/action.yml

@@ -0,0 +1,8 @@
+name: 'Setup Linux'
+description: 'Run Linux in Virtual Desktop'
+runs:
+  using: "composite"
+  steps:
+    - shell: bash
+      run: |
+        Xvfb :99 &

data/.github/workflows/chrome.yml

@@ -0,0 +1,34 @@
+name: Chrome Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  local-tests:
+    name: Local Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        ruby: [ 2.6, 3.0 ]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/setup-linux
+        if:  matrix.os == 'ubuntu-latest'
+      - uses: ./.github/actions/install-chrome
+        if:  matrix.os == 'ubuntu-latest'
+      - run: |
+          echo "COVERAGE=true" >> $GITHUB_ENV
+        if: |
+          matrix.os == 'ubuntu-latest' ||
+          matrix.os == 'macos-latest'
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: |
+          bundle exec rake spec:chrome
+        env:
+          DISPLAY: :99

data/.github/workflows/edge.yml

@@ -0,0 +1,28 @@
+name: Edge Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  local-tests:
+    name: Local Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest]
+        ruby: [ 2.6, 3.0 ]
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          echo "COVERAGE=true" >> $GITHUB_ENV
+        if: matrix.os == 'macos-latest'
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: |
+          bundle exec rake spec:edge
+        env:
+          DISPLAY: :99

data/.github/workflows/firefox.yml

@@ -0,0 +1,35 @@
+name: Firefox Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  local-tests:
+    name: Local Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        ruby: [ 2.6, 3.0 ]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/setup-linux
+        if:  matrix.os == 'ubuntu-latest'
+      - uses: browser-actions/setup-firefox@latest
+        with:
+          firefox-version: '93.0'
+      - run: |
+          echo "COVERAGE=true" >> $GITHUB_ENV
+        if: |
+          matrix.os == 'ubuntu-latest' ||
+          matrix.os == 'macos-latest'
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: |
+          bundle exec rake spec:firefox
+        env:
+          DISPLAY: :99

data/.github/workflows/ie.yml

@@ -0,0 +1,24 @@
+name: IE Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  local-tests:
+    name: Local Tests
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.6, 3.0 ]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: |
+          bundle exec rake spec:ie
+        env:
+          DISPLAY: :99

data/.github/workflows/safari.yml

@@ -0,0 +1,27 @@
+name: Safari Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  local-tests:
+    name: Local Tests
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.6, 3.0 ]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/enable-safari
+      - run: |
+          echo "COVERAGE=true" >> $GITHUB_ENV
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: |
+          bundle exec rake spec:safari
+        env:
+          DISPLAY: :99

data/.github/workflows/unit.yml

@@ -0,0 +1,52 @@
+name: Unit Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  documentation-test:
+    name: Yard Doctest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: bundle install
+      - uses: ./.github/actions/install-chrome
+      - uses: ./.github/actions/setup-linux
+      - run: |
+          bundle exec rake yard:doctest
+
+
+  unit-test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.6', '2.7', '3.0']
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - uses: ./.github/actions/install-chrome
+      - uses: ./.github/actions/setup-linux
+      - run: |
+          bundle exec rake spec:unit
+        env:
+          DISPLAY: :99
+
+  linter-test:
+    name: Rubocop Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: bundle install
+      - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.5.8
+  TargetRubyVersion: 2.6.8
   NewCops: enable
   Exclude:
     - 'lib/watir/elements/html_elements.rb'
@@ -19,17 +19,12 @@ Lint/UnifiedInteger:
 
 # Default: 17
 Metrics/AbcSize:
-  Max: 20
+  Max: 22
   Exclude:
-    - 'lib/watir/capabilities.rb'
     - 'lib/watir/locators/element/selector_builder.rb'
-    - 'lib/watir/locators/element/selector_builder/regexp_disassembler.rb'
-    - 'lib/watir/locators/element/selector_builder/xpath.rb'
-    - 'lib/watir/locators/element/locator.rb'
+    - 'lib/watir/locators/element/selector_builder/*.rb'
     - 'lib/watir/generator/base/generator.rb'
-    - 'lib/watir/generator/base/visitor.rb'
     - 'spec/locator_spec_helper.rb'
-    - 'spec/watirspec_helper.rb'
 
 Metrics/BlockLength:
   Exclude:

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-08-27 01:55:04 UTC using RuboCop version 0.89.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 116
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 11
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  Exclude:
+    - 'lib/watir/browser.rb'
+    - 'lib/watir/window.rb'
+
+# Offense count: 229
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Remove for Watir 7
+Naming/FileName:
+  Exclude:
+    - 'lib/watir-webdriver.rb'
+
+# Fix in Watir 7
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/watir/wait.rb'

data/CHANGES.md

@@ -1,3 +1,94 @@
+### 7.1.0 (2021-11-15)
+
+* Add automatic scroll to `Element#click` with method parameters to ensure element is in viewport
+* Provide `:scroll_to` parameter for element methods implemented with `Actions` class (thanks osadasami #948, #949)
+* Allow `:scroll_to` parameter to accept `nil` argument to avoid automatic scrolling
+* Implement `Element#in_viewport?`
+* Fix but where `Scroll#to` for `Browser` with `:center` argument did not scroll to center of page
+* Change `Element#obscured?` to only scroll when element out of viewport and then scroll to bottom instead of top
+
+### 7.0.0 (2021-10-18)
+
+* Requires Selenium 4.0.0+
+* Requires Ruby 2.6+
+* Implement `Window#minimize`
+* Implement `Window#full_screen`
+
+### 7.0.0.beta5 (2021-08-02)
+
+* Add support for passing in Proxy and proxy Hash to Capabilities (#933)
+* Trigger change event when setting values on date and date-time fields (#938)
+* Allow user to obtain Capabilities instance from Browser instance
+
+### 7.0.0.beta4 (2021-05-29)
+
+* Fix Bug in using negative class names within a collection (#934)
+
+### 7.0.0.beta3 (2021-05-05)
+
+* Fix Bug preventing proper use of vendor extension capabilities
+* Changed how timeouts are supported in Watir Capabilities (#932)
+* Changed the default Alert Behavior not to automatically get dismissed when an exception happens (#931)
+
+### 7.0.0.beta2 (2021-03-28)
+
+* Replace Watir Logger implementation with Selenium Logger subclass
+* Change Watir Guards to use Selenium's new Guards. Tests run as pending when guarded.
+* Implement `#set` as standard interface for each Input Element (#405)
+* Implement `Element#set` to take correct `#set` behavior based on evaluated element (#664)
+* Optimize Performance for Select Lists (#846)
+* Allow user to set values on Select List exclusively by `:label`, `:text`, or `:value` (#846)
+* Allow user to check if option selected in Select List by `:label`, `:text`, or `:value` (#929)
+* Implement `Window#restore!` to return to original Window and close all others (#923)
+* Minor performance improvement for iterating over windows (#923)
+* Implement `Browser#closed?`; same as `Browser#exists?` without the Windows checks (#923)
+* Update methods that use Selenium's Actions class to scroll element into view before acting (#847)
+* Fix bug for `:text` locator with `Regexp` value based on whitespace (#924)
+* Remove executing after hooks when changing frames (#888)
+
+### 7.0.0.beta1 (2021-03-18)
+
+* Requires Selenium 4
+* Supports Ruby 3
+* Add support for Microsoft Edge Chromium
+* Remove support for all deprecated functionality
+
+### 6.19.1 (2021-03-17)
+
+* Fix bug preventing using Selenium 4
+* Fix bug preventing non-xml characters in attributes (#787)
+
+### 6.19.0 (2021-03-12)
+
+* Create custom Watir HTTP Client
+* Require minimum of Selenium 3.142.7
+* Add support for starting browser with :http_client and :service hashes
+* Allow inferring desired browser from Capabilities or Options if browser not specified
+* Deprecate WindowCollection#to_a method
+* Deprecate starting browser with both Capabilities and Options
+* Deprecate starting browser with both URL and Service
+* Deprecate using :desired_capabilities
+* Deprecate starting browser service keywords in top level Hash
+* Deprecate using :remote to start a browser; browser name must be specified
+* Deprecate sending unknown keywords into the top level
+* Fix bug preventing Safari Options from being recognized
+* Fix bug preventing options provided without :remote keyword from being properly recognized (#812, #870)
+* Fix bug preventing :headless from being recognized when :options specified (#692)
+
+### 6.18.0 (2021-02-26)
+
+* Implement `WindowCollection` to manage multiple `Window` objects
+* Add support for locating `Window` by `:element`
+* Deprecate locating `Window` by `:index`
+* Deprecate `Select#select_all` in favor of `#select` and an `Array`
+* Implement `Browser#switch_window` (#849)
+* Add support for `Numeric` attribute values to `Waitable`
+* Allow users to specify Selenium 4 in their projects
+* Update stale element handling behavior to match webdriver spec (#905 #909)
+* Implement `Waitable` for `ElementCollection` (#853 #857)
+* Improve performance for nested elements (#843)
+* Less strict version check for `regexp_parser` gem (thanks Pavel Lobashov)
+
 ### 6.17.0 (2020-08-27)
 * Require Ruby > 2.5
 * Implement Logger#selenium= to set selenium level from Watir

data/LICENSE

@@ -1,8 +1,8 @@
 (the MIT License)
 
 Copyright (c) 2009-2015 Jari Bakken
-Copyright (c) 2015-2018 Alex Rodionov, Titus Fortner
-Copyright (c) 2018 Justin Ko
+Copyright (c) 2015-2021 Alex Rodionov, Titus Fortner
+Copyright (c) 2018-2021 Justin Ko
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,10 +3,9 @@
 Watir Powered By Selenium!
 
 [![Gem Version](https://badge.fury.io/rb/watir.svg)](http://badge.fury.io/rb/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)
+[![All Tests](https://github.com/watir/watir/actions/workflows/tests.yml/badge.svg)](https://github.com/watir/watir/actions/workflows/tests.yml)
 [![Code Climate](https://codeclimate.com/github/watir/watir.svg)](https://codeclimate.com/github/watir/watir)
-[![Coverage Status](https://coveralls.io/repos/github/watir/watir/badge.svg?branch=master)](https://coveralls.io/github/watir/watir?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/watir/watir/badge.svg?branch=main)](https://coveralls.io/github/watir/watir?branch=main)
 
 ## Using Watir
 
@@ -69,11 +68,11 @@ $ bundle exec rake svg:update
 
 ## Specs
 
-#### Travis CI
+#### Github Actions
 
-Watir specs are run on [Travis CI](https://travis-ci.org/watir/watir).
+Watir specs are run with [Github Actions](https://github.com/watir/watir/workflows).
 
-Watir code is tested with 2.3, 2.4 and 2.5 versions in multiple browsers and with multiple configurations.
+Watir code is tested on Linux with latest versions of supported browsers and all active Ruby versions.
 
 #### Doctests
 
@@ -95,7 +94,7 @@ to ensure all paths in their code have tests associated with them.
 
 Watir is using [Rubocop](https://github.com/rubocop-hq/rubocop) to ensure a consistent style across the
 code base. It is run with our minimum supported Ruby version (2.3) 
-We have some [established exceptions](https://github.com/watir/watir/blob/master/.rubocop.yml) 
+We have some [established exceptions](https://github.com/watir/watir/blob/main/.rubocop.yml) 
 that might need to be tweaked for new code submissions. This can be addressed in the PR as necessary.
 
 #### Statistics
@@ -107,7 +106,4 @@ on wire calls.
 
 ## Copyright
 
-Copyright (c) 2009-2015 Jari Bakken
-Copyright (c) 2015-2018 Alex Rodionov, Titus Fortner
-Copyright (c) 2018 Justin Ko
 See LICENSE for details

data/Rakefile

@@ -5,7 +5,7 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = %w[--color --require fuubar --format Fuubar]
+  spec.rspec_opts = %w[--color --format doc]
   spec.pattern = 'spec/**/*_spec.rb'
   spec.exclude_pattern = 'spec/unit/**/*_spec.rb'
 end
@@ -25,7 +25,7 @@ end
 
 {
   html: 'https://www.w3.org/TR/html52/single-page.html',
-  svg: 'http://www.w3.org/TR/SVG2/single-page.html'
+  svg: 'https://www.w3.org/TR/2018/CR-SVG2-20180807/single-page.html'
 }.each do |type, spec_uri|
   namespace type do
     spec_path = "support/#{type}.html"

data/lib/watir/adjacent.rb

@@ -117,7 +117,7 @@ module Watir
         el = Watir.element_class_for(opt[:tag_name] || '').new(self, opt)
         el.is_a?(Input) ? el.to_subtype : el
       elsif opt[:tag_name]
-        Object.const_get("#{Watir.element_class_for(opt[:tag_name])}Collection").new(self, opt)
+        Watir.const_get("#{Watir.element_class_for(opt[:tag_name])}Collection").new(self, opt)
       else
         HTMLElementCollection.new(self, opt)
       end

data/lib/watir/alert.rb

@@ -1,6 +1,5 @@
 module Watir
   class Alert
-    include EventuallyPresent
     include Waitable
     include Exception
 
@@ -84,6 +83,7 @@ module Watir
       false
     end
     alias present? exists?
+    alias exist? exists?
 
     #
     # @api private
@@ -103,13 +103,9 @@ module Watir
     end
 
     def wait_for_exists
-      return assert_exists unless Watir.relaxed_locate?
-
-      begin
-        wait_until(message: 'waiting for alert', &:exists?)
-      rescue Wait::TimeoutError
-        raise UnknownObjectException, 'unable to locate alert'
-      end
+      wait_until(message: 'waiting for alert', &:exists?)
+    rescue Wait::TimeoutError
+      raise UnknownObjectException, 'unable to locate alert'
     end
   end # Alert
 end # Watir

data/lib/watir/attribute_helper.rb

@@ -29,7 +29,7 @@ module Watir
 
     def attribute_list
       @attribute_list ||= (typed_attributes.values.flatten +
-                           ancestors[1..-1].map { |e|
+                           ancestors[1..].map { |e|
                              e.attribute_list if e.respond_to?(:attribute_list)
                            }.compact.flatten
                           ).uniq
@@ -46,6 +46,8 @@ module Watir
     #  @return [$1] value of $3 property
     #
     def attribute(type, method, attr)
+      return if method_defined?(method)
+
       typed_attributes[type] << [method, attr]
       define_attribute(type, method, attr)
     end

data/lib/watir/browser.rb

@@ -12,7 +12,7 @@ module Watir
     include Scrolling
 
     attr_writer :default_context, :original_window, :locator_namespace, :timer
-    attr_reader :driver, :after_hooks
+    attr_reader :driver, :after_hooks, :capabilities
     alias wd driver # ensures duck typing with Watir::Element
 
     class << self
@@ -42,8 +42,8 @@ module Watir
     def initialize(browser = :chrome, *args)
       case browser
       when ::Symbol, String
-        selenium_args = Capabilities.new(browser, *args).to_args
-        @driver = Selenium::WebDriver.for(*selenium_args)
+        @capabilities = Capabilities.new(browser, *args)
+        @driver = Selenium::WebDriver.for(*@capabilities.to_args)
       when Selenium::WebDriver::Driver
         @driver = browser
       else
@@ -55,16 +55,21 @@ module Watir
       @default_context = true
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # TODO: w3c default behavior does not like checking if alert exists
     def inspect
       if alert.exists?
         format('#<%s:0x%x alert=true>', self.class, hash * 2)
       else
         format('#<%s:0x%x url=%s title=%s>', self.class, hash * 2, url.inspect, title.inspect)
       end
+    rescue Selenium::WebDriver::Error::NoSuchWindowError
+      format('#<%s:0x%x closed=%s>', self.class, hash * 2, closed?)
     rescue Errno::ECONNREFUSED
       format('#<%s:0x%x closed=true>', self.class, hash * 2)
     end
     alias selector_string inspect
+    # rubocop:enable Metrics/AbcSize
 
     #
     # Returns URL of current page.
@@ -101,13 +106,23 @@ module Watir
     #
 
     def close
-      return if @closed
+      return if closed?
 
       @driver.quit
       @closed = true
     end
     alias quit close
 
+    #
+    # Returns true if browser is closed and false otherwise.
+    #
+    # @return [Boolean]
+    #
+
+    def closed?
+      @closed
+    end
+
     #
     # Handles cookies.
     #
@@ -213,11 +228,11 @@ module Watir
     # @param args Arguments will be available in the given script in the 'arguments' pseudo-array
     #
 
-    def execute_script(script, *args)
+    def execute_script(script, *args, function_name: nil)
       args.map! do |e|
         e.is_a?(Element) ? e.wait_until(&:exists?).wd : e
       end
-
+      Watir.logger.info "Executing Script on Browser: #{function_name}" if function_name
       wrap_elements_in(self, @driver.execute_script(script, *args))
     end
 
@@ -252,12 +267,12 @@ module Watir
     #
 
     def exist?
-      !@closed && window.present?
+      !closed? && window.present?
     end
     alias exists? exist?
 
     def locate
-      raise Error, 'browser was closed' if @closed
+      raise Error, 'browser was closed' if closed?
 
       ensure_context
     end
@@ -267,7 +282,6 @@ module Watir
 
       driver.switch_to.default_content
       @default_context = true
-      after_hooks.run
     end
 
     def browser