selenium-webdriver 4.0.0.alpha2 → 4.0.0.alpha3

data/lib/selenium/webdriver/{edge → edge_html}/driver.rb

@@ -19,7 +19,7 @@
 
 module Selenium
   module WebDriver
-    module Edge
+    module EdgeHtml
 
       #
       # Driver implementation for Microsoft Edge.
@@ -31,7 +31,7 @@ module Selenium
         include DriverExtensions::TakesScreenshot
 
         def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
+          opts[:desired_capabilities] ||= Remote::Capabilities.edge
 
           opts[:url] ||= service_url(opts)
 
@@ -47,23 +47,6 @@ module Selenium
         def browser
           :edge
         end
-
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        private
-
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.edge }
-          options = opts.delete(:options) { Options.new }
-          options = options.as_json
-          caps.merge!(options) unless options.empty?
-
-          caps
-        end
       end # Driver
     end # Edge
   end # WebDriver

data/lib/selenium/webdriver/{edge → edge_html}/options.rb

@@ -19,10 +19,22 @@
 
 module Selenium
   module WebDriver
-    module Edge
-      class Options
-        attr_accessor :in_private, :start_page
-        attr_reader :extension_paths
+    module EdgeHtml
+      class Options < WebDriver::Options
+        # see https://docs.microsoft.com/en-us/microsoft-edge/webdriver#capabilities
+        CAPABILITIES = {in_private: 'ms:inPrivate',
+                        extension_paths: 'ms:extensionPaths',
+                        start_page: 'ms:startPage'}.freeze
+
+        CAPABILITIES.each_key do |key|
+          define_method key do
+            @options[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @options[key] = value
+          end
+        end
 
         #
         # Create a new Options instance for Edge.
@@ -40,9 +52,8 @@ module Selenium
         #
 
         def initialize(**opts)
-          @in_private = opts.delete(:in_private) || false
-          @extension_paths = opts.delete(:extension_paths) || []
-          @start_page = opts.delete(:start_page)
+          super
+          @options[:extensions]&.each(&method(:validate_extension))
         end
 
         #
@@ -56,9 +67,9 @@ module Selenium
         #
 
         def add_extension_path(path)
-          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
-
-          @extension_paths << path
+          validate_extension(path)
+          @options[:extension_paths] ||= []
+          @options[:extension_paths] << path
         end
 
         #
@@ -66,13 +77,13 @@ module Selenium
         #
 
         def as_json(*)
-          opts = {}
+          generate_as_json(super)
+        end
 
-          opts['ms:inPrivate'] = true if @in_private
-          opts['ms:extensionPaths'] = @extension_paths if @extension_paths.any?
-          opts['ms:startPage'] = @start_page if @start_page
+        private
 
-          opts
+        def validate_extension(path)
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
         end
       end # Options
     end # Edge

data/lib/selenium/webdriver/{edge → edge_html}/service.rb

@@ -19,7 +19,7 @@
 
 module Selenium
   module WebDriver
-    module Edge
+    module EdgeHtml
       #
       # @api private
       #

data/lib/selenium/webdriver/firefox.rb

@@ -21,19 +21,18 @@ require 'timeout'
 require 'socket'
 require 'rexml/document'
 
-require 'selenium/webdriver/firefox/driver'
-
-require 'selenium/webdriver/firefox/extension'
-require 'selenium/webdriver/firefox/binary'
-require 'selenium/webdriver/firefox/profiles_ini'
-require 'selenium/webdriver/firefox/profile'
-require 'selenium/webdriver/firefox/bridge'
-require 'selenium/webdriver/firefox/driver'
-require 'selenium/webdriver/firefox/options'
-
 module Selenium
   module WebDriver
     module Firefox
+      autoload :Extension, 'selenium/webdriver/firefox/extension'
+      autoload :Binary, 'selenium/webdriver/firefox/binary'
+      autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
+      autoload :Profile, 'selenium/webdriver/firefox/profile'
+      autoload :Bridge, 'selenium/webdriver/firefox/bridge'
+      autoload :Driver, 'selenium/webdriver/firefox/driver'
+      autoload :Options, 'selenium/webdriver/firefox/options'
+      autoload :Service, 'selenium/webdriver/firefox/service'
+
       DEFAULT_PORT = 7055
       DEFAULT_ENABLE_NATIVE_EVENTS = Platform.os == :windows
       DEFAULT_SECURE_SSL = false
@@ -58,5 +57,3 @@ module Selenium
     end # Firefox
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/firefox/service'

data/lib/selenium/webdriver/firefox/binary.rb

@@ -53,8 +53,8 @@ module Selenium
             @path = Platform.cygwin_path(@path, windows: true) if Platform.cygwin?
 
             unless File.file?(@path.to_s)
-              error = "Could not find Firefox binary (os=#{Platform.os}). "
-              error << "Make sure Firefox is installed or set the path manually with #{self}.path="
+              error = "Could not find Firefox binary (os=#{Platform.os}). " \
+                      "Make sure Firefox is installed or set the path manually with #{self}.path="
               raise Error::WebDriverError, error
             end
 

data/lib/selenium/webdriver/firefox/driver.rb

@@ -32,16 +32,17 @@ module Selenium
         include DriverExtensions::TakesScreenshot
 
         def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
+          opts[:desired_capabilities] ||= Remote::Capabilities.firefox
 
           opts[:url] ||= service_url(opts)
 
           listener = opts.delete(:listener)
           desired_capabilities = opts.delete(:desired_capabilities)
+          options = opts.delete(:options)
 
           @bridge = Remote::Bridge.new(opts)
           @bridge.extend Bridge
-          @bridge.create_session(desired_capabilities)
+          @bridge.create_session(desired_capabilities, options)
 
           super(@bridge, listener: listener)
         end
@@ -49,23 +50,6 @@ module Selenium
         def browser
           :firefox
         end
-
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        private
-
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.firefox }
-          options = opts.delete(:options) { Options.new }
-          options = options.as_json
-          caps.merge!(options) unless options.empty?
-
-          caps
-        end
       end # Driver
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/extension.rb

@@ -87,6 +87,14 @@ module Selenium
           return unless File.exist?(manifest_path)
 
           manifest = JSON.parse(File.read(manifest_path))
+          applications_gecko_id(manifest) || name_and_version(manifest)
+        end
+
+        def applications_gecko_id(manifest)
+          manifest.dig('applications', 'gecko', 'id')&.strip
+        end
+
+        def name_and_version(manifest)
           [manifest['name'].delete(' '), manifest['version']].join('@')
         end
       end # Extension

data/lib/selenium/webdriver/firefox/options.rb

@@ -20,12 +20,26 @@
 module Selenium
   module WebDriver
     module Firefox
-      class Options
-        attr_reader :args, :prefs, :options, :profile
-        attr_accessor :binary, :log_level
-
+      class Options < WebDriver::Options
         KEY = 'moz:firefoxOptions'
 
+        # see: https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html
+        CAPABILITIES = {binary: 'binary',
+                        args: 'args',
+                        profile: 'profile',
+                        log: 'log',
+                        prefs: 'prefs'}.freeze
+
+        CAPABILITIES.each_key do |key|
+          define_method key do
+            @options[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @options[key] = value
+          end
+        end
+
         #
         # Create a new Options instance, only for W3C-capable versions of Firefox.
         #
@@ -42,13 +56,11 @@ module Selenium
         # @option opts [Hash] :options A hash for raw options
         #
 
-        def initialize(**opts)
-          @args = Set.new(opts.delete(:args) || [])
-          @binary = opts.delete(:binary)
-          @profile = process_profile(opts.delete(:profile))
-          @log_level = opts.delete(:log_level)
-          @prefs = opts.delete(:prefs) || {}
-          @options = opts.delete(:options) || {}
+        def initialize(log_level: nil, **opts)
+          super(opts)
+
+          @options[:log] ||= {level: log_level} if log_level
+          process_profile(@options[:profile]) if @options.key?(:profile)
         end
 
         #
@@ -62,22 +74,8 @@ module Selenium
         #
 
         def add_argument(arg)
-          @args << arg
-        end
-
-        #
-        # Add a new option not yet handled by these bindings.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Firefox::Options.new
-        #   options.add_option(:foo, 'bar')
-        #
-        # @param [String, Symbol] name Name of the option
-        # @param [Boolean, String, Integer] value Value of the option
-        #
-
-        def add_option(name, value)
-          @options[name] = value
+          @options[:args] ||= []
+          @options[:args] << arg
         end
 
         #
@@ -92,7 +90,8 @@ module Selenium
         #
 
         def add_preference(name, value)
-          prefs[name] = value
+          @options[:prefs] ||= {}
+          @options[:prefs][name] = value
         end
 
         #
@@ -122,8 +121,17 @@ module Selenium
         # @param [Profile, String] profile Profile to be used
         #
 
+        undef profile=
         def profile=(profile)
-          @profile = process_profile(profile)
+          process_profile(profile)
+        end
+
+        def log_level
+          @options.dig(:log, :level)
+        end
+
+        def log_level=(level)
+          @options[:log] = {level: level}
         end
 
         #
@@ -131,30 +139,19 @@ module Selenium
         #
 
         def as_json(*)
-          opts = @options
-
-          opts[:profile] = @profile.encoded if @profile
-          opts[:args] = @args.to_a if @args.any?
-          opts[:binary] = @binary if @binary
-          opts[:prefs] = @prefs unless @prefs.empty?
-          opts[:log] = {level: @log_level} if @log_level
-
-          {KEY => opts}
+          {KEY => generate_as_json(super)}
         end
 
         private
 
         def process_profile(profile)
-          return unless profile
-
-          case profile
-          when Profile
-            profile
-          when String
-            Profile.from_name(profile)
-          else
-            raise Error::WebDriverError, "don't know how to handle profile: #{profile.inspect}"
-          end
+          @options[:profile] = if profile.nil?
+                                 nil
+                               elsif profile.is_a? Profile
+                                 profile
+                               else
+                                 Profile.from_name(profile)
+                               end
         end
       end # Options
     end # Firefox

data/lib/selenium/webdriver/firefox/profile.rb

@@ -53,6 +53,10 @@ module Selenium
               File.read(File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/prefs.json"))
             ).freeze
           end
+
+          def decoded(json)
+            JSON.parse(json)
+          end
         end
 
         #
@@ -178,9 +182,7 @@ module Selenium
           end
         end
 
-        def encoded
-          Zipper.zip(layout_on_disk)
-        end
+        alias_method :as_json, :encoded
 
         private
 

data/lib/selenium/webdriver/ie.rb

@@ -17,12 +17,13 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/ie/driver'
-require 'selenium/webdriver/ie/options'
-
 module Selenium
   module WebDriver
     module IE
+      autoload :Driver, 'selenium/webdriver/ie/driver'
+      autoload :Options, 'selenium/webdriver/ie/options'
+      autoload :Service, 'selenium/webdriver/ie/service'
+
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
                                    'Selenium::WebDriver::IE::Service#driver_path='
@@ -37,5 +38,3 @@ module Selenium
     end # IE
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/ie/service'

data/lib/selenium/webdriver/ie/driver.rb

@@ -32,15 +32,16 @@ module Selenium
         include DriverExtensions::TakesScreenshot
 
         def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
+          opts[:desired_capabilities] ||= Remote::Capabilities.internet_explorer
 
           opts[:url] ||= service_url(opts)
 
           listener = opts.delete(:listener)
           desired_capabilities = opts.delete(:desired_capabilities)
+          options = opts.delete(:options)
 
           @bridge = Remote::Bridge.new(opts)
-          @bridge.create_session(desired_capabilities)
+          @bridge.create_session(desired_capabilities, options)
 
           super(@bridge, listener: listener)
         end
@@ -48,24 +49,6 @@ module Selenium
         def browser
           :internet_explorer
         end
-
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        private
-
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.internet_explorer }
-          options = opts.delete(:options) { Options.new }
-          options = options.as_json
-          caps.merge!(options) unless options.empty?
-
-          caps
-        end
-
       end # Driver
     end # IE
   end # WebDriver