appium_lib_core 3.11.1 → 4.2.1

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/appium_lib_core.svg)](https://badge.fury.io/rb/appium_lib_core)
 
-[![Build Status](https://dev.azure.com/kazucocoa/ruby_lib_core/_apis/build/status/ruby_lib_core?branchName=master)](https://dev.azure.com/kazucocoa/ruby_lib_core/_build/latest?definitionId=9&branchName=master)
+[![Build Status](https://dev.azure.com/AppiumCI/Appium%20CI/_apis/build/status/appium.ruby_lib_core?branchName=master)](https://dev.azure.com/AppiumCI/Appium%20CI/_build/latest?definitionId=54&branchName=master)
 
 This library is a Ruby client for Appium.  The gem is available via [appium_lib_core](https://rubygems.org/gems/appium_lib_core).
 

data/appium_lib_core.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.2'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'webmock', '~> 3.10.0'
-  spec.add_development_dependency 'rubocop', '0.68.1'
+  spec.add_development_dependency 'webmock', '~> 3.11.0'
+  spec.add_development_dependency 'rubocop', '1.8.0'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional/ios_setup.yml

@@ -3,3 +3,5 @@ steps:
   displayName: Xcode Select ${{ parameters.xcodeVersion }}
 - script: xcrun simctl list
   displayName: List Installed Simulators
+- script: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
+  displayName: Disable pasteboard automatic sync

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/ci-jobs/functional_test.yml

@@ -2,8 +2,8 @@
 parameters:
   vmImage: 'macOS-10.15'
   vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
-  xcodeForIOS: 11.5
-  xcodeForTVOS: 11.5
+  xcodeForIOS: 12.2
+  xcodeForTVOS: 12.2
   androidSDK: 30
   appiumVersion: 'beta'
   ignoreVersionSkip: true

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.rb

@@ -60,9 +60,6 @@ module Appium
         # Creates session handling both OSS and W3C dialects.
         # Copy from Selenium::WebDriver::Remote::Bridge to keep using +merged_capabilities+ for Appium
         #
-        # If +desired_capabilities+ has +forceMjsonwp: true+ in the capability, this bridge works with mjsonwp protocol.
-        # If +forceMjsonwp: false+ or no the capability, it depends on server side whether this bridge works as w3c or mjsonwp.
-        #
         # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] desired_capabilities A capability
         # @return [::Selenium::WebDriver::Remote::Capabilities, ::Selenium::WebDriver::Remote::W3C::Capabilities]
         #
@@ -76,25 +73,6 @@ module Appium
         #       platformVersion: '11.4',
         #       deviceName: 'iPhone Simulator',
         #       useNewWDA: true,
-        #       forceMjsonwp: true
-        #     },
-        #     appium_lib: {
-        #       wait: 30
-        #     }
-        #   }
-        #   core = ::Appium::Core.for(caps)
-        #   driver = core.start_driver #=> driver.dialect == :oss
-        #
-        # @example
-        #
-        #   opts = {
-        #     caps: {
-        #       platformName: :ios,
-        #       automationName: 'XCUITest',
-        #       app: 'test/functional/app/UICatalog.app.zip',
-        #       platformVersion: '11.4',
-        #       deviceName: 'iPhone Simulator',
-        #       useNewWDA: true,
         #     },
         #     appium_lib: {
         #       wait: 30
@@ -194,21 +172,17 @@ module Appium
           force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
           desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
 
-          if force_mjsonwp
-            {
-              desiredCapabilities: desired_capabilities
-            }
-          else
-            new_caps = add_appium_prefix(desired_capabilities)
-            w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
-
-            {
-              desiredCapabilities: desired_capabilities,
-              capabilities: {
-                firstMatch: [w3c_capabilities]
-              }
+          ::Appium::Logger.warn "'forceMjsonwp' no longer works. Sending both W3C and MJSONWP capabilities" if force_mjsonwp
+
+          new_caps = add_appium_prefix(desired_capabilities)
+          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
+
+          {
+            desiredCapabilities: desired_capabilities,
+            capabilities: {
+              firstMatch: [w3c_capabilities]
             }
-          end
+          }
         end
       end # class Bridge
     end # class Base

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
@@ -311,6 +312,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 +320,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+.

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 = {}

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)

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/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/touch_action/multi_touch.rb

@@ -24,8 +24,8 @@ module Appium
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver
-    #   action_1 = TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
-    #   action_2 = TouchAction.new(@driver).tap(element: el, x: 50, y:5, count: 3)
+    #   action_1 = Appium::Core::TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
+    #   action_2 = Appium::Core::TouchAction.new(@driver).tap(element: el, x: 50, y:5, count: 3)
     #
     #   multi_touch_action = MultiTouch.new(@driver)
     #   multi_touch_action.add action_1

data/lib/appium_lib_core/common/touch_action/touch_actions.rb

@@ -27,9 +27,9 @@ module Appium
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver
-    #   action = TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
+    #   action = Appium::Core::TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
     #   action.perform
-    #   action = TouchAction.new(@driver).swipe(....)
+    #   action = Appium::Core::TouchAction.new(@driver).swipe(....)
     #   action.perform
     #
     class TouchAction
@@ -59,7 +59,7 @@ module Appium
       # Press down for a specific duration.
       # Alternatively, you can use +press(...).wait(...).release()+ instead of +long_press+ if duration doesn't work well.
       # https://github.com/appium/ruby_lib/issues/231#issuecomment-269895512
-      # e.g. Appium::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
+      # e.g. Appium::Core::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
       #
       # @param opts [Hash] Options
       # @option opts [WebDriver::Element] element the element to press.