selenium-webdriver 2.45.0 → 3.142.7

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

@@ -0,0 +1,43 @@
+# 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
+      module Escaper
+        def self.escape(str)
+          if str.include?('"') && str.include?("'")
+            parts = str.split('"', -1).map { |part| %("#{part}") }
+
+            quoted = parts.join(%(, '"', ))
+                          .gsub(/^"", |, ""$/, '')
+
+            "concat(#{quoted})"
+          elsif str.include?('"')
+            # escape string with just a quote into being single quoted: f"oo -> 'f"oo'
+            "'#{str}'"
+          else
+            # otherwise return the quoted string
+            %("#{str}")
+          end
+        end
+      end # Escaper
+    end # Support
+  end # WebDriver
+end # Selenium

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

@@ -1,7 +1,25 @@
+# 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
       #
@@ -10,69 +28,69 @@ module Selenium
         def initialize(delegate, listener)
           @delegate = delegate
 
-          if listener.respond_to? :call
-            @listener = BlockEventListener.new(listener)
-          else
-            @listener = listener
-          end
+          @listener = if listener.respond_to? :call
+                        BlockEventListener.new(listener)
+                      else
+                        listener
+                      end
         end
 
         def get(url)
-          dispatch(:navigate_to, url, driver) {
+          dispatch(:navigate_to, url, driver) do
             @delegate.get(url)
-          }
+          end
         end
 
-        def goForward
-          dispatch(:navigate_forward, driver) {
-            @delegate.goForward
-          }
+        def go_forward
+          dispatch(:navigate_forward, driver) do
+            @delegate.go_forward
+          end
         end
 
-        def goBack
-          dispatch(:navigate_back, driver) {
-            @delegate.goBack
-          }
+        def go_back
+          dispatch(:navigate_back, driver) do
+            @delegate.go_back
+          end
         end
 
-        def clickElement(ref)
-          dispatch(:click, create_element(ref), driver) {
-            @delegate.clickElement(ref)
-          }
+        def click_element(ref)
+          dispatch(:click, create_element(ref), driver) do
+            @delegate.click_element(ref)
+          end
         end
 
-        def clearElement(ref)
-          dispatch(:change_value_of, create_element(ref), driver) {
-            @delegate.clearElement(ref)
-          }
+        def clear_element(ref)
+          dispatch(:change_value_of, create_element(ref), driver) do
+            @delegate.clear_element(ref)
+          end
         end
 
-        def sendKeysToElement(ref, keys)
-          dispatch(:change_value_of, create_element(ref), driver) {
-            @delegate.sendKeysToElement(ref, keys)
-          }
+        def send_keys_to_element(ref, keys)
+          dispatch(:change_value_of, create_element(ref), driver) do
+            @delegate.send_keys_to_element(ref, keys)
+          end
         end
 
         def find_element_by(how, what, parent = nil)
-          e = dispatch(:find, how, what, driver) {
+          e = dispatch(:find, how, what, driver) do
             @delegate.find_element_by how, what, parent
-          }
+          end
 
           Element.new self, e.ref
         end
 
         def find_elements_by(how, what, parent = nil)
-          es = dispatch(:find, how, what, driver) {
+          es = dispatch(:find, how, what, driver) do
             @delegate.find_elements_by(how, what, parent)
-          }
+          end
 
           es.map { |e| Element.new self, e.ref }
         end
 
-        def executeScript(script, *args)
-          dispatch(:execute_script, script, driver) {
-            @delegate.executeScript(script, *args)
-          }
+        def execute_script(script, *args)
+          dispatch(:execute_script, script, driver) do
+            @delegate.execute_script(script, *args)
+          end
         end
 
         def quit
@@ -94,7 +112,7 @@ module Selenium
           @driver ||= Driver.new(self)
         end
 
-        def dispatch(name, *args, &blk)
+        def dispatch(name, *args)
           @listener.__send__("before_#{name}", *args)
           returned = yield
           @listener.__send__("after_#{name}", *args)
@@ -102,11 +120,10 @@ module Selenium
           returned
         end
 
-        def method_missing(meth, *args, &blk)
+        def method_missing(meth, *args, &blk) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
           @delegate.__send__(meth, *args, &blk)
         end
       end # EventFiringBridge
-
     end # Support
   end # WebDriver
 end # Selenium

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

@@ -1,8 +1,26 @@
+# 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 Select
-
         #
         # @param [Element] element The select element to use
         #
@@ -10,12 +28,10 @@ module Selenium
         def initialize(element)
           tag_name = element.tag_name
 
-          unless tag_name.downcase == "select"
-            raise ArgumentError, "unexpected tag name #{tag_name.inspect}"
-          end
+          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.attribute(:multiple))
         end
 
         #
@@ -35,7 +51,7 @@ module Selenium
         #
 
         def options
-          @element.find_elements :tag_name, 'option'
+          @element.find_elements tag_name: 'option'
         end
 
         #
@@ -45,7 +61,7 @@ module Selenium
         #
 
         def selected_options
-          options.select { |e| e.selected? }
+          options.select(&:selected?)
         end
 
         #
@@ -56,8 +72,10 @@ module Selenium
         #
 
         def first_selected_option
-          option = options.find { |e| e.selected? }
-          option or raise Error::NoSuchElementError, 'no options are selected'
+          option = options.find(&:selected?)
+          return option if option
+
+          raise Error::NoSuchElementError, 'no options are selected'
         end
 
         #
@@ -98,6 +116,7 @@ module Selenium
         #
         # @param [:text, :index, :value] how How to find the option
         # @param [String] what What value to find the option by.
+        # @raise [Error::UnsupportedOperationError] if the element does not support multiple selections.
         #
         # @see Select#select_by
         #
@@ -122,9 +141,7 @@ module Selenium
         #
 
         def select_all
-          unless multiple?
-            raise Error::UnsupportedOperationError, 'you may only select all options of a multi-select'
-          end
+          raise Error::UnsupportedOperationError, 'you may only select all options of a multi-select' unless multiple?
 
           options.each { |e| select_option e }
         end
@@ -136,9 +153,7 @@ module Selenium
         #
 
         def deselect_all
-          unless multiple?
-            raise Error::UnsupportedOperationError, 'you may only deselect all options of a multi-select'
-          end
+          raise Error::UnsupportedOperationError, 'you may only deselect all options of a multi-select' unless multiple?
 
           options.each { |e| deselect_option e }
         end
@@ -148,65 +163,57 @@ module Selenium
         def select_by_text(text)
           opts = find_by_text text
 
-          if opts.empty?
-            raise Error::NoSuchElementError, "cannot locate element with text: #{text.inspect}"
-          end
+          return select_options(opts) unless opts.empty?
 
-          select_options opts
+          raise Error::NoSuchElementError, "cannot locate element with text: #{text.inspect}"
         end
 
         def select_by_index(index)
           opts = find_by_index index
 
-          if opts.empty?
-            raise Error::NoSuchElementError, "cannot locate element with index: #{index.inspect}"
-          end
+          return select_option(opts.first) unless opts.empty?
 
-          select_options opts
+          raise Error::NoSuchElementError, "cannot locate element with index: #{index.inspect}"
         end
 
         def select_by_value(value)
           opts = find_by_value value
 
-          if opts.empty?
-            raise Error::NoSuchElementError, "cannot locate option with value: #{value.inspect}"
-          end
+          return select_options(opts) unless opts.empty?
 
-          select_options opts
+          raise Error::NoSuchElementError, "cannot locate option with value: #{value.inspect}"
         end
 
         def deselect_by_text(text)
+          raise Error::UnsupportedOperationError, 'you may only deselect option of a multi-select' unless multiple?
+
           opts = find_by_text text
 
-          if opts.empty?
-            raise Error::NoSuchElementError, "cannot locate element with text: #{text.inspect}"
-          end
+          return deselect_options(opts) unless opts.empty?
 
-          deselect_options opts
+          raise Error::NoSuchElementError, "cannot locate element with text: #{text.inspect}"
         end
 
         def deselect_by_value(value)
+          raise Error::UnsupportedOperationError, 'you may only deselect option of a multi-select' unless multiple?
+
           opts = find_by_value value
 
-          if opts.empty?
-            raise Error::NoSuchElementError, "cannot locate option with value: #{value.inspect}"
-          end
+          return deselect_options(opts) unless opts.empty?
 
-          deselect_options opts
+          raise Error::NoSuchElementError, "cannot locate option with value: #{value.inspect}"
         end
 
         def deselect_by_index(index)
+          raise Error::UnsupportedOperationError, 'you may only deselect option of a multi-select' unless multiple?
+
           opts = find_by_index index
 
-          if opts.empty?
-            raise Error::NoSuchElementError, "cannot locate option with index: #{index}"
-          end
+          return deselect_option(opts.first) unless opts.empty?
 
-          deselect_options opts
+          raise Error::NoSuchElementError, "cannot locate option with index: #{index}"
         end
 
-        private
-
         def select_option(option)
           option.click unless option.selected?
         end
@@ -233,61 +240,31 @@ module Selenium
 
         def find_by_text(text)
           xpath = ".//option[normalize-space(.) = #{Escaper.escape text}]"
-          opts = @element.find_elements(:xpath, xpath)
-
-          if opts.empty? && text =~ /\s+/
-            longest_word = text.split(/\s+/).max_by { |item| item.length }
-
-            if longest_word.empty?
-              candidates = options
-            else
-              xpath = ".//option[contains(., #{Escaper.escape longest_word})]"
-              candidates = @element.find_elements(:xpath, xpath)
-            end
-
-            if multiple?
-              candidates.select { |option| text == option.text }
-            else
-              Array(candidates.find { |option| text == option.text })
-            end
+          opts = @element.find_elements(xpath: xpath)
+
+          return opts unless opts.empty? && text =~ /\s+/
+
+          longest_word = text.split(/\s+/).max_by(&:length)
+          if longest_word.empty?
+            candidates = options
           else
-            opts
+            xpath = ".//option[contains(., #{Escaper.escape longest_word})]"
+            candidates = @element.find_elements(xpath: xpath)
           end
+
+          return Array(candidates.find { |option| text == option.text }) unless multiple?
+
+          candidates.select { |option| text == option.text }
         end
 
         def find_by_index(index)
-          index = index.to_s
-          options.select { |option| option.attribute(:index) == index }
+          options.select { |option| option.attribute(:index) == index.to_s }
         end
 
         def find_by_value(value)
-          @element.find_elements(:xpath, ".//option[@value = #{Escaper.escape value}]")
+          @element.find_elements(xpath: ".//option[@value = #{Escaper.escape value}]")
         end
-
-        #
-        # @api private
-        #
-
-        module Escaper
-          def self.escape(str)
-            if str.include?('"') && str.include?("'")
-              parts = str.split('"', -1).map { |part| %{"#{part}"} }
-
-              quoted = parts.join(%{, '"', }).
-                             gsub(/^"", |, ""$/, '')
-
-              "concat(#{quoted})"
-            elsif str.include?('"')
-              # escape string with just a quote into being single quoted: f"oo -> 'f"oo'
-              "'#{str}'"
-            else
-              # otherwise return the quoted string
-              %{"#{str}"}
-            end
-          end
-        end # Escaper
-
       end # Select
-    end
-  end
-end
+    end # Support
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/support.rb

@@ -1,5 +1,25 @@
+# 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 'selenium/webdriver/support/event_firing_bridge'
 require 'selenium/webdriver/support/abstract_event_listener'
 require 'selenium/webdriver/support/block_event_listener'
+require 'selenium/webdriver/support/escaper'
 require 'selenium/webdriver/support/select'
 require 'selenium/webdriver/support/color'

data/lib/selenium/webdriver/version.rb

@@ -0,0 +1,24 @@
+# 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
+    VERSION = '3.142.7'
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver.rb

@@ -1,25 +1,44 @@
+# 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 'childprocess'
 require 'tmpdir'
 require 'fileutils'
 require 'date'
+require 'json'
+require 'set'
 
-require 'multi_json'
 require 'selenium/webdriver/common'
+require 'selenium/webdriver/atoms'
+require 'selenium/webdriver/version'
 
 module Selenium
   module WebDriver
-    extend JsonHelper
-
     Point     = Struct.new(:x, :y)
     Dimension = Struct.new(:width, :height)
+    Rectangle = Struct.new(:x, :y, :width, :height)
     Location  = Struct.new(:latitude, :longitude, :altitude)
 
-    autoload :Android,   'selenium/webdriver/android'
     autoload :Chrome,    'selenium/webdriver/chrome'
+    autoload :Edge,      'selenium/webdriver/edge'
     autoload :Firefox,   'selenium/webdriver/firefox'
     autoload :IE,        'selenium/webdriver/ie'
-    autoload :IPhone,    'selenium/webdriver/iphone'
-    autoload :Opera,     'selenium/webdriver/opera'
     autoload :PhantomJS, 'selenium/webdriver/phantomjs'
     autoload :Remote,    'selenium/webdriver/remote'
     autoload :Safari,    'selenium/webdriver/safari'
@@ -28,37 +47,39 @@ module Selenium
     # @api private
 
     def self.root
-      @root ||= File.expand_path("../..", __FILE__)
+      @root ||= File.expand_path('..', __dir__)
     end
 
     #
     # Create a new Driver instance with the correct bridge for the given browser
     #
-    # @param browser [:ie, :internet_explorer, :remote, :chrome, :firefox, :ff, :android, :iphone, :opera, :phantomjs, :safari]
-    #   the driver type to use
-    # @param *rest
-    #   arguments passed to Bridge.new
+    # @overload for(browser)
+    #   @param [:ie, :internet_explorer, :edge, :remote, :chrome, :firefox, :ff, :phantomjs, :safari] browser The browser to
+    #     create the driver for
+    # @overload for(browser, opts)
+    #   @param [:ie, :internet_explorer, :edge, :remote, :chrome, :firefox, :ff, :phantomjs, :safari] browser The browser to
+    #     create the driver for
+    #   @param [Hash] opts Options passed to Driver.new
     #
     # @return [Driver]
     #
-    # @see Selenium::WebDriver::Remote::Bridge
-    # @see Selenium::WebDriver::Firefox::Bridge
-    # @see Selenium::WebDriver::IE::Bridge
-    # @see Selenium::WebDriver::Chrome::Bridge
-    # @see Selenium::WebDriver::Android::Bridge
-    # @see Selenium::WebDriver::IPhone::Bridge
-    # @see Selenium::WebDriver::Opera::Bridge
-    # @see Selenium::WebDriver::PhantomJS::Bridge
-    # @see Selenium::WebDriver::Safari::Bridge
+    # @see Selenium::WebDriver::Remote::Driver
+    # @see Selenium::WebDriver::Firefox::Driver
+    # @see Selenium::WebDriver::IE::Driver
+    # @see Selenium::WebDriver::Edge::Driver
+    # @see Selenium::WebDriver::Chrome::Driver
+    # @see Selenium::WebDriver::PhantomJS::Driver
+    # @see Selenium::WebDriver::Safari::Driver
     #
     # @example
     #
-    #   WebDriver.for :firefox, :profile => "some-profile"
-    #   WebDriver.for :firefox, :profile => Profile.new
-    #   WebDriver.for :remote,  :url => "http://localhost:4444/wd/hub", :desired_capabilities => caps
+    #   WebDriver.for :firefox, profile: 'some-profile'
+    #   WebDriver.for :firefox, profile: Profile.new
+    #   WebDriver.for :remote,  url: "http://localhost:4444/wd/hub", desired_capabilities: caps
     #
-    # One special argument is not passed on to the bridges, :listener. You can pass a listener for this option
-    # to get notified of WebDriver events. The passed object must respond to #call or implement the methods from AbstractEventListener.
+    # One special argument is not passed on to the bridges, :listener.
+    # You can pass a listener for this option to get notified of WebDriver events.
+    # The passed object must respond to #call or implement the methods from AbstractEventListener.
     #
     # @see Selenium::WebDriver::Support::AbstractEventListener
     #
@@ -67,5 +88,14 @@ module Selenium
       WebDriver::Driver.for(*args)
     end
 
+    #
+    # Returns logger instance that can be used across the whole Selenium.
+    #
+    # @return [Logger]
+    #
+
+    def self.logger
+      @logger ||= WebDriver::Logger.new
+    end
   end # WebDriver
 end # Selenium

data/lib/selenium-webdriver.rb

@@ -1 +1,20 @@
+# 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 'selenium/webdriver'