Rewrite as a real lib

Author: bootstraponline

Rakefile

@@ -5,7 +5,7 @@ require 'date'
 # Defines gem name.
 def repo_name; 'appium_lib'; end # ruby_lib published as appium_lib
 def gh_name; 'ruby_lib'; end # the name as used on github.com
-def version_file; "lib/#{repo_name}/version.rb"; end
+def version_file; "lib/#{repo_name}/common/version.rb"; end
 def version_rgx; /VERSION = '([^']+)'/m; end
 
 def version
@@ -79,9 +79,16 @@ desc 'Build a new gem (same as gem task)'
 task :build => :gem do
 end
 
+desc 'Uninstall gem'
+task :uninstall do
+  cmd = "gem uninstall -aIx #{repo_name}"
+  puts cmd
+  # rescue on gem not installed error.
+  begin; `cmd`; rescue; end
+end
+
 desc 'Install gem'
-task :install => :gem do
-  `gem uninstall -aIx #{repo_name}`
+task :install => [ :gem, :uninstall ] do
   sh "gem install --no-rdoc --no-ri #{repo_name}-#{version}.gem"
 end
 

appium_lib.gemspec

@@ -8,15 +8,15 @@ end
 
 add_to_path 'lib'
 
-require 'appium_lib/version'
+require 'appium_lib/common/version'
 
 Gem::Specification.new do |s|
   # 1.8.x is not supported
   s.required_ruby_version = '>= 1.9.3'
 
   s.name = 'appium_lib'
-  s.version = AppiumLib::VERSION
-  s.date = AppiumLib::DATE
+  s.version = Appium::VERSION
+  s.date = Appium::DATE
   s.license = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
   s.description = s.summary = 'Ruby lib for use with Appium'
   s.description += '.' # avoid identical warning

lib/appium_lib.rb

@@ -1,10 +1,13 @@
-def self.add_to_path file, path=false
- path = path ? "../#{path}/" : '..' 
- path = File.expand_path path, file
+# encoding: utf-8
+module Appium
+  def self.add_to_path file, path=false
+   path = path ? "../#{path}/" : '..'
+   path = File.expand_path path, file
 
- $:.unshift path unless $:.include? path
-end
+   $:.unshift path unless $:.include? path
+  end
 
-add_to_path __FILE__, 'appium_lib'
+  add_to_path __FILE__
 
-require 'console'
+  require 'appium_lib/driver'
+end

lib/appium_lib/android/element/alert.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Appium::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 # module Appium::Android

lib/appium_lib/android/element/generic.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+module Appium::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
+
+=begin
+    // iOS version
+    // https://github.com/appium/ruby_lib/blob/37bb4e90b29e5adb4438b287b6387a504c94b5c4/lib/appium_lib/element/ios/generic.rb#L23
+    var search = "name contains[c] '#{text}' || label contains[c] '#{text}' || value contains[c] '#{text}'";
+    var a = w.secureTextFields().firstWithPredicate(search);
+    if ( isNil(a) ) {
+      a = w.textFields().firstWithPredicate(search);
+      if ( isNil(a) ) {
+        a = w.buttons().firstWithPredicate(search);
+        if ( isNil(a) ) {
+          a = w.elements().firstWithPredicate(search);
+        }
+      }
+    }
+
+Android considers both a textfield and a secure textfield to be "EditText".
+Name (the content desc) is searched first and then we search for value (text).
+There's no label in Android.
+
+Android buttons have different class names (android.widget.Button, android.widget.ImageButton)
+so we consider the element a button if the class name contains the word button.
+
+After looking for textfields and buttons, then we search all elements. Find will return
+the first element that matches.
+=end
+  def find val
+    # s.className('android.widget.EditText').descriptionContains(value);
+    args = [ [4, 'android.widget.EditText'], [7, val] ],
+    # s.className('android.widget.EditText').textContains(value);
+           [ [4, 'android.widget.EditText'], [3, val] ],
+
+           # s.className('android.widget.Button').descriptionContains(value);
+           [ [4, 'android.widget.Button'], [7, val] ],
+           # s.className('android.widget.Button').textContains(value);
+           [ [4, 'android.widget.Button'], [3, val] ],
+
+           # s.className('android.widget.ImageButton').descriptionContains(value);
+           [ [4, 'android.widget.ImageButton'], [7, val] ],
+           # s.className('android.widget.ImageButton').textContains(value);
+           [ [4, 'android.widget.ImageButton'], [3, val] ],
+
+           # s.descriptionContains(value);
+           [ [7, val] ],
+           # s.textContains(value);
+           [ [3, val] ]
+    mobile :find, args
+  end
+
+  # Return the first element matching text.
+  # @param text [String] the text to search for
+  # @return [Element] the first matching element
+  def text text
+    # Return the first element matching selector.
+    # s.textContains(value)
+    mobile :find, [ [ [3, text] ] ]
+  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 # module Appium::Android

lib/appium_lib/android/element/textfield.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Appium::Android
+  # UIATextField methods
+
+  # Get an array of textfield texts.
+  # @return [Array<String>]
+  def textfields
+    find_eles_attr :textfield, :text
+  end
+
+  # Get an array of textfield elements.
+  # @return [Array<Textfield>]
+  def e_textfields
+    find_eles :textfield
+  end
+
+  # Get the first textfield element.
+  # @return [Textfield]
+  def first_textfield
+    first_ele :textfield
+  end
+
+  # Get the last textfield element.
+  # @return [Textfield]
+  def last_textfield
+    last_ele :textfield
+  end
+
+  # Get the first textfield that matches text.
+  # @param text [String, Integer] the text to match exactly. If int then the textfield at that index is returned.
+  # @return [Textfield]
+  def textfield text
+    return ele_index :textfield, text if text.is_a? Numeric
+    find_ele_by_text :textfield, text
+  end
+
+  # Get the first textfield that includes text.
+  # @param text [String] the text the textfield must include
+  # @return [Textfield]
+  def textfield_include text
+    find_ele_by_text_include :textfield, text
+  end
+end # module Appium::Android

lib/appium_lib/android/helper.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+module Appium::Android
+  # Returns an array of android classes that match the tag name
+  def tag_name_to_android tag_name
+    tag_name = tag_name.to_s.downcase.strip
+
+    def prefix *tags
+      tags.map!{ |tag| "android.widget.#{tag}" }
+    end
+    # note that 'secure' is not an allowed tag name on android
+    # because android can't tell what a secure textfield is
+    # they're all edittexts.
+
+    # must match names in AndroidElementClassMap (Appium's Java server)
+    case tag_name
+      when 'button'
+        prefix 'Button', 'ImageButton'
+      when 'text'
+        prefix 'TextView'
+      when 'list'
+        prefix 'ListView'
+      when 'window', 'frame'
+        prefix 'FrameLayout'
+      when 'grid'
+        prefix 'GridView'
+      when 'relative'
+        prefix 'RelativeLayout'
+      when 'linear'
+        prefix 'LinearLayout'
+      when 'textfield'
+        prefix 'EditText'
+      else
+        raise "Invalid tag name #{tag_name}"
+    end # return result of case
+  end
+
+  # on android, assume the attr is name (which falls back to text).
+  def find_eles_attr tag_name
+=begin
+    sel1 = [ [4, 'android.widget.Button'], [100] ]
+    sel2 = [ [4, 'android.widget.ImageButton'], [100] ]
+
+    args = [ 'all', sel1, sel2 ]
+
+    mobile :find, args
+=end
+    array = ['all']
+
+    tag_name_to_android(tag_name).each do |name|
+      # sel.className(name).getStringAttribute("name")
+      array.push [ [4, name], [100] ]
+    end
+
+    mobile :find, array
+  end
+
+
+  # Android only.
+  def get_inspect
+    def run node
+      r = []
+
+      run_internal = lambda do |node|
+        if node.kind_of? Array
+          node.each { |node| run_internal.call node }
+          return
+        end
+
+        keys = node.keys
+        return if keys.empty?
+
+        obj = {}
+        obj.merge!( { desc: node['@content-desc'] } ) if keys.include?('@content-desc') && !node['@content-desc'].empty?
+        obj.merge!( { text: node['@text'] } ) if keys.include?('@text') && !node['@text'].empty?
+        obj.merge!( { class: node['@class'] } ) if keys.include?('@class') && !obj.empty?
+
+        r.push obj if !obj.empty?
+        run_internal.call node['node'] if keys.include?('node')
+      end
+
+      run_internal.call node
+      r
+    end
+
+    json = JSON.parse(@driver.page_source)
+    node = json['hierarchy']
+    results = run node
+
+    out = ''
+    results.each { |e|
+      out += e[:class].split('.').last + "\n"
+
+      out += "  class: #{e[:class]}\n"
+      if ( e[:text] == e[:desc] )
+        out += "  text, name: #{e[:text]}\n" unless e[:text].nil?
+      else
+        out += "  text: #{e[:text]}\n" unless e[:text].nil?
+        out += "  name: #{e[:desc]}\n" unless e[:desc].nil?
+      end
+    }
+    out
+  end
+
+  # Android only. Intended for use with console.
+  # Inspects and prints the current page.
+  def page
+    puts get_inspect
+    nil
+  end
+
+  # JavaScript code from https://github.com/appium/appium/blob/master/app/android.js
+  #
+  # Math.round((duration * 1000) / 200)
+  # (.20 * 1000) / 200 = 1
+  #
+  # We want steps to be exactly 1. If it's zero then a tap is used instead of a swipe.
+  def fast_duration
+    0.20
+  end
+end # module Appium::Android

lib/appium_lib/android/patch.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Appium::Android
+  # Implement useful features for element.
+  class Selenium::WebDriver::Element
+    # Cross platform way of entering text into a textfield
+    def type text
+      self.send_keys text
+    end
+  end
+end