appium_lib_core 5.0.0.rc5 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19a2c4c9f752e5f2e4287ce8b0d53bc428bafaa997b58c40bc0b796b878eadeb
-  data.tar.gz: 451e46bc56fa768879ab680520dff4ec137455ca020e1176f3022160d1a46009
+  metadata.gz: 88e1099c62a49f922529ee84563d0b475c160a981451da59210819e61956f985
+  data.tar.gz: bb653d62d35c461e8e0c9dcec726064992e735418b20c85b4aa6aae16d9b0a88
 SHA512:
-  metadata.gz: e9e155e17e026514e12657489569b17b389d62cb9d7cd79e8a753e12b37571d4a9d3a3f28227b935b2d3d101747a7ce66d28ff7eb08f6c9cfb7c1c94ca7f3f03
-  data.tar.gz: 13e2620a48fe753b5647a0ffcb6bf370f54796aa3b87ca34522659c219474804dfa7843394307ad84b36dc377a10d2bd5bec782467354abb252e945c27cdd748
+  metadata.gz: 1a18f9f6ea13b72f0aff09ea748c102fdfe202be60ac59f7fcaceee34485746a75fd83d8e438c2fd0447b64ce3c17655418ccdf599fba618afd75db7bab72e73
+  data.tar.gz: 6cac7cbba8c64d8f97fa34af6adc1b33f432549950551826cfc0e1d0340e0add900b85bf0c09cbbfa9fae551aec873d68b08b9f301d9ace40e9716d453c3ca4b

data/.github/workflows/unittest.yml

@@ -29,9 +29,9 @@ jobs:
     - name: Run tests
       run: |
         bundle exec rake rubocop
-        bundle exec parallel_test test/unit/ -n 4
-        AUTOMATION_NAME_DROID=espresso bundle exec parallel_test test/unit/android -n 4
-        AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec parallel_test test/unit -n 4
+        bundle exec rake test:unit
+        AUTOMATION_NAME_DROID=espresso bundle exec rake test:unit:android
+        AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec rake test:unit
 
   test-win:
     strategy:
@@ -57,11 +57,11 @@ jobs:
           gem uninstall --force eventmachine && gem install eventmachine --platform ruby
       - name: Run tests
         run: |
-          parallel_test test/unit/ -n 4
+          rake test:unit
 
           setx AUTOMATION_NAME_DROID espresso
-          parallel_test test/unit/android -n 4
+          rake test:unit:android
 
           setx AUTOMATION_NAME_DROID appium
           setx AUTOMATION_NAME_IOS appium
-          parallel_test test/unit -n 4
+          rake test:unit

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 Layout/LineLength:
   Max: 128
 Layout/RescueEnsureAlignment:
@@ -56,3 +56,91 @@ Style/ExplicitBlockArgument:
   Enabled: false
 Style/KeywordParametersOrder:
   Enabled: false
+Gemspec/DateAssignment:
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Security/IoMethods:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/EndlessMethod:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/SelectByRegexp:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

data/CHANGELOG.md

@@ -10,21 +10,44 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
-## [5.0.0]
+## [5.0.0] - 2021-11-05
 
 ### Enhancements
 
-- Update base selenium webdriver version to `4.0.0`
-  - Support only W3C spec as following Selenium v4 client
+- Update base selenium webdriver version to `v4`
+  - Base Selenium Ruby binding is now v4
+  - Support only W3C WebDriver spec (and a few Appium specific commands)
   - Support Ruby 2.6+
-- `element.id` returns the element id instead of `element.ref`. `element.ref` now returns an array.
-- Removed `desired_capabilities` as capabilities for `Appium::Core#for`. Please use `capabilities` key name instead
-- Removals that already had _duplication_ mark
+- Add `driver#wait`, `driver#wait_until`, `driver#wait_true`, `driver#wait_until_true` syntaxes
+  - Can give `driver` instance as its block variable
+- `element.id` returns the element id instead of `element.ref`.
+  - `element.ref` now returns an array.
+- Removed `desired_capabilities` as capabilities for `Appium::Core#for`. Please use `capabilities` key name instead.
+  - e.g. `Appium::Core.for capabilities: {...}` instead of `Appium::Core.for desired_capabilities: {...}`
+- Removed methods that had _Deprecated_ mark
   - Removed `driver#screenshot`. Please use `driver#save_screenshot` instead
   - Removed `driver#send_keys` to send keys to an active element. Please use `driver.action.send_keys('happy testing').perform` instead
   - Removed `forceMjsonwp` to send only MJSONWP capabilities since Selenium cleint v4 no longer supports MJSONWP
-- No longer set default `timeouts` as `0`. ruby_lib_core calls `/timeouts` endpoint only when `appium_lib: { wait: 5 }` is provided explicitly
+- No longer set default `timeouts` as `0`
+  - ruby_lib_core calls `/timeouts` endpoint only when `appium_lib: { wait: 5 }` is provided explicitly
 - Raises `::Appium::Core::Error::ArgumentError` instead of `ArgumentError` for this library specific argument errors
+- Removed Selendroid related methods
+
+### Deprecations
+- `Appium::Core::TouchAction` and `Appium::Core::MultiTouch` are deprecated
+    - Please use W3C actions instead http://appium.io/docs/en/commands/interactions/actions/
+    - More working examples:
+        - [test/functional/android/webdriver/w3c_actions_test.rb](test/functional/android/webdriver/w3c_actions_test.rb)
+        - [test/functional/ios/webdriver/w3c_actions_test.rb](test/functional/ios/webdriver/w3c_actions_test.rb)
+        - [test/functional/common_w3c_actions.rb](test/functional/common_w3c_actions.rb)
+        - https://www.selenium.dev/documentation/support_packages/mouse_and_keyboard_actions_in_detail/
+        - https://www.youtube.com/watch?v=oAJ7jwMNFVU
+        - https://appiumpro.com/editions/30-ios-specific-touch-action-methods
+        - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
+- `launch_app`, `close_app` and `reset`. Please read [issues#15807](https://github.com/appium/appium/issues/15807) for more details.
+    - `activate_app` or a new session request can be alternatives of `launch_app`
+    - `terminate_app` or close the session request can be alternatives of `close_app`
+    - Close current session and creating a new session, or `terminate_app` and `launch_app` can be alternatives of `reset`
 
 ## [4.7.1] - 2021-09-26
 

data/README.md

@@ -13,6 +13,10 @@ This library wraps [selenium-webdriver](https://github.com/SeleniumHQ/selenium/w
 - http://www.rubydoc.info/github/appium/ruby_lib_core
     - You can find working API examples in test code, [test/functional](test/functional)
 
+# Migration from v4 to v5
+
+Please read `[5.0.0]` section in CHANGELOG.md
+
 # Related library
 - https://github.com/appium/ruby_lib
 

data/appium_lib_core.gemspec

@@ -25,16 +25,13 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'selenium-webdriver', '~> 4.0.0'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
-  spec.add_development_dependency 'bundler', '>= 1.14'
   spec.add_development_dependency 'rake', '~> 13.0'
   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.14.0'
-  spec.add_development_dependency 'rubocop', '1.12.1'
+  spec.add_development_dependency 'rubocop', '1.22.3'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'parallel_tests'
   spec.add_development_dependency 'simplecov'
 end

data/bin/console

@@ -6,9 +6,5 @@ require "appium_lib_core"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require "irb"
 IRB.start(__FILE__)

data/ci-jobs/functional/run_appium.yml

@@ -11,7 +11,7 @@ steps:
   displayName: Installed node dependencies
 - task: UseRubyVersion@0
   inputs:
-    versionSpec: '2.7'
+    versionSpec: '3.0'
 - 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

@@ -1,7 +1,7 @@
 # jobs for functional test
 parameters:
   vmImage: 'macOS-10.15'
-  vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
+  vmImageForIOS: 'macOS-10.15'
   xcodeForIOS: 12.2
   xcodeForTVOS: 12.2
   androidSDK: 29  # API Level 30 emulators are more unstable than 29

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

@@ -51,7 +51,7 @@ module Appium
         end
 
         # Override
-        # Creates session handling both OSS and W3C dialects.
+        # Creates session handling.
         #
         # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
         # @return [::Selenium::WebDriver::Remote::Capabilities]
@@ -187,8 +187,8 @@ module Appium
 
         # Port from MJSONWP
         def send_keys_to_active_element(key)
-          text = ::Selenium::WebDriver::Keys.encode(key).join('')
-          execute :send_keys_to_active_element, {}, { value: text.split(//) }
+          text = ::Selenium::WebDriver::Keys.encode(key).join
+          execute :send_keys_to_active_element, {}, { value: text.chars }
         end
 
         # For Appium
@@ -319,11 +319,9 @@ module Appium
           data = execute :get_log, {}, { type: type.to_s }
 
           Array(data).map do |l|
-            begin
-              ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-            rescue KeyError
-              next
-            end
+            ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+          rescue KeyError
+            next
           end
         end
 

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

@@ -21,6 +21,7 @@ require_relative 'rotable'
 require_relative 'remote_status'
 require_relative 'has_location'
 require_relative 'has_network_connection'
+require_relative '../wait'
 
 module Appium
   module Core
@@ -38,6 +39,8 @@ module Appium
         include ::Appium::Core::Base::HasLocation
         include ::Appium::Core::Base::HasNetworkConnection
 
+        include ::Appium::Core::Waitable
+
         private
 
         # Private API.
@@ -45,14 +48,18 @@ module Appium
         attr_reader :bridge
 
         def initialize(bridge: nil, listener: nil, **opts)
+          # For ::Appium::Core::Waitable
+          @wait_timeout = opts.delete(:wait_timeout)
+          @wait_interval = opts.delete(:wait_interval)
+
+          # For logging.
+          # TODO: Remove when appium core no longer uses this in this bridge.
+          @automation_name = opts.delete(:automation_name)
+
           super
         end
 
-        # Implements protocol handshake which:
-        #
-        #   1. Creates session with driver.
-        #   2. Sniffs response.
-        #   3. Based on the response, understands which dialect we should use.
+        # Create a proper bridge instance.
         #
         # @return [::Appium::Core::Base::Bridge]
         #
@@ -83,7 +90,7 @@ module Appium
         def update_sending_request_to(protocol:, host:, port:, path:)
           unless @bridge.http&.class&.method_defined? :update_sending_request_to
             ::Appium::Logger.warn "#{@bridge.http&.class} has no 'update_sending_request_to'. " \
-              'It keeps current connection target.'
+                                  'It keeps current connection target.'
             return
           end
 
@@ -411,17 +418,9 @@ module Appium
         alias set_context context=
 
         # Place a file in a specific location on the device.
-        # On iOS, the server should have ifuse libraries installed and configured properly for this feature to work on
-        # real devices.
         # On Android, the application under test should be built with debuggable flag enabled in order to get access to
         # its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
         #                      If the path starts with application id prefix, then the file will be pushed to the root of
         #                      the corresponding application container.
@@ -438,18 +437,10 @@ module Appium
           @bridge.push_file(path, filedata)
         end
 
-        # Pull a file from the simulator/device.
-        # On iOS the server should have ifuse
-        # libraries installed and configured properly for this feature to work on real devices.
+        # Pull a file from the remote device.
         # On Android the application under test should be built with debuggable flag enabled in order to get access
         # to its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
         #                      If the path starts with application id prefix, then the file will be pulled from the root
         #                      of the corresponding application container.
@@ -458,7 +449,6 @@ module Appium
         #                      Only pulling files from application containers is supported for iOS Simulator.
         #                      Provide the remote path in format
         #                      <code>@bundle.identifier:container_type/relative_path_in_container</code>
-        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data
         #
@@ -475,18 +465,10 @@ module Appium
           @bridge.pull_file(path)
         end
 
-        # Pull a folder content from the simulator/device.
-        # On iOS the server should have ifuse libraries installed and configured properly for this feature to work
-        # on real devices.
+        # Pull a folder content from the remote device.
         # On Android the application under test should be built with debuggable flag enabled in order to get access to
         # its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Absolute path to the folder.
         #                      If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled
         #                      from the root of the corresponding application container.
@@ -495,7 +477,6 @@ module Appium
         #                      Only pulling files from application containers is supported for iOS Simulator.
         #                      Provide the remote path in format
         #                      <code>@bundle.identifier:container_type/relative_path_in_container</code>
-        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data which is zip archived
         #
@@ -509,19 +490,6 @@ module Appium
           @bridge.pull_folder(path)
         end
 
-        # Send keyevent on the device.(Only for Selendroid)
-        # http://developer.android.com/reference/android/view/KeyEvent.html
-        # @param [integer] key The key to press.
-        # @param [String] metastate The state the metakeys should be in when pressing the key.
-        #
-        # @example
-        #
-        #   @driver.keyevent 82
-        #
-        def keyevent(key, metastate = nil)
-          @bridge.keyevent(key, metastate)
-        end
-
         # Press keycode on the device.
         # http://developer.android.com/reference/android/view/KeyEvent.html
         # @param [Integer] key The key to press. The values which have +KEYCODE_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
@@ -566,6 +534,7 @@ module Appium
           @bridge.long_press_keycode(key, metastate: metastate, flags: flags)
         end
 
+        # @deprecated Except for Windows
         # Start the simulator and application configured with desired capabilities
         #
         # @example
@@ -573,9 +542,16 @@ module Appium
         #   @driver.launch_app
         #
         def launch_app
+          # TODO: Define only in Windows module when ruby_lib_core removes this method
+          if @automation_name != :windows
+            ::Appium::Logger.warn(
+              '[DEPRECATION] launch_app is deprecated. Please use activate_app instead.'
+            )
+          end
           @bridge.launch_app
         end
 
+        # @deprecated Except for Windows
         # Close an app on device
         #
         # @example
@@ -583,9 +559,16 @@ module Appium
         #   @driver.close_app
         #
         def close_app
+          # TODO: Define only in Windows module when ruby_lib_core removes this method
+          if @automation_name != :windows
+            ::Appium::Logger.warn(
+              '[DEPRECATION] close_app is deprecated. Please use terminate_app instead.'
+            )
+          end
           @bridge.close_app
         end
 
+        # @deprecated
         # Reset the device, relaunching the application.
         #
         # @example
@@ -593,6 +576,10 @@ module Appium
         #   @driver.reset
         #
         def reset
+          ::Appium::Logger.warn(
+            '[DEPRECATION] reset is deprecated. Please use terminate_app and activate_app, ' \
+            'or quit and create a new session instead.'
+          )
           @bridge.reset
         end
 
@@ -810,7 +797,7 @@ module Appium
         #
         # @example: Zoom
         #
-        #    f1 = @driver.action.add_pointer_input(:touch, 'finger1')
+        #    f1 = ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'finger1')
         #    f1.create_pointer_move(duration: 1, x: 200, y: 500,
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f1.create_pointer_down(:left)
@@ -818,7 +805,7 @@ module Appium
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f1.create_pointer_up(:left)
         #
-        #    f2 = @driver.action.add_pointer_input(:touch, 'finger2')
+        #    f2 = ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'finger2')
         #    f2.create_pointer_move(duration: 1, x: 200, y: 500,
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f2.create_pointer_down(:left)
@@ -831,6 +818,10 @@ module Appium
         def perform_actions(data)
           raise ::Appium::Core::Error::ArgumentError, "'#{data}' must be Array" unless data.is_a? Array
 
+          # NOTE: 'add_input' in Selenium Ruby implementation has additional 'pause'.
+          # This implementation is to avoid the additional pause.
+          # https://github.com/SeleniumHQ/selenium/blob/64447d4b03f6986337d1ca8d8b6476653570bcc1/rb/lib/selenium/webdriver/common/action_builder.rb#L207
+
           @bridge.send_actions data.map(&:encode).compact
           data.each(&:clear_actions)
           nil

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

@@ -63,8 +63,8 @@ module Appium
         def save_element_screenshot(element, png_path)
           extension = File.extname(png_path).downcase
           if extension != '.png'
-            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
-                                'It should end with .png extension'
+            ::Appium::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 << element_screenshot_as(element, :png) }
         end

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

@@ -32,6 +32,7 @@ module Appium
           predicate:            '-ios predicate string',
           class_chain:          '-ios class chain',
           # Windows with windows prefix
+          # @deprecated
           windows_uiautomation: '-windows uiautomation',
           # Tizen with Tizen prefix
           tizen_uiautomation:   '-tizen uiautomation'
@@ -122,6 +123,7 @@ module Appium
         #     e.tag_name #=> "XCUIElementTypeStaticText"
         #
         #     # For Windows
+        #     # @deprecated
         #     @driver.find_elements :windows_uiautomation, '....'
         #
         #     # For Tizen
@@ -158,6 +160,12 @@ module Appium
         private
 
         def _set_by_from_finders(how)
+          if how == :windows_uiautomation
+            ::Appium::Logger.warn(
+              '[DEPRECATION] :windows_uiautomation is deprecated. Please use other locators.'
+            )
+          end
+
           by = FINDERS[how.to_sym]
           unless by
             raise ::Appium::Core::Error::ArgumentError,

data/lib/appium_lib_core/common/command.rb

@@ -213,8 +213,6 @@ module Appium
         hide_keyboard: [:post, 'session/:session_id/appium/device/hide_keyboard'],
         press_keycode: [:post, 'session/:session_id/appium/device/press_keycode'],
         long_press_keycode: [:post, 'session/:session_id/appium/device/long_press_keycode'],
-        # keyevent is only for Selendroid
-        keyevent: [:post, 'session/:session_id/appium/device/keyevent'],
         push_file: [:post, 'session/:session_id/appium/device/push_file'],
         pull_file: [:post, 'session/:session_id/appium/device/pull_file'],
         pull_folder: [:post, 'session/:session_id/appium/device/pull_folder'],

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

@@ -20,11 +20,13 @@ module Appium
     class Base
       module Device
         module TouchActions
+          # @deprecated Use W3C actions instead
           def touch_actions(actions)
             actions = { actions: [actions].flatten }
             execute :touch_actions, {}, actions
           end
 
+          # @deprecated Use W3C actions instead
           def multi_touch(actions)
             execute :multi_touch, {}, actions: actions
           end

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

@@ -39,11 +39,11 @@ module Appium
             end
 
             # Keep .split(//) for backward compatibility for now
-            text = keys.join('')
+            text = keys.join
 
             # FIXME: further work for W3C. Over appium 1.15.0 or later
             # { value: text.split(//), text: text }
-            { value: text.split(//) }
+            { value: text.chars }
           end
         end # module Value
       end # module Device

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

@@ -14,6 +14,9 @@
 
 module Appium
   module Core
+    #
+    # @deprecated Use W3C actions instead
+    #
     # MultiTouch actions allow for multiple touches to happen at the same time,
     # for instance, to simulate multiple finger swipes.
     #
@@ -21,6 +24,18 @@ module Appium
     # add to a new MultiTouch action.  When ready, call +prepare()+ and all
     # actions will be executed simultaneously.
     #
+    # Consider to use W3C spec touch action like the followings.
+    # https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
+    # https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/w3c_actions_test.rb
+    # https://github.com/appium/ruby_lib_core/blob/master/test/functional/ios/webdriver/w3c_actions_test.rb
+    #
+    # About W3C actions
+    # https://www.youtube.com/watch?v=oAJ7jwMNFVU
+    # https://appiumpro.com/editions/30-ios-specific-touch-action-methods
+    # https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
+    #
+    # Functional test code in ruby_lib_core repository also helps.
+    #
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver
@@ -36,6 +51,10 @@ module Appium
       attr_reader :driver
 
       def initialize(driver)
+        ::Appium::Logger.warn(
+          '[DEPRECATION] Appium::Core::MultiTouch is deprecated in W3C spec. Use W3C actions instead'
+        )
+
         @actions = []
         @driver = driver
       end

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

@@ -14,16 +14,26 @@
 
 module Appium
   module Core
+    #
+    # @deprecated Use W3C actions instead
+    #
     # Perform a series of gestures, one after another.  Gestures are chained
     # together and only performed when +perform()+ is called. Default is conducted by global driver.
     #
     # Each method returns the object itself, so calls can be chained.
     #
     # Consider to use W3C spec touch action like the followings.
-    # https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
+    # https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
     # https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/w3c_actions_test.rb
     # https://github.com/appium/ruby_lib_core/blob/master/test/functional/ios/webdriver/w3c_actions_test.rb
     #
+    # About W3C actions
+    # https://www.youtube.com/watch?v=oAJ7jwMNFVU
+    # https://appiumpro.com/editions/30-ios-specific-touch-action-methods
+    # https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
+    #
+    # Functional test code in ruby_lib_core repository also helps.
+    #
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver
@@ -39,6 +49,10 @@ module Appium
       attr_reader :actions, :driver
 
       def initialize(driver)
+        ::Appium::Logger.warn(
+          '[DEPRECATION] Appium::Core::TouchAction is deprecated in W3C spec. Use W3C actions instead'
+        )
+
         @actions = []
         @driver = driver
       end

data/lib/appium_lib_core/common/wait.rb

@@ -38,6 +38,8 @@ module Appium
         #
         #     result = Appium::Core::Wait.until { @driver.find_element(:id, 'something') }
         #
+        #     result = Appium::Core::Wait.until(timeout: 30, message: 'timeout') { @driver.find_element(:id, 'something') }
+        #
         #     result = Appium::Core::Wait.until(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -82,6 +84,8 @@ module Appium
         #
         #     Appium::Core::Wait.until_true { @driver.find_element(:id, 'something') }
         #
+        #     Appium::Core::Wait.until_true(timeout: 30) { @driver.find_element(:id, 'something') }
+        #
         #     Appium::Core::Wait.until_true(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -133,17 +137,31 @@ module Appium
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
-      # @example
+      # @example With core instance
       #
       #   @core.wait_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @core.wait_until_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_until_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      # @example With driver instance
+      #
+      #   @driver.wait_true { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_true(timeout: 30, interval: 2) { |d| driver.find_element :accessibility_id, 'something' }
       #
-      def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
+      #   @driver.wait_until_true { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_until_true(timeout: 30, interval: 2) { |d| driver.find_element :accessibility_id, 'something' }
+      #
+      def wait_until_true(timeout: nil, interval: nil, message: nil, ignored: nil, &block)
         Wait.until_true(timeout: timeout || @wait_timeout,
                         interval: interval || @wait_interval,
                         message: message,
                         ignored: ignored,
-                        object: self) { yield }
+                        object: self,
+                        &block)
       end
+      alias wait_true wait_until_true
 
       # Check every interval seconds to see if yield doesn't raise an exception.
       # Give up after timeout seconds.
@@ -155,17 +173,31 @@ module Appium
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
-      # @example
+      # @example With core instance
       #
       #   @core.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @core.wait_until { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_until(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      # @example With driver instance
+      #
+      #   @driver.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @driver.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @driver.wait_until { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_until(timeout: 30, interval: 2) { |d| d.find_element :accessibility_id, 'something' }
       #
-      def wait(timeout: nil, interval: nil, message: nil, ignored: nil)
+      def wait_until(timeout: nil, interval: nil, message: nil, ignored: nil, &block)
         Wait.until(timeout: timeout || @wait_timeout,
                    interval: interval || @wait_interval,
                    message: message,
                    ignored: ignored,
-                   object: self) { yield }
+                   object: self,
+                   &block)
       end
+      alias wait wait_until
     end
   end # module Core
 end # module Appium

data/lib/appium_lib_core/driver.rb

@@ -51,7 +51,7 @@ module Appium
 
         @port = appium_lib_opts.fetch :port, Driver::DEFAULT_APPIUM_PORT
 
-        # timeout and interval used in ::Appium::Comm.wait/wait_true
+        # timeout and interval used in ::Appium::Commn.wait/wait_true
         @wait_timeout  = appium_lib_opts.fetch :wait_timeout, ::Appium::Core::Wait::DEFAULT_TIMEOUT
         @wait_interval = appium_lib_opts.fetch :wait_interval, ::Appium::Core::Wait::DEFAULT_INTERVAL
 
@@ -320,7 +320,7 @@ module Appium
       #
       #     # Start iOS driver
       #     opts = {
-      #              caps: {
+      #              capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -364,7 +364,10 @@ module Appium
           @driver = ::Appium::Core::Base::Driver.new(listener: @listener,
                                                      http_client: @http_client,
                                                      capabilities: @caps, # ::Selenium::WebDriver::Remote::Capabilities
-                                                     url: @custom_url)
+                                                     url: @custom_url,
+                                                     wait_timeout: @wait_timeout,
+                                                     wait_interval: @wait_interval,
+                                                     automation_name: @automation_name)
 
           if @direct_connect
             d_c = DirectConnections.new(@driver.capabilities)

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.0.0.rc5' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-10-15' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-11-05' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,27 @@
+#### v5.0.0 2021-11-05
+
+- [e2d1e2d](https://github.com/appium/ruby_lib_core/commit/e2d1e2da59b10f84b3c8ecafba7be6ab27223b73) Release 5.0.0
+- [ac4c312](https://github.com/appium/ruby_lib_core/commit/ac4c312b7e6b314a5e23463d930fb6a957ec3e8f) chore: cleanup dev dependencies
+- [0c84f30](https://github.com/appium/ruby_lib_core/commit/0c84f30a1623445576df70de54d8c46e40948d18) bump rc to 8
+- [8c42356](https://github.com/appium/ruby_lib_core/commit/8c423566315b47cf99150a38be09b059aab4d358) chore: add deprecated in app management (#353)
+- [5ad23bc](https://github.com/appium/ruby_lib_core/commit/5ad23bc0826c7afa36a95066b65aeb00f1742ad8) chore: use ::Selenium::WebDriver::Interactions.pointer as example (#352)
+- [a77a6eb](https://github.com/appium/ruby_lib_core/commit/a77a6ebd87b1116254c4900cebd900a3d106940e) chore: create links
+- [bc13166](https://github.com/appium/ruby_lib_core/commit/bc13166ac7f2e65d94acdf3cff1841863f4b59fe) chore: tweak the order of changelog
+- [a6fa1b9](https://github.com/appium/ruby_lib_core/commit/a6fa1b9a68584915646ff11fef4cc70a750d5d79) chore: add deprecation mark for windows (#351)
+- [c7286ed](https://github.com/appium/ruby_lib_core/commit/c7286eda8bfbaa49154b12d024187fd384171d4e) chore(deps-dev): update rubocop requirement from = 1.22.2 to = 1.22.3 (#350)
+- [d30dff4](https://github.com/appium/ruby_lib_core/commit/d30dff483dec6d0fec67b01f1a28a8c6612e32e6) bump version to 5.0.0.rc7
+- [7f0fe5a](https://github.com/appium/ruby_lib_core/commit/7f0fe5aedf43c9f81636b8db7efd505e93850f00) chore: add deprecations for TouchAction and Multitouch (#348)
+- [9ed1202](https://github.com/appium/ruby_lib_core/commit/9ed1202a7979500a4744ceb340827b16137eb188) chore: remove selendroid stuff (#349)
+- [fc37c9f](https://github.com/appium/ruby_lib_core/commit/fc37c9f1841fcb7efb5c23cf9200a13d0d35bdcf) chore: pass wait_timeout and wait_interval (#346)
+- [1da3e75](https://github.com/appium/ruby_lib_core/commit/1da3e753907ac431d925a1489a50af3fa406638f) chore: bump to rc6
+- [61ebace](https://github.com/appium/ruby_lib_core/commit/61ebaceaf2d4a6450356a0a51ffe67cab0b33287) feat: add a few new wait syntaxes (#344)
+- [d6f73b1](https://github.com/appium/ruby_lib_core/commit/d6f73b131fd6c8da96b45edfaa6c6db9a85b383a) chore(deps-dev): update rubocop requirement from = 1.22.1 to = 1.22.2 (#345)
+- [0d69af1](https://github.com/appium/ruby_lib_core/commit/0d69af1b93deefd343c910833557a39ceaef59da) chore: cleanup a bit (#342)
+- [115465e](https://github.com/appium/ruby_lib_core/commit/115465e2b73e65dd3777e698d98f1cdaa161f3eb) chore: append example in wait
+- [ad519ee](https://github.com/appium/ruby_lib_core/commit/ad519ee70ba7b7122107b8b2d986ff1523b654d0) chore: update rubocop (#341)
+- [e13b0ef](https://github.com/appium/ruby_lib_core/commit/e13b0efae6b964cc6b0e7b0ed10816eaf6e007d4) feat: selenium v4 base (#315)
+
+
 #### v4.7.1 2021-09-26
 
 - [cdd8906](https://github.com/appium/ruby_lib_core/commit/cdd890662585aa5051912d20d90ec3c3866ad8b1) Release 4.7.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc5
+  version: 5.0.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.22.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.22.3
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -150,34 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -336,9 +294,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.15
 signing_key: