appium_lib 1.0.0 → 2.0.0

data/docs/migration.md

@@ -0,0 +1,27 @@
+### Breaking Changes in 2.0
+
+In 2.0, the e_* methods have been renamed.
+
+           Old | New
+            :--|:--
+`e_buttons`    | `buttons`
+`e_s_texts`    | `texts`
+`e_textfields` | `textfields`
+
+All s_texts methods have been renamed.
+
+            Old | New
+             :--|:--
+`s_text`        | `text`
+`s_texts`       | `texts`
+`first_s_text`  | `first_text`
+`last_s_text`   | `last_text`
+`s_text_exact`  | `text_exact`
+`s_texts_exact` | `texts_exact`
+
+Other changes:
+
+                 Old | New
+                  :--|:--
+`press_for_duration` | `long_press`
+`current_context=`   | `set_context`

data/docs_gen/make_docs.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'yard'
 
 def space amount
- ' ' * amount
+  ' ' * amount
 end
 
 def last_sha
@@ -17,18 +17,18 @@ def mobj_to_md obj
 
   # skip class vars
   if sig.start_with?('@@') ||
-     # skip methods marked private
-     obj.tag('private') ||
-     # skip date and version from version.rb
-     obj.name.match(/DATE|VERSION/)
-     return out 
+    # skip methods marked private
+    obj.tag('private') ||
+    # skip date and version from version.rb
+    obj.name.match(/DATE|VERSION/)
+    return out
   end
 
   method_path = obj.file.split('/lib/').last
-  os = method_path.downcase.match /ios|android/
-  out += "##### [#{obj.name.to_s}](https://github.com/appium/ruby_lib/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n"
-  out += "> #{obj.signature}\n\n"
-  out += "#{obj.docstring}\n\n"
+  os          = method_path.downcase.match /ios|android/
+  out         += "##### [#{obj.name.to_s}](https://github.com/appium/ruby_lib/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n"
+  out         += "> #{obj.signature}\n\n"
+  out         += "#{obj.docstring}\n\n"
 
 
   indent = space 5
@@ -56,12 +56,12 @@ def run out_file, globs
   puts "Globbing: #{globs}"
   puts "Writing: #{out_file}"
   YARD::Parser::SourceParser.parse globs
-  File.open(out_file, 'w') do | file |
-    entries = YARD::Registry.entries
+  File.open(out_file, 'w') do |file|
+    entries        = YARD::Registry.entries
     entries_length = entries.length
     puts "Processing: #{entries_length} entries"
     raise 'No entries to process' if entries_length <= 0
-    YARD::Registry.entries.each do | entry |
+    YARD::Registry.entries.each do |entry|
       file.write mobj_to_md entry
     end
   end
@@ -71,14 +71,14 @@ end
 
 def globs paths
   # Convert single string to array for map
-  paths = [ paths ] unless paths.kind_of? Array
+  paths = [paths] unless paths.kind_of? Array
   # Adjust path based on system
   paths.map! { |path| "#{Dir.pwd}#{path}" }
 end
 
-common_globs = '/lib/appium_lib/*.rb', '/lib/appium_lib/device/*.rb', '/lib/appium_lib/common/**/*.rb'
-android_globs = common_globs + [ '/lib/appium_lib/android/**/*.rb' ]
-ios_globs = common_globs + [ '/lib/appium_lib/ios/**/*.rb' ]
+common_globs  = '/lib/appium_lib/*.rb', '/lib/appium_lib/device/*.rb', '/lib/appium_lib/common/**/*.rb'
+android_globs = common_globs + ['/lib/appium_lib/android/**/*.rb']
+ios_globs     = common_globs + ['/lib/appium_lib/ios/**/*.rb']
 
 run 'docs/android_docs.md', globs(android_globs)
 

data/ios_tests/Rakefile

@@ -5,7 +5,10 @@ task :default => :ios
 
 # Run sh and ignore exception
 def run_sh cmd
-  begin; sh cmd; rescue; end
+  begin
+    sh cmd
+  rescue
+  end
 end
 
 # Run cmd. On failure run install and try again.
@@ -32,8 +35,8 @@ task :ios, :args, :test_file do |args, test_file|
   # rake android['ok']
   # args = android
   # test_file = {:args=>"ok"}
-  test_file = test_file[:args]
-  path = File.expand_path('appium.txt', Rake.application.original_dir)
+  test_file         = test_file[:args]
+  path              = File.expand_path('appium.txt', Rake.application.original_dir)
   ENV['APPIUM_TXT'] = path
   puts "Rake appium.txt path is: #{path}"
   cmd = 'bundle exec ruby ./lib/run.rb ios'

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

@@ -65,7 +65,7 @@ must_not_raise is a no-op.
     # start page
     tag('UIANavigationBar').name.must_equal 'UICatalog'
     # nav to new page.
-    wait_true { s_text('buttons').click; tag('UIANavigationBar').name == 'Buttons' }
+    wait_true { text('buttons').click; tag('UIANavigationBar').name == 'Buttons' }
     tag('UIANavigationBar').name.must_equal 'Buttons'
     # go back
     back_click

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

@@ -19,13 +19,13 @@ describe 'common/patch.rb' do
     # todo: t 'value' do; end
 
     t 'name' do
-      first_s_text.name.must_equal 'UICatalog'
+      first_text.name.must_equal 'UICatalog'
     end
 
     # t 'tag_name' do; end # Doesn't work on Android
 
     t 'location_rel' do
-      loc = first_s_text.location_rel
+      loc = first_text.location_rel
       loc.x.class.must_equal String
       loc.y.class.must_equal String
     end

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

@@ -55,6 +55,7 @@ describe 'device/device' do
 
   t 'app_strings' do
     app_strings.must_include "SearchBarExplain"
+    app_strings('en').must_include "SearchBarExplain"
   end
 
   t 'action_chain' do
@@ -66,11 +67,11 @@ describe 'device/device' do
   end
 
   t 'swipe' do
-    swipe start_x: 75, start_y: 500, end_x: 75, end_y: 0, duration: 0.8
+    swipe start_x: 75, start_y: 500, end_x: 75, end_y: 0, duration: 800
   end
 
   t 'pinch & zoom' do
-    s_text('Images, Use of UIImageView').click
+    text('Images, Use of UIImageView').click
     zoom 200
     pinch 75
   end

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

@@ -1,5 +1,5 @@
 describe 'device/multi_touch' do
-  t { } # place holder test
+  t {} # place holder test
 end
 
 # todo: write tests

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

@@ -1,10 +1,10 @@
 describe 'device/touch_actions' do
-  t { } # place holder test
+  t {} # place holder test
 end
 # todo: write tests
 =begin
 move_to
-press_for_duration
+long_press
 press
 release
 tap

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

@@ -44,8 +44,8 @@ describe 'driver' do
                               debug:            true }
 
       if actual != expected
-        diff = HashDiff.diff expected, actual
-        diff = "diff (expected, actual):\n#{diff}"
+        diff    = HashDiff.diff expected, actual
+        diff    = "diff (expected, actual):\n#{diff}"
         # example:
         # change :ios in expected to match 'ios' in actual
         # [["~", "caps.platformName", :ios, "ios"]]
@@ -56,8 +56,8 @@ describe 'driver' do
 
     t 'verify attributes are immutable' do
       driver_attributes[:caps][:app] = 'fake'
-      actual = File.basename driver_attributes[:caps][:app]
-      expected = 'UICatalog.app'
+      actual                         = File.basename driver_attributes[:caps][:app]
+      expected                       = 'UICatalog.app'
       actual.must_equal expected
     end
 
@@ -139,7 +139,7 @@ describe 'driver' do
 
     t 'restart' do
       restart
-      s_text 'buttons'
+      text 'buttons'
     end
 
     t 'driver' do

data/ios_tests/lib/ios/specs/ios/element/alert.rb

@@ -2,7 +2,7 @@
 describe 'ios/element/alert' do
   def nav_once
     screen.must_equal catalog
-    wait_true { s_text('alerts').click; tag('UIANavigationBar').name == 'Alerts' } # wait for true
+    wait_true { text('alerts').click; tag('UIANavigationBar').name == 'Alerts' } # wait for true
     tag('UIANavigationBar').name.must_equal 'Alerts'
 
     # redefine method as no-op after it's invoked once
@@ -10,7 +10,7 @@ describe 'ios/element/alert' do
   end
 
   def after_last
-    alert_accept if exists { s_text('UIActionSheet <title>') }
+    alert_accept if exists { text('UIActionSheet <title>') }
     back_click
     screen.must_equal catalog
     sleep 1
@@ -23,9 +23,9 @@ describe 'ios/element/alert' do
 
   def open_alert
     wait_true do
-      return true if exists { s_text('UIActionSheet <title>') }
-      s_text('Show OK-Cancel').click
-      s_text('UIActionSheet <title>').displayed?
+      return true if exists { text('UIActionSheet <title>') }
+      text('Show OK-Cancel').click
+      text('UIActionSheet <title>').displayed?
     end
   end
 

data/ios_tests/lib/ios/specs/ios/element/button.rb

@@ -3,7 +3,7 @@ describe 'ios/element/button' do
   def before_first
     screen.must_equal catalog
     # nav to buttons activity
-    wait { s_text('buttons').click }
+    wait { text('buttons').click }
   end
 
   def after_last
@@ -30,6 +30,7 @@ describe 'ios/element/button' do
   t 'buttons' do
     exp = ['Back', 'Gray', 'Right pointing arrow']
     buttons('a').map { |e| e.name }.must_equal exp
+    buttons.length.must_equal 4
   end
 
   t 'first_button' do
@@ -48,10 +49,6 @@ describe 'ios/element/button' do
     buttons_exact(gray).first.name.must_equal gray
   end
 
-  t 'e_buttons' do
-    e_buttons.length.must_equal 4
-  end
-
   t 'after_last' do
     after_last
   end

data/ios_tests/lib/ios/specs/ios/element/text.rb

@@ -12,43 +12,43 @@ describe 'ios/element/text' do
     before_first
   end
 
-  t 'e_s_texts' do
-    e_s_texts.length.must_equal 13
+  t 'first_text' do
+    first_text.text.must_equal ui_catalog
   end
 
-  t 'first_s_text' do
-    first_s_text.text.must_equal ui_catalog
+  t 'last_text' do
+    last_text.text.must_equal ''
+    last_text.name.must_equal 'Transitions, Shows UIViewAnimationTransitions'
   end
 
-  t 'last_s_text' do
-    last_s_text.text.must_equal ''
-    last_s_text.name.must_equal 'Transitions, Shows UIViewAnimationTransitions'
+  t 'text' do
+    text('mat').text.must_equal ''
+    text(1).text.must_equal ui_catalog
+    text('mat').name.must_equal 'Transitions, Shows UIViewAnimationTransitions'
   end
 
-  t 's_text' do
-    s_text('mat').text.must_equal ''
-    s_text(1).text.must_equal ui_catalog
-    s_text('mat').name.must_equal 'Transitions, Shows UIViewAnimationTransitions'
-  end
-
-  t 's_texts' do
+  t 'texts' do
     exp = ['Controls, Various uses of UIControl', 'Segments, Various uses of UISegmentedControl']
-    s_texts('trol').map { |e| e.name }.must_equal exp
-    s_texts('uses').length.must_equal 7
+    texts.length.must_equal 13
+    texts('trol').map { |e| e.name }.must_equal exp
+    texts('uses').length.must_equal 7
   end
 
-  t 's_text_exact' do
+  t 'text_exact' do
     # should fail
     set_wait 0
-    act = begin; s_text_exact 'mos'; rescue; end
+    act = begin
+      text_exact 'mos'
+    rescue
+    end
     act.must_be_nil
     set_wait
 
     # should pass
-    s_text_exact(ui_catalog).text.must_equal ui_catalog
+    text_exact(ui_catalog).text.must_equal ui_catalog
   end
 
-  t 's_texts_exact' do
-    s_texts_exact('UICatalog').length.must_equal 1
+  t 'texts_exact' do
+    texts_exact('UICatalog').length.must_equal 1
   end
 end

data/ios_tests/lib/ios/specs/ios/element/textfield.rb

@@ -30,6 +30,7 @@ describe 'ios/element/textfield' do
     values = textfields('enter').map { |e| e.value }
     values.include?('<enter text>').must_equal true
     values.include?('<enter password>').must_equal true
+    textfields.length.must_equal 4
   end
 
   t 'first_textfield' do
@@ -48,10 +49,6 @@ describe 'ios/element/textfield' do
     textfields_exact(enter_password).first.text.must_equal enter_password
   end
 
-  t 'e_textfields' do
-    e_textfields.length.must_equal 4
-  end
-
   def keyboard_exists?
     !!ignore { wait_true(3) { execute_script 'au.mainApp().keyboard().type() !== "UIAElementNil"' } }
   end
@@ -113,10 +110,6 @@ describe 'ios/element/textfield' do
     textfields_exact('does not exist').length.must_equal 0
   end
 
-  t 'no e_textfields' do
-    e_textfields.length.must_equal 0
-  end
-
   t 'after_last' do
     after_last
   end

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

@@ -9,8 +9,8 @@ describe 'ios/helper' do
   end
 
   t 'ios_password' do
-    ios_password.must_equal '•'
-    ios_password(2).must_equal '•' * 2
+    ios_password.must_equal 8226.chr('UTF-8')
+    ios_password(2).must_equal 8226.chr('UTF-8') * 2
   end
 
   # todo: t 'get_page' do

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

@@ -17,7 +17,7 @@ describe 'ios/patch' do
 
   t 'type' do
     # nav to textfield
-    s_text('textfields').click
+    text('textfields').click
 
     ele = first_textfield
     ele.type 'ok'

data/ios_tests/lib/run.rb

@@ -34,7 +34,7 @@ end
 
 def go_to_textfields
   screen.must_equal catalog
-  wait_true { s_text('textfield').click; screen == 'TextFields' } # wait for screen transition
+  wait_true { text('textfield').click; screen == 'TextFields' } # wait for screen transition
   screen.must_equal 'TextFields'
 end
 

data/ios_tests/upload/sauce_storage.rb

@@ -26,30 +26,31 @@ remote_md5: 764efa883dda1e11db47671c4a3bbd9e
 require 'rubygems'
 require 'restclient'
 require 'json'
- 
+
 class SauceStorage
   attr_reader :username, :key, :url, :debug
+
   def initialize opts
     @username = opts.fetch :username, ENV['SAUCE_USERNAME']
-    @key = opts.fetch :key, ENV['SAUCE_ACCESS_KEY']
-    @url = "https://#{@username}:#{@key}@saucelabs.com/rest/v1/storage/#{@username}"
-    @debug = opts.fetch :debug, false
+    @key      = opts.fetch :key, ENV['SAUCE_ACCESS_KEY']
+    @url      = "https://#{@username}:#{@key}@saucelabs.com/rest/v1/storage/#{@username}"
+    @debug    = opts.fetch :debug, false
   end
- 
+
   def upload file_path
     file_name = File.basename file_path
-    file = File.new file_path
+    file      = File.new file_path
     local_md5 = Digest::MD5.hexdigest File.read file_path
-    
+
     self.files.each do |file|
       if file['md5'] == local_md5
         puts 'File already uploaded' if @debug
         return true
       end
     end
-    
-    url = "#{@url}/#{file_name}?overwrite=plz"
-    remote_md5 = JSON.parse( RestClient.post url, file, content_type: 'application/octet-stream' )['md5']
+
+    url        = "#{@url}/#{file_name}?overwrite=plz"
+    remote_md5 = JSON.parse(RestClient.post url, file, content_type: 'application/octet-stream')['md5']
     if @debug
       puts "Uploaded #{file_path}"
       puts " local_md5: #{local_md5}"
@@ -57,8 +58,8 @@ class SauceStorage
     end
     local_md5 == remote_md5
   end
- 
+
   def files
-    JSON.parse( RestClient.get @url )['files']
+    JSON.parse(RestClient.get @url)['files']
   end
 end