webdrivers 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa8f1d0b04f0eae3dc76133a1d473e524d78969a6905eaa4aaefb5b9262311d2
-  data.tar.gz: 685a871618bcd101c24a24cca0e31effd64634cd9a67bf66a0e5c863b922316f
+  metadata.gz: c836de6a779887c856d52f673efe3aa222046c32d50386f195c31e1c1f37ac4f
+  data.tar.gz: 972c301f2b3176ad1629820779bff1174043858160e36c56f57522f263458284
 SHA512:
-  metadata.gz: 451f3117e49414c40bb6d1e422e81f79dc0203f9547d03eca7a7015768b6eff429a6478c1d9fc269ff4e44d0c750e617fbe1334bc2a421e5569abe353a604c93
-  data.tar.gz: 1b02b191b395b7defdf76b9f941747f8739a938c9725aa0f13345ea8dfe8ad832da76aa2050d4561382fe5ea7bbe4a7d561ed9a0ff3d27ff5c60a18c88f8e798
+  metadata.gz: 89f7b359fe431e1fe4092baf2867049af4876df5f38f6edc8e7b91fc22bd2a8b7f81e6ea5492c97778453f9e532e4756f5102cc0b90e9954c9b4345e1b0e697f
+  data.tar.gz: 4c237d64c244c3e62581179b57c58d3961412ea1577d2a57f9c636c86b280db61496a156a28a341b7d6155136c855b38bc034efcc464370c9a6dc543d6a0b808

data/.github/ISSUE_TEMPLATE.md

@@ -1,14 +1,16 @@
-#### Summary
-Short summary of the bug or feature request.
-
-#### Debug Info
-Please provide the following information for bug reports:
-
-* Operating system / CI Environment:
-* Browser and version:
-
-#### Expected Behavior
-What you expect to happen.
-
-#### Actual Behavior
-What is actually happening: Error message, stack trace, DEBUG log if applicable (set `Webdrivers.logger.level = :DEBUG` after you require webdrivers)
+#### Summary
+Short summary of the bug or feature request.
+
+#### Debug Info
+Please provide the following information for bug reports:
+
+* Webdrivers version:
+* Ruby version:
+* Operating system / CI Environment:
+* Browser and version:
+
+#### Expected Behavior
+What you expect to happen.
+
+#### Actual Behavior
+What is actually happening: Error message, stack trace, DEBUG log if applicable (set `Webdrivers.logger.level = :DEBUG` after you require webdrivers)

data/.gitignore

@@ -1,7 +1,8 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-chromedriver.log
-/.idea/
-coverage/
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+chromedriver.log
+/.idea/
+coverage/
+gemfiles/Gemfile.*.lock

data/.travis.yml

@@ -1,24 +1,40 @@
-language: ruby
-cache: bundler
-addons:
-  apt:
-    packages:
-      - chromium-browser
-      - libgconf-2-4
-  chrome: stable
-script: bundle exec rake $RAKE_TASK
-matrix:
-  include:
-    - rvm: 2.6.3
-      env: RAKE_TASK=spec
-    - rvm: 2.5.5
-      env: RAKE_TASK=spec
-    - rvm: 2.4.6
-      env: RAKE_TASK=spec
-    - rvm: 2.4.6
-      os: osx
-      env: RAKE_TASK=spec
-    - rvm: 2.4.6
-      env: RAKE_TASK=rubocop
-    - rvm: jruby-9.2.7.0
-      env: RAKE_TASK=spec
+language: ruby
+cache: bundler
+addons:
+  apt:
+    packages:
+      - chromium-browser
+      - libgconf-2-4
+  chrome: stable
+script: bundle exec rake $RAKE_TASK
+before_install:
+  - gem update --system
+  - gem update bundler
+matrix:
+  include:
+    - rvm: 2.6.3
+      env: RAKE_TASK=spec
+    - rvm: 2.5.5
+      env: RAKE_TASK=spec
+    - rvm: 2.4.6
+      env: RAKE_TASK=spec
+    - rvm: 2.4.6
+      os: osx
+      env: RAKE_TASK=spec
+    - rvm: 2.4.6
+      env: RAKE_TASK=rubocop
+    - rvm: jruby-9.2.7.0
+      env: RAKE_TASK=spec
+    - rvm: 2.6
+      env: RAKE_TASK=spec
+      gemfile: gemfiles/Gemfile.edge
+      os: osx
+      osx_image: xcode10.2
+      addons:
+        chrome: stable
+        homebrew:
+          taps: homebrew/cask-versions
+          casks:
+            - microsoft-edge-canary
+  allow_failures:
+    - gemfile: gemfiles/Gemfile.edge

data/CHANGELOG.md

@@ -1,5 +1,18 @@
+### 4.1.0 (2019-06-26)
+* Add support for `msedgedriver` (issue [#93](https://github.com/titusfortner/webdrivers/issues/93))
+* Allow users to provide a custom binary path via `WD_CHROME_PATH` 
+and `WD_EDGE_CHROME_ATH` environment variables (issues #[137](https://github.com/titusfortner/webdrivers/issues/137) 
+and [#93](https://github.com/titusfortner/webdrivers/issues/93))
+* Fix a bug where the user given Chrome binary path via `Selenium::WebDriver::Chrome.path` 
+was not properly escaped (issue [#139](https://github.com/titusfortner/webdrivers/issues/139))
+* Fix miscellaneous code warnings.
+* **Announcement**: As of 06/21/2019, `heroku-buildpack-google-chrome` 
+no longer requires a [workaround](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) 
+to work with this gem. See [heroku-buildpack-google-chrome#73](https://github.com/heroku/heroku-buildpack-google-chrome/pull/73) 
+for more information.
+
 ### 4.0.1 (2019-06-12)
-* Cache time now defaults to 86,400 Seconds (24 hours). Please note the special exception for `chromedriver` in the [README](https://github.com/titusfortner/webdrivers#special-exception-for-chromedriver) (issue [#132](https://github.com/titusfortner/webdrivers/issues/132))
+* Cache time now defaults to 86,400 Seconds (24 hours). Please note the special exception for `chromedriver` in the [README](https://github.com/titusfortner/webdrivers#special-exception-for-chromedriver-and-msedgedriver) (issue [#132](https://github.com/titusfortner/webdrivers/issues/132))
 * Properly escape Chrome binary path when using JRuby on Windows (issue [#130](https://github.com/titusfortner/webdrivers/issues/130))
 * Allow use of `selenium-webdriver` v4 (pre-releases only)
 

data/LICENSE.txt

@@ -1,23 +1,23 @@
-(The MIT License)
-
-Copyright (c) 2017-2019: Titus Fortner
-Copyright (c) 2019: Lakshya Kapoor, Thomas Walpole
-
-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.
+(The MIT License)
+
+Copyright (c) 2017-2019: Titus Fortner
+Copyright (c) 2019: Lakshya Kapoor, Thomas Walpole
+
+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

@@ -13,10 +13,7 @@ Run Selenium tests more easily with automatic installation and updates for all s
 * [chromedriver](http://chromedriver.chromium.org/)
 * [geckodriver](https://github.com/mozilla/geckodriver)
 * [IEDriverServer](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver)
-
-Support for [`msedgedriver`](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
-will be added once the next Microsoft Edge version (v75) is released. More information is available 
-[here](https://developer.microsoft.com/en-us/microsoft-edge/).
+* [msedgedriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)  - Dev and Canary releases on Windows and macOS only
 
 ## Usage
 
@@ -36,10 +33,12 @@ through Selenium.
 ### Specific Drivers
 
 If you want webdrivers to only manage specific drivers you can specify one or more as follows:
+
 ```ruby
 require 'webdrivers/chromedriver'
 require 'webdrivers/geckodriver'
 require 'webdrivers/iedriver'
+require 'webdrivers/edgedriver'
 ```
 
 ### Download Location
@@ -67,6 +66,9 @@ Webdrivers::Geckodriver.required_version  = '0.23.0'
 
 # Internet Explorer
 Webdrivers::IEdriver.required_version     = '3.14.0'
+
+# Edge (Chromium)
+Webdrivers::Edgedriver.required_version     = '76.0.183.0'
 ```
 
 You can explicitly trigger the update in your code, but this will happen
@@ -86,14 +88,13 @@ Webdrivers.cache_time = 86_400 # Default: 86,400 Seconds (24 hours)
 ```
 
 Alternatively, you can define this value via the `WD_CACHE_TIME` environment
-variable, which takes precedence over the `Webdrivers.cache_time` value. 
-**Only set one to avoid confusion**.
+variable. **Only set one to avoid confusion**.
 
-##### Special exception for chromedriver
+##### Special exception for chromedriver and msedgedriver
 
-Cache time will be respected as long as a `chromedriver` binary exists and the major versions of 
-Chrome and `chromedriver` match. For example, if you update Chrome to v76 and `chromedriver` is 
-still at v75, `webdrivers` will ignore the cache time and update `chromedriver` to make sure you're 
+Cache time will be respected as long as a driver binary exists and the major versions of 
+the browser and the driver match. For example, if you update Chrome or Edge to v76 and its driver is 
+still at v75, `webdrivers` will ignore the cache time and update the driver to make sure you're 
 using a compatible version.
 
 ### Proxy
@@ -133,7 +134,7 @@ Other solutions are documented on the RubyGems [website](https://guides.rubygems
 ### Rake tasks
 
 Each driver has its own set of `rake` tasks (with `Railtie` support) that
-you can call once before executing the tests.  These are especially 
+you can call once before executing the tests. These are especially 
 useful if you're running tests in parallel and want to avoid performing 
 an update check per thread.
 
@@ -142,6 +143,9 @@ $ bundle exec rake -T
 rake webdrivers:chromedriver:remove           # Force remove chromedriver
 rake webdrivers:chromedriver:update[version]  # Remove and download updated chromedriver if necessary
 rake webdrivers:chromedriver:version          # Print current chromedriver version
+rake webdrivers:edgedriver:remove             # Force remove msedgedriver
+rake webdrivers:edgedriver:update[version]    # Remove and download updated msedgedriver if necessary
+rake webdrivers:edgedriver:version            # Print current msedgedriver version
 rake webdrivers:geckodriver:remove            # Force remove geckodriver
 rake webdrivers:geckodriver:update[version]   # Remove and download updated geckodriver if necessary
 rake webdrivers:geckodriver:version           # Print current geckodriver version
@@ -157,8 +161,9 @@ require 'webdrivers'
 load 'webdrivers/Rakefile'
 ```
 
-These tasks respect the `WD_INSTALL_DIR` and `WD_CACHE_TIME` environment
-variables which can also be passed through the `rake` command:
+These tasks respect the `WD_INSTALL_DIR`, `WD_CACHE_TIME`, `WD_CHROME_PATH`,
+and `WD_EDGE_CHROME_PATH` environment variables, which can also be passed 
+through the `rake` command:
 
 ```bash
 $ bundle exec rake webdrivers:chromedriver:update[2.46] webdrivers:geckodriver:update[0.24.0] WD_CACHE_TIME=86_400 WD_INSTALL_DIR='my_dir'
@@ -180,7 +185,7 @@ Webdrivers.logger.level = :DEBUG
 
 ### Browser Specific Notes
 
-#### Chrome/Chromium
+#### Chrome/Chromium 
 
 The version of `chromedriver` will depend on the version of Chrome you are using it with:
 
@@ -197,21 +202,25 @@ You can override this behavior by providing a path to the browser binary you wan
 Selenium::WebDriver::Chrome.path = '/chromium/install/path/to/binary'
 ```
 
+Alternatively, you can define the path via the `WD_CHROME_PATH` environment
+variable.
+
 This is also required if Google Chrome is not installed in its 
 [default location](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).
 
-##### Heroku/CircleCI Users
+##### CircleCI Users
 
-Follow the specific instructions [here](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) if your CI environment provides custom shims for Chrome or Chromium.
+Follow the specific instructions [here](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) if your CI environment provides custom shims for Chrome or Chromium. 
 
-#### Microsoft Edge
+Please note that as of 06/21/2019, [`heroku-buildpack-google-chrome`](https://github.com/heroku/heroku-buildpack-google-chrome/pull/73) no longer requires this workaround.
 
-Microsoft Edge support for v18 and older has been removed for now, as it is currently 
-unreliable. To use Microsoft Edge, please visit the [Downloads and Installation page](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/#downloads). 
+#### Microsoft Edge (Chromium)
 
-Support for [`msedgedriver`](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
-will be added once the next Microsoft Edge version (v75) is released. More information is available 
-[here](https://developer.microsoft.com/en-us/microsoft-edge/).
+Microsoft Edge (Chromium) support was added in v4.1.0. Notes 
+from the [Chrome/Chromium](https://github.com/titusfortner/webdrivers#chromechromium) 
+section apply to this browser as well.
+  
+Please note that `msedgedriver` requires `selenium-webdriver` v4.
 
 ## Wiki
 

data/appveyor.yml

@@ -1,6 +1,8 @@
 build: off
 cache:
   - vendor/bundle
+image:
+  - Visual Studio 2017
 environment:
   matrix:
     - RUBY_VERSION: Ruby24
@@ -23,12 +25,14 @@ environment:
       RUBY_BIN: jruby
       RAKE_TASK: spec
       SCRIPT_CONTEXT: jruby -G -S
+    - RUBY_VERSION: Ruby26
+      RUBY_BIN: ruby
+      RAKE_TASK: spec
+      SCRIPT_CONTEXT: bundle exec
+      BUNDLE_GEMFILE: gemfiles/Gemfile.edge
 install:
-  - ps: |
-      if ($env:RUBY_BIN -eq 'jruby')
-      {
-        support\install_jruby.ps1
-      }
+  - ps: if ($env:RUBY_BIN -eq 'jruby') { support\install_jruby.ps1 }
+  - ps: support\install_msedge.ps1
   - set PATH=C:\%RUBY_VERSION%\bin;%PATH%
   - '%RUBY_BIN% -S gem update --system'
   - '%RUBY_BIN% -S gem install bundler'

data/gemfiles/Gemfile.edge

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webdrivers.gemspec
+gemspec path: '..'
+gem 'selenium-webdriver', github: 'seleniumhq/selenium', glob: 'rb/*.gemspec'

data/lib/webdrivers.rb

@@ -2,5 +2,6 @@
 
 require 'webdrivers/chromedriver'
 require 'webdrivers/geckodriver'
+require 'webdrivers/edgedriver'
 require 'webdrivers/iedriver'
 require 'webdrivers/railtie' if defined?(Rails)

data/lib/webdrivers/chrome_finder.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module Webdrivers
+  #
+  # @api private
+  #
   class ChromeFinder
     class << self
       def version
-        location = Selenium::WebDriver::Chrome.path || send("#{System.platform}_location")
         version = send("#{System.platform}_version", location)
 
         raise VersionError, 'Failed to find Chrome binary or its version.' if version.nil? || version.empty?
@@ -13,9 +15,25 @@ module Webdrivers
         version[/\d+\.\d+\.\d+\.\d+/] # Google Chrome 73.0.3683.75 -> 73.0.3683.75
       end
 
-      def win_location
-        return Selenium::WebDriver::Chrome.path unless Selenium::WebDriver::Chrome.path.nil?
+      def location
+        user_defined_location || send("#{System.platform}_location")
+      end
+
+      private
+
+      def user_defined_location
+        if Selenium::WebDriver::Chrome.path
+          Webdrivers.logger.debug "Selenium::WebDriver::Chrome.path: #{Selenium::WebDriver::Chrome.path}"
+          return Selenium::WebDriver::Chrome.path
+        end
+
+        return if ENV['WD_CHROME_PATH'].nil?
 
+        Webdrivers.logger.debug "WD_CHROME_PATH: #{ENV['WD_CHROME_PATH']}"
+        ENV['WD_CHROME_PATH']
+      end
+
+      def win_location
         envs = %w[LOCALAPPDATA PROGRAMFILES PROGRAMFILES(X86)]
         directories = ['\\Google\\Chrome\\Application', '\\Chromium\\Application']
         file = 'chrome.exe'
@@ -23,13 +41,7 @@ module Webdrivers
         directories.each do |dir|
           envs.each do |root|
             option = "#{ENV[root]}\\#{dir}\\#{file}"
-            next unless File.exist?(option)
-
-            # Fix for JRuby on Windows - #41 and #130.
-            # Escape space and parenthesis with backticks.
-            option = option.gsub(/([\s()])/, '`\1') if RUBY_PLATFORM == 'java'
-
-            return System.escape_path(option)
+            return option if File.exist?(option)
           end
         end
       end
@@ -42,7 +54,7 @@ module Webdrivers
         directories.each do |dir|
           files.each do |file|
             option = "#{dir}/#{file}"
-            return System.escape_path(option) if File.exist?(option)
+            return option if File.exist?(option)
           end
         end
       end
@@ -54,7 +66,7 @@ module Webdrivers
         directories.each do |dir|
           files.each do |file|
             option = "#{dir}/#{file}"
-            return System.escape_path(option) if File.exist?(option)
+            return option if File.exist?(option)
           end
         end
       end
@@ -64,11 +76,11 @@ module Webdrivers
       end
 
       def linux_version(location)
-        System.call("#{location} --product-version")&.strip
+        System.call(location, '--product-version')&.strip
       end
 
       def mac_version(location)
-        System.call("#{location} --version")&.strip
+        System.call(location, '--version')&.strip
       end
     end
   end