appium_lib_core 4.0.0 → 4.3.0

data/appium_lib_core.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.11.0'
-  spec.add_development_dependency 'rubocop', '0.68.1'
+  spec.add_development_dependency 'rubocop', '1.8.1'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional/run_appium.yml

@@ -11,7 +11,7 @@ steps:
   displayName: Installed node dependencies
 - task: UseRubyVersion@0
   inputs:
-    versionSpec: '2.4' # so far, bundler does not work over 2.5 since it raises openssl error
+    versionSpec: '2.7'
 - script: |
     mkdir -p test/report
     nohup appium --relaxed-security --log-timestamp --log-no-colors > test/report/appium.out 2>&1 &

data/lib/appium_lib_core.rb

@@ -34,11 +34,11 @@ module Appium
 
     hash.each_with_object({}) do |pair, acc|
       key = begin
-              pair[0].to_sym
-            rescue StandardError => e
-              ::Appium::Logger.warn(e.message)
-              pair[0]
-            end
+        pair[0].to_sym
+      rescue StandardError => e
+        ::Appium::Logger.warn(e.message)
+        pair[0]
+      end
 
       value = pair[1]
       acc[key] = value.is_a?(Hash) ? symbolize_keys(value) : value

data/lib/appium_lib_core/android/device.rb

@@ -25,7 +25,7 @@ module Appium
       module Device
         extend Forwardable
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
 
         # @!method open_notifications
         #   Open Android notifications
@@ -290,16 +290,16 @@ module Appium
         #   @driver.finger_print 1
         #
 
-        # @!method execute_cdp(cmd, params)
+        # @!method execute_cdp(cmd, **params)
         #     Execute Chrome Devtools protocol commands
         #     https://chromedevtools.github.io/devtools-protocol
         #
         # @param [String] cmd The name of command
-        # @param [Hash] params The parameter for the command as hash.
+        # @option params The parameter for the command as keyword options.
         #
         # @example
         #
-        #   @driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }
+        #   @driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'
         #   @driver.execute_cdp 'Page.getResourceTree'
         #
 
@@ -307,7 +307,7 @@ module Appium
         ## class << self
         ####
 
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         class << self
           def extended(_mod)

data/lib/appium_lib_core/common/base.rb

@@ -29,6 +29,7 @@ require_relative 'device/clipboard_content_type'
 require_relative 'device/device'
 require_relative 'device/touch_actions'
 require_relative 'device/execute_driver'
+require_relative 'device/orientation'
 
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'

data/lib/appium_lib_core/common/base/bridge/w3c.rb

@@ -32,6 +32,7 @@ module Appium
           include Device::Device
           include Device::TouchActions
           include Device::ExecuteDriver
+          include Device::Orientation
 
           def commands(command)
             ::Appium::Core::Commands::W3C::COMMANDS[command]

data/lib/appium_lib_core/common/base/driver.rb

@@ -15,6 +15,7 @@
 require 'base64'
 require_relative 'search_context'
 require_relative 'screenshot'
+require_relative 'rotable'
 
 module Appium
   module Core
@@ -22,12 +23,12 @@ module Appium
       class Driver < ::Selenium::WebDriver::Driver
         include ::Selenium::WebDriver::DriverExtensions::UploadsFiles
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
-        include ::Selenium::WebDriver::DriverExtensions::Rotatable
         include ::Selenium::WebDriver::DriverExtensions::HasRemoteStatus
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
+        include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::SearchContext
-        include ::Appium::Core::Base::TakeScreenshot
+        include ::Appium::Core::Base::TakesScreenshot
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
@@ -58,6 +59,7 @@ module Appium
         # Update +server_url+ and HTTP clients following this arguments, protocol, host, port and path.
         # After this method, +@bridge.http+ will be a new instance following them instead of +server_url+ which is
         # set before creating session.
+        # If +@bridge.http+ did not have +update_sending_request_to+ method, this method returns immediately.
         #
         # @example
         #
@@ -66,10 +68,16 @@ module Appium
         #     driver.manage.timeouts.implicit_wait = 10 # @bridge.http is for 'https://example2.com:9000/wd/hub/'
         #
         def update_sending_request_to(protocol:, host:, port:, path:)
-          @bridge.http.update_sending_request_to(scheme: protocol,
-                                                 host: host,
-                                                 port: port,
-                                                 path: path)
+          unless @bridge.http&.class&.method_defined? :update_sending_request_to
+            ::Appium::Logger.fatal "#{@bridge.http&.class} has no 'update_sending_request_to'. " \
+              'It keeps current connection target.'
+            return
+          end
+
+          @bridge.http&.update_sending_request_to(scheme: protocol,
+                                                  host: host,
+                                                  port: port,
+                                                  path: path)
         end
 
         ### Methods for Appium
@@ -239,6 +247,8 @@ module Appium
 
         # Returns an instance of DeviceIME
         #
+        # @return [Appium::Core::Base::Driver::DeviceIME]
+        #
         # @example
         #
         #   @driver.ime.activate engine: 'com.android.inputmethod.latin/.LatinIME'
@@ -289,6 +299,8 @@ module Appium
         # @!method ime_activated
         #   Android only. Indicates whether IME input is active at the moment (not if it is available).
         #
+        # @return [Boolean]
+        #
         # @example
         #
         #   @driver.ime_activated #=> True if IME is activated
@@ -311,6 +323,7 @@ module Appium
 
         # Perform a block within the given context, then switch back to the starting context.
         # @param [String] context The context to switch to for the duration of the block.
+        # @param [Proc] block The block to involve within the context
         #
         # @example
         #
@@ -318,8 +331,8 @@ module Appium
         #     @driver.find_element :tag, "button"
         #   end # The result of 'find_element :tag, "button"'
         #
-        def within_context(context)
-          block_given? ? @bridge.within_context(context, &Proc.new) : @bridge.within_context(context)
+        def within_context(context, &block)
+          block_given? ? @bridge.within_context(context, &block) : @bridge.within_context(context)
         end
 
         # Change to the default context. This is equivalent to +set_context nil+.
@@ -852,7 +865,7 @@ module Appium
         end
 
         # Get the device window's logs.
-        # @return [String]
+        # @return [Appium::Core::Logs]
         #
         # @example
         #
@@ -878,7 +891,7 @@ module Appium
         # Retrieve the capabilities of the specified session.
         # It's almost same as +@driver.capabilities+ but you can get more details.
         #
-        # @return [Selenium::WebDriver::Remote::Capabilities]
+        # @return [Selenium::WebDriver::Remote::Capabilities, Selenium::WebDriver::Remote::W3C::Capabilities]
         #
         # @example
         #   @driver.session_capabilities
@@ -1037,7 +1050,7 @@ module Appium
         #
         # @param [String] img_path A path to a partial image you'd like to find
         #
-        # @return [::Selenium::WebDriver::Element]
+        # @return [Array<Selenium::WebDriver::Element>]
         #
         # @example
         #

data/lib/appium_lib_core/common/base/http_default.rb

@@ -36,7 +36,8 @@ module Appium
 
           attr_reader :additional_headers
 
-          def initialize(open_timeout: nil, read_timeout: nil)
+          # override
+          def initialize(open_timeout: nil, read_timeout: nil) # rubocop:disable Lint/MissingSuper
             @open_timeout = open_timeout
             @read_timeout = read_timeout
             @additional_headers = {}
@@ -54,8 +55,6 @@ module Appium
           def update_sending_request_to(scheme:, host:, port:, path:)
             return @server_url unless validate_url_param(scheme, host, port, path)
 
-            ::Appium::Logger.debug("[experimental] This feature, #{__method__}, is an experimental")
-
             # Add / if 'path' does not have it
             path = path.start_with?('/') ? path : "/#{path}"
             path = path.end_with?('/') ? path : "#{path}/"

data/lib/appium_lib_core/common/base/rotable.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Licensed 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 Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+
+      module Rotatable
+        ORIENTATIONS = %i[landscape portrait].freeze
+
+        #
+        # Change the screen orientation
+        #
+        # @param [:landscape, :portrait] orientation
+        #
+        #
+        def rotation=(orientation)
+          unless ORIENTATIONS.include?(orientation)
+            raise ArgumentError, "expected #{ORIENTATIONS.inspect}, got #{orientation.inspect}"
+          end
+
+          bridge.screen_orientation = orientation.to_s.upcase
+        end
+        alias rotate rotation=
+
+        #
+        # Get the current screen orientation
+        #
+        # @return [:landscape, :portrait] orientation
+        #
+        # @api public
+        #
+
+        def orientation
+          bridge.screen_orientation.to_sym.downcase
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/common/base/screenshot.rb

@@ -15,7 +15,7 @@
 module Appium
   module Core
     class Base
-      module TakeScreenshot
+      module TakesScreenshot
         #
         # Save a PNG screenshot to the given path
         #

data/lib/appium_lib_core/common/base/search_context.rb

@@ -18,7 +18,6 @@ module Appium
       module SearchContext
         # referenced: ::Selenium::WebDriver::SearchContext
 
-        # rubocop:disable Layout/AlignHash
         FINDERS = ::Selenium::WebDriver::SearchContext::FINDERS.merge(
           accessibility_id:     'accessibility id',
           image:                '-image',
@@ -37,9 +36,8 @@ module Appium
           # Tizen with Tizen prefix
           tizen_uiautomation:   '-tizen uiautomation'
         )
-        # rubocop:enable Layout/AlignHash
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         #
         # Find the first element matching the given arguments
         #
@@ -129,7 +127,7 @@ module Appium
         #     # For Tizen
         #     @driver.find_elements :tizen_uiautomation, '....'
         #
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         def find_element(*args)
           how, what = extract_args(args)
           by = _set_by_from_finders(how)
@@ -143,6 +141,8 @@ module Appium
         #
         # Find all elements matching the given arguments
         #
+        # @return [Array<Selenium::WebDriver::Element>]
+        #
         # @see SearchContext#find_elements
         #
         def find_elements(*args)

data/lib/appium_lib_core/common/command/common.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Layout/AlignHash
 module Appium
   module Core
     # ref: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js
@@ -109,4 +108,3 @@ module Appium
     end # module Commands
   end # module Core
 end # module Appium
-# rubocop:enable Layout/AlignHash

data/lib/appium_lib_core/common/command/mjsonwp.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Layout/AlignHash
 module Appium
   module Core
     module Commands
@@ -27,4 +26,3 @@ module Appium
     end # module Commands
   end # module Core
 end # Appium
-# rubocop:enable Layout/AlignHash

data/lib/appium_lib_core/common/command/w3c.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Layout/AlignHash
 module Appium
   module Core
     module Commands
@@ -55,4 +54,3 @@ module Appium
     end # module Commands
   end # module Core
 end # module Appium
-# rubocop:enable Layout/AlignHash

data/lib/appium_lib_core/common/device/app_management.rb

@@ -34,7 +34,7 @@ module Appium
             execute :app_strings, {}, opts
           end
 
-          def background_app(duration = 0) # rubocop:disable Lint/UnusedMethodArgument
+          def background_app(duration = 0)
             # Should override in each driver
             raise NotImplementedError
           end

data/lib/appium_lib_core/common/device/image_comparison.rb

@@ -47,7 +47,7 @@ module Appium
           #                               not available in the default OpenCV installation and have to be enabled manually
           #                               before library compilation. The default detector name is 'ORB'.
           # @param [String] match_func The name of the matching function. The default one is 'BruteForce'.
-          # @param [String] good_matches_factor The maximum count of "good" matches (e. g. with minimal distances).
+          # @param [String, nil] good_matches_factor The maximum count of "good" matches (e. g. with minimal distances).
           #                                     The default one is nil.
           # @param [Bool] visualize Makes the endpoint to return an image, which contains the visualized result of
           #                         the corresponding picture matching operation. This option is disabled by default.
@@ -94,7 +94,7 @@ module Appium
           #                                are supported.
           # @param [Bool] visualize Makes the endpoint to return an image, which contains the visualized result of
           #                         the corresponding picture matching operation. This option is disabled by default.
-          # @param [Float] threshold [0.5] At what normalized threshold to reject
+          # @param [Float, nil] threshold [0.5] At what normalized threshold to reject
           #
           # @example
           #     @driver.find_image_occurrence full_image: "image data 1", partial_image: "image data 2"
@@ -144,7 +144,7 @@ module Appium
           #                      +:matchFeatures is by default.
           # @param [String] first_image An image data. All image formats, that OpenCV library itself accepts, are supported.
           # @param [String] second_image An image data. All image formats, that OpenCV library itself accepts, are supported.
-          # @param [Hash] options The content of this dictionary depends on the actual +mode+ value.
+          # @param [Hash, nil] options The content of this dictionary depends on the actual +mode+ value.
           #                       See the documentation on +appium-support+ module for more details.
           # @return [Hash] The content of the resulting dictionary depends on the actual +mode+ and +options+ values.
           #                 See the documentation on +appium-support+ module for more details.

data/lib/appium_lib_core/common/device/orientation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Licensed 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 Appium
+  module Core
+    class Base
+      module Device
+        module Orientation
+          def screen_orientation=(orientation)
+            execute :set_screen_orientation, {}, { orientation: orientation }
+          end
+
+          def screen_orientation
+            execute :get_screen_orientation
+          end
+        end # module Orientation
+      end # module Device
+    end # class Base
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/common/wait.rb

@@ -53,7 +53,7 @@ module Appium
               return yield(object)
             rescue ::Errno::ECONNREFUSED => e
               raise e
-            rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
+            rescue *ignored => last_error
               # swallowed
             end
             sleep interval
@@ -98,7 +98,7 @@ module Appium
               return result if result
             rescue ::Errno::ECONNREFUSED => e
               raise e
-            rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
+            rescue *ignored => last_error
               # swallowed
             end
             sleep interval