feat: bump ruby lib core v8 (#1018)

- BREAKING: Remove Appium::MultiTouch and Appium::TouchAction
appium · Mar 16, 2024 · c450c20 · c450c20
1 parent 9d40e0e
commit c450c20
Show file tree

Hide file tree

Showing 14 changed files with 22 additions and 478 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,11 +3,18 @@ Commit based release not is [release_notes.md](./release_notes.md)
 
 Release tags are https://github.com/appium/ruby_lib/releases .
 
+## (not released yet)
+- Breaking
+    - Use appium_lib_core 8.0.0 and up
+        - Please refer to [the diff](https://github.com/appium/ruby_lib_core/blob/master/CHANGELOG.md#800---2024-03-08) about the details.
+        - Remove `Appium::MultiTouch` and `Appium::TouchAction`
+            - `swipe` could use `mobile:swipe`, or w3c actions. Multi-touch actions such as zoom/pinch can be written in w3c actions.
+            - Please use [w3c actions](https://github.com/appium/ruby_lib/blob/master/docs/w3c.md) instead. Several resources such as [test code in ruby_lib_core](https://github.com/appium/ruby_lib_core/blob/master/test/functional/common_w3c_actions.rb) also would help to check the syntax.
 
 ## 14.0.0 - 2024-01-25
 - Use appium_lib_core  7.4.0 and up
     - Removed deprecated `export_session` and `export_session_path`
-    - Please get the session id via `driver.session_id` intead
+    - Please get the session id via `driver.session_id` instead
 
 ## 13.0.2 - 2024-01-25
 - Allow up to appium_lib_core 7.3

diff --git a/android_tests/lib/android/specs/device/touch_actions.rb b/android_tests/lib/android/specs/device/touch_actions.rb
diff --git a/appium_lib.gemspec b/appium_lib.gemspec
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/appium/ruby_lib' # published as appium_lib
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'appium_lib_core', '>= 7.4.0', '< 8'
+  s.add_runtime_dependency 'appium_lib_core', '~> 8.0.0'
   s.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.1'
   s.add_runtime_dependency 'tomlrb', '>= 1.1', '< 3.0'
 

diff --git a/docs/w3c.md b/docs/w3c.md
@@ -11,11 +11,15 @@ dialect #=> :w3c
 el = find_element(:name, 'Pickers')
 driver.action.click(el).perform #=> work
 
+
+# Scroll/Swipe
 driver.action
       .move_to_location(500, 500).pointer_down(:left)
       .move_to_location(0, 700)
       .release.perform
 
+
+# Zoom in
 # multiple action chains
 f1 = driver.action.add_pointer_input(:touch, 'finger1')
 f1.create_pointer_move(duration: 1, x: 200, y: 500,
@@ -48,4 +52,4 @@ driver.perform_actions [f1, f2]
 ## Limitations
 - WebDriverAgent support only `touch` as a `pointer type`.
     - By default, [ruby_lib_core](https://github.com/appium/ruby_lib_core/blob/ab5d7c5ed31f318a9395e5aeafe1d0d655d3cff4/lib/appium_lib_core/common/base/w3c_bridge.rb#L26) generate `touch` based actions.
-    - About `pointer type` => [W3C](https://www.w3.org/TR/webdriver/#perform-actions) and [Simple WD Spec](https://github.com/jlipps/simple-wd-spec#perform-actions) 
+    - About `pointer type` => [W3C](https://www.w3.org/TR/webdriver/#perform-actions) and [Simple WD Spec](https://github.com/jlipps/simple-wd-spec#perform-actions)
diff --git a/ios_tests/appium.txt b/ios_tests/appium.txt
@@ -1,6 +1,6 @@
 [caps]
 platformName = "ios"
-platformVersion = "17.0"
+platformVersion = "17.2"
 deviceName ="iPhone 15"
 automationName = 'XCUITest'
 app = "../test_apps/UICatalog.app.zip"

diff --git a/ios_tests/lib/ios/specs/device/device.rb b/ios_tests/lib/ios/specs/device/device.rb
@@ -40,10 +40,6 @@ def go_back
     proc { screen }.must_raise ::Selenium::WebDriver::Error::NoSuchElementError
   end
 
-  t 'reset' do
-    reset
-  end
-
   t 'app_strings' do
     app_strings.must_include 'A Short Title Is Best'
     app_strings('en').must_include 'A Short Title Is Best'

diff --git a/ios_tests/lib/ios/specs/device/multi_touch.rb b/ios_tests/lib/ios/specs/device/multi_touch.rb
diff --git a/ios_tests/lib/ios/specs/device/touch_actions.rb b/ios_tests/lib/ios/specs/device/touch_actions.rb
diff --git a/ios_tests/parallel/test.rb b/ios_tests/parallel/test.rb
@@ -53,9 +53,9 @@ def test_run
 
     sleep 5
 
-    # TouchAction
+    # TODO: fixme
     text_elem = @appium.text(@appium.app_strings['ButtonsExplain'])
-    @appium.tap x: 0, y: 0, element: text_elem
+    @appium.driver.action.click(text_elem).perform
     @appium.back
 
     teardown
@@ -92,9 +92,10 @@ def test_run
 
     sleep 5
 
+    # TODO: fixme
     # TouchAction
     text_elem = text(app_strings['ButtonsExplain'])
-    tap x: 0, y: 0, element: text_elem
+    driver.action.click(text_elem).perform
     back
 
     teardown

diff --git a/lib/appium_lib/appium.rb b/lib/appium_lib/appium.rb
@@ -26,8 +26,6 @@
 require_relative 'common/wait'
 require_relative 'common/log'
 require_relative 'common/helper'
-require_relative 'common/multi_touch'
-require_relative 'common/touch_actions'
 require_relative 'common/http_client'
 require_relative 'common/device'
 require_relative 'common/command'

diff --git a/lib/appium_lib/common/device.rb b/lib/appium_lib/common/device.rb
@@ -15,29 +15,5 @@
 module Appium
   module Device
     extend Forwardable
-
-    class << self
-      def extended(_mod)
-        add_touch_actions
-      end
-
-      private
-
-      def add_touch_actions
-        actions = Appium::TouchAction::COMPLEX_ACTIONS
-        actions.each do |method|
-          delegate_from_appium_driver(method, Appium::TouchAction)
-        end
-
-        # To keep compatibility
-        # pinch and zoom are defined in Appium::MultiTouch.
-        delegate_from_appium_driver(:pinch, Appium::MultiTouch)
-        delegate_from_appium_driver(:zoom, Appium::MultiTouch)
-      end
-
-      def delegate_from_appium_driver(method, delegation_target)
-        def_delegator delegation_target, method
-      end
-    end # class << self
   end # module Device
 end # module Appium