appium_lib 0.0.25 → 0.0.26

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2ExYzEwMjM4NDA2N2FlMjAwNTY3MDA2ZmEwZmRkMzk0MDVkYjA4MQ==
+    ODllNGVkMzc4M2RhNDMzYjE5Yzc4NDM3MTdhMzYzNjRmMDVlMGVhMQ==
   data.tar.gz: !binary |-
-    NWYyODE1M2NlN2E5OGNiZjY3YzEyMTRhZDI0YmQ4Mjk1YWVhODg5Yw==
+    NjI2OGVjNjY4NWJmNTAxZjk5M2E0MmM5MDE0YWQzMjRkODRkNmI5Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjQxMzFlY2EzMmU0Y2M4MjAzYmUxYzMyYmRjMDk0Mjc2MTc4OTEwNTQ2NjQ2
-    NGRhZGFjY2RmYmJlM2Q0NTMwMDAxZDBhMDk4YjYwYmNlODQ4OTgzNWJhZjNk
-    YjFiODAwYTgxZWVlYWY2ZTNhYWU1ZGQxMzJmYjNlNWE5ODI2N2Q=
+    MDdkNjIwNWUzODQzZmVkYzJlYjAwMmQ5MTdiNjUyZGUzMjNlMDVkNGE1M2Zk
+    ZmQwMTBhZjdmYmRlZmQ0MmNkZmVjOTRkZGJjOWRhYjJhMjcxZGU4YjFlNTgy
+    NDI3ODM5Mzc3NjJhODc4NmIwM2ZlZWFjODY0MDhlODliMjRiY2Q=
   data.tar.gz: !binary |-
-    Y2U3OGZkZmZjYjFiMThmNjU1YTQwMmIwYzZkYWIyZjUzM2I2ZjMwM2FmNzM2
-    Y2E0NTUwNGZlZmIzZmE0YjUxYzY4NWZjNzEwODY0OWZkMjg3ZmZiOWNmZmI1
-    YzA4YmQ2YjBkOWZiYmUzM2U5NGEwY2QyMGIzNzk0OTE5ZTdjYzA=
+    ZmI2YWU4YmNkNTc2YzMwZmRkMTVlYTZkNWZkZmE1NTg4MWE5MDEzNDYzMzAy
+    M2I5YzBhODY5M2JkNTk0MjNkZWFmN2EwNzAxNGM4NjUzMmExYjFjNjY4MjJk
+    YjQ2OWMzZTkyMTVhYmY5MTMzMGQwNmE5OWVkOWNmM2EyNmRlOWI=

data/lib/appium_lib/console.rb

@@ -65,6 +65,9 @@ require 'alert'
 # combine secure & textfield on iOS to match Android behavior.
 $os == :ios ? require('ios/textfield') :
               require('android/textfield')
+              
+# implicit_wait default_wait
+$default_wait = 30
 
 # WebDriver capabilities. Must be valid for Sauce to work.
 # https://github.com/jlipps/appium/blob/master/app/android.js
@@ -146,11 +149,8 @@ def start_driver
   # when no commands are entered after 60 seconds.
   $driver.execute_script 'mobile: setCommandTimeout', timeout: 9999
 
-  # Must set implicit_wait to zero or $ commands will fail.
-  # execute_script "$('button')"
-  # $ commands fail anyway now so set implicit wait.
-  # https://github.com/appium/appium/issues/214
-  $driver.manage.timeouts.implicit_wait = 30
+  # Set implicit wait by default unless we're using Pry.
+  $driver.manage.timeouts.implicit_wait = $default_wait unless defined?(Pry)
 
   $driver
 end
@@ -163,12 +163,47 @@ end
 # Set implicit wait to timeout, defaults to 30.
 # @param timeout [Integer] the timeout in seconds
 # @return [void]
-def set_wait timeout=30
+def set_wait timeout=$default_wait
   $driver.manage.timeouts.implicit_wait = timeout
 end
 
+# Returns the default client side wait.
+# This value is independent of what the server is using
+# @return [Integer]
+def get_wait
+  $default_wait
+end
+
+# Returns existance of element.
+#
+# Example:
+#
+# exists { button('sign in') } ? puts('true') : puts('false')
+#
+# @return [Boolean]
+def exists &search_block
+  pre_check = 0
+  post_check = $default_wait
+
+  set_wait pre_check # set wait to zero
+
+  # the element exists unless an error is raised.
+  exists = true
+
+  begin
+    search_block.call # search for element
+  rescue
+    exists = false # error means it's not there
+  end
+
+  # restore wait
+  set_wait post_check
+
+  return exists
+end
+
 # The same as $driver.execute_script
-# @return the object returned by execute_script
+# @return [Object] the object returned by execute_script
 def execute_script script, *args
   $driver.execute_script script, *args
 end

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

@@ -0,0 +1,45 @@
+# encoding: utf-8
+if $os == :android
+
+# Tap the alert button identified by value.
+# @param value [Integer, String] either an integer index of the button or the button's name
+# @return [void]
+def alert_click value
+  button(value).click
+end
+
+# Get the alert message text.
+# @return [String]
+def alert_text
+  get_page
+end
+
+# Accept the alert.
+# The last button is considered "accept."
+# @return [void]
+def alert_accept
+  last_button.click
+end
+
+# Get the text of the alert's accept button.
+# The last button is considered "accept."
+# @return [String]
+def alert_accept_text
+  last_button.text
+end
+
+# Dismiss the alert.
+# The first button is considered "dismiss."
+# @return [void]
+def alert_dismiss
+  first_button.click
+end
+
+# Get the text of the alert's dismiss button.
+# The first button is considered "dismiss."
+# @return [String]
+def alert_dismiss_text
+  first_button.text
+end
+
+end # if $os == :android

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

@@ -0,0 +1,47 @@
+# encoding: utf-8
+if $os == :android
+=begin
+name, names, text, text should match substring and case insensitive.
+
+In Android //* is used to find partial case insensitive text matches.
+//* is not currently implemented in iOS.
+
+find_element :name by default uses a partial case insensitive match.
+On iOS the default is an exact name match.
+=end
+
+# Return the first element matching text.
+# @param text [String] the text to search for
+# @return [Element] the first matching element
+def text text
+  # TODO: Use XPath index once it's implemented
+  # https://github.com/appium/appium/issues/295
+  texts(text).first
+end
+
+# Return all elements matching text.
+# @param text [String] the text to search for
+# @return [Array<Element>] all matching elements
+def texts text
+  $driver.find_elements :xpath, "//*[contains(@text, '#{text}')]"
+end
+
+# Return the first element matching name.
+# on Android name is content description
+# on iOS name is the accessibility label or the text.
+# @param name [String] the name to search for
+# @return [Element] the first matching element
+def name name
+  $driver.find_element :name, name
+end
+
+# Return all elements matching name.
+# on Android name is content description
+# on iOS name is the accessibility label or the text.
+# @param name [String] the name to search for
+# @return [Array<Element>] all matching elements
+def names name
+  $driver.find_elements :name, name
+end
+
+end # if $os == :android

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

@@ -1,7 +1,6 @@
 # encoding: utf-8
-# UIATextField methods
-
 if $os == :android
+# UIATextField methods
 
 # Get an array of textfield texts.
 # @return [Array<String>]
@@ -42,4 +41,4 @@ def textfield_include text
   find_ele_by_text_include :textfield, text
 end
 
-end # if $os
+end # if $os == :android

data/lib/appium_lib/element/button.rb

@@ -1,62 +1,24 @@
 # encoding: utf-8
 # UIAButton methods
 
-=begin
- Method Signatures:
-
-   button( text, number = -1 )
-   buttons( text = nil )
-   button_include( text )
-   buttons_include( text )
-   first_button
-   last_button
-
- Examples:
-
-   button 'text'    # 1st button exactly matching text
-   button 'text', 2 # 2nd button exactly matching text
-
-   buttons          # text of all buttons.
-   buttons 'text'   # all buttons exactly matching text
-
-   button_include  'text' # the first button that includes text
-   buttons_include 'text' # all buttons that include text
-
-   first_button     # the first button
-   last_button      # the last button
-=end
-
 # Find a button by text and optionally number.
 # @param text [String, Integer] the text to exactly match. If int then the button at that index is returned.
 # @param number [Integer] the occurance of the button matching text. Defaults to the first button.
 # @return [Button] the button found with text and matching number
 def button text, number=0
+  # return button at index.
   return ele_index :button, text if text.is_a? Numeric
 
-  number >= 1 ? button_text_num( text, number ) :
-  button_text( text )
+  number >= 1 ? button_num( text, number ) :
+                find_ele_by_text_include( :button, text )
 end
 
 # Get an array of button texts or button elements if text is provided.
 # @param text [String] the text to exactly match
 # @return [Array<String>, Array<Buttons>] either an array of button texts or an array of button elements if text is provided.
 def buttons text=nil
-  text == nil ? find_eles_attr(:button, :text) :
-                find_ele_by_text(:button, text)
-end
-
-# Get the first button that includes text.
-# @param text [String] the text that the element must include
-# @return [Button]
-def button_include text
-  find_ele_by_text_include :button, text
-end
-
-# Get all buttons that include text.
-# @param text [String] the text that the element must include
-# @return [Array<Button>]
-def buttons_include text
-  find_eles_by_text_include :button, text
+  text == nil ? find_eles_attr( :button, :text ) :
+                find_eles_by_text_include( :button, text )
 end
 
 # Get the first button element.
@@ -71,16 +33,28 @@ def last_button
   last_ele :button
 end
 
-# -- prefer above methods before using these.
-private
-
 # Get the first button element that exactly matches text.
 # @param text [String] the text to match exactly
 # @return [Button]
-def button_text text
+def button_exact text
   find_ele_by_text :button, text
 end
 
+# Get all button elements that exactly match text.
+# @param text [String] the text to match exactly
+# @return [Array<Button>]
+def buttons_exact text
+  find_eles_by_text :button, text
+end
+
+# Get an array of button elements.
+# @return [Array<Button>]
+def e_buttons
+  find_eles :button
+end
+
+# Expected to be called via button method.
+#
 # Get the button element exactly matching text and
 # occurrence. number=2 means the 2nd occurrence.
 #
@@ -92,24 +66,18 @@ end
 # so if there's no button found at number then
 # return the first button.
 #
-# @param text [String] the text to match exactly
+# @param text [String] the text to match
 # @param number [Integer] the button occurance to return. 1 = first button
-# @return [Button] the button that exactly matches text and number
-def button_text_num text, number=1
+# @return [Button] the button that matches text and number
+def button_num text, number=1
   raise "Number must be >= 1" if number <= 0
   number = number - 1 # zero indexed
 
   result = nil
 
-  elements = find_eles_by_text :button, text
+  elements = buttons text
   elements.size > number ? result = elements[number]
                          : result = elements.first
 
   result
-end
-
-# Get an array of button elements.
-# @return [Array<Button>]
-def e_buttons
-  find_eles :button
-end
+end

data/lib/appium_lib/element/{alert.rb → ios/alert.rb}

@@ -1,5 +1,5 @@
 # encoding: utf-8
-
+if $os == :ios
 # iOS only
 # Tap the alert button identified by value.
 # @param value [Integer, String] either an integer index of the button or the button's name
@@ -44,4 +44,6 @@ def alert_dismiss_text
   return if a.nil?
   b = a.find_elements(:tag_name, :button)
   b.first.text if b && b.size >= 1
-end
+end
+
+end # if $os == :ios

data/lib/appium_lib/element/ios/generic.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+if $os == :ios
+=begin
+name, names, text, text should match substring and case insensitive.
+
+iOS .name() is the accessibility attribute. If not defined, then .label() is used instead.
+This differs from Android where name (the content description) is empty when not set.
+=end
+
+# Return the first element matching text.
+# @param text [String] the text to search for
+# @return [Element] the first matching element
+def text text
+  # returnElems requires a wrapped $(element).
+  js = %Q(
+    var element = $(au.mainWindow.elements().firstWithPredicate("name contains[c] '#{text}'"));
+    au._returnElems(element);
+  )
+
+  execute_script(js).first
+end
+
+# Return all elements matching text.
+# @param text [String] the text to search for
+# @return [Array<Element>] all matching elements
+def texts text
+  # returnElems requires a wrapped $(element).
+  # must call toArray when using withPredicate instead of firstWithPredicate.
+  js = %Q(
+    var a = au.mainWindow.elements().withPredicate("name contains[c] '#{text}'").toArray();
+    au._returnElems($(a));
+  )
+
+  execute_script js
+end
+
+# Return the first element matching name.
+# on Android name is content description
+# on iOS name is the accessibility label or the text.
+# @param name [String] the name to search for
+# @return [Element] the first matching element
+def name name
+  text name
+end
+
+# Return all elements matching name.
+# on Android name is content description
+# on iOS name is the accessibility label or the text.
+# @param name [String] the name to search for
+# @return [Array<Element>] all matching elements
+def names name
+  texts name
+end
+
+end # if ios

data/lib/appium_lib/element/ios/textfield.rb

@@ -1,11 +1,10 @@
 # encoding: utf-8
+if $os == :ios
 # UIATextField & UIASecureTextField methods
 #
 # Find textfield and then secure elements in one server call
 # to match Android.
 
-if $os == :ios
-
 # Get an array of textfield texts.
 # @return [Array<String>]
 def textfields

data/lib/appium_lib/element/text.rb

@@ -1,41 +1,43 @@
 # encoding: utf-8
 # UIAStaticText methods
 
+# s_ prefix for static_text to avoid conflict with generic text methods.
+
 # Get an array of text texts.
 # @return [Array<String>]
-def texts
+def s_texts
   find_eles_attr :text, :text
 end
 
 # Get an array of text elements.
 # @return [Array<Text>]
-def e_texts
+def s_e_texts
   find_eles :text
 end
 
 # Get the first text element.
 # @return [Text]
-def first_text
+def s_first_text
   first_ele :text
 end
 
 # Get the last text element
 # @return [Text]
-def last_text
+def s_last_text
   last_ele :text
 end
 
-# Get the first element that matches text.
-# @param text [String, Integer] the text to find exactly. If int then the text at that index is returned.
+# Get the first element that includes text.
+# @param text [String, Integer] the text to find. If int then the text at that index is returned.
 # @return [Text]
-def text text
+def s_text text
   return ele_index :text, text if text.is_a? Numeric
-  find_ele_by_text :text, text
+  find_ele_by_text_include :text, text
 end
 
-# Get the first textfield that includes text.
-# @param text [String] the text that the tag must include
+# Get the first textfield that matches text.
+# @param text [String] the text that the tag must match
 # @return [Text]
-def text_include text
-  find_ele_by_text_include :text, text
+def s_text_exact text
+  find_ele_by_text :text, text
 end

data/lib/appium_lib/helper.rb

@@ -29,24 +29,6 @@ def wait &block
   result
 end
 
-# Return the first element matching name.
-# on Android name is content description
-# on iOS name is the accessibility label or the text.
-# @param name [String] the name to search for
-# @return [Element] the first matching element
-def name name
-  $driver.find_element :name, name
-end
-
-# Return all element matching name.
-# on Android name is content description
-# on iOS name is the accessibility label or the text.
-# @param name [String] the name to search for
-# @return [Array<Element>] all matching elements
-def names name
-  $driver.find_elements :name, name
-end
-
 # Presses the back button on Android.
 # @return [void]
 def back
@@ -234,7 +216,7 @@ def get_inspect
   results.each { |e|
     out += e[:class].split('.').last + "\n"
     out += "  text: #{e[:text]}\n" unless e[:text].nil?
-    out += "  desc: #{e[:desc]}\n" unless e[:desc].nil?
+    out += "  name: #{e[:desc]}\n" unless e[:desc].nil?
   }
   out
 end
@@ -244,4 +226,4 @@ end
 def page
   puts get_inspect
   nil
-end
+end

data/lib/appium_lib/patch.rb

@@ -12,20 +12,17 @@ class Selenium::WebDriver::Element
     self.attribute :name
   end
   
-  # Fixes NoMethodError: undefined method `type' for #<Selenium::WebDriver::Element
-  def type
-    self.attribute :type
-  end
-  
+  # Use tag_name to get element's type.
+  #
   # Tag name appears to be the same as type.
   #
   # Fixes Selenium::WebDriver::Error::UnknownError: Not yet implemented
   def tag_name
-    type
+    self.attribute :type
   end
 
   # Cross platform way of entering text into a textfield
-  def set_value text
+  def type text
   # enter text then tap window to hide the keyboard.
   js = %Q(
     au.getElement('#{self.ref}').setValue('#{text}');
@@ -35,7 +32,7 @@ class Selenium::WebDriver::Element
   end if $os == :ios
 
   # Cross platform way of entering text into a textfield
-  def set_value text
+  def type text
     self.send_keys text
   end if $os == :android
 

data/lib/appium_lib/version.rb

@@ -1,4 +1,4 @@
 module AppiumLib
-  VERSION = '0.0.25' unless defined? ::AppiumLib::VERSION
-  DATE = '2013-03-28' unless defined? ::AppiumLib::DATE
+  VERSION = '0.0.26' unless defined? ::AppiumLib::VERSION
+  DATE = '2013-04-04' unless defined? ::AppiumLib::DATE
 end

data/readme.md

@@ -4,6 +4,7 @@
 - [Documentation for appium_lib](http://www.rubydoc.info/github/appium/ruby_lib/master/frames)
 
 Helper methods for writing cross platform (iPad, iPhone, Android) tests in Ruby using Appium.
+There's also an [Appium Ruby Console](https://github.com/appium/ruby_console) which uses this lib.
 
 Make sure you're using Ruby 1.9.3+ with upgraded rubygems and bundler.
 

data/release_notes.md

@@ -0,0 +1,4 @@
+#### master
+
+  - Start driver will no longer default to implicit wait when used in Pry.
+  [*](https://github.com/appium/ruby_lib/commit/2e71e477962c70113b556700cf08c74060d77370)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -66,9 +66,12 @@ files:
 - appium_lib.gemspec
 - lib/appium_lib.rb
 - lib/appium_lib/console.rb
-- lib/appium_lib/element/alert.rb
+- lib/appium_lib/element/android/alert.rb
+- lib/appium_lib/element/android/generic.rb
 - lib/appium_lib/element/android/textfield.rb
 - lib/appium_lib/element/button.rb
+- lib/appium_lib/element/ios/alert.rb
+- lib/appium_lib/element/ios/generic.rb
 - lib/appium_lib/element/ios/textfield.rb
 - lib/appium_lib/element/text.rb
 - lib/appium_lib/element/window.rb
@@ -76,6 +79,7 @@ files:
 - lib/appium_lib/patch.rb
 - lib/appium_lib/version.rb
 - readme.md
+- release_notes.md
 homepage: https://github.com/appium/ruby_lib
 licenses:
 - http://www.apache.org/licenses/LICENSE-2.0.txt