webdrivers 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f9dfef27ff9ab5bae476fa1b8667572f892ef8f4d6631d150bc95018d33d327
-  data.tar.gz: a38a950bf647ec8d94fc7101d06a0325cac68568a2b0bcde65775fb64ee34a4e
+  metadata.gz: fa8f1d0b04f0eae3dc76133a1d473e524d78969a6905eaa4aaefb5b9262311d2
+  data.tar.gz: 685a871618bcd101c24a24cca0e31effd64634cd9a67bf66a0e5c863b922316f
 SHA512:
-  metadata.gz: 27a4cdef15c93e2fee024e0314dcaa663aeaf1f33bc23a5caecf3143d73b958c5486d4b09e52b961ab9bd80273630957dec8e773a7d76a4c8f85533c1cded036
-  data.tar.gz: bef2bc7580981a2444d5a8e5eb45c9be99c5bcdbe1f60029179cf0e28d3d2a3145bf608e06afec4da63d75041e4fdd47444a3a8e67c98b222b69e9a7095d5437
+  metadata.gz: 451f3117e49414c40bb6d1e422e81f79dc0203f9547d03eca7a7015768b6eff429a6478c1d9fc269ff4e44d0c750e617fbe1334bc2a421e5569abe353a604c93
+  data.tar.gz: 1b02b191b395b7defdf76b9f941747f8739a938c9725aa0f13345ea8dfe8ad832da76aa2050d4561382fe5ea7bbe4a7d561ed9a0ff3d27ff5c60a18c88f8e798

data/.rubocop.yml

@@ -26,6 +26,8 @@ Metrics/BlockLength:
 
 Metrics/ClassLength:
   Max: 116
+  Exclude:
+    - 'lib/webdrivers/system.rb'
 
 Metrics/CyclomaticComplexity:
   Max: 8

data/.travis.yml

@@ -1,24 +1,24 @@
-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
+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

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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))
+* 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)
+
 ### 4.0.0 (2019-05-28)
 
 No changes since rc2. Please report any issues [here](https://github.com/titusfortner/webdrivers/issues)

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

@@ -82,13 +82,19 @@ You can set Webdrivers to only look for updates if the previous check
 was longer ago than a specified number of seconds.
 
 ```ruby
-Webdrivers.cache_time = 86_400
+Webdrivers.cache_time = 86_400 # Default: 86,400 Seconds (24 hours)
 ```
 
 Alternatively, you can define this value via the `WD_CACHE_TIME` environment
-variable. 
+variable, which takes precedence over the `Webdrivers.cache_time` value. 
+**Only set one to avoid confusion**.
 
-The default is set to 24 hours (86,400 seconds).
+##### Special exception for chromedriver
+
+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 
+using a compatible version.
 
 ### Proxy
 
@@ -144,6 +150,13 @@ rake webdrivers:iedriver:update[version]      # Remove and download updated IEDr
 rake webdrivers:iedriver:version              # Print current IEDriverServer version
 ```
 
+If you are not using Rails, you'll need to load them into your Rakefile like this:
+
+```ruby
+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:
 

data/appveyor.yml

@@ -1,23 +1,41 @@
-build: off
-cache:
-  - vendor/bundle
-environment:
-  matrix:
-    - RUBY_VERSION: 24
-      RAKE_TASK: spec
-    - RUBY_VERSION: 24
-      RAKE_TASK: rubocop
-    - RUBY_VERSION: 25
-      RAKE_TASK: spec
-    - RUBY_VERSION: 26
-      RAKE_TASK: spec
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle config --local path vendor/bundle
-  - bundle install
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-test_script:
-  - bundle exec rake %RAKE_TASK%
+build: off
+cache:
+  - vendor/bundle
+environment:
+  matrix:
+    - RUBY_VERSION: Ruby24
+      RUBY_BIN: ruby
+      RAKE_TASK: spec
+      SCRIPT_CONTEXT: bundle exec
+    - RUBY_VERSION: Ruby24
+      RUBY_BIN: ruby
+      RAKE_TASK: rubocop
+      SCRIPT_CONTEXT: bundle exec
+    - RUBY_VERSION: Ruby25
+      RUBY_BIN: ruby
+      RAKE_TASK: spec
+      SCRIPT_CONTEXT: bundle exec
+    - RUBY_VERSION: Ruby26
+      RUBY_BIN: ruby
+      RAKE_TASK: spec
+      SCRIPT_CONTEXT: bundle exec
+    - RUBY_VERSION: jruby-9.2.7.0
+      RUBY_BIN: jruby
+      RAKE_TASK: spec
+      SCRIPT_CONTEXT: jruby -G -S
+install:
+  - ps: |
+      if ($env:RUBY_BIN -eq 'jruby')
+      {
+        support\install_jruby.ps1
+      }
+  - set PATH=C:\%RUBY_VERSION%\bin;%PATH%
+  - '%RUBY_BIN% -S gem update --system'
+  - '%RUBY_BIN% -S gem install bundler'
+  - '%RUBY_BIN% -S bundle install'
+before_test:
+  - '%RUBY_BIN% -v'
+  - '%RUBY_BIN% -S gem -v'
+  - '%RUBY_BIN% -S bundle -v'
+test_script:
+  - '%SCRIPT_CONTEXT% rake %RAKE_TASK%'

data/lib/webdrivers/chrome_finder.rb

@@ -23,7 +23,13 @@ module Webdrivers
         directories.each do |dir|
           envs.each do |root|
             option = "#{ENV[root]}\\#{dir}\\#{file}"
-            return option if File.exist?(option)
+            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)
           end
         end
       end
@@ -36,7 +42,7 @@ module Webdrivers
         directories.each do |dir|
           files.each do |file|
             option = "#{dir}/#{file}"
-            return option if File.exist?(option)
+            return System.escape_path(option) if File.exist?(option)
           end
         end
       end
@@ -48,7 +54,7 @@ module Webdrivers
         directories.each do |dir|
           files.each do |file|
             option = "#{dir}/#{file}"
-            return option if File.exist?(option)
+            return System.escape_path(option) if File.exist?(option)
           end
         end
       end
@@ -58,11 +64,11 @@ module Webdrivers
       end
 
       def linux_version(location)
-        System.call("#{Shellwords.escape location} --product-version")&.strip
+        System.call("#{location} --product-version")&.strip
       end
 
       def mac_version(location)
-        System.call("#{Shellwords.escape location} --version")&.strip
+        System.call("#{location} --version")&.strip
       end
     end
   end

data/lib/webdrivers/common.rb

@@ -18,15 +18,19 @@ module Webdrivers
   class NetworkError < StandardError
   end
 
+  DEFAULT_CACHE_TIME = 86_400 # 24 hours
+
   class << self
     attr_accessor :proxy_addr, :proxy_port, :proxy_user, :proxy_pass
     attr_writer :install_dir, :cache_time
 
     #
     # Returns the amount of time (Seconds) the gem waits between two update checks.
+    # @note Value from the environment variable "WD_CACHE_TIME" takes precedence over Webdrivers.cache_time. If neither
+    # are set, it defaults to 86,400 Seconds (24 hours).
     #
     def cache_time
-      (@cache_time || ENV['WD_CACHE_TIME']).to_i
+      (ENV['WD_CACHE_TIME'] || @cache_time || DEFAULT_CACHE_TIME).to_i
     end
 
     #
@@ -105,7 +109,7 @@ end
       #
       # @return [String]
       def driver_path
-        File.join System.install_dir, file_name
+        System.escape_path File.join(System.install_dir, file_name)
       end
 
       private

data/lib/webdrivers/system.rb

@@ -149,6 +149,12 @@ module Webdrivers
         Webdrivers.logger.debug "making System call: #{cmd}"
         `#{cmd}`
       end
+
+      def escape_path(path)
+        return path.tr('/', '\\') if platform == 'win' # Windows
+
+        Shellwords.escape(path) # Linux and macOS
+      end
     end
   end
 end

data/lib/webdrivers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webdrivers
-  VERSION = '4.0.0'
+  VERSION = '4.0.1'
 end

data/spec/webdrivers/chromedriver_spec.rb

@@ -114,7 +114,7 @@ describe Webdrivers::Chromedriver do
 
       chromedriver.update
 
-      expect(Webdrivers::Network).to have_received(:get).twice
+      expect(Webdrivers::Network).to have_received(:get).once
     end
 
     context 'when required version is 0' do
@@ -252,7 +252,9 @@ describe Webdrivers::Chromedriver do
 
   describe '#driver_path' do
     it 'returns full location of binary' do
-      expect(chromedriver.driver_path).to match("#{File.join(ENV['HOME'])}/.webdrivers/chromedriver")
+      expected_bin = "chromedriver#{'.exe' if Selenium::WebDriver::Platform.windows?}"
+      expected_path = Webdrivers::System.escape_path("#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}")
+      expect(chromedriver.driver_path).to eq(expected_path)
     end
   end
 end

data/spec/webdrivers/geckodriver_spec.rb

@@ -204,7 +204,9 @@ You can obtain a copy of the license at https://mozilla.org/MPL/2.0/"
 
   describe '#driver_path' do
     it 'returns full location of binary' do
-      expect(geckodriver.driver_path).to match("#{File.join(ENV['HOME'])}/.webdrivers/geckodriver")
+      expected_bin = "geckodriver#{'.exe' if Selenium::WebDriver::Platform.windows?}"
+      expected_path = Webdrivers::System.escape_path("#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}")
+      expect(geckodriver.driver_path).to eq(expected_path)
     end
   end
 end

data/spec/webdrivers/i_edriver_spec.rb

@@ -186,7 +186,8 @@ describe Webdrivers::IEdriver do
 
   describe '#driver_path' do
     it 'returns full location of binary' do
-      expect(iedriver.driver_path).to eq("#{File.join(ENV['HOME'])}/.webdrivers/IEDriverServer.exe")
+      expected_path = Webdrivers::System.escape_path("#{File.join(ENV['HOME'])}/.webdrivers/IEDriverServer.exe")
+      expect(iedriver.driver_path).to eq(expected_path)
     end
   end
 end

data/spec/webdrivers/webdrivers_spec.rb

@@ -6,32 +6,38 @@ describe Webdrivers do
   describe '#cache_time' do
     before { Webdrivers::Chromedriver.remove }
 
-    after { described_class.cache_time = 0 }
+    after { described_class.cache_time = nil }
 
-    it 'does not warn if cache time is set' do
-      described_class.cache_time = 50
+    context 'when cache time is not set' do
+      before { described_class.cache_time = nil }
 
-      msg = /Webdrivers Driver caching is turned off in this version, but will be enabled by default in 4\.x/
-      expect { Webdrivers::Chromedriver.update }.not_to output(msg).to_stdout_from_any_process
+      it 'defaults cache time to 86,400 Seconds (24 hours)' do
+        expect(described_class.cache_time).to eq(86_400)
+      end
     end
 
-    context 'when ENV variable WD_CACHE_TIME is set and Webdrivers.cache_time is not' do
-      before { described_class.cache_time = nil }
+    context 'when Webdrivers.cache_time is set' do
+      before { described_class.cache_time = '999' }
 
-      it 'uses cache time value from ENV variable' do
-        allow(ENV).to receive(:[]).with('WD_CACHE_TIME').and_return('999')
-        expect(described_class.cache_time).to be(999)
+      it 'returns user defined cache time' do
+        expect(described_class.cache_time).to eq(999)
       end
 
       it 'returns cache time as an Integer' do
-        allow(ENV).to receive(:[]).with('WD_CACHE_TIME').and_return('999')
         expect(described_class.cache_time).to be_an_instance_of(Integer)
       end
     end
 
-    context 'when Webdrivers.cache_time is set' do
+    context 'when ENV variable WD_CACHE_TIME is set' do
+      before { described_class.cache_time = 86_400 }
+
+      it 'uses cache time value from ENV variable over the Webdrivers.cache_time value' do
+        allow(ENV).to receive(:[]).with('WD_CACHE_TIME').and_return(999)
+        expect(described_class.cache_time).to be(999)
+      end
+
       it 'returns cache time as an Integer' do
-        described_class.cache_time = '999'
+        allow(ENV).to receive(:fetch).with('WD_CACHE_TIME', 86_400).and_return('999')
         expect(described_class.cache_time).to be_an_instance_of(Integer)
       end
     end

data/support/install_jruby.ps1

@@ -0,0 +1,7 @@
+$downloadLink = "https://repo1.maven.org/maven2/org/jruby/jruby-dist/9.2.7.0/jruby-dist-9.2.7.0-bin.zip"
+$zipPath = "c:\jruby-dist-9.2.7.0-bin.zip"
+
+Write-Host "Installing $($env:RUBY_VERSION)" -ForegroundColor cyan
+appveyor DownloadFile "$($downloadLink)" -FileName "$($zipPath)"
+7z x "$($zipPath)" -oc:\ -y # Unzip to c:\
+Write-Host "JRuby installed.`n" -ForegroundColor green

data/webdrivers.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'nokogiri', '~> 1.6'
   s.add_runtime_dependency 'rubyzip', '~> 1.0'
-  s.add_runtime_dependency 'selenium-webdriver', '~> 3.0'
+  s.add_runtime_dependency 'selenium-webdriver', '>= 3.0', '< 4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webdrivers
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Titus Fortner
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -142,16 +142,22 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Run Selenium tests more easily with install and updates for all supported
   webdrivers.
 email:
@@ -192,6 +198,7 @@ files:
 - spec/webdrivers/i_edriver_spec.rb
 - spec/webdrivers/webdrivers_spec.rb
 - spec/webdrivers_proxy_support_spec.rb
+- support/install_jruby.ps1
 - webdrivers.gemspec
 homepage: https://github.com/titusfortner/webdrivers
 licenses: