selenium-webdriver 4.0.0.alpha2 → 4.0.0

data/lib/selenium/webdriver/safari.rb

@@ -17,20 +17,28 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/safari/bridge'
-require 'selenium/webdriver/safari/driver'
-require 'selenium/webdriver/safari/options'
-
 module Selenium
   module WebDriver
     module Safari
+      autoload :Features, 'selenium/webdriver/safari/features'
+      autoload :Driver, 'selenium/webdriver/safari/driver'
+      autoload :Options, 'selenium/webdriver/safari/options'
+      autoload :Service, 'selenium/webdriver/safari/service'
+
       class << self
+        attr_accessor :use_technology_preview
+
         def technology_preview
           "/Applications/Safari\ Technology\ Preview.app/Contents/MacOS/safaridriver"
         end
 
         def technology_preview!
           Service.driver_path = technology_preview
+          @use_technology_preview = true
+        end
+
+        def technology_preview?
+          use_technology_preview
         end
 
         def path=(path)
@@ -48,18 +56,18 @@ module Selenium
 
         def driver_path=(path)
           WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path=',
-                                     'Selenium::WebDriver::Safari::Service#driver_path='
+                                     'Selenium::WebDriver::Safari::Service#driver_path=',
+                                     id: :driver_path
           Selenium::WebDriver::Safari::Service.driver_path = path
         end
 
         def driver_path
           WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path',
-                                     'Selenium::WebDriver::Safari::Service#driver_path'
+                                     'Selenium::WebDriver::Safari::Service#driver_path',
+                                     id: :driver_path
           Selenium::WebDriver::Safari::Service.driver_path
         end
       end
     end # Safari
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/safari/service'

data/lib/selenium/webdriver/support/block_event_listener.rb

@@ -25,7 +25,7 @@ module Selenium
           @callback = callback
         end
 
-        def method_missing(meth, *args) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+        def method_missing(meth, *args) # rubocop:disable Style/MissingRespondToMissing
           @callback.call meth, *args
         end
       end # BlockEventListener

data/lib/selenium/webdriver/support/cdp/domain.rb.erb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module DevTools
+    module <%= version %>
+      class <%= domain[:domain] %>
+        <% if domain[:events] %>
+        EVENTS = {
+          <% domain[:events].each do |event| %>
+          <%= h.snake_case(event[:name]) %>: '<%= event[:name] %>',
+          <% end %>
+        }.freeze
+        <% end %>
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["<%= domain[:domain] %>.#{event}"] << block
+        end
+
+        <% domain[:commands].each do |command| %>
+        <% if command[:parameters] %>
+        def <%= h.snake_case(command[:name]) %>(<%= h.kwargs(command[:parameters]) %>)
+        <% else %>
+        def <%= h.snake_case(command[:name]) %>
+        <% end %>
+          <% if command[:parameters] %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>',
+            <% until command[:parameters].empty? %>
+              <% parameter = command[:parameters].shift %>
+                             <%= parameter[:name] %>: <%= h.snake_case(parameter[:name]) %><%= command[:parameters].empty? ? ')' : ',' %>
+            <% end %>
+          <% else %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>')
+          <% end %>
+        end
+
+        <% end %>
+      end # <%= domain[:domain] %>
+    end # <%= version %>
+  end # DevTools
+end # Selenium

data/lib/selenium/webdriver/support/cdp_client_generator.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'erb'
+require 'fileutils'
+require 'json'
+
+module Selenium
+  module WebDriver
+    module Support
+      class CDPClientGenerator
+        # Input JSON files are generated from PDL tasks.
+        TEMPLATE_PATH = File.expand_path('cdp/domain.rb.erb', __dir__)
+
+        RESERVED_KEYWORDS = %w[end].freeze
+
+        def call(output_dir:, version:, browser_protocol_path: nil, js_protocol_path: nil, loader_path: nil, **)
+          @template = ERB.new(File.read(TEMPLATE_PATH))
+          @output_dir = output_dir
+          @loader_path = loader_path || "#{@output_dir}.rb"
+          @version = version
+
+          browser_protocol_path ||= File.expand_path('cdp/browser_protocol.json', __dir__)
+          js_protocol_path ||= File.expand_path('cdp/js_protocol.json', __dir__)
+
+          browser_protocol = JSON.parse(File.read(browser_protocol_path), symbolize_names: true)
+          js_protocol = JSON.parse(File.read(js_protocol_path), symbolize_names: true)
+
+          FileUtils.mkdir_p(@output_dir)
+
+          browser_protocol[:domains].each(&method(:process_domain))
+          js_protocol[:domains].each(&method(:process_domain))
+          require_file
+        end
+
+        def process_domain(domain)
+          result = @template.result_with_hash(domain: domain, version: @version.upcase, h: self)
+          filename = File.join(@output_dir, "#{snake_case(domain[:domain])}.rb")
+          File.write(filename, remove_empty_lines(result))
+        end
+
+        def snake_case(string)
+          name = string.gsub('JavaScript', 'Javascript')
+                       .gsub(/([A-Z]+)([A-Z][a-z]{2,})/, '\1_\2')
+                       .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                       .downcase
+          # Certain CDP parameters conflict with Ruby keywords
+          # so we prefix the name with underscore.
+          name = "_#{name}" if RESERVED_KEYWORDS.include?(name)
+
+          name
+        end
+
+        def kwargs(parameters)
+          parameters = parameters.map do |parameter|
+            if parameter[:optional]
+              "#{snake_case(parameter[:name])}: nil"
+            else
+              "#{snake_case(parameter[:name])}:"
+            end
+          end
+          parameters.join(', ')
+        end
+
+        def remove_empty_lines(string)
+          string.split("\n").reject { |l| l =~ /^\s+$/ }.join("\n")
+        end
+
+        def require_file
+          # rubocop:disable Lint/InterpolationCheck
+          dynamic_location = '#{File.dirname(File.absolute_path(__FILE__))}'
+          # rubocop:enable Lint/InterpolationCheck
+
+          require_all = "Dir.glob(\"#{dynamic_location}/#{@version}/*\", &method(:require))"
+          File.open(@loader_path, 'w') { |file| file.write(require_all) }
+        end
+      end
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  browser_protocol_path, js_protocol_path, output_dir, loader_path, version = *ARGV
+
+  Selenium::WebDriver::Support::CDPClientGenerator.new.call(
+    browser_protocol_path: browser_protocol_path,
+    js_protocol_path: js_protocol_path,
+    output_dir: output_dir,
+    loader_path: loader_path,
+    version: version
+  )
+end

data/lib/selenium/webdriver/support/color.rb

@@ -72,7 +72,7 @@ module Selenium
           end
         end
 
-        def self.from_hsl(h, s, l, a) # rubocop:disable Naming/UncommunicativeMethodParamName
+        def self.from_hsl(h, s, l, a) # rubocop:disable Naming/MethodParameterName
           h = Float(h) / 360
           s = Float(s) / 100
           l = Float(l) / 100
@@ -138,7 +138,7 @@ module Selenium
         end
 
         def hex
-          format '#%02x%02x%02x', red, green, blue
+          format '#%<red>02x%<green>02x%<blue>02x', red: red, green: green, blue: blue
         end
       end # Color
     end # Support

data/lib/selenium/webdriver/support/event_firing_bridge.rb

@@ -76,7 +76,7 @@ module Selenium
             @delegate.find_element_by how, what, parent
           end
 
-          Element.new self, e.ref
+          Element.new self, e.ref.last
         end
 
         def find_elements_by(how, what, parent = nil)
@@ -84,7 +84,7 @@ module Selenium
             @delegate.find_elements_by(how, what, parent)
           end
 
-          es.map { |e| Element.new self, e.ref }
+          es.map { |e| Element.new self, e.ref.last }
         end
 
         def execute_script(script, *args)
@@ -109,7 +109,7 @@ module Selenium
         end
 
         def driver
-          @driver ||= Driver.new(self)
+          @driver ||= Driver.new(bridge: self)
         end
 
         def dispatch(name, *args)
@@ -120,7 +120,7 @@ module Selenium
           returned
         end
 
-        def method_missing(meth, *args, &blk) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+        def method_missing(meth, *args, &blk) # rubocop:disable Style/MissingRespondToMissing
           @delegate.__send__(meth, *args, &blk)
         end
       end # EventFiringBridge

data/lib/selenium/webdriver/support/guards/guard.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Support
+      class Guards
+
+        #
+        # Guard derived from RSpec example metadata.
+        # @api private
+        #
+
+        class Guard
+
+          attr_reader :guarded, :type, :messages, :reason
+
+          def initialize(guarded, type, guards = nil)
+            @guarded = guarded
+            @tracker = guards&.bug_tracker || ''
+            @messages = guards&.messages || {}
+            @messages[:unknown] = 'TODO: Investigate why this is failing and file a bug report'
+            @type = type
+
+            @reason = @guarded.delete(:reason)
+          end
+
+          def message
+            details = case @reason
+                      when Integer
+                        "Bug Filed: #{@tracker}/#{@reason}"
+                      when Symbol
+                        @messages[@reason]
+                      when String
+                        @reason
+                      else
+                        'no reason given'
+                      end
+
+            case @type
+            when :exclude
+              "Test not guarded because it breaks test run; #{details}"
+            when :exclusive
+              "Test does not apply to this configuration; #{details}"
+            else
+              "Test guarded; #{details}"
+            end
+          end
+
+          # Bug is present on all configurations specified
+          def except?
+            @type == :except
+          end
+
+          # Bug is present on all configurations not specified
+          def only?
+            @type == :only
+          end
+
+          # Bug is present on all configurations specified, but test can not be run because it breaks other tests
+          def exclude?
+            @type == :exclude
+          end
+
+          # Test only applies to configurations specified
+          def exclusive?
+            @type == :exclusive
+          end
+        end # Guard
+      end # Guards
+    end # Support
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/support/guards/guard_condition.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Support
+      class Guards
+
+        #
+        # Guard derived from RSpec example metadata.
+        # @api private
+        #
+
+        class GuardCondition
+          attr_accessor :name, :execution
+
+          def initialize(name, condition = nil, &blk)
+            @name = name
+            @execution = if block_given?
+                           proc(&blk)
+                         else
+                           proc { |guarded| guarded.include?(condition) }
+                         end
+          end
+
+          def satisfied?(guard)
+            list = Array(guard.guarded[@name])
+
+            list.empty? || @execution.call(list)
+          end
+
+        end # GuardCondition
+      end # Guards
+    end # Support
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/support/guards.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require_relative 'guards/guard_condition'
+require_relative 'guards/guard'
+
+module Selenium
+  module WebDriver
+    module Support
+      class Guards
+        GUARD_TYPES = %i[except only exclude exclusive].freeze
+
+        attr_reader :messages
+        attr_accessor :bug_tracker
+
+        def initialize(example, bug_tracker: '', conditions: nil)
+          @example = example
+          @bug_tracker = bug_tracker
+          @guard_conditions = conditions || []
+          @guards = collect_example_guards
+          @messages = {}
+        end
+
+        def add_condition(name, condition = nil, &blk)
+          @guard_conditions << GuardCondition.new(name, condition, &blk)
+        end
+
+        def add_message(name, message)
+          @messages[name] = message
+        end
+
+        def disposition
+          if !skipping_guard.nil?
+            [:skip, skipping_guard.message]
+          elsif !pending_guard.nil? && ENV['SKIP_PENDING']
+            [:skip, pending_guard.message]
+          elsif !pending_guard.nil?
+            [:pending, pending_guard.message]
+          end
+        end
+
+        def satisfied?(guard)
+          @guard_conditions.all? { |condition| condition.satisfied?(guard) }
+        end
+
+        private
+
+        def collect_example_guards
+          guards = []
+
+          GUARD_TYPES.each do |guard_type|
+            example_group = @example.metadata[:example_group]
+            example_guards = [@example.metadata[guard_type], example_group[guard_type]]
+            while example_group[:parent_example_group]
+              example_group = example_group[:parent_example_group]
+              example_guards << example_group[guard_type]
+            end
+
+            example_guards.flatten.uniq.compact.each do |example_guard|
+              guards << Guard.new(example_guard, guard_type, self)
+            end
+          end
+
+          guards
+        end
+
+        def skipping_guard
+          @guards.select(&:exclusive?).find { |guard| !satisfied?(guard) } ||
+            @guards.select(&:exclude?).find { |guard| satisfied?(guard) }
+        end
+
+        def pending_guard
+          @guards.select(&:except?).find { |guard| satisfied?(guard) } ||
+            @guards.select(&:only?).find { |guard| !satisfied?(guard) }
+        end
+      end # Guards
+    end # Support
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/support/relative_locator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Support
+
+      #
+      # @api private
+      #
+
+      class RelativeLocator
+        KEYS = %w[above below left right near distance].freeze
+
+        def initialize(locator)
+          @filters, @root = locator.partition { |how, _| KEYS.include?(how) }.map(&:to_h)
+        end
+
+        def as_json
+          {
+            relative: {
+              root: @root,
+              filters: @filters.map do |kind, filter|
+                {
+                  kind: kind,
+                  args: [filter]
+                }
+              end
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/selenium/webdriver/support/select.rb

@@ -31,7 +31,7 @@ module Selenium
           raise ArgumentError, "unexpected tag name #{tag_name.inspect}" unless tag_name.casecmp('select').zero?
 
           @element = element
-          @multi = ![nil, 'false'].include?(element.attribute(:multiple))
+          @multi = ![nil, 'false'].include?(element.dom_attribute(:multiple))
         end
 
         #
@@ -258,7 +258,7 @@ module Selenium
         end
 
         def find_by_index(index)
-          options.select { |option| option.attribute(:index) == index.to_s }
+          options.select { |option| option.dom_attribute(:index) == index.to_s }
         end
 
         def find_by_value(value)

data/lib/selenium/webdriver/support.rb

@@ -23,3 +23,4 @@ require 'selenium/webdriver/support/block_event_listener'
 require 'selenium/webdriver/support/escaper'
 require 'selenium/webdriver/support/select'
 require 'selenium/webdriver/support/color'
+require 'selenium/webdriver/support/relative_locator'

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.0.0.alpha2'
+    VERSION = '4.0.0'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -23,9 +23,10 @@ require 'fileutils'
 require 'date'
 require 'json'
 require 'set'
+require 'uri'
 
-require 'selenium/webdriver/common'
 require 'selenium/webdriver/atoms'
+require 'selenium/webdriver/common'
 require 'selenium/webdriver/version'
 
 module Selenium
@@ -35,13 +36,14 @@ module Selenium
     Rectangle = Struct.new(:x, :y, :width, :height)
     Location  = Struct.new(:latitude, :longitude, :altitude)
 
-    autoload :Chrome,    'selenium/webdriver/chrome'
-    autoload :Edge,      'selenium/webdriver/edge'
-    autoload :Firefox,   'selenium/webdriver/firefox'
-    autoload :IE,        'selenium/webdriver/ie'
-    autoload :Remote,    'selenium/webdriver/remote'
-    autoload :Safari,    'selenium/webdriver/safari'
-    autoload :Support,   'selenium/webdriver/support'
+    autoload :Chrome,     'selenium/webdriver/chrome'
+    autoload :DevTools,   'selenium/webdriver/devtools'
+    autoload :Edge,       'selenium/webdriver/edge'
+    autoload :Firefox,    'selenium/webdriver/firefox'
+    autoload :IE,         'selenium/webdriver/ie'
+    autoload :Remote,     'selenium/webdriver/remote'
+    autoload :Safari,     'selenium/webdriver/safari'
+    autoload :Support,    'selenium/webdriver/support'
 
     # @api private