appium_lib 6.0.0 → 7.0.0

data/docs/migration.md

@@ -1,3 +1,13 @@
+### Breaking Changes in 7.0
+
+Requires appium 1.4.0-beta or newer for iOS helper methods. appium_lib no longer automatically promotes methods on minispec. To restore the old behavior use: `Appium.promote_appium_methods ::Minitest::Spec`
+
+The implicit wait now defaults to zero. To restore the old behavior, use `set_wait 30`.
+
+           Old | New
+            :--|:--
+`installed?`   | `app_installed?`
+
 ### Breaking Changes in 5.0
 
            Old | New

data/docs_gen/make_docs.rb

@@ -30,13 +30,15 @@ def mobj_to_md obj
   out         += "> #{obj.signature}\n\n"
   out         += "#{obj.docstring}\n\n"
 
+  # puts "Processing: #{obj.name} #{method_path}"
 
   indent = space 5
   params = obj.tags.select { |tag| tag.tag_name == 'param' }
   if !params.empty?
     out += "__Parameters:__\n\n"
     params.each do |param|
-      out += indent + "[#{param.types.join ', '}] "
+      param_types = param.types ? "[#{param.types.join ', '}] " : ''
+      out += indent + param_types
       out += "#{param.name} - #{param.text}\n\n"
     end
   end

data/ios_tests/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec path: File.expand_path('../../', __FILE__) # __dir__ fails on 1.9
+gemspec path: File.expand_path('../../', __FILE__) # __dir__ fails on 1.9

data/ios_tests/Rakefile

@@ -1,22 +1,22 @@
 require 'rubygems'
 require 'rake'
+require 'rubocop/rake_task'
 
-task :default => :ios
+task default: :ios
 
 # Run sh and ignore exception
-def run_sh cmd
-  begin
-    sh cmd
-  rescue
-  end
+# rubocop:disable Lint/HandleExceptions
+def run_sh(cmd)
+  sh cmd
+rescue
 end
 
 # Run cmd. On failure run install and try again.
-def bash cmd
+def bash(cmd)
   sh cmd do |successful, result|
     # exitstatus 7 means bundle install failed
     # exitstatus 1 means the test failed
-    if !successful && result.exitstatus === 7
+    if !successful && result.exitstatus == 7
       Rake::Task['install'].execute
       run_sh cmd
     end
@@ -31,13 +31,13 @@ end
 # Run all tests with:
 # rake ios
 desc 'Run the iOS tests'
-task :ios, :args, :test_file do |args, test_file|
+task :ios, :args, :test_file do |_args, test_file|
   # rake android['ok']
   # args = android
   # test_file = {:args=>"ok"}
   test_file         = test_file[:args]
   cmd = 'bundle exec ruby ./lib/run.rb ios'
-  cmd += %Q( "#{test_file}") if test_file
+  cmd += %( "#{test_file}") if test_file
   bash cmd
 end
 
@@ -45,3 +45,10 @@ desc 'Run bundle install'
 task :install do
   sh 'bundle install'
 end
+
+desc 'Execute RuboCop static code analysis'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = %w(**/*.rb)
+  t.options = %w(-D)
+  t.fail_on_error = false
+end

data/ios_tests/appium.txt

@@ -1,6 +1,6 @@
 [caps]
 platformName = "ios"
-platformVersion = "8.1"
+platformVersion = "8.3"
 deviceName ="iPhone Simulator"
 app = "./UICatalog.app"
 

data/ios_tests/lib/common.rb

@@ -1,7 +1,7 @@
 
 # common methods
-def back_click(opts={})
-  opts        ||= {}
+def back_click(opts = {})
+  opts ||= {}
   search_wait = opts.fetch(:wait, 60 * 1.7)
   # iOS may have multiple 'back' buttons
   # select the first displayed? back button.
@@ -17,7 +17,11 @@ end
 
 def go_to_textfields
   screen.must_equal catalog
-  wait_true { text('textfield').click; screen == 'TextFields' } # wait for screen transition
+  wait_true do
+    text('textfield').click
+    screen == 'TextFields' # wait for screen transition
+  end
+
   screen.must_equal 'TextFields'
 end
 
@@ -27,4 +31,4 @@ end
 
 def catalog
   'UICatalog'
-end
+end

data/ios_tests/lib/format.rb

@@ -15,11 +15,9 @@ list.split("\n").each do |method|
   puts
 end
 
-=begin
 # for Pry
-class Object
-  def must_equal b
-    raise 'not equal' unless self == b
-  end
-end
-=end
+# class Object
+#   def must_equal b
+#     raise 'not equal' unless self == b
+#   end
+# end

data/ios_tests/lib/ios/specs/common/element/window.rb

@@ -12,4 +12,4 @@ describe 'common/element/window' do
     size.width.class.must_equal Fixnum
     size.height.class.must_equal Fixnum
   end
-end
+end

data/ios_tests/lib/ios/specs/common/helper.rb

@@ -1,6 +1,5 @@
 # rake ios[common/helper]
 describe 'common/helper.rb' do
-
   def before_first
     screen.must_equal catalog
   end
@@ -11,12 +10,10 @@ describe 'common/helper.rb' do
 
   wait_opts = { timeout: 0.2, interval: 0.2 } # max_wait, interval
 
-=begin
-There's no `must_not_raise` as the opposite of must_raise
-
-By default code is expected to not raise exceptions.
-must_not_raise is a no-op.
-=end
+  # There's no `must_not_raise` as the opposite of must_raise
+  #
+  # By default code is expected to not raise exceptions.
+  # must_not_raise is a no-op.
 
   # wait is a success unless an error is raised
   # max_wait=0 is infinity to use 0.1
@@ -27,12 +24,12 @@ must_not_raise is a no-op.
     wait(wait_opts) { nil }
 
     # failed wait should error
-    proc { wait(wait_opts) { raise } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(wait_opts) { fail } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # regular rescue will not handle exceptions outside of StandardError hierarchy
     # must rescue Exception explicitly to rescue everything
-    proc { wait(wait_opts) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
-    proc { wait(timeout: 0.2, interval: 0.0) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(wait_opts) { fail NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(timeout: 0.2, interval: 0.0) { fail NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # invalid keys are rejected
     proc { wait(invalidkey: 2) { true } }.must_raise RuntimeError
@@ -43,8 +40,8 @@ must_not_raise is a no-op.
     ignore { true }
     ignore { false }
     ignore { nil }
-    ignore { raise }
-    ignore { raise NoMemoryError }
+    ignore { fail }
+    ignore { fail NoMemoryError }
   end
 
   # wait_true is a success unless the value is not true
@@ -57,12 +54,13 @@ must_not_raise is a no-op.
     proc { wait_true(wait_opts) { nil } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # raise should error
-    proc { wait_true(wait_opts) { raise } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(wait_opts) { fail } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # regular rescue will not handle exceptions outside of StandardError hierarchy
     # must rescue Exception explicitly to rescue everything
-    proc { wait_true(wait_opts) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
-    proc { wait_true(timeout: 0.2, interval: 0.0) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(wait_opts) { fail NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(timeout: 0.2, interval: 0.0) { fail NoMemoryError } }
+      .must_raise Selenium::WebDriver::Error::TimeOutError
 
     # invalid keys are rejected
     proc { wait_true(invalidkey: 2) { true } }.must_raise RuntimeError
@@ -74,7 +72,11 @@ must_not_raise is a no-op.
     # start page
     tag('UIANavigationBar').name.must_equal 'UICatalog'
     # nav to new page.
-    wait_true { text('buttons').click; tag('UIANavigationBar').name == 'Buttons' }
+    wait_true do
+      text('buttons').click
+      tag('UIANavigationBar').name == 'Buttons'
+    end
+
     tag('UIANavigationBar').name.must_equal 'Buttons'
     # go back
     back_click
@@ -84,7 +86,7 @@ must_not_raise is a no-op.
 
   t 'session_id' do
     # Sauce doesn't return '-' so make them optional.
-    session_id.must_match /\h{8}-?\h{4}-?\h{4}-?\h{4}-?\h{12}/
+    session_id.must_match(/\h{8}-?\h{4}-?\h{4}-?\h{4}-?\h{12}/)
   end
 
   t 'xpath' do
@@ -103,11 +105,11 @@ must_not_raise is a no-op.
     ele_index('UIAStaticText', 2).name.must_equal uibutton_text
   end
 
-  # todo: 'string_attr_exact'
+  # TODO: 'string_attr_exact'
 
   t 'find_ele_by_attr' do
     el_id = find_ele_by_attr('UIAStaticText', 'name', uibutton_text).instance_variable_get :@id
-    el_id.must_match /\d+/
+    el_id.must_match(/\d+/)
   end
 
   t 'find_eles_by_attr' do
@@ -123,7 +125,7 @@ must_not_raise is a no-op.
     set_wait
   end
 
-  # todo: 'string_attr_include'
+  # TODO: 'string_attr_include'
 
   t 'find_ele_by_attr_include' do
     el_text = find_ele_by_attr_include('UIAStaticText', :name, 'button').text
@@ -181,23 +183,22 @@ must_not_raise is a no-op.
     # 8 local. 9 on sauce.
     get_page_class.split("\n").length.must_be :>=, 8
   end
-=begin
-todo:
-get_page_class
-page_class
-tag
-tags
-px_to_window_rel
-lazy_load_strings
-xml_keys
-xml_values
-resolve_id
-string_visible_contains
-xpath_visible_contains
-xpaths_visible_contains
-string_visible_exact
-xpath_visible_exact
-xpaths_visible_exact
-raise_no_element_error
-=end
+
+  # TODO: write tests
+  # get_page_class
+  # page_class
+  # tag
+  # tags
+  # px_to_window_rel
+  # lazy_load_strings
+  # xml_keys
+  # xml_values
+  # resolve_id
+  # string_visible_contains
+  # xpath_visible_contains
+  # xpaths_visible_contains
+  # string_visible_exact
+  # xpath_visible_exact
+  # xpaths_visible_exact
+  # raise_no_element_error
 end

data/ios_tests/lib/ios/specs/common/patch.rb

@@ -1,8 +1,12 @@
-=begin
-  Skip:
-    status # status patches are already tested in driver.rb
-    raw_execute # debug output for Pry
-=end
+# rubocop:disable Lint/RescueException
+# rubocop:disable Metrics/LineLength
+
+#
+#  Skip:
+#    status # status patches are already tested in driver.rb
+#    raw_execute # debug output for Pry
+#
+
 # rake ios[common/patch]
 describe 'common/patch.rb' do
   def before_first
@@ -13,10 +17,10 @@ describe 'common/patch.rb' do
     before_first
   end
 
-# Attributes are busted in Android.
-# Blocked on https://github.com/appium/appium/issues/628
+  # Attributes are busted in Android.
+  # Blocked on https://github.com/appium/appium/issues/628
   describe 'Selenium::WebDriver::Element methods' do
-    # todo: t 'value' do; end
+    # TODO: t 'value' do; end
 
     t 'name' do
       first_text.name.must_equal 'UICatalog'
@@ -39,12 +43,12 @@ describe 'common/patch.rb' do
       begin
         set_wait 0
         find_element(:css, 'ok')
-      rescue Exception => e;
+      rescue Exception => e
         value = e.message
       ensure
         set_wait
       end
-      value.must_equal "Invalid locator strategy: css selector"
+      value.must_equal 'Invalid locator strategy: css selector'
     end
   end
-end
+end

data/ios_tests/lib/ios/specs/common/version.rb

@@ -8,10 +8,10 @@ describe 'version.rb' do
   end
 
   t '::Appium::VERSION' do
-    ::Appium::VERSION.must_match /(\d+)\.(\d+).(\d+)/
+    ::Appium::VERSION.must_match(/(\d+)\.(\d+).(\d+)/)
   end
 
   t '::Appium::DATE' do
-    ::Appium::DATE.must_match /(\d+)\-(\d+)\-(\d+)/
+    ::Appium::DATE.must_match(/(\d+)\-(\d+)\-(\d+)/)
   end
-end
+end

data/ios_tests/lib/ios/specs/common/web_context.rb

@@ -1,11 +1,10 @@
 # Tests specifically for areas where the web_context differs in behaviour
 describe 'the web context' do
-
   t 'get_android_inspect' do
     text('Web').click
     set_context 'WEBVIEW'
     current_context.must_equal 'WEBVIEW_1'
-    sleep 1  #Give a chance to load
+    sleep 1  # Give a chance to load
     page.start_with?("\nhtml\n").must_equal true
   end
 

data/ios_tests/lib/ios/specs/device/device.rb

@@ -6,7 +6,7 @@ describe 'device/device' do
   # go back to the main page
   def go_back
     back
-    wait { ! exists { id 'ArrowButton'  } } # successfully transitioned back
+    wait { !exists { id 'ArrowButton'  } } # successfully transitioned back
   end
 
   t 'before_first' do
@@ -27,8 +27,8 @@ describe 'device/device' do
     screen.must_equal catalog
   end
 
-  t 'is_installed' do
-    installed = is_installed? "Derrp"
+  t 'app_installed' do
+    installed = app_installed? 'Derrp'
     installed.must_equal false
   end
 
@@ -47,7 +47,7 @@ describe 'device/device' do
   end
 
   t 'available_contexts' do
-    available_contexts.must_equal ["NATIVE_APP"]
+    available_contexts.must_equal ['NATIVE_APP']
   end
 
   t 'current_context' do
@@ -60,8 +60,8 @@ describe 'device/device' do
   end
 
   t 'app_strings' do
-    app_strings.must_include "SearchBarExplain"
-    app_strings('en').must_include "SearchBarExplain"
+    app_strings.must_include 'SearchBarExplain'
+    app_strings('en').must_include 'SearchBarExplain'
   end
 
   t 'action_chain' do
@@ -91,4 +91,4 @@ describe 'device/device' do
     data = pull_folder 'Library/AddressBook'
     data.length.must_be :>, 1
   end
-end
+end

data/ios_tests/lib/ios/specs/device/multi_touch.rb

@@ -2,11 +2,9 @@ describe 'device/multi_touch' do
   t {} # place holder test
 end
 
-# todo: write tests
-=begin
-pinch
-zoom
-initialize
-add
-perform
-=end
+# TODO: write tests
+# pinch
+# zoom
+# initialize
+# add
+# perform

data/ios_tests/lib/ios/specs/device/touch_actions.rb

@@ -1,15 +1,15 @@
 describe 'device/touch_actions' do
   t {} # place holder test
 end
-# todo: write tests
-=begin
-move_to
-long_press
-press
-release
-tap
-wait
-swipe
-perform
-cancel
-=end
+
+# TODO: write tests
+#
+# move_to
+# long_press
+# press
+# release
+# tap
+# wait
+# swipe
+# perform
+# cancel