webdrivers 4.7.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124d154092dc8915735f459f0476c7700e47300bec986e9b88ba214b2db8b92c
-  data.tar.gz: 9db15712e5227ef9b92db34a7d1714ba9613ca2bd30563b85cf5dbeee5322063
+  metadata.gz: 366e7e4f90b5bd54a2f5f1cbe2df6074f6cad56026502ec6d9f0ceddd4a269c8
+  data.tar.gz: '09439fb8a5f6e550ab6562891e1b11daa43f13694e21740e8e7141916b02641d'
 SHA512:
-  metadata.gz: 727a676f6b025291ecc30fff84b16159820607f4dba0c1216b3c1487f56b5bb4da8679b69b464a5234dc78d872da4b63112b11d60efd3fbb72cfbaf61ea57223
-  data.tar.gz: 744f5a8173676d02b2f94ff3eda885ec77d47a4e2e04cbfaa04876262e500e906313f6280d0a12e93274ba7f558886a035879d72b0264903fc695c2139b4ca83
+  metadata.gz: d7b1a0e9791e985716d7e887c23e7346752218c108ac1bc11c1833c087ecfbf43f5eab718968ab6ddbce1b313740af6d8758a9568cb058edcbe06ae08583a44d
+  data.tar.gz: 98fe42f01271e270387795e0dd30ec943d5c0937d413f8ddedf96946ac00b7686a9cf2aee4ce78e52510ff08e2dffb963dd6a282c9abb6267d003a2704f9cfe1

data/CHANGELOG.md

@@ -1,8 +1,19 @@
+# 5.1.0 (2022-09-19)
+* Improve error messages (#232, thanks dan-jensen)
+* Fix circular require bug with railtie (#233, thanks amatsuda)
+* Support downloading correct geckodriver on Apple silicon (#234 thanks stephannv)
+* Update linux locations for Chrome to latest chromedriver finder (thanks entretechno-jeremiah) 
+* Add support for Microsoft Edge on Linux (#236)
+
+# 5.0.0 (2021-10-19)
+* Require Selenium 4+
+* Remove custom Logger and use the one in Selenium 4
+
 # 4.7.0 (2021-10-14)
 * Add support for Selenium 4.x #218 (thanks yahonda )
 * Allow Edge on Linux
 * Update required Selenium > 3.141 because of a change in 4.6
-* Require Selenium 2.6+
+* Require Ruby 2.6+
 * Fix IE downloads with the change in location of assets
 
 # 4.6.1 (2021-08-19)

data/README.md

@@ -22,7 +22,7 @@ notes at the bottom.
 In your Gemfile:
 
 ```ruby
-gem 'webdrivers', '~> 4.0', require: false
+gem 'webdrivers', '~> 5.0', require: false
 ```
 
 In your project:

data/lib/webdrivers/chrome_finder.rb

@@ -8,7 +8,7 @@ module Webdrivers
     class << self
       def version
         version = send("#{System.platform}_version", location)
-        raise VersionError, 'Failed to find Chrome version.' if version.nil? || version.empty?
+        raise VersionError, 'Failed to determine Chrome version.' if version.nil? || version.empty?
 
         Webdrivers.logger.debug "Browser version: #{version}"
         version[/\d+\.\d+\.\d+\.\d+/] # Google Chrome 73.0.3683.75 -> 73.0.3683.75
@@ -18,7 +18,7 @@ module Webdrivers
         chrome_bin = user_defined_location || send("#{System.platform}_location")
         return chrome_bin unless chrome_bin.nil?
 
-        raise BrowserNotFound, 'Failed to find Chrome binary.'
+        raise BrowserNotFound, 'Failed to determine Chrome binary location.'
       end
 
       private
@@ -90,7 +90,17 @@ module Webdrivers
       def linux_location
         return wsl_location if System.wsl_v1?
 
-        directories = %w[/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin /snap/bin /opt/google/chrome]
+        directories = %w[
+          /usr/local/sbin
+          /usr/local/bin
+          /usr/sbin
+          /usr/bin
+          /sbin
+          /bin
+          /snap/bin
+          /opt/google/chrome
+          /opt/chromium.org/chromium
+        ]
         files = %w[google-chrome chrome chromium chromium-browser]
 
         directories.each do |dir|

data/lib/webdrivers/common.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'rubygems/package'
-require 'webdrivers/logger'
 require 'webdrivers/network'
 require 'webdrivers/system'
 require 'selenium-webdriver'
+require 'webdrivers/logger'
 require 'webdrivers/version'
 
 module Webdrivers

data/lib/webdrivers/edge_finder.rb

@@ -69,18 +69,17 @@ module Webdrivers
       end
 
       def linux_location
-        # directories = %w[/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin /snap/bin /opt/google/chrome]
-        # files = %w[microsoft-edge] # Based on Microsoft Edge 89.0.760.0 dev
-        #
-        # directories.each do |dir|
-        #   files.each do |file|
-        #     option = "#{dir}/#{file}"
-        #     return option if File.exist?(option)
-        #   end
-        # end
-        #
-        # nil
-        raise 'Default location not yet known'
+        directories = %w[/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin /snap/bin /opt/microsoft/edge]
+        files = %w[microsoft-edge microsoft-edge-beta microsoft-edge-dev]
+
+        directories.each do |dir|
+          files.each do |file|
+            option = "#{dir}/#{file}"
+            return option if File.exist?(option)
+          end
+        end
+
+        nil
       end
 
       def win_version(location)

data/lib/webdrivers/edgedriver.rb

@@ -22,8 +22,7 @@ module Webdrivers
       #
       # @return [String]
       def base_url
-        # 'https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/'
-        'https://msedgedriver.azureedge.net/'
+        'https://msedgedriver.azureedge.net'
       end
 
       private
@@ -76,14 +75,10 @@ module Webdrivers
         false
       end
 
-      def linux_compatible?(driver_version)
-        System.platform == 'linux' && driver_version >= normalize_version('89.0.731.0')
-      end
-
       def driver_filename(driver_version)
         if System.platform == 'win' || System.wsl_v1?
           "win#{System.bitsize}" # 32 or 64-bit
-        elsif linux_compatible?(driver_version)
+        elsif System.platform == 'linux'
           'linux64'
         elsif System.platform == 'mac'
           # Determine M1 or Intel architecture

data/lib/webdrivers/geckodriver.rb

@@ -51,7 +51,7 @@ module Webdrivers
         when 'linux'
           "linux#{System.bitsize}.tar.gz"
         when 'mac'
-          'macos.tar.gz'
+          System.apple_m1_architecture? ? 'macos-aarch64.tar.gz' : 'macos.tar.gz'
         when 'win'
           "win#{System.bitsize}.zip"
         end

data/lib/webdrivers/logger.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'logger'
-
-# Code adapted from Selenium Implementation
-# https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/common/logger.rb
-
 module Webdrivers
   #
   # @example Enable full logging
@@ -18,94 +12,9 @@ module Webdrivers
   #   Webdrivers.logger.info('This is info message')
   #   Webdrivers.logger.warn('This is warning message')
   #
-  class Logger
-    extend Forwardable
-    include ::Logger::Severity
-
-    def_delegators :@logger, :debug, :debug?,
-                   :info, :info?,
-                   :warn, :warn?,
-                   :error, :error?,
-                   :fatal, :fatal?,
-                   :level
-
+  class Logger < Selenium::WebDriver::Logger
     def initialize
-      @logger = create_logger($stdout)
-    end
-
-    def output=(io)
-      # `Logger#reopen` was added in Ruby 2.3
-      if @logger.respond_to?(:reopen)
-        @logger.reopen(io)
-      else
-        @logger = create_logger(io)
-      end
-    end
-
-    #
-    # For Ruby < 2.3 compatibility
-    # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
-    #
-
-    def level=(severity)
-      if severity.is_a?(Integer)
-        @logger.level = severity
-      else
-        case severity.to_s.downcase
-        when 'debug'
-          @logger.level = DEBUG
-        when 'info'
-          @logger.level = INFO
-        when 'warn'
-          @logger.level = WARN
-        when 'error'
-          @logger.level = ERROR
-        when 'fatal'
-          @logger.level = FATAL
-        when 'unknown'
-          @logger.level = UNKNOWN
-        else
-          raise ArgumentError, "invalid log level: #{severity}"
-        end
-      end
-    end
-
-    #
-    # Returns IO object used by logger internally.
-    #
-    # Normally, we would have never needed it, but we want to
-    # use it as IO object for all child processes to ensure their
-    # output is redirected there.
-    #
-    # It is only used in debug level, in other cases output is suppressed.
-    #
-    # @api private
-    #
-    def io
-      @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
-    end
-
-    #
-    # Marks code as deprecated with replacement.
-    #
-    # @param [String] old
-    # @param [String] new
-    #
-    def deprecate(old, new)
-      warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
-    end
-
-    private
-
-    def create_logger(output)
-      logger = ::Logger.new(output)
-      logger.progname = 'Webdrivers'
-      logger.level = ($DEBUG ? DEBUG : WARN)
-      logger.formatter = proc do |severity, time, progname, msg|
-        "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
-      end
-
-      logger
+      super('Webdrivers')
     end
   end
 end

data/lib/webdrivers/railtie.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'webdrivers'
 require 'rails'
 
 module Webdrivers

data/lib/webdrivers/version.rb

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

data/spec/webdrivers/chromedriver_spec.rb

@@ -168,8 +168,8 @@ describe Webdrivers::Chromedriver do
     end
 
     it 'raises VersionError for beta version' do
-      allow(chromedriver).to receive(:browser_version).and_return Gem::Version.new('100.0.0')
-      msg = 'Unable to find latest point release version for 100.0.0. '\
+      allow(chromedriver).to receive(:browser_version).and_return Gem::Version.new('999.0.0')
+      msg = 'Unable to find latest point release version for 999.0.0. '\
 'You appear to be using a non-production version of Chrome. '\
 'Please set `Webdrivers::Chromedriver.required_version = <desired driver version>` '\
 'to a known chromedriver version: https://chromedriver.storage.googleapis.com/index.html'

data/spec/webdrivers/edge_finder_spec.rb

@@ -5,13 +5,7 @@ require 'spec_helper'
 describe Webdrivers::EdgeFinder do
   let(:edge_finder) { described_class }
 
-  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
-    if Selenium::WebDriver::VERSION[0].to_i < 4
-      skip 'The current selenium-webdriver does not include Chromium based Edge support'
-    elsif Webdrivers::System.platform == 'linux'
-      skip 'Edge is not yet supported on Linux'
-    end
-  end
+  before { skip 'Edge is not yet supported on Linux' if Webdrivers::System.platform == 'linux' }
 
   context 'when the user relies on the gem to figure out the location of Edge' do
     it 'determines the location correctly based on the current OS' do

data/spec/webdrivers/edgedriver_spec.rb

@@ -5,16 +5,10 @@ require 'spec_helper'
 describe Webdrivers::Edgedriver do
   let(:edgedriver) { described_class }
 
-  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
-    if Selenium::WebDriver::VERSION[0].to_i < 4
-      skip 'The current selenium-webdriver does not include Chromium based Edge support'
-    elsif Webdrivers::System.platform == 'linux'
-      skip 'Edge is not yet supported on Linux'
-    end
+  before do
+    edgedriver.remove
   end
 
-  before { edgedriver.remove }
-
   describe '#update' do
     context 'when evaluating #correct_binary?' do
       it 'does not download when latest version and current version match' do
@@ -128,19 +122,19 @@ describe Webdrivers::Edgedriver do
 
     context 'when required version is 0' do
       it 'downloads the latest version' do
-        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('77.0.207.0'))
+        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('98.0.1089.1'))
         edgedriver.required_version = 0
         edgedriver.update
-        expect(edgedriver.current_version.version).to eq('77.0.207.0')
+        expect(edgedriver.current_version.version).to eq('98.0.1089.1')
       end
     end
 
     context 'when required version is nil' do
       it 'downloads the latest version' do
-        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('77.0.207.0'))
+        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('98.0.1089.1'))
         edgedriver.required_version = nil
         edgedriver.update
-        expect(edgedriver.current_version.version).to eq('77.0.207.0')
+        expect(edgedriver.current_version.version).to eq('98.0.1089.1')
       end
     end
   end
@@ -170,11 +164,11 @@ describe Webdrivers::Edgedriver do
     end
 
     it 'raises VersionError for beta version' do
-      allow(edgedriver).to receive(:browser_version).and_return Gem::Version.new('100.0.0')
-      msg = 'Unable to find latest point release version for 100.0.0. '\
+      allow(edgedriver).to receive(:browser_version).and_return Gem::Version.new('999.0.0')
+      msg = 'Unable to find latest point release version for 999.0.0. '\
 'You appear to be using a non-production version of Edge. '\
 'Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` '\
-'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net/'
+'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net'
 
       expect { edgedriver.latest_version }.to raise_exception(Webdrivers::VersionError, msg)
     end
@@ -183,7 +177,7 @@ describe Webdrivers::Edgedriver do
       allow(edgedriver).to receive(:browser_version).and_return Gem::Version.new('77.0.9999')
       msg = 'Unable to find latest point release version for 77.0.9999. '\
 'Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` '\
-'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net/'
+'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net'
 
       expect { edgedriver.latest_version }.to raise_exception(Webdrivers::VersionError, msg)
     end

data/spec/webdrivers/geckodriver_spec.rb

@@ -92,6 +92,40 @@ describe Webdrivers::Geckodriver do
       msg = /Net::HTTPServerException: 404 "Not Found"/
       expect { geckodriver.update }.to raise_error(StandardError, msg)
     end
+
+    context 'when platform is Apple Sillicon' do
+      it 'downloads aarch64 binary' do
+        allow(Webdrivers::System).to receive(:platform).and_return('mac')
+        allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(true)
+        base = 'https://github.com/mozilla/geckodriver/releases/download'
+        binary = 'geckodriver-v0.31.0-macos-aarch64.tar.gz'
+        url = "#{base}/v0.31.0/#{binary}"
+
+        allow(Webdrivers::System).to receive(:download).with(url, geckodriver.driver_path)
+
+        geckodriver.required_version = '0.31.0'
+        geckodriver.update
+
+        expect(Webdrivers::System).to have_received(:download).with(url, geckodriver.driver_path)
+      end
+    end
+
+    context 'when platform isn\'t Apple Sillicon' do
+      it 'downloads default binary' do
+        allow(Webdrivers::System).to receive(:platform).and_return('mac')
+        allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(false)
+        base = 'https://github.com/mozilla/geckodriver/releases/download'
+        binary = 'geckodriver-v0.31.0-macos.tar.gz'
+        url = "#{base}/v0.31.0/#{binary}"
+
+        allow(Webdrivers::System).to receive(:download).with(url, geckodriver.driver_path)
+
+        geckodriver.required_version = '0.31.0'
+        geckodriver.update
+
+        expect(Webdrivers::System).to have_received(:download).with(url, geckodriver.driver_path)
+      end
+    end
   end
 
   describe '#current_version' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webdrivers
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Titus Fortner
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -156,22 +156,16 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '3.141'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '3.141'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
 description: Run Selenium tests more easily with install and updates for all supported
   webdrivers.
 email:
@@ -218,8 +212,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/titusfortner/webdrivers/issues
   changelog_uri: https://github.com/titusfortner/webdrivers/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webdrivers/4.7.0
-  source_code_uri: https://github.com/titusfortner/webdrivers/tree/v4.7.0
+  documentation_uri: https://www.rubydoc.info/gems/webdrivers/5.1.0
+  source_code_uri: https://github.com/titusfortner/webdrivers/tree/v5.1.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -235,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Easy download and use of browser drivers.