refactor: loading xcuitest related methods only for XCUITest case (#631)

* make global driver arguments of several methods

* use $ instead of @

* use $ instead of @

* fix rubocop

* separate xcuitest related methos in the xcuitest directory

* reduce global driver in multu touch

* separate some added endpoint method

Author: KazuCocoa

lib/appium_lib/android/device.rb

@@ -0,0 +1,39 @@
+require 'base64'
+
+module Appium
+  module Android
+    module Device
+      extend Forwardable
+
+      # @!method hide_keyboard
+      #   Hide the onscreen keyboard
+      #   @param [String] close_key The name of the key which closes the keyboard.
+      #     Defaults to 'Done' for iOS(except for XCUITest).
+      #   @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
+      #     XCUITest ignore this argument.
+      #     Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
+      #  ```ruby
+      #  hide_keyboard # Close a keyboard with the 'Done' button
+      #  hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
+      #  hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard
+      #  ```
+
+      class << self
+        def extended(_mod)
+          ::Appium::Device.extend_webdriver_with_forwardable
+
+          ::Appium::Device.add_endpoint_method(:hide_keyboard) do
+            def hide_keyboard(close_key = nil, strategy = nil)
+              option = {}
+
+              option[:key] = close_key if close_key
+              option[:strategy] = strategy || :tapOutside # default to pressKey
+
+              execute :hide_keyboard, {}, option
+            end
+          end
+        end
+      end # class << self
+    end # module Device
+  end # module Android
+end # module Appium

lib/appium_lib/device/device.rb

@@ -253,15 +253,8 @@ def app_installed?(app_id)
         end
 
         add_endpoint_method(:background_app) do
-          def background_app(duration = 0, driver = $driver)
-            # https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741
-            # `execute :background_app, {}, seconds: { timeout: duration_milli_sec }` works over Appium 1.6.4
-            if driver.automation_name_is_xcuitest?
-              duration_milli_sec = duration.nil? ? nil : duration * 1000
-              execute :background_app, {}, seconds: { timeout: duration_milli_sec }
-            else
-              execute :background_app, {}, seconds: duration
-            end
+          def background_app(duration = 0)
+            execute :background_app, {}, seconds: duration
           end
         end
 
@@ -292,19 +285,12 @@ def set_context(context = null)
         end
 
         add_endpoint_method(:hide_keyboard) do
-          def hide_keyboard(close_key = nil, strategy = nil, driver = $driver)
+          def hide_keyboard(close_key = nil, strategy = nil)
             option = {}
 
-            if driver.device_is_android? # Android can only tapOutside.
-              option[:key] = close_key if close_key
-              option[:strategy] = strategy || :tapOutside # default to pressKey
-            elsif driver.automation_name_is_xcuitest?
-              option[:key] = close_key if close_key
-              option[:strategy] = strategy if strategy
-            else
-              option[:key] = close_key || 'Done'        # default to Done key.
-              option[:strategy] = strategy || :pressKey # default to pressKey
-            end
+            option[:key] = close_key || 'Done'        # default to Done key.
+            option[:strategy] = strategy || :pressKey # default to pressKey
+
             execute :hide_keyboard, {}, option
           end
         end

lib/appium_lib/device/multi_touch.rb

@@ -29,16 +29,16 @@ def pinch(percentage = 25, auto_perform = true, driver = $driver)
         raise ArgumentError("Can't pinch to greater than screen size.") if percentage > 100
 
         rate = Float(percentage) / 100
+        pinch = MultiTouch.new(driver)
 
-        if driver.automation_name_is_xcuitest?
-          top, bottom = pinch_for_xcuitest(rate, driver)
-        elsif driver.device_is_android?
+        if pinch.driver.automation_name_is_xcuitest?
+          top, bottom = pinch_for_xcuitest(rate, pinch.driver)
+        elsif pinch.driver.device_is_android?
           top, bottom = pinch_android(rate)
         else
           top, bottom = pinch_ios(rate)
         end
 
-        pinch = MultiTouch.new
         pinch.add top
         pinch.add bottom
         return pinch unless auto_perform
@@ -58,16 +58,16 @@ def zoom(percentage = 200, auto_perform = true, driver = $driver)
         raise ArgumentError("Can't zoom to smaller then screen size.") if percentage < 100
 
         rate = 100 / Float(percentage)
+        zoom = MultiTouch.new(driver)
 
-        if driver.automation_name_is_xcuitest?
-          top, bottom = zoom_for_xcuitest(rate, driver)
-        elsif driver.device_is_android?
+        if zoom.driver.automation_name_is_xcuitest?
+          top, bottom = zoom_for_xcuitest(rate, zoom.driver)
+        elsif zoom.driver.device_is_android?
           top, bottom = zoom_android(rate)
         else
           top, bottom = zoom_ios(rate)
         end
 
-        zoom = MultiTouch.new
         zoom.add top
         zoom.add bottom
         return zoom unless auto_perform
@@ -163,11 +163,12 @@ def zoom_ios(rate)
       end
     end # self
 
-    attr_reader :actions
+    attr_reader :actions, :driver
 
-    # Create a new multi-action
-    def initialize
+    # Create a new multi-action with Driver
+    def initialize(driver = $driver)
       @actions = []
+      @driver = driver
     end
 
     # Add a touch_action to be performed
@@ -177,8 +178,8 @@ def add(chain)
     end
 
     # Ask Appium to perform the actions
-    def perform(driver = $driver)
-      driver.multi_touch @actions
+    def perform
+      @driver.multi_touch @actions
       @actions.clear
     end
   end # class MultiTouch

lib/appium_lib/driver.rb

@@ -24,7 +24,12 @@
 require_relative 'ios/element/textfield'
 require_relative 'ios/element/text'
 require_relative 'ios/mobile_methods'
-require_relative 'ios/xcuitest_gestures'
+
+# ios - xcuitest
+require_relative 'ios/xcuitest/element'
+require_relative 'ios/xcuitest/gestures'
+require_relative 'ios/xcuitest/mobile_methods'
+require_relative 'ios/xcuitest/device'
 
 # android
 require_relative 'android/helper'
@@ -37,6 +42,8 @@
 require_relative 'android/element/text'
 require_relative 'android/mobile_methods'
 
+require_relative 'android/device'
+
 # device methods
 require_relative 'device/device'
 require_relative 'device/touch_actions'
@@ -391,11 +398,14 @@ def initialize(opts = {}, driver = $driver)
 
       if device_is_android?
         extend Appium::Android
+        extend Appium::Android::Device
       else
         extend Appium::Ios
-        if automation_name_is_xcuitest? # Override touch actions
+        if automation_name_is_xcuitest?
+          # Override touch actions and patch_webdriver_element
           extend Appium::Ios::Xcuitest
           extend Appium::Ios::Xcuitest::Gesture
+          extend Appium::Ios::Xcuitest::Device
         end
       end
 

lib/appium_lib/ios/mobile_methods.rb

@@ -21,25 +21,5 @@ def extended(_mod)
         ::Appium::Driver::SearchContext::FINDERS[:predicate] = '-ios predicate string'
       end
     end # class << self
-
-    module Xcuitest
-      class << self
-        # @!method ios_class_chain_find
-        #   Only for XCUITest(WebDriverAgent)
-        #   find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries)
-        #
-        #   ```ruby
-        #    # select the third child button of the first child window element
-        #    find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
-        #    # select all the children windows
-        #    find_elements :class_chain, 'XCUIElementTypeWindow'
-        #    # select the second last child of the second child window
-        #    find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
-        #   ```
-        def extended(_mod)
-          ::Appium::Driver::SearchContext::FINDERS[:class_chain] = '-ios class chain'
-        end
-      end
-    end
   end # module Ios
 end # module Appium

lib/appium_lib/ios/xcuitest/device.rb

@@ -0,0 +1,59 @@
+require 'base64'
+
+module Appium
+  module Ios
+    module Xcuitest
+      module Device
+        extend Forwardable
+
+        # @!method hide_keyboard
+        #   Hide the onscreen keyboard
+        #   @param [String] close_key The name of the key which closes the keyboard.
+        #   @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
+        #     XCUITest ignore this argument.
+        #     Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
+        #  ```ruby
+        #  hide_keyboard # Close a keyboard with the 'Done' button
+        #  hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
+        #  ```
+
+        # @!method background_app
+        #  Backgrounds the app for a set number of seconds.
+        #  This is a blocking application
+        # @param [Integer] seconds How many seconds to background the app for.
+        #
+        #   ```ruby
+        #   background_app
+        #   background_app(5)
+        #   background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
+        #   ```
+
+        class << self
+          def extended(_mod)
+            ::Appium::Device.extend_webdriver_with_forwardable
+
+            ::Appium::Device.add_endpoint_method(:hide_keyboard) do
+              def hide_keyboard(close_key = nil, strategy = nil)
+                option = {}
+
+                option[:key] = close_key if close_key
+                option[:strategy] = strategy if strategy
+
+                execute :hide_keyboard, {}, option
+              end
+            end
+
+            ::Appium::Device.add_endpoint_method(:background_app) do
+              def background_app(duration = 0)
+                # https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741
+                # `execute :background_app, {}, seconds: { timeout: duration_milli_sec }` works over Appium 1.6.4
+                duration_milli_sec = duration.nil? ? nil : duration * 1000
+                execute :background_app, {}, seconds: { timeout: duration_milli_sec }
+              end
+            end
+          end
+        end # class << self
+      end # module Device
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

lib/appium_lib/ios/xcuitest/element.rb

@@ -0,0 +1,24 @@
+module Appium
+  module Ios
+    module Xcuitest
+      # @private
+      # class_eval inside a method because class Selenium::WebDriver::Element
+      # will trigger as soon as the file is required. in contrast a method
+      # will trigger only when invoked.
+      def patch_webdriver_element
+        Selenium::WebDriver::Element.class_eval do
+          # Enable access to iOS accessibility label
+          # accessibility identifier is supported as 'name'
+          def label
+            attribute('label')
+          end
+
+          # Cross platform way of entering text into a textfield
+          def type(text)
+            send_keys text
+          end # def type
+        end # Selenium::WebDriver::Element.class_eval
+      end # def patch_webdriver_element
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

lib/appium_lib/ios/xcuitest_gestures.rb renamed to lib/appium_lib/ios/xcuitest/gestures.rb

@@ -0,0 +1,23 @@
+module Appium
+  module Ios
+    module Xcuitest
+      class << self
+        # @!method ios_class_chain_find
+        #   Only for XCUITest(WebDriverAgent)
+        #   find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries)
+        #
+        #   ```ruby
+        #    # select the third child button of the first child window element
+        #    find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
+        #    # select all the children windows
+        #    find_elements :class_chain, 'XCUIElementTypeWindow'
+        #    # select the second last child of the second child window
+        #    find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
+        #   ```
+        def extended(_mod)
+          ::Appium::Driver::SearchContext::FINDERS[:class_chain] = '-ios class chain'
+        end
+      end
+    end
+  end # module Ios
+end # module Appium