appium_lib_core 3.2.0 → 3.2.1

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

@@ -51,15 +51,15 @@ module Appium
           @bridge.dialect
         end
 
-        # 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
+        # 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.
         #
         # @example
         #
-        #     driver = core.start_driver server_url: 'http://example1.com:8000/wd/hub # @bridge.http is for `http://example1.com:8000/wd/hub/`
+        #     driver = core.start_driver server_url: 'http://example1.com:8000/wd/hub # @bridge.http is for 'http://example1.com:8000/wd/hub/'
         #     driver.update_sending_request_to protocol: 'https', host: 'example2.com', port: 9000, path: '/wd/hub'
-        #     driver.manage.timeouts.implicit_wait = 10 # @bridge.http is for `https://example2.com:9000/wd/hub/`
+        #     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,
@@ -110,7 +110,7 @@ module Appium
         #   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`.
+        #   Default for iOS is +:pressKey+. Default for Android is +:tapOutside+.
         #
         # @example
         #
@@ -312,13 +312,13 @@ module Appium
         #
         #   result = @driver.within_context('NATIVE_APP') do
         #     @driver.find_element :tag, "button"
-        #   end # The result of `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)
         end
 
-        # Change to the default context. This is equivalent to `set_context nil`.
+        # Change to the default context. This is equivalent to +set_context nil+.
         #
         # @example
         #
@@ -368,6 +368,8 @@ module Appium
         #   @driver.set_immediate_value element, 'hello'
         #
         def set_immediate_value(element, *value)
+          ::Appium::Logger.warn '[DEPRECATION] driver#set_immediate_value(element, *value) is deprecated. ' \
+            'Use Element#immediate_value(*value) instead'
           @bridge.set_immediate_value(element, *value)
         end
 
@@ -375,9 +377,11 @@ module Appium
         #
         # @example
         #
-        #   replace_value element, 'hello'
+        #   @driver.replace_value element, 'hello'
         #
         def replace_value(element, *value)
+          ::Appium::Logger.warn '[DEPRECATION] driver#replace_value(element, *value) is deprecated. ' \
+            'Use Element#replace_value(*value) instead'
           @bridge.replace_value(element, *value)
         end
 
@@ -495,15 +499,15 @@ module Appium
 
         # 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
-        #                      e.g.: KEYCODE_HOME is `3` or `0x00000003`
+        # @param [Integer] key The key to press. The values which have +KEYCODE_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                      e.g.: KEYCODE_HOME is +3+ or +0x00000003+
         # @param [[Integer]] metastate The state the metakeys should be in when pressing the key. Default is empty Array.
-        #                              Metastate have `META_` prefix in https://developer.android.com/reference/android/view/KeyEvent.html
-        #                              e.g.: META_SHIFT_ON is `1` or `0x00000001`
+        #                              Metastate have +META_+ prefix in https://developer.android.com/reference/android/view/KeyEvent.html
+        #                              e.g.: META_SHIFT_ON is +1+ or +0x00000001+
         # @param [[Integer]] flags Native Android flag value. Several flags can be combined into a single key event.
         #                          Default is empty Array.  Can set multiple flags as Array.
-        #                          Flags have `FLAG_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
-        #                          e.g.: FLAG_CANCELED is `32` or `0x00000020`
+        #                          Flags have +FLAG_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                          e.g.: FLAG_CANCELED is +32+ or +0x00000020+
         #
         # @example
         #
@@ -517,15 +521,15 @@ module Appium
 
         # Long press keycode on the device.
         # http://developer.android.com/reference/android/view/KeyEvent.html
-        # @param [Integer] key The key to long press. The values which have `KEYCODE_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
-        #                      e.g.: KEYCODE_HOME is `3` or `0x00000003`
+        # @param [Integer] key The key to long press. The values which have +KEYCODE_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                      e.g.: KEYCODE_HOME is +3+ or +0x00000003+
         # @param [[Integer]] metastate The state the metakeys should be in when pressing the key. Default is empty Array.
-        #                              Metastate have `META_` prefix in https://developer.android.com/reference/android/view/KeyEvent.html
-        #                              e.g.: META_SHIFT_ON is `1` or `0x00000001`
+        #                              Metastate have +META_+ prefix in https://developer.android.com/reference/android/view/KeyEvent.html
+        #                              e.g.: META_SHIFT_ON is +1+ or +0x00000001+
         # @param [[Integer]] flags Native Android flag value. Several flags can be combined into a single key event.
         #                          Default is empty Array. Can set multiple flags as Array.
-        #                          Flags have `FLAG_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
-        #                          e.g.: FLAG_CANCELED is `32` or `0x00000020`
+        #                          Flags have +FLAG_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                          e.g.: FLAG_CANCELED is +32+ or +0x00000020+
         #
         # @example
         #
@@ -598,14 +602,14 @@ module Appium
         # @param [String] path The absolute local path or remote http URL to an .ipa or .apk file,
         #                      or a .zip containing one of these.
         # @param [Boolean] replace Only for Android. Whether to reinstall/upgrade the package if it is already present
-        #                          on the device under test. `true` by default
+        #                          on the device under test. +true+ by default
         # @param [Integer] timeout Only for Android. How much time to wait for the installation to complete.
         #                          60000ms by default.
         # @param [Boolean] allow_test_packages Only for Android. Whether to allow installation of packages marked as test
-        #                                      in the manifest. `false` by default
-        # @param [Boolean] use_sdcard Only for Android. Whether to use the SD card to install the app. `false` by default
+        #                                      in the manifest. +false+ by default
+        # @param [Boolean] use_sdcard Only for Android. Whether to use the SD card to install the app. +false+ by default
         # @param [Boolean] grant_permissions Only for Android. whether to automatically grant application permissions
-        #                                    on Android 6+ after the installation completes. `false` by default
+        #                                    on Android 6+ after the installation completes. +false+ by default
         #
         # @example
         #
@@ -629,7 +633,7 @@ module Appium
 
         # @param [Strong] app_id BundleId for iOS or package name for Android
         # @param [Boolean] keep_data Only for Android. Whether to keep application data and caches after it is uninstalled.
-        #                             `false` by default
+        #                             +false+ by default
         # @param [Integer] timeout Only for Android. How much time to wait for the uninstall to complete. 20000ms by default.
         #
         # @example
@@ -728,7 +732,7 @@ module Appium
         #
         #    # iOS
         #    @driver.start_recording_screen video_type: 'libx264'
-        #    @driver.stop_and_save_recording_screen 'example.mp4' # Video type `libx264` can be play as `.mp4` video
+        #    @driver.stop_and_save_recording_screen 'example.mp4' # Video type 'libx264' can be play as '.mp4' video
         #
         #    # Android
         #    @driver.start_recording_screen
@@ -752,7 +756,7 @@ module Appium
         #
         # @param [String] format The set of format specifiers. Read https://momentjs.com/docs/ to get
         #                        the full list of supported datetime format specifiers.
-        #                        The default format is `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601
+        #                        The default format is +YYYY-MM-DDTHH:mm:ssZ+, which complies to ISO-8601
         # @return [String] Formatted datetime string or the raw command output if formatting fails
         #
         # @example
@@ -774,7 +778,7 @@ module Appium
         end
 
         #
-        # Send multiple W3C action chains to server. Use `@driver.action` for single action chain.
+        # Send multiple W3C action chains to server. Use +@driver.action+ for single action chain.
         #
         # @param [Array] data Array of actions
         # @return nil|error
@@ -797,7 +801,7 @@ module Appium
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f2.create_pointer_up(:left)
         #
-        #    @driver.perform_actions [f1, f2] #=> `nil` if the action succeed
+        #    @driver.perform_actions [f1, f2] #=> 'nil' if the action succeed
         #
         def perform_actions(data)
           raise ArgumentError, "'#{data}' must be Array" unless data.is_a? Array
@@ -868,7 +872,7 @@ module Appium
         end
 
         # Retrieve the capabilities of the specified session.
-        # It's almost same as `@driver.capabilities` but you can get more details.
+        # It's almost same as +@driver.capabilities+ but you can get more details.
         #
         # @return [Selenium::WebDriver::Remote::Capabilities]
         #
@@ -1036,7 +1040,7 @@ module Appium
         #     @@driver.update_settings({ fixImageFindScreenshotDims: false, fixImageTemplateSize: true,
         #                                autoUpdateImageElementPosition: true })
         #     e = @@driver.find_elements_by_image ['./test/functional/data/test_element_image.png']
-        #     e == [] # if the `e` is empty
+        #     e == [] # if the 'e' is empty
         #
         def find_elements_by_image(img_path)
           template = Base64.strict_encode64 File.read img_path
@@ -1053,7 +1057,7 @@ module Appium
         # @param [String] script The string consisting of the script itself
         # @param [String] type The name of the script type.
         #                      Defaults to 'webdriverio'. Depends on server implementation which type is supported.
-        # @param [Integer] timeout_ms The number of `ms` Appium should wait for the script to finish
+        # @param [Integer] timeout_ms The number of +ms+ Appium should wait for the script to finish
         #                          before killing it due to timeout.
         #
         # @return [Appium::Core::Base::Device::ExecuteDriver::Result] The script result parsed by
@@ -1070,8 +1074,8 @@ module Appium
         #      SCRIPT
         #      r = @@driver.execute_driver(script: script, type: 'webdriverio', timeout: 10_000)
         #      r        #=> An instance of Appium::Core::Base::Device::ExecuteDriver::Result
-        #      r.result #=> The `result` key part as the result of the script
-        #      r.logs   #=> The `logs` key part as `{'log' => [], 'warn' => [], 'error' => []}`
+        #      r.result #=> The 'result' key part as the result of the script
+        #      r.logs   #=> The 'logs' key part as '{'log' => [], 'warn' => [], 'error' => []}'
         #
         def execute_driver(script: '', type: 'webdriverio', timeout_ms: nil)
           @bridge.execute_driver(script: script, type: type, timeout_ms: timeout_ms)

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

@@ -34,13 +34,13 @@ module Appium
           # @param [string|integer] port A port number to update server_url to
           # @param [string] path A path to update server_url to
           #
-          # @return [URI] An instance of URI updated to. Returns default `server_url` if some of arguments are `nil`
+          # @return [URI] An instance of URI updated to. Returns default +server_url+ if some of arguments are +nil+
           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
+            # 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/platform.rb

@@ -22,7 +22,7 @@ module Appium
       #
       # @example
       #
-      #   ::Appium::Core::Base.platform.windows? #=> `true` or `false`
+      #   ::Appium::Core::Base.platform.windows? #=> 'true' or 'false'
       #
       def self.platform
         ::Selenium::WebDriver::Platform

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

@@ -94,7 +94,7 @@ module Appium
 
         # @since Appium 1.3.4
         # @!method save_viewport_screenshot
-        # Save screenshot except for status bar while `@driver.save_screenshot` save entire screen.
+        # Save screenshot except for status bar while +@driver.save_screenshot+ save entire screen.
         #
         # @example
         #

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

@@ -93,7 +93,7 @@ module Appium
         #     ## With uiautomator
         #     @driver.find_elements :uiautomator, 'new UiSelector().clickable(true)'
         #     ## With viewtag, but only for Espresso
-        #     ## `setTag`/`getTag` in https://developer.android.com/reference/android/view/View
+        #     ## 'setTag'/'getTag' in https://developer.android.com/reference/android/view/View
         #     @driver.find_elements :viewtag, 'new UiSelector().clickable(true)'
         #     # With data_matcher. The argument should be JSON format.
         #     @driver.find_elements :data_matcher, { name: 'hasEntry', args: %w(title Animation) }.to_json
@@ -111,9 +111,9 @@ module Appium
         #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow'
         #     ### select the second last child of the second child window
         #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
-        #     ### matching predicate. <code>`</code> is the mark.
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[`visible = 1][`name = "bla"`]'
-        #     ### containing predicate. `$` is the mark.
+        #     ### matching predicate. <code>'</code> is the mark.
+        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow['visible = 1]['name = "bla"']'
+        #     ### containing predicate. '$' is the mark.
         #     ### Require appium-xcuitest-driver 2.54.0+. PR: https://github.com/facebook/WebDriverAgent/pull/707/files
         #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[$name = \"bla$$$bla\"$]'
         #     e = find_element :class_chain, "**/XCUIElementTypeWindow[$name == 'Buttons'$]"

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

@@ -113,7 +113,7 @@ module Appium
           end
 
           # Performs images matching to calculate the similarity score between them
-          # with default options. The flow there is similar to the one used in `find_image_occurrence`
+          # with default options. The flow there is similar to the one used in +find_image_occurrence+
           # but it is mandatory that both images are of equal size.
           #
           # @param [String] first_image An image data. All image formats, that OpenCV library itself accepts, are supported.
@@ -140,14 +140,14 @@ module Appium
           # It is expected that both OpenCV framework and opencv4nodejs
           # module are installed on the machine where Appium server is running.
           #
-          # @param [Symbol] mode One of possible comparison modes: `:matchFeatures`, `:getSimilarity`, `:matchTemplate`.
-          #                      `:matchFeatures is by default.
+          # @param [Symbol] mode One of possible comparison modes: +:matchFeatures+, +:getSimilarity+, +:matchTemplate+.
+          #                      +: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.
-          #                       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.
+          # @param [Hash] 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.
           #
           def compare_images(mode: :matchFeatures, first_image:, second_image:, options: nil)
             raise "content_type should be #{MODE}" unless MODE.member?(mode)

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

@@ -17,8 +17,8 @@ module Appium
     # MultiTouch actions allow for multiple touches to happen at the same time,
     # for instance, to simulate multiple finger swipes.
     #
-    # Create a series of touch actions by themselves (without a `prepare()`), then
-    # add to a new MultiTouch action.  When ready, call `prepare()` and all
+    # Create a series of touch actions by themselves (without a +prepare()+), then
+    # add to a new MultiTouch action.  When ready, call +prepare()+ and all
     # actions will be executed simultaneously.
     #
     # @example

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

@@ -15,7 +15,7 @@
 module Appium
   module Core
     # 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.
+    # 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.
     #
@@ -45,7 +45,7 @@ module Appium
 
       # Move to the given co-ordinates.
       #
-      # `move_to`'s `x` and `y` have two case. One is working as coordinate, the other is working as offset.
+      # +move_to+'s +x+ and +y+ have two case. One is working as coordinate, the other is working as offset.
       #
       # @param opts [Hash] Options
       # @option opts [integer] :x x co-ordinate to move to if element isn't set. Works as an absolute if x is set with Element.
@@ -57,7 +57,7 @@ module Appium
       end
 
       # Press down for a specific duration.
-      # Alternatively, you can use `press(...).wait(...).release()` instead of `long_press` if duration doesn't work well.
+      # 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
       #
@@ -72,14 +72,14 @@ module Appium
         chain_method(:longPress, args) # longPress is what the appium server expects
       end
 
-      # Press a finger onto the screen.  Finger will stay down until you call `release`.
+      # Press a finger onto the screen.  Finger will stay down until you call +release+.
       #
       # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to press within.
       # @option opts [integer] :x x co-ordinate to press on
       # @option opts [integer] :y y co-ordinate to press on
       # @option opts [Float] pressure (iOS Only) press as force touch.
-      #                                          See the description of `force` property on Apple's UITouch class
+      #                                          See the description of +force+ property on Apple's UITouch class
       #                                          (https://developer.apple.com/documentation/uikit/uitouch?language=objc)
       #                                          for more details on possible value ranges.
       def press(opts)
@@ -101,7 +101,7 @@ module Appium
       end
 
       # Touch a point on the screen.
-      # Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`.
+      # Alternatively, you can use +press(...).release.perform+ instead of +tap(...).perform+.
       #
       # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.

data/lib/appium_lib_core/common/wait.rb

@@ -28,8 +28,8 @@ module Appium
         #
         # If only a number is provided then it's treated as the timeout value.
         #
-        # @param [Integer] timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
-        # @param [Integer] interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+        # @param [Integer] timeout Seconds to wait before timing out. Set default by +appium_wait_timeout+ (30).
+        # @param [Integer] interval Seconds to sleep between polls. Set default by +appium_wait_interval+ (0.5).
         # @param [String] message Exception message if timed out.
         # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
         # @param [Object, NilClass] object Object to evaluate block against
@@ -72,8 +72,8 @@ module Appium
         #
         # If only a number is provided then it's treated as the timeout value.
         #
-        # @param [Integer] timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
-        # @param [Integer] interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+        # @param [Integer] timeout Seconds to wait before timing out. Set default by +appium_wait_timeout+ (30).
+        # @param [Integer] interval Seconds to sleep between polls. Set default by +appium_wait_interval+ (0.5).
         # @param [String] message Exception message if timed out.
         # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
         # @param [Object, NilClass] object Object to evaluate block against
@@ -128,8 +128,8 @@ module Appium
       #
       # If only a number is provided then it's treated as the timeout value.
       #
-      # @param [Integer] timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
-      # @param [Integer] interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+      # @param [Integer] timeout Seconds to wait before timing out. Set default by +appium_wait_timeout+ (30).
+      # @param [Integer] interval Seconds to sleep between polls. Set default by +appium_wait_interval+ (0.5).
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
@@ -150,8 +150,8 @@ module Appium
       #
       # If only a number is provided then it's treated as the timeout value.
       #
-      # @param [Integer] timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
-      # @param [Integer] interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+      # @param [Integer] timeout Seconds to wait before timing out. Set default by +appium_wait_timeout+ (30).
+      # @param [Integer] interval Seconds to sleep between polls. Set default by +appium_wait_interval+ (0.5).
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #

data/lib/appium_lib_core/common/ws/websocket.rb

@@ -25,13 +25,13 @@ module Appium
       # with close method.
       #
       # @param [String] url URL to establish web socket connection. If the URL has no port, the client use:
-      #                     `ws`: 80, `wss`: 443 ports.
+      #                     +ws+: 80, +wss+: 443 ports.
       # @param [Array] protocols An array of strings representing acceptable subprotocols for use over the socket.
       #                          The driver will negotiate one of these to use via the Sec-WebSocket-Protocol header
       #                          if supported by the other peer. Default is nil.
       #                          The protocols is equal to https://github.com/faye/faye-websocket-ruby/ 's one for client.
       # @param [Hash] options Initialize options for Faye client. Read https://github.com/faye/faye-websocket-ruby#initialization-options
-      #                       for more details. Default is `{}`.
+      #                       for more details. Default is +{}+.
       #
       # @example
       #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
@@ -127,7 +127,7 @@ module Appium
       # In general, users should customise only message_data
 
       #
-      # Fires when the socket receives a message. The message gas one `data` attribute and this method can handle the data.
+      # Fires when the socket receives a message. The message gas one +data+ attribute and this method can handle the data.
       # The data is either a String (for text frames) or an Array of byte-sized integers (for binary frames).
       #
       # Default is just put a debug message and puts the result on standard out.
@@ -149,11 +149,11 @@ module Appium
       end
 
       #
-      # Fires when either the client or the server closes the connection. The method gets `code` and `reason` attributes.
+      # Fires when either the client or the server closes the connection. The method gets +code+ and +reason+ attributes.
       # They expose the status code and message sent by the peer that closed the connection.
       #
       # Default is just put a error message.
-      # The methods also clear `client` instance and stop the eventmachine which is called in initialising this class.
+      # The methods also clear +client+ instance and stop the eventmachine which is called in initialising this class.
       #
       def handle_close(code, reason)
         ::Appium::Logger.debug %W(#{self.class} :close #{code} #{reason})

data/lib/appium_lib_core/driver.rb

@@ -51,7 +51,7 @@ module Appium
         @wait_interval = appium_lib_opts.fetch :wait_interval, ::Appium::Core::Wait::DEFAULT_INTERVAL
 
         # to pass it in Selenium.new.
-        # `listener = opts.delete(:listener)` is called in Selenium::Driver.new
+        # 'listener = opts.delete(:listener)' is called in Selenium::Driver.new
         @listener = appium_lib_opts.fetch :listener, nil
       end
 
@@ -184,9 +184,9 @@ module Appium
       #
       #     # format 1
       #     @core = Appium::Core.for caps: {...}, appium_lib: {...}
-      #     # format 2. `desired_capabilities:` is also available instead of `caps:`. Either is fine.
+      #     # format 2. 'desired_capabilities:' is also available instead of 'caps:'. Either is fine.
       #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}, appium_lib: {...}
-      #     # format 3. `appium_lib: {...}` can be blank
+      #     # format 3. 'appium_lib: {...}' can be blank
       #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}
       #
       #
@@ -211,11 +211,11 @@ module Appium
       #                listener: nil,
       #              }
       #            }
-      #     @core = Appium::Core.for(opts) # create a core driver with `opts` and extend methods into `self`
-      #     @core.start_driver # Connect to `http://127.0.0.1:8080/wd/hub` because of `port: 8080`
+      #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
+      #     @core.start_driver # Connect to 'http://127.0.0.1:8080/wd/hub' because of 'port: 8080'
       #
       #     # Start iOS driver with .zip file over HTTP
-      #     #  `desired_capabilities:` is also available instead of `caps:`. Either is fine.
+      #     #  'desired_capabilities:' is also available instead of 'caps:'. Either is fine.
       #     opts = {
       #              desired_capabilities: {
       #                platformName: :ios,
@@ -234,9 +234,9 @@ module Appium
       #              }
       #            }
       #     @core = Appium::Core.for(opts)
-      #     @core.start_driver # Connect to `http://custom-host:8080/wd/hub.com`
+      #     @core.start_driver # Connect to 'http://custom-host:8080/wd/hub.com'
       #
-      #     # Start iOS driver as another format. `url` is available like below
+      #     # Start iOS driver as another format. 'url' is available like below
       #     opts = {
       #              url: "http://custom-host:8080/wd/hub.com",
       #              desired_capabilities: {
@@ -254,8 +254,8 @@ module Appium
       #                listener: nil,
       #              }
       #            }
-      #     @core = Appium::Core.for(opts) # create a core driver with `opts` and extend methods into `self`
-      #     @core.start_driver # start driver with `url`. Connect to `http://custom-host:8080/wd/hub.com`
+      #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
+      #     @core.start_driver # start driver with 'url'. Connect to 'http://custom-host:8080/wd/hub.com'
       #
       def self.for(opts = {})
         new(opts)
@@ -274,7 +274,7 @@ module Appium
       # @private
       def initialize(opts = {})
         @delegate_target = self # for testing purpose
-        @automation_name = nil # initialise before `set_automation_name`
+        @automation_name = nil # initialise before 'set_automation_name'
 
         opts = Appium.symbolize_keys opts
         validate_keys(opts)
@@ -325,7 +325,7 @@ module Appium
       #              }
       #            }
       #
-      #     @core = Appium::Core.for(opts) # create a core driver with `opts` and extend methods into `self`
+      #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
       #     @driver = @core.start_driver server_url: "http://127.0.0.1:8000/wd/hub"
       #
       #     # Attach custom HTTP client
@@ -421,7 +421,7 @@ module Appium
       #         }
       #     }
       #
-      # Returns blank hash for Selenium Grid since `remote_status` gets 500 error
+      # Returns blank hash for Selenium Grid since 'remote_status' gets 500 error
       #
       # @example
       #
@@ -456,7 +456,7 @@ module Appium
       # @example
       #
       #   @core.screenshot '/tmp/hi.png' #=> nil
-      #   # same as `@driver.save_screenshot png_save_path`
+      #   # same as '@driver.save_screenshot png_save_path'
       #
       def screenshot(png_save_path)
         ::Appium::Logger.warn '[DEPRECATION] screenshot will be removed. Please use driver.save_screenshot instead.'
@@ -496,11 +496,14 @@ module Appium
         when :tizen
           # https://github.com/Samsung/appium-tizen-driver
           ::Appium::Logger.debug('tizen')
-        when :youiengine
-          # https://github.com/YOU-i-Labs/appium-youiengine-driver
-          ::Appium::Logger.debug('YouiEngine')
         else
-          ::Appium::Logger.warn('no device matched')
+          case automation_name
+          when :youiengine
+            # https://github.com/YOU-i-Labs/appium-youiengine-driver
+            ::Appium::Logger.debug('YouiEngine')
+          else
+            ::Appium::Logger.warn("No matched driver by platformName: #{device} and automationName: #{automation_name}")
+          end
         end
 
         self
@@ -541,7 +544,7 @@ module Appium
 
       # @private
       # Path to the .apk, .app or .app.zip.
-      # The path can be local, HTTP/S, Windows Share and other path like `sauce-storage:`.
+      # The path can be local, HTTP/S, Windows Share and other path like 'sauce-storage:'.
       # Use @caps[:app] without modifications if the path isn't HTTP/S or local path.
       def set_app_path
         return unless @caps && @caps[:app] && !@caps[:app].empty?