appium_lib 6.0.0 → 7.0.0

data/lib/appium_lib/android/mobile_methods.rb

@@ -7,11 +7,11 @@ module Appium
       #   ```ruby
       #    find_elements :uiautomator, 'new UiSelector().clickable(true)'
       #   ```
-      def extended(mod)
+      def extended(_mod)
         Selenium::WebDriver::SearchContext.class_eval do
           Selenium::WebDriver::SearchContext::FINDERS[:uiautomator] = '-android uiautomator'
         end
       end
     end # class << self
   end # module Android
-end # module Appium
+end # module Appium

data/lib/appium_lib/android/patch.rb

@@ -7,10 +7,10 @@ module Appium
     def patch_webdriver_element
       Selenium::WebDriver::Element.class_eval do
         # Cross platform way of entering text into a textfield
-        def type text
-          self.send_keys text
+        def type(text)
+          send_keys text
         end
       end
     end
   end # Android
-end # Appium
+end # Appium

data/lib/appium_lib/common/element/window.rb

@@ -7,4 +7,4 @@ module Appium
       @driver.manage.window.size
     end
   end # module Common
-end # module Appium
+end # module Appium

data/lib/appium_lib/common/helper.rb

@@ -21,11 +21,9 @@ module Appium
     # find_element :text doesn't work so use XPath to find by text.
 
     # Return block.call and ignore any exceptions.
-    def ignore &block
-      begin
-        block.call
-      rescue Exception
-      end
+    def ignore(&block)
+      block.call
+    rescue Exception # rubocop:disable Lint/HandleExceptions, Lint/RescueException
     end
 
     # Navigate back.
@@ -43,7 +41,7 @@ module Appium
     #
     # @param xpath_str [String] the XPath string
     # @return [Element]
-    def xpath xpath_str
+    def xpath(xpath_str)
       find_element :xpath, xpath_str
     end
 
@@ -51,11 +49,11 @@ module Appium
     #
     # @param xpath_str [String] the XPath string
     # @return [Array<Element>]
-    def xpaths xpath_str
+    def xpaths(xpath_str)
       find_elements :xpath, xpath_str
     end
 
-    def _print_source source
+    def _print_source(source)
       opts = Nokogiri::XML::ParseOptions::NOBLANKS | Nokogiri::XML::ParseOptions::NONET
       if source.start_with? '<html'
         doc = Nokogiri::HTML(source) { |cfg| cfg.options = opts }
@@ -79,15 +77,15 @@ module Appium
       end
 
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html
-      def start_element name, attrs = []
+      def start_element(name, attrs = [])
         # Count only visible elements. Android is always visible
         element_visible = $driver.device_is_android? ? true : Hash[attrs]['visible'] == 'true'
-        @result[name]   += 1 if element_visible
+        @result[name] += 1 if element_visible
       end
 
       def formatted_result
         message = ''
-        sorted  = @result.sort_by { |element, count| count }.reverse
+        sorted  = @result.sort_by { |_element, count| count }.reverse
         sorted.each do |element, count|
           message += "#{count}x #{element}\n"
         end
@@ -117,7 +115,7 @@ module Appium
     # ```ruby
     # px_to_window_rel x: 50, y: 150
     # ```
-    def px_to_window_rel opts={}
+    def px_to_window_rel(opts = {})
       w = $driver.window_size
       x = opts.fetch :x, 0
       y = opts.fetch :y, 0
@@ -136,34 +134,32 @@ module Appium
     # Search strings.xml's values for target.
     # @param target [String] the target to search for in strings.xml values
     # @return [Array]
-    def xml_keys target
+    def xml_keys(target)
       lazy_load_strings
-      @strings_xml.select { |key, value| key.downcase.include? target.downcase }
+      @strings_xml.select { |key, _value| key.downcase.include? target.downcase }
     end
 
     # Search strings.xml's keys for target.
     # @param target [String] the target to search for in strings.xml keys
     # @return [Array]
-    def xml_values target
+    def xml_values(target)
       lazy_load_strings
-      @strings_xml.select { |key, value| value.downcase.include? target.downcase }
+      @strings_xml.select { |_key, value| value.downcase.include? target.downcase }
     end
 
     # Resolve id in strings.xml and return the value.
     # @param id [String] the id to resolve
     # @return [String]
-    def resolve_id id
+    def resolve_id(id)
       lazy_load_strings
       @strings_xml[id]
     end
 
     class HTMLElements < Nokogiri::XML::SAX::Document
-      def filter
-        @filter
-      end
+      attr_reader :filter
 
       # convert to string to support symbols
-      def filter= value
+      def filter=(value)
         # nil and false disable the filter
         return @filter = false unless value
         @filter = value.to_s.downcase
@@ -186,7 +182,7 @@ module Appium
           attr_string = e.reduce('') do |string, attr|
             attr_1 = attr[1]
             attr_1 = attr_1 ? attr_1.strip : attr_1
-            string += "  #{attr[0]}: #{attr_1}\n"
+            string + "  #{attr[0]}: #{attr_1}\n"
           end
 
           unless attr_string.nil? || attr_string.empty?
@@ -196,32 +192,31 @@ module Appium
         end
       end
 
-      def start_element name, attrs = []
+      def start_element(name, attrs = [])
         @skip_element = filter && !filter.include?(name.downcase)
-        unless @skip_element
-          element = { name: name }
-          attrs.each { |a| element[a[0]] = a[1] }
-          @element_stack.push element
-          @elements_in_order.push element
-        end
+        return if @skip_element
+        element = { name: name }
+        attrs.each { |a| element[a[0]] = a[1] }
+        @element_stack.push element
+        @elements_in_order.push element
       end
 
-      def end_element name
+      def end_element(name)
         return if filter && !filter.include?(name.downcase)
         element_index = @element_stack.rindex { |e| e[:name] == name }
         @element_stack.delete_at element_index
       end
 
       def characters(chars)
-        unless @skip_element
-          element        = @element_stack.last
-          element[:text] = chars
-        end
+        return if @skip_element
+        element        = @element_stack.last
+        element[:text] = chars
       end
     end
 
     def _no_such_element
-      raise Selenium::WebDriver::Error::NoSuchElementError, 'An element could not be located on the page using the given search parameters.'
+      fail Selenium::WebDriver::Error::NoSuchElementError,
+           'An element could not be located on the page using the given search parameters.'
     end
   end # module Common
 end # module Appium

data/lib/appium_lib/common/patch.rb

@@ -3,21 +3,21 @@ require_relative 'version'
 module Appium
   module Common
     # Implement useful features for element.
-    class Selenium::WebDriver::Element
+    class Selenium::WebDriver::Element # rubocop:disable Style/ClassAndModuleChildren
       # Note: For testing .text should be used over value, and name.
 
       # Returns the value attribute
       #
       # Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
       def value
-        self.attribute :value
+        attribute :value
       end
 
       # Returns the name attribute
       #
       # Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
       def name
-        self.attribute :name
+        attribute :name
       end
 
       # For use with mobile tap.
@@ -67,8 +67,9 @@ def patch_webdriver_bridge
   Selenium::WebDriver::Remote::Bridge.class_eval do
     # Code from lib/selenium/webdriver/remote/bridge.rb
     def raw_execute(command, opts = {}, command_hash = nil)
-      verb, path          = Selenium::WebDriver::Remote::COMMANDS[command] || raise(ArgumentError, "unknown command: #{command.inspect}")
-      path                = path.dup
+      verb, path = Selenium::WebDriver::Remote::COMMANDS[command] ||
+                   fail(ArgumentError, "unknown command: #{command.inspect}")
+      path       = path.dup
 
       path[':session_id'] = @session_id if path.include?(':session_id')
 
@@ -79,18 +80,17 @@ def patch_webdriver_bridge
       end
 
       # convert /// into /
-      path.gsub! /\/+/, '/'
+      path.gsub!(/\/+/, '/')
 
       # change path from session/efac972c-941a-499c-803c-d7d008749/execute
       # to /execute
       # path may be nil, session, or not have anything after the session_id.
       path_str   = path
-      path_str   = '/' + path_str unless path_str.nil? ||
-        path_str.length <= 0 || path_str[0] == '/'
-      path_match = path.match /.*\h{8}-?\h{4}-?\h{4}-?\h{4}-?\h{12}/
+      path_str   = '/' + path_str unless path_str.nil? || path_str.length <= 0 || path_str[0] == '/'
+      path_match = path.match(/.*\h{8}-?\h{4}-?\h{4}-?\h{4}-?\h{12}/)
       path_str   = path.sub(path_match[0], '') unless path_match.nil?
 
-      Appium::Logger.info  "#{verb} #{path_str}"
+      Appium::Logger.info "#{verb} #{path_str}"
 
       # must check to see if command_hash is a hash. sometimes it's not.
       if command_hash.is_a?(Hash) && !command_hash.empty?
@@ -98,7 +98,7 @@ def patch_webdriver_bridge
 
         print_command.delete :args if print_command[:args] == []
 
-        if print_command[:using] === '-android uiautomator'
+        if print_command[:using] == '-android uiautomator'
           value                 = print_command[:value].split(';').map { |v| "#{v};" }
           print_command[:value] = value.length == 1 ? value[0] : value
 
@@ -121,26 +121,28 @@ def patch_webdriver_bridge
 end
 
 # Print Appium's origValue error messages.
+# rubocop:disable Style/ClassAndModuleChildren
+# rubocop:disable Style/AndOr
 class Selenium::WebDriver::Remote::Response
   # @private
   def error_message
     val = value
 
     case val
-      when Hash
-        msg = val['origValue'] || val['message'] or return 'unknown error'
-        msg << " (#{ val['class'] })" if val['class']
-      when String
-        msg = val
-      else
-        msg = "unknown error, status=#{status}: #{val.inspect}"
+    when Hash
+      msg = val['origValue'] || val['message'] or return 'unknown error'
+      msg << " (#{ val['class'] })" if val['class']
+    when String
+      msg = val
+    else
+      msg = "unknown error, status=#{status}: #{val.inspect}"
     end
 
     msg
   end
 end
 
-class Selenium::WebDriver::Remote::Http::Common
+class Selenium::WebDriver::Remote::Http::Common # rubocop:disable Style/ClassAndModuleChildren
   remove_const :DEFAULT_HEADERS if defined? DEFAULT_HEADERS
   DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }
-end
+end

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '6.0.0' unless defined? ::Appium::VERSION
-  DATE    = '2015-01-26' unless defined? ::Appium::DATE
-end
+  VERSION = '7.0.0' unless defined? ::Appium::VERSION
+  DATE    = '2015-05-08' unless defined? ::Appium::DATE
+end

data/lib/appium_lib/common/wait.rb

@@ -1,18 +1,17 @@
 module Appium
   module Common
-
     # http://mudge.name/2011/01/26/passing-blocks-in-ruby-without-block.html
     # Note that the Ruby timeout module is avoided. timeout has problems.
     # https://coderwall.com/p/1novga
 
     # Wait code from the selenium Ruby gem
     # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-    def _generic_wait opts={}, &block
+    def _generic_wait(opts = {}, &block)
       valid_keys = [:timeout, :interval, :message, :ignore, :return_if_true]
       invalid_keys = []
       opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
       # [:one, :two] => :one, :two
-      raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
+      fail "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
 
       timeout        = opts.fetch(:timeout, 30)
       interval       = opts.fetch(:interval, 0.5)
@@ -33,7 +32,7 @@ module Appium
           end
         rescue ::Errno::ECONNREFUSED => e
           raise e
-        rescue *ignored => last_error
+        rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
           # swallowed
         end
 
@@ -48,13 +47,13 @@ module Appium
 
       msg << " (#{last_error.message})" if last_error
 
-      raise Selenium::WebDriver::Error::TimeOutError, msg
+      fail Selenium::WebDriver::Error::TimeOutError, msg
     end
 
     # process opts before calling _generic_wait
-    def _process_wait_opts opts
+    def _process_wait_opts(opts)
       opts = { timeout: opts } if opts.is_a?(Numeric)
-      raise 'opts must be a hash' unless opts.is_a? Hash
+      fail 'opts must be a hash' unless opts.is_a? Hash
       opts
     end
 
@@ -73,7 +72,7 @@ module Appium
     # @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
-    def wait_true opts={}, &block
+    def wait_true(opts = {}, &block)
       opts = _process_wait_opts(opts).merge(return_if_true: true)
       _generic_wait opts, &block
     end
@@ -91,9 +90,9 @@ module Appium
     # @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
-    def wait opts={}, &block
+    def wait(opts = {}, &block)
       opts = _process_wait_opts(opts).merge(return_if_true: false)
       _generic_wait opts, &block
     end
   end # module Common
-end # module Appium
+end # module Appium

data/lib/appium_lib/device/device.rb

@@ -12,11 +12,12 @@ module Appium
         close_app:            'session/:session_id/appium/app/close',
         reset:                'session/:session_id/appium/app/reset',
         toggle_airplane_mode: 'session/:session_id/appium/device/toggle_airplane_mode',
+        device_locked?:       'session/:session_id/appium/device/is_locked'
       },
       get:  {
         current_activity:       'session/:session_id/appium/device/current_activity',
         current_context:        'session/:session_id/context',
-        get_network_connection: 'session/:session_id/network_connection',
+        get_network_connection: 'session/:session_id/network_connection'
       }
     }
 
@@ -34,7 +35,7 @@ module Appium
     # @!method current_activity
 
     # @!method launch_app
-    #   Start the simulator and applicaton configured with desired capabilities  
+    #   Start the simulator and application configured with desired capabilities
 
     # @!method reset
     #   Reset the device, relaunching the application.
@@ -43,7 +44,9 @@ module Appium
     #   Cause the device to shake
 
     # @!method toggle_flight_mode
-    #   toggle flight mode on or off
+    #   Toggle flight mode on or off
+
+    # @!method device_locked?
 
     # @!method hide_keyboard
     #   Hide the onscreen keyboard
@@ -101,7 +104,7 @@ module Appium
     #   Update appium Settings for current test session
     #   @param settings (hash) Settings to update, keys are settings, values to value to set each setting to
     class << self
-      def extended(mod)
+      def extended(_mod)
         extend_webdriver_with_forwardable
 
         NoArgMethods.each_pair do |verb, pair|
@@ -116,7 +119,7 @@ module Appium
         end
 
         add_endpoint_method(:app_strings, 'session/:session_id/appium/app/strings') do
-          def app_strings language=nil
+          def app_strings(language = nil)
             opts = language ? { language: language } : {}
             execute :app_strings, {}, opts
           end
@@ -124,31 +127,31 @@ module Appium
 
         add_endpoint_method(:lock, 'session/:session_id/appium/device/lock') do
           def lock(duration)
-            execute :lock, {}, :seconds => duration
+            execute :lock, {}, seconds: duration
           end
         end
 
         add_endpoint_method(:install_app, 'session/:session_id/appium/device/install_app') do
           def install_app(path)
-            execute :install_app, {}, :appPath => path
+            execute :install_app, {}, appPath: path
           end
         end
 
         add_endpoint_method(:remove_app, 'session/:session_id/appium/device/remove_app') do
           def remove_app(id)
-            execute :remove_app, {}, :appId => id
+            execute :remove_app, {}, appId: id
           end
         end
 
-        add_endpoint_method(:is_installed?, 'session/:session_id/appium/device/app_installed') do
-          def is_installed?(app_id)
-            execute :is_installed?, {}, :bundleId => app_id
+        add_endpoint_method(:app_installed?, 'session/:session_id/appium/device/app_installed') do
+          def app_installed?(app_id)
+            execute :app_installed?, {}, bundleId: app_id
           end
         end
 
         add_endpoint_method(:background_app, 'session/:session_id/appium/app/background') do
           def background_app(duration)
-            execute :background_app, {}, :seconds => duration
+            execute :background_app, {}, seconds: duration
           end
         end
 
@@ -162,37 +165,40 @@ module Appium
         #   @param [String] The activity to start before the target activity [optional]
         #
         #   ```ruby
-        #   start_activity app_package: 'io.appium.android.apis', app_activity: '.accessibility.AccessibilityNodeProviderActivity'
+        #   start_activity app_package: 'io.appium.android.apis',
+        #     app_activity: '.accessibility.AccessibilityNodeProviderActivity'
         #   ```
         add_endpoint_method(:start_activity, 'session/:session_id/appium/device/start_activity') do
           def start_activity(opts)
-            raise 'opts must be a hash' unless opts.is_a? Hash
+            fail 'opts must be a hash' unless opts.is_a? Hash
             app_package = opts[:app_package]
-            raise 'app_package is required' unless app_package
+            fail 'app_package is required' unless app_package
             app_activity = opts[:app_activity]
-            raise 'app_activity is required' unless opts[:app_activity]
+            fail 'app_activity is required' unless opts[:app_activity]
             app_wait_package  = opts.fetch(:app_wait_package, '')
             app_wait_activity = opts.fetch(:app_wait_activity, '')
 
             unknown_opts = opts.keys - [:app_package, :app_activity, :app_wait_package, :app_wait_activity]
-            raise "Unknown options #{unknown_opts}" unless unknown_opts.empty?
+            fail "Unknown options #{unknown_opts}" unless unknown_opts.empty?
 
-            execute :start_activity, {}, { appPackage:     app_package,      appActivity: app_activity,
-                                           appWaitPackage: app_wait_package, appWaitActivity: app_wait_activity }
+            execute :start_activity, {}, appPackage: app_package,
+                                         appActivity: app_activity,
+                                         appWaitPackage: app_wait_package,
+                                         appWaitActivity: app_wait_activity
           end
         end
 
         add_endpoint_method(:set_context, 'session/:session_id/context') do
-          def set_context(context=null)
-            execute :set_context, {}, :name => context
+          def set_context(context = null)
+            execute :set_context, {}, name: context
           end
         end
 
         add_endpoint_method(:hide_keyboard, 'session/:session_id/appium/device/hide_keyboard') do
-          def hide_keyboard(close_key=nil)
+          def hide_keyboard(close_key = nil)
             # Android can only tapOutside.
             if $driver.device_is_android?
-             return execute :hide_keyboard, {}, { strategy: :tapOutside }
+              return execute :hide_keyboard, {}, strategy: :tapOutside
             end
 
             close_key ||= 'Done' # default to Done key.
@@ -201,7 +207,7 @@ module Appium
         end
 
         add_endpoint_method(:press_keycode, 'session/:session_id/appium/device/press_keycode') do
-          def press_keycode(key, metastate=nil)
+          def press_keycode(key, metastate = nil)
             args             = { keycode: key }
             args[:metastate] = metastate if metastate
             execute :press_keycode, {}, args
@@ -209,17 +215,17 @@ module Appium
         end
 
         add_endpoint_method(:long_press_keycode, 'session/:session_id/appium/device/long_press_keycode') do
-          def long_press_keycode(key, metastate=nil)
+          def long_press_keycode(key, metastate = nil)
             args             = { keycode: key }
             args[:metastate] = metastate if metastate
             execute :long_press_keycode, {}, args
           end
         end
 
-        # TODO TEST ME
+        # TODO: TEST ME
         add_endpoint_method(:set_immediate_value, 'session/:session_id/appium/element/:id/value') do
           def set_immediate_value(element, value)
-            execute :set_immediate_value, { :id => element.ref }, value: value
+            execute :set_immediate_value, { id: element.ref }, value: value
           end
         end
 
@@ -237,7 +243,7 @@ module Appium
           end
         end
 
-        # TODO TEST ME
+        # TODO: TEST ME
         add_endpoint_method(:pull_folder, 'session/:session_id/appium/device/pull_folder') do
           def pull_folder(path)
             data = execute :pull_folder, {}, path: path
@@ -245,7 +251,7 @@ module Appium
           end
         end
 
-        # TODO TEST ME
+        # TODO: TEST ME
         add_endpoint_method(:end_coverage, 'session/:session_id/appium/app/end_test_coverage') do
           def end_coverage(path, intent)
             execute :end_coverage, {}, path: path, intent: intent
@@ -292,7 +298,7 @@ module Appium
       # def extended
 
       # @private
-      def add_endpoint_method(method, path, verb=:post)
+      def add_endpoint_method(method, path, verb = :post)
         if block_given?
           # &Proc.new with no args passes the passed_in block
           # Because creating Procs from blocks is slow
@@ -307,7 +313,7 @@ module Appium
 
       # @private
       def extend_webdriver_with_forwardable
-        return if Selenium::WebDriver::Driver.kind_of? Forwardable
+        return if Selenium::WebDriver::Driver.is_a? Forwardable
         Selenium::WebDriver::Driver.class_eval do
           extend Forwardable
         end
@@ -320,7 +326,7 @@ module Appium
       end
 
       # @private
-      def delegate_from_appium_driver(method, delegation_target=:driver)
+      def delegate_from_appium_driver(method, delegation_target = :driver)
         def_delegator delegation_target, method
       end
 
@@ -329,7 +335,7 @@ module Appium
         Selenium::WebDriver::Remote::Bridge.class_eval do
           command method, verb, path
           if block_given?
-            class_eval &Proc.new
+            class_eval(&Proc.new)
           else
             define_method(method) { execute method }
           end