selenium-webdriver 2.45.0 → 3.142.7

data/lib/selenium/webdriver/common/driver_extensions/has_session_id.rb

@@ -1,13 +1,30 @@
+# 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
-
     #
     # @api private
     #
 
     module DriverExtensions
       module HasSessionId
-
         #
         # @return [String] the session id
         # @api public

data/lib/selenium/webdriver/common/driver_extensions/has_touch_screen.rb

@@ -1,10 +1,28 @@
+# 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 DriverExtensions
-
       module HasTouchScreen
         def touch
-          TouchActionBuilder.new mouse, keyboard, touch_screen
+          TouchActionBuilder.new Mouse.new(@bridge), Keyboard.new(@bridge), touch_screen
         end
 
         private
@@ -12,8 +30,7 @@ module Selenium
         def touch_screen
           TouchScreen.new @bridge
         end
-      end
-
-    end
-  end
-end
+      end # HasTouchScreen
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_web_storage.rb

@@ -1,13 +1,30 @@
+# 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
-
     #
     # @api private
     #
 
     module DriverExtensions
       module HasWebStorage
-
         def local_storage
           HTML5::LocalStorage.new @bridge
         end
@@ -15,7 +32,6 @@ module Selenium
         def session_storage
           HTML5::SessionStorage.new @bridge
         end
-
       end # HasWebStorage
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/rotatable.rb

@@ -1,19 +1,36 @@
+# 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
-
     #
     # @api private
     #
 
     module DriverExtensions
       module Rotatable
-
-        ORIENTATIONS = [:landscape, :portrait]
+        ORIENTATIONS = %i[landscape portrait].freeze
 
         #
         # Change the screen orientation
         #
-        # @param [:landscape, :portrait] Orientation
+        # @param [:landscape, :portrait] orientation
         #
         # @api public
         #
@@ -23,7 +40,7 @@ module Selenium
             raise ArgumentError, "expected #{ORIENTATIONS.inspect}, got #{orientation.inspect}"
           end
 
-          bridge.setScreenOrientation(orientation.to_s.upcase)
+          bridge.screen_orientation = orientation.to_s.upcase
         end
         alias_method :rotate, :rotation=
 
@@ -36,9 +53,8 @@ module Selenium
         #
 
         def orientation
-          bridge.getScreenOrientation.to_sym.downcase
+          bridge.screen_orientation.to_sym.downcase
         end
-
       end # Rotatable
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/takes_screenshot.rb

@@ -1,13 +1,30 @@
+# 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
-
     #
     # @api private
     #
 
     module DriverExtensions
       module TakesScreenshot
-
         #
         # Save a PNG screenshot to the given path
         #
@@ -15,6 +32,11 @@ module Selenium
         #
 
         def save_screenshot(png_path)
+          extension = File.extname(png_path).downcase
+          if extension != '.png'
+            WebDriver.logger.warn "name used for saved screenshot does not match file type. "\
+                                  "It should end with .png extension"
+          end
           File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
         end
 
@@ -29,14 +51,13 @@ module Selenium
         def screenshot_as(format)
           case format
           when :base64
-            bridge.getScreenshot
+            bridge.screenshot
           when :png
-            bridge.getScreenshot.unpack("m")[0]
+            bridge.screenshot.unpack('m')[0]
           else
             raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
           end
         end
-
       end # TakesScreenshot
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/uploads_files.rb

@@ -1,13 +1,30 @@
+# 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
-
     #
     # @api private
     #
 
     module DriverExtensions
       module UploadsFiles
-
         #
         # Set the file detector to pass local files to a remote WebDriver.
         #
@@ -33,13 +50,10 @@ module Selenium
         #
 
         def file_detector=(detector)
-          unless detector.nil? or detector.respond_to? :call
-            raise ArgumentError, "detector must respond to #call"
-          end
+          raise ArgumentError, 'detector must respond to #call' unless detector.nil? || detector.respond_to?(:call)
 
           bridge.file_detector = detector
         end
-
       end # UploadsFiles
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/element.rb

@@ -1,3 +1,22 @@
+# 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
     class Element
@@ -10,15 +29,16 @@ module Selenium
       #
 
       def initialize(bridge, id)
-        @bridge, @id = bridge, id
+        @bridge = bridge
+        @id = id
       end
 
       def inspect
-        '#<%s:0x%x id=%s>' % [self.class, hash*2, @id.inspect]
+        format '#<%<class>s:0x%<hash>x id=%<id>s>', class: self.class, hash: hash * 2, id: @id.inspect
       end
 
       def ==(other)
-        other.kind_of?(self.class) && bridge.elementEquals(self, other)
+        other.is_a?(self.class) && ref == other.ref
       end
       alias_method :eql?, :==
 
@@ -44,14 +64,14 @@ module Selenium
       #
       # @example Click on a button
       #
-      #    driver.find_element(:tag_name, "button").click
+      #    driver.find_element(tag_name: "button").click
       #
       # @raise [StaleElementReferenceError] if the element no longer exists as
       #  defined
       #
 
       def click
-        bridge.clickElement @id
+        bridge.click_element @id
       end
 
       #
@@ -59,13 +79,13 @@ module Selenium
       #
       # @example Get the tagname of an INPUT element(returns "input")
       #
-      #    driver.find_element(:xpath, "//input").tag_name
+      #    driver.find_element(xpath: "//input").tag_name
       #
       # @return [String] The tag name of this element.
       #
 
       def tag_name
-        bridge.getElementTagName @id
+        bridge.element_tag_name @id
       end
 
       #
@@ -88,14 +108,24 @@ module Selenium
       #
       # class, readonly
       #
-      # @param [String]
-      #   attribute name
-      # @return [String,nil]
-      #   attribute value
+      # @param [String] name attribute name
+      # @return [String, nil] attribute value
       #
 
       def attribute(name)
-        bridge.getElementAttribute @id, name
+        bridge.element_attribute self, name
+      end
+
+      #
+      # Get the value of a the given property with the same name of the element. If the value is not
+      # set, nil is returned.
+      #
+      # @param [String] name property name
+      # @return [String, nil] property value
+      #
+
+      def property(name)
+        bridge.element_property self, name
       end
 
       #
@@ -105,13 +135,13 @@ module Selenium
       #
 
       def text
-        bridge.getElementText @id
+        bridge.element_text @id
       end
 
       #
       # Send keystrokes to this element
       #
-      # @param [String, Symbol, Array]
+      # @param [String, Symbol, Array] args keystrokes to send
       #
       # Examples:
       #
@@ -123,7 +153,7 @@ module Selenium
       #
 
       def send_keys(*args)
-        bridge.sendKeysToElement @id, Keys.encode(args)
+        bridge.send_keys_to_element @id, Keys.encode(args)
       end
       alias_method :send_key, :send_keys
 
@@ -133,12 +163,12 @@ module Selenium
       #
       # Note that the events fired by this event may not be as you'd expect.  In particular, we don't
       # fire any keyboard or mouse events.  If you want to ensure keyboard events are
-      # fired, consider using #send_keys with the backspace key. To ensure you get a change event, 
+      # fired, consider using #send_keys with the backspace key. To ensure you get a change event,
       # consider following with a call to #send_keys with the tab key.
       #
 
       def clear
-        bridge.clearElement @id
+        bridge.clear_element @id
       end
 
       #
@@ -148,7 +178,7 @@ module Selenium
       #
 
       def enabled?
-        bridge.isElementEnabled @id
+        bridge.element_enabled? @id
       end
 
       #
@@ -158,7 +188,7 @@ module Selenium
       #
 
       def selected?
-        bridge.isElementSelected @id
+        bridge.element_selected? @id
       end
 
       #
@@ -168,7 +198,7 @@ module Selenium
       #
 
       def displayed?
-        bridge.isElementDisplayed @id
+        bridge.element_displayed? self
       end
 
       #
@@ -176,7 +206,7 @@ module Selenium
       #
 
       def submit
-        bridge.submitElement @id
+        bridge.submit_element @id
       end
 
       #
@@ -191,7 +221,7 @@ module Selenium
       #
 
       def css_value(prop)
-        bridge.getElementValueOfCssProperty @id, prop
+        bridge.element_value_of_css_property @id, prop
       end
       alias_method :style, :css_value
 
@@ -202,7 +232,17 @@ module Selenium
       #
 
       def location
-        bridge.getElementLocation @id
+        bridge.element_location @id
+      end
+
+      #
+      # Get the dimensions and coordinates of this element.
+      #
+      # @return [WebDriver::Rectangle]
+      #
+
+      def rect
+        bridge.element_rect @id
       end
 
       #
@@ -212,7 +252,7 @@ module Selenium
       #
 
       def location_once_scrolled_into_view
-        bridge.getElementLocationOnceScrolledIntoView @id
+        bridge.element_location_once_scrolled_into_view @id
       end
 
       #
@@ -222,19 +262,19 @@ module Selenium
       #
 
       def size
-        bridge.getElementSize @id
+        bridge.element_size @id
       end
 
       #-------------------------------- sugar  --------------------------------
 
       #
-      #   element.first(:id, 'foo')
+      #   element.first(id: 'foo')
       #
 
       alias_method :first, :find_element
 
       #
-      #   element.all(:class, 'bar')
+      #   element.all(class: 'bar')
       #
 
       alias_method :all, :find_elements
@@ -256,13 +296,13 @@ module Selenium
 
       #
       # Convert to a WebElement JSON Object for transmission over the wire.
-      # @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Basic_Concepts_And_Terms
+      # @see https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#basic-terms-and-concepts
       #
       # @api private
       #
 
-      def to_json(*args)
-        WebDriver.json_dump as_json
+      def to_json(*)
+        JSON.generate as_json
       end
 
       #
@@ -271,23 +311,25 @@ module Selenium
       # @api private
       #
 
-      def as_json(opts = nil)
-        { :ELEMENT => @id }
+      def as_json(*)
+        key = if bridge.dialect == :w3c
+                'element-6066-11e4-a52e-4f735466cecf'
+              else
+                'ELEMENT'
+              end
+        @id.is_a?(Hash) ? @id : {key => @id}
       end
 
       private
 
-      def bridge
-        @bridge
-      end
+      attr_reader :bridge
 
       def selectable?
         tn = tag_name.downcase
         type = attribute(:type).to_s.downcase
 
-        tn == "option" || (tn == "input" && %w[radio checkbox].include?(type))
+        tn == 'option' || (tn == 'input' && %w[radio checkbox].include?(type))
       end
-
     end # Element
   end # WebDriver
 end # Selenium