appium_lib 10.4.0 → 11.1.0

data/lib/appium_lib/android/common/helper.rb

@@ -27,7 +27,7 @@ module Appium
         @filter = value.to_s.downcase
       end
 
-      def initialize
+      def initialize # rubocop:disable Lint/MissingSuper
         reset
         @filter   = false
       end
@@ -217,7 +217,7 @@ module Appium
       # [^\/]+          - type is made up of at least one non-/ characters
       # \\/             - / ends the type and starts the name
       # [\S]+$          - the name contains at least one non-space character and then the line is ended
-      resource_id = /^[a-zA-Z_][a-zA-Z0-9\._]*:[^\/]+\/[\S]+$/
+      resource_id = /^[a-zA-Z_][a-zA-Z0-9._]*:[^\/]+\/\S+$/
       string.match(resource_id) ? on_match : ''
     end
 

data/lib/appium_lib/android/element/button.rb

@@ -60,9 +60,9 @@ module Appium
       # uiautomator index doesn't support last
       # and it's 0 indexed
       button_index = tags(BUTTON).length
-      button_index -= 1 if button_index > 0
+      button_index -= 1 if button_index.positive?
       image_button_index = tags(IMAGE_BUTTON).length
-      image_button_index -= 1 if image_button_index > 0
+      image_button_index -= 1 if image_button_index.positive?
 
       find_element :uiautomator,
                    _button_visible_selectors(button_index: button_index,

data/lib/appium_lib/android/espresso/element/button.rb

@@ -63,9 +63,9 @@ module Appium
           # uiautomator index doesn't support last
           # and it's 0 indexed
           button_index = tags(::Appium::Android::BUTTON).length
-          button_index -= 1 if button_index > 0
+          button_index -= 1 if button_index.positive?
           image_button_index = tags(::Appium::Android::IMAGE_BUTTON).length
-          image_button_index -= 1 if image_button_index > 0
+          image_button_index -= 1 if image_button_index.positive?
 
           _button_visible_selectors_xpath(button_index: button_index,
                                           image_button_index: image_button_index)

data/lib/appium_lib/android/uiautomator2/element/button.rb

@@ -60,9 +60,9 @@ module Appium
           # uiautomator index doesn't support last
           # and it's 0 indexed
           button_index = tags(::Appium::Android::Button).length
-          button_index -= 1 if button_index > 0
+          button_index -= 1 if button_index.positive?
           image_button_index = tags(::Appium::Android::ImageButton).length
-          image_button_index -= 1 if image_button_index > 0
+          image_button_index -= 1 if image_button_index.positive?
 
           elements = find_elements :uiautomator,
                                    _button_visible_selectors(button_index: button_index,

data/lib/appium_lib/appium.rb

@@ -77,9 +77,8 @@ module Appium
       Appium::Logger.info "Loading #{toml}" if verbose
 
       data = Tomlrb.load_file(toml, symbolize_keys: true)
-      if verbose
-        Appium::Logger.info data unless data.empty?
-      end
+
+      Appium::Logger.info data if verbose && !data.empty?
 
       if data && data[:caps] && data[:caps][:app] && !data[:caps][:app].empty?
         data[:caps][:app] = Appium::Driver.absolute_app_path data
@@ -200,12 +199,17 @@ module Appium
       raise 'Driver is nil' if driver.nil?
 
       # Wrap single class into an array
-      class_array = [class_array] unless class_array.class == Array
+      class_array = [class_array] unless class_array.instance_of? Array
       # Promote Appium driver methods to class instance methods.
       class_array.each do |klass|
-        driver.public_methods(false).each do |m|
+        driver.public_methods(false).each do |method|
           klass.class_eval do
-            define_method m do |*args, &block|
+            if method_defined? method
+              ::Appium::Logger.warn "'#{method}' is already defined. Skipping to override it."
+              next
+            end
+
+            define_method method do |*args, &block|
               begin
                 # Prefer existing method.
                 # super will invoke method missing on driver
@@ -215,7 +219,14 @@ module Appium
                 # so rescue argument error
                 # and call the name method on $driver
               rescue NoMethodError, ArgumentError
-                driver.send m, *args, &block if driver.respond_to?(m)
+                if args.size == 1 && args.first.is_a?(Hash)
+                  # To prevent warnings by keyword arguments (for Ruby 2.7 and 3)
+                  driver.send method, **args.first, &block if driver.respond_to?(method)
+                else
+                  ::Appium::Logger.warn "Should fix this '#{args}' for Ruby 2.7 (and 3)" if args.first.is_a?(Hash)
+
+                  driver.send method, *args, &block if driver.respond_to?(method)
+                end
               end
             end
           end

data/lib/appium_lib/common/helper.rb

@@ -29,7 +29,8 @@ module Appium
     # Return yield and ignore any exceptions.
     def ignore
       yield
-    rescue Exception # rubocop:disable Lint/HandleExceptions, Lint/RescueException
+    rescue Exception # rubocop:disable Lint/RescueException
+      # Ignored
     end
 
     # Navigate back.
@@ -73,7 +74,7 @@ module Appium
     class CountElements < Nokogiri::XML::SAX::Document
       attr_reader :result
 
-      def initialize(platform)
+      def initialize(platform) # rubocop:disable Lint/MissingSuper
         reset
         @platform = platform
       end
@@ -213,7 +214,7 @@ module Appium
         @filter = value.to_s.downcase
       end
 
-      def initialize
+      def initialize # rubocop:disable Lint/MissingSuper
         reset
         @filter = false
       end
@@ -232,8 +233,9 @@ module Appium
             "#{string}  #{attr[0]}: #{attr1}\n"
           end
 
-          r.concat "\n#{name}\n#{attr_string}" unless attr_string.nil? || attr_string.empty?
-          r
+          return r if attr_string.nil? || attr_string.empty?
+
+          "#{r}\n#{name}\n#{attr_string}"
         end
       end
 

data/lib/appium_lib/common/wait.rb

@@ -45,7 +45,7 @@ module Appium
       opts = opts.is_a?(Numeric) ? { timeout: opts } : opts
 
       if opts.is_a? Hash
-        opts.empty? ? @core.wait_true { yield } : @core.wait_true(opts) { yield }
+        opts.empty? ? @core.wait_true { yield } : @core.wait_true(**opts) { yield }
       else
         ::Appium::Logger.warn('Arguments should be Hash like {timeout: 100}')
       end
@@ -74,7 +74,7 @@ module Appium
       opts = opts.is_a?(Numeric) ? { timeout: opts } : opts
 
       if opts.is_a? Hash
-        opts.empty? ? @core.wait { yield } : @core.wait(opts) { yield }
+        opts.empty? ? @core.wait { yield } : @core.wait(**opts) { yield }
       else
         ::Appium::Logger.warn('Arguments should be Hash like {timeout: 100}')
       end

data/lib/appium_lib/driver.rb

@@ -163,9 +163,8 @@ module Appium
         global_driver = true # if global_driver is nil, then global_driver must be default value.
       end
 
-      if global_driver
-        $driver.driver_quit if $driver
-      end
+      $driver&.driver_quit if global_driver
+
       raise 'opts must be a hash' unless opts.is_a? Hash
 
       @core = ::Appium::Core.for(opts)
@@ -253,7 +252,7 @@ module Appium
           # https://github.com/YOU-i-Labs/appium-youiengine-driver
           Appium::Logger.debug('YouiEngine')
         else
-          Appium::Logger.debug('no device matched') # core also shows waring message
+          Appium::Logger.debug('no device matched') # core also shows warning message
         end
       end
     end
@@ -277,7 +276,6 @@ module Appium
 
     # Returns a hash of the driver attributes
     def driver_attributes
-      # rubocop:disable Layout/AlignHash
       {
         caps:                @core.caps,
         automation_name:     @core.automation_name,
@@ -295,7 +293,6 @@ module Appium
         wait_timeout:        @core.wait_timeout,
         wait_interval:       @core.wait_interval
       }
-      # rubocop:enable Layout/AlignHash
     end
 
     def device_is_android?
@@ -426,14 +423,12 @@ module Appium
       return app_path if app_path =~ URI::DEFAULT_PARSER.make_regexp # public URL for Sauce
 
       absolute_app_path = File.expand_path app_path
-      app_path = if File.exist? absolute_app_path
-                   absolute_app_path
-                 else
-                   ::Appium::Logger.info("Use #{app_path}")
-                   app_path
-                 end
-
-      app_path
+      if File.exist? absolute_app_path
+        absolute_app_path
+      else
+        ::Appium::Logger.info("Use #{app_path}")
+        app_path
+      end
     end
 
     # Get the server url
@@ -798,6 +793,48 @@ module Appium
       @driver.set_location(latitude, longitude, altitude)
     end
 
+    # @since Appium 1.16.0
+    #
+    # Logs a custom event. The event is available via {::Appium::Core::Events#get} or
+    # <code>driver.session_capabilities['events']</code> with <code>eventTimings</code> capabilities.
+    #
+    # @param [String] vendor The vendor prefix for the event
+    # @param [String] event The name of event
+    # @return [nil]
+    #
+    # @example
+    #
+    #   log_event vendor: 'appium', event: 'funEvent'
+    #
+    #   log_event = { vendor: 'appium', event: 'anotherEvent' }
+    #   log_events #=> {...., 'appium:funEvent' => [1572957315, 1572960305],
+    #              #          'appium:anotherEvent' => 1572959315}
+    #
+    def log_event(vendor:, event:)
+      @driver.logs.event vendor: vendor, event: event
+    end
+
+    def log_event=(log_event)
+      raise ArgumentError('log_event should be Hash like { vendor: "appium", event: "funEvent"}') unless log_event.is_a?(Hash)
+
+      @driver.logs.event vendor: log_event[:vendor], event: log_event[:event]
+    end
+
+    # @since Appium 1.16.0
+    # Returns events with filtering with 'type'. Defaults to all available events.
+    #
+    # @param [String] type The type of events to get
+    # @return [Hash]
+    #
+    # @example
+    #
+    #   log_events #=> {}
+    #   log_events #=> {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }
+    #
+    def log_events(type = nil)
+      @driver.logs.events(type)
+    end
+
     # Quit the driver and Pry.
     # quit and exit are reserved by Pry.
     # @return [void]
@@ -807,11 +844,3 @@ module Appium
     end
   end # class Driver
 end # module Appium
-
-# Paging in Pry is annoying :q required to exit.
-# With pager disabled, the output is similar to IRB
-# Only set if Pry is defined and there is no `.pryrc` files.
-if defined?(Pry) && !(File.exist?(Pry::HOME_RC_FILE) || File.exist?(Pry::LOCAL_RC_FILE))
-  Appium::Logger.debug 'Pry.config.pager = false is set.'
-  Pry.config.pager = false
-end

data/lib/appium_lib/ios/common/helper.rb

@@ -21,7 +21,7 @@ module Appium
       def start_element(type, attrs = [])
         return if filter && !filter.eql?(type)
 
-        page = attrs.each_with_object({}) do |hash, attr|
+        page = attrs.each_with_object({}) do |attr, hash|
           hash[attr[0]] = attr[1] if %w(name label value hint visible).include?(attr[0])
           hash
         end
@@ -49,6 +49,7 @@ module Appium
         puts "   visible: #{visible}" if visible
       end
     end
+
     # iOS only. On Android uiautomator always returns an empty string for EditText password.
     #
     # Password character returned from value of UIASecureTextField
@@ -76,7 +77,7 @@ module Appium
       source = get_source
 
       # current_context may be nil which breaks start_with
-      if current_context && current_context.start_with?('WEBVIEW')
+      if current_context&.start_with?('WEBVIEW')
         parser = @android_html_parser ||= Nokogiri::HTML::SAX::Parser.new(Appium::Common::HTMLElements.new)
         parser.document.reset
         parser.document.filter = class_name
@@ -470,7 +471,7 @@ module Appium
       # will be present.
       _validate_object opts[:name], opts[:label], opts[:value]
 
-      # note that mainWindow is sometimes nil so it's passed as a param
+      # NOTE: that mainWindow is sometimes nil so it's passed as a param
       # $._elementOrElementsByType will validate that the window isn't nil
       element_or_elements_by_type = <<-JS
         (function() {

data/lib/appium_lib/ios/xcuitest.rb

@@ -15,7 +15,6 @@
 require_relative 'xcuitest/element'
 require_relative 'xcuitest/command'
 require_relative 'xcuitest/helper'
-require_relative 'xcuitest/element'
 require_relative 'xcuitest/bridge'
 
 module Appium

data/lib/appium_lib/ios/xcuitest/command/gestures.rb

@@ -79,7 +79,7 @@ module Appium
         #   double_tap x: 100, y: 100
         #   double_tap element: find_element(:accessibility_id, "some item")
         #   ```
-        def double_tap(x: nil, y: nil, element: nil) # rubocop:disable Naming/UncommunicativeMethodParamName
+        def double_tap(x: nil, y: nil, element: nil)
           return 'Set x, y or element' if (x.nil? || y.nil?) && element.nil?
 
           args = element.nil? ? { x: x, y: y } : { element: element.ref }
@@ -96,7 +96,7 @@ module Appium
         #   touch_and_hold x: 100, y: 100, duration: 2.0
         #   touch_and_hold element: find_element(:accessibility_id, "some item")
         #   ```
-        def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0) # rubocop:disable Naming/UncommunicativeMethodParamName
+        def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0)
           return 'Set x, y or element' if (x.nil? || y.nil?) && element.nil?
 
           args = element.nil? ? { x: x, y: y } : { element: element.ref }
@@ -121,10 +121,10 @@ module Appium
         #   Otherwise they should be calculated relatively to screen borders.
         #
         #   ```ruby
-        #   tap x: 100, y: 100
-        #   tap x: 100, y: 100, element: find_element(:accessibility_id, "some item")
+        #   one_finger_tap x: 100, y: 100
+        #   one_finger_tap x: 100, y: 100, element: find_element(:accessibility_id, "some item")
         #   ```
-        def tap(x:, y:, element: nil) # rubocop:disable Naming/UncommunicativeMethodParamName
+        def one_finger_tap(x:, y:, element: nil)
           args = { x: x, y: y }
           args[:element] = element.ref if element
           @driver.execute_script 'mobile: tap', args

data/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb

@@ -33,8 +33,7 @@ module Appium
         #     xcuitest_install_app(app: "path/to/app.app")
         #
         def xcuitest_install_app(app:)
-          args = { app: app }
-          @driver.execute_script 'mobile: installApp', args
+          @driver.install_app app
         end
 
         # Verifies whether the application with given bundle identifier is installed on the device.
@@ -47,8 +46,7 @@ module Appium
         #     xcuitest_app_installed?(bundle_id: "io.appium.bundle") #=> true or false
         #
         def xcuitest_app_installed?(bundle_id:)
-          args = { bundleId: bundle_id }
-          @driver.execute_script 'mobile: isAppInstalled', args
+          @driver.app_installed? bundle_id
         end
 
         # Uninstalls an existing application from the device under test. This endpoint does not verify
@@ -62,8 +60,7 @@ module Appium
         #     xcuitest_remove_app(bundle_id: "io.appium.bundle") #=> 1
         #
         def xcuitest_remove_app(bundle_id:)
-          args = { bundleId: bundle_id }
-          @driver.execute_script 'mobile: removeApp', args
+          @driver.remove_app bundle_id
         end
 
         # Executes an existing application on the device. If the application is already running then
@@ -92,8 +89,7 @@ module Appium
         #     xcuitest_terminate_app(bundle_id: "io.appium.bundle") #=> 1
         #
         def xcuitest_terminate_app(bundle_id:)
-          args = { bundleId: bundle_id }
-          @driver.execute_script 'mobile: terminateApp', args
+          @driver.terminate_app bundle_id
         end
 
         # Get the status of an existing application on the device.
@@ -114,8 +110,7 @@ module Appium
         #     xcuitest_query_app_status(bundle_id: "io.appium.bundle") #=> 1
         #
         def xcuitest_query_app_status(bundle_id:)
-          args = { bundleId: bundle_id }
-          @driver.execute_script 'mobile: queryAppState', args
+          @driver.app_state bundle_id
         end
 
         # Activates an existing application on the device under test and moves it to the foreground.
@@ -130,8 +125,7 @@ module Appium
         #     xcuitest_activate_app(bundle_id: "io.appium.bundle") #=> 1
         #
         def xcuitest_activate_app(bundle_id:)
-          args = { bundleId: bundle_id }
-          @driver.execute_script 'mobile: activateApp', args
+          @driver.activate_app bundle_id
         end
       end
     end # module Xcuitest

data/lib/appium_lib/ios/xcuitest/helper.rb

@@ -74,7 +74,7 @@ module Appium
           c_names = class_names.map { |class_name| %(type == "#{class_name}") }.join(' || ')
 
           predicate = if value
-                        %((#{c_names}) && (name contains[c] "#{value}" || label contains[c] "#{value}" || value contains[c] "#{value}")) # rubocop:disable Metrics/LineLength
+                        %((#{c_names}) && (name contains[c] "#{value}" || label contains[c] "#{value}" || value contains[c] "#{value}")) # rubocop:disable Layout/LineLength
                       else
                         c_names
                       end

data/lib/appium_lib/version.rb

@@ -14,6 +14,6 @@
 
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '10.4.0' unless defined? ::Appium::VERSION
-  DATE    = '2019-07-19' unless defined? ::Appium::DATE
+  VERSION = '11.1.0' unless defined? ::Appium::VERSION
+  DATE    = '2020-12-29' unless defined? ::Appium::DATE
 end

data/readme.md

@@ -21,7 +21,7 @@ We can avoid the class driver with current `ruby_lib`, but if you'd like to impl
 # Setup
 ## Requirement
 - [Appium](https://github.com/appium/appium#requirements)
-- Ruby: 2.2+
+- Ruby: 2.4+
 
 ### Ruby Lib and Appium
 - Ruby library version over `9.8.0` requires Appium over `1.8`

data/release_notes.md

@@ -1,3 +1,46 @@
+#### v11.1.0 2020-12-29
+
+- [bc3da9b](https://github.com/appium/ruby_lib/commit/bc3da9bc1ee58d5e96811b72f3ed737ed0e9c401) Release 11.1.0
+- [3c33cd6](https://github.com/appium/ruby_lib/commit/3c33cd639f8ce55fb81c5ae2116a863407529599) ci: Set up CI with Azure Pipelines (#895)
+- [ecee089](https://github.com/appium/ruby_lib/commit/ecee08981f935295e6413cd98dea4366cbc7bc69) feat: work with Ruby 3 (#893)
+- [bb3d715](https://github.com/appium/ruby_lib/commit/bb3d715e39509ac091b8f493cca42eb4fe8fd5bf) feat: work with Ruby 3 (#892)
+- [eb5cee7](https://github.com/appium/ruby_lib/commit/eb5cee7a926b90bbedd6aa28f013a0b3c5f38510) chore: Update rubocop requirement from = 1.6.1 to = 1.7.0 (#891)
+- [219181d](https://github.com/appium/ruby_lib/commit/219181d80f3b86999706f90a68996945fdc7b1d0) fix: rubocop (#890)
+- [334b791](https://github.com/appium/ruby_lib/commit/334b791a3c4420598e3e832023aa1a16af92492f) chore: Update fakefs requirement from ~> 0.13.0 to ~> 1.3.0 (#888)
+
+
+#### v11.0.0 2020-12-19
+
+- [b4313b0](https://github.com/appium/ruby_lib/commit/b4313b09e62dd22bb95c2e0bc6edd296c7ece7b4) Release 11.0.0
+- [42f01dd](https://github.com/appium/ruby_lib/commit/42f01dd3513e82f9a7ed25ac9055a65dfaa7d81f) feat: bump ruby version (#887)
+- [dc228b3](https://github.com/appium/ruby_lib/commit/dc228b33487281d0428dcd20e92263d7132dd53e) ci: move to GitHub Actions (#882)
+
+
+#### v10.6.0 2020-04-03
+
+- [65f690f](https://github.com/appium/ruby_lib/commit/65f690f1fec62a5f8868270287b0099d8b22a2ac) Release 10.6.0
+- [f792db3](https://github.com/appium/ruby_lib/commit/f792db3afbfe3f6056e0af60ce9f6be3e2cecadc) feat: remove pager off (#879)
+- [7ad3189](https://github.com/appium/ruby_lib/commit/7ad318925c0cd2c3e73cc015a1ec929485b8af85) Update hashdiff requirement from ~> 0.3.7 to ~> 1.0.0 (#874)
+- [457e765](https://github.com/appium/ruby_lib/commit/457e7657175e6c9ba981ca476098469e91e522e1) Update rubocop requirement from ~> 0.61.0 to ~> 0.68.1 (#875)
+- [9a2b9fa](https://github.com/appium/ruby_lib/commit/9a2b9fa736877141f92d35b9e2ae97657d9955d7) Update rake requirement from ~> 12.0 to ~> 13.0 (#876)
+- [8748244](https://github.com/appium/ruby_lib/commit/8748244f75ae9344e8b22dd20b2d42fb0bd84d75) fix ruby27 warning (#872)
+- [f1734ab](https://github.com/appium/ruby_lib/commit/f1734ab0ff2a210463ab6a83120a673e1b6efd4a) ci: add 2.7 (#871)
+- [b26a8f7](https://github.com/appium/ruby_lib/commit/b26a8f7c00c966ee3f193b4c97255a4751f0041e) fix a yardoc syntax
+
+
+#### v10.5.0 2019-11-09
+
+- [722c3a9](https://github.com/appium/ruby_lib/commit/722c3a9aa387d3537b648a50dc24070e62fcc57a) Release 10.5.0
+- [7a2197b](https://github.com/appium/ruby_lib/commit/7a2197b46f6ec15f1adc8626bbff1be74640e98e) feat: Add log event/s (#868)
+
+
+#### v10.4.1 2019-09-11
+
+- [12317e4](https://github.com/appium/ruby_lib/commit/12317e4d74b20d01813526b28e642e3522193fa3) Release 10.4.1
+- [58218e1](https://github.com/appium/ruby_lib/commit/58218e18f74df362e874b2a39d9e922b27b6bd5e) fix ios page (#866)
+- [7f010e7](https://github.com/appium/ruby_lib/commit/7f010e70149847ae5af8dcf08eae889311f78e6d) fix typo in a comment
+
+
 #### v10.4.0 2019-07-19
 
 - [954a3a8](https://github.com/appium/ruby_lib/commit/954a3a8d4d5cd56fa5a4e80d021805759dbf5e10) Release 10.4.0