appium_lib 0.4.2 → 0.5.0

data/lib/appium_lib/{common → android}/dynamic.rb

@@ -35,6 +35,7 @@ module Appium
         100 => [ 'getStringAttribute("name")', 'GET_NAME', 100]
       }
 
+      # @private
       def dynamic_code_to_string code, value=false
         result = @@map[code].first
         return result unless value

data/lib/appium_lib/android/helper.rb

@@ -39,9 +39,13 @@ module Appium::Android
   # Find all elements matching the attribute
   # On android, assume the attr is name (which falls back to text).
   #
+  # ```ruby
+  #   find_eles_attr :text
+  # ```
+  #
   # @param tag_name [String] the tag name to search for
   # @return [Element]
-  def find_eles_attr tag_name
+  def find_eles_attr tag_name, attribute=nil
 =begin
     sel1 = [ [4, 'android.widget.Button'], [100] ]
     sel2 = [ [4, 'android.widget.ImageButton'], [100] ]
@@ -125,8 +129,36 @@ module Appium::Android
     out
   end
 
+  # Count all classes on screen and print to stdout.
+  # Useful for appium_console.
+  def page_class
+    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?
+      r.push node['@class'] if keys.include?('@class')
+
+      run_internal.call node['node'] if keys.include?('node')
+    end
+    json = get_source
+    run_internal.call json['hierarchy']
+
+    r = r.sort
+    r.uniq.each do |ele|
+      print r.count(ele)
+      puts "x #{ele}\n"
+    end
+    nil
+  end
+
   # Android only.
   # Returns a string containing interesting elements.
+  # If an element has no content desc or text, then it's not returned by this method.
   # @return [String]
   def get_android_inspect
     # @private

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

@@ -17,13 +17,13 @@ module Appium::Common
 
   # Get the first text element.
   # @return [Text]
-  def s_first_text
+  def first_s_text
     first_ele :text
   end
 
   # Get the last text element
   # @return [Text]
-  def s_last_text
+  def last_s_text
     last_ele :text
   end
 

data/lib/appium_lib/common/helper.rb

@@ -25,7 +25,8 @@ module Appium::Common
   # Example: wait { name('back').click }
   #
   # Give up after 30 seconds.
-  # @param max_wait [Integer] the maximum time in seconds to wait for
+  # @param max_wait [Integer] the maximum time in seconds to wait for.
+  #         Note that max wait 0 means infinity.
   # @param interval [Float] the time in seconds to wait after calling the block
   # @param block [Block] the block to call
   # @return [Object] the result of block.call
@@ -187,17 +188,17 @@ module Appium::Common
     JSON.parse @driver.page_source, max_nesting: 9999
   end
 
-  # Returns the first element that matches name
+  # Returns the first element that exactly matches name
   #
-  # @param name [String] the name to match
+  # @param name [String] the name to exactly match
   # @return [Element]
   def find_name name
     find_element :name, name
   end
 
-  # Returns all elements that match name
+  # Returns all elements that exactly match name
   #
-  # @param name [String] the name to match
+  # @param name [String] the name to exactly match
   # @return [Array<Element>]
   def find_names name
     find_elements :name, name

data/lib/appium_lib/common/patch.rb

@@ -3,12 +3,14 @@
 # Add status to WebDriver
 # https://code.google.com/p/selenium/issues/detail?id=5669
 class Selenium::WebDriver::Driver
+  # @private
   def status
     bridge.status
   end
 end
 
 class Selenium::WebDriver::Remote::Bridge
+  # @private
   def status
     raw_execute :status
   end

data/lib/appium_lib/common/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '0.4.2' unless defined? ::Appium::VERSION
-  DATE = '2013-05-20' unless defined? ::Appium::DATE
+  VERSION = '0.5.0' unless defined? ::Appium::VERSION
+  DATE = '2013-05-24' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/driver.rb

@@ -4,6 +4,55 @@ Based on simple_test.rb
 https://github.com/appium/appium/blob/82995f47408530c80c3376f4e07a1f649d96ba22/sample-code/examples/ruby/simple_test.rb
 https://github.com/appium/appium/blob/c58eeb66f2d6fa3b9a89d188a2e657cca7cb300f/LICENSE
 =end
+
+# Load appium.txt (toml format) into system ENV
+# the basedir of this file + appium.txt is what's used
+# @param opts [Hash] file: '/path/to/appium.txt', verbose: true
+# @return [nil]
+def load_appium_txt opts
+  raise 'opts must be a hash' unless opts.kind_of? Hash
+  opts.each_pair { |k,v| opts[k.to_s.downcase.strip.intern] = v }
+  opts = {} if opts.nil?
+  file = opts.fetch :file, nil
+  raise 'Must pass file' unless file
+  verbose = opts.fetch :verbose, false
+  # Check for env vars in .txt
+  toml = File.expand_path File.join File.dirname(file), 'appium.txt'
+  puts "appium.txt path: #{toml}" if verbose
+  # @private
+  def update data, *args
+    args.each do |name|
+      var = data[name]
+      ENV[name] = var if var
+    end
+  end
+
+  toml_exists = File.exists? toml
+  puts "Exists? #{toml_exists}" if verbose
+
+  if toml_exists
+    require 'toml'
+    require 'ap'
+    puts "Loading #{toml}" if verbose
+
+    # bash requires A="OK"
+    # toml requires A = "OK"
+    #
+    # A="OK" => A = "OK"
+    data = File.read(toml).gsub /([^\s])\=(")/, "\\1 = \\2"
+    data = TOML::Parser.new(data).parsed
+    ap data unless data.empty?
+
+    update data, 'APP_PATH', 'APP_APK', 'APP_PACKAGE',
+           'APP_ACTIVITY', 'APP_WAIT_ACTIVITY',
+           'SELENDROID'
+
+    # Ensure app path is absolute
+    ENV['APP_PATH'] = File.expand_path ENV['APP_PATH'] if ENV['APP_PATH']
+  end
+  nil
+end
+
 module Appium
   add_to_path __FILE__
 
@@ -13,7 +62,6 @@ module Appium
   require 'common/helper'
   require 'common/patch'
   require 'common/version'
-  require 'common/dynamic'
   require 'common/element/button'
   require 'common/element/text'
   require 'common/element/window'
@@ -26,6 +74,7 @@ module Appium
   require 'ios/element/textfield'
 
   # android
+  require 'android/dynamic'
   require 'android/helper'
   require 'android/patch'
   require 'android/element/alert'
@@ -35,9 +84,9 @@ module Appium
   class Driver
     @@loaded = false
 
-    attr_reader :app_path, :app_name, :app_package, :app_activity,
-                :app_wait_activity, :sauce_username, :sauce_access_key,
-                :port, :os, :debug
+    attr_reader :default_wait, :app_path, :app_name, :selendroid,
+                :app_package, :app_activity, :app_wait_activity,
+                :sauce_username, :sauce_access_key, :port, :os, :debug
     # Creates a new driver.
     #
     # ```ruby
@@ -63,17 +112,17 @@ module Appium
     # Appium::Driver.new(apk).start_driver
     # ```
     #
-    # @param options [Object] A hash containing various options.
+    # @param opts [Object] A hash containing various options.
     # @return [Driver]
-    def initialize options={}
+    def initialize opts={}
       # quit last driver
       $driver.driver_quit if $driver
-
-      opts = {}
+      opts = {} if opts.nil?
       # convert to downcased symbols
-      options.each_pair { |k,v| opts[k.to_s.downcase.strip.intern] = v }
+      opts.each_pair { |k,v| opts[k.to_s.downcase.strip.intern] = v }
+
+      @default_wait = opts.fetch :wait, 30
 
-      opts = {} if opts.nil?
       # Path to the .apk, .app or .app.zip.
       # The path can be local or remote for Sauce.
       @app_path = opts.fetch :app_path, ENV['APP_PATH']
@@ -122,9 +171,11 @@ module Appium
       patch_webdriver_element
 
       # enable debug patch
-      @debug = opts.fetch :debug, defined?(Pry)
-
+      # !!'constant' == true
+      @debug = opts.fetch :debug, !!defined?(Pry)
+      puts "Debug is: #{@debug}"
       if @debug
+        ap opts unless opts.empty?
         puts "OS is: #{@os}"
         patch_webdriver_bridge
       end
@@ -198,15 +249,15 @@ module Appium
     # Converts environment variable APP_PATH to an absolute path.
     # @return [String] APP_PATH as an absolute path
     def absolute_app_path
-        raise 'APP_PATH environment variable not set!' if @app_path.nil? || @app_path.empty?
-        return @app_path if @app_path.match(/^http/) # public URL for Sauce
-        if @app_path.match(/^\//) # absolute file path
-          raise "App doesn't exist. #{@app_path}" unless File.exist? @app_path
-          return @app_path
-        end
-        file = File.join(File.dirname(__FILE__), @app_path)
-        raise "App doesn't exist #{file}" unless File.exist? file
-        file
+      raise 'APP_PATH environment variable not set!' if @app_path.nil? || @app_path.empty?
+      return @app_path if @app_path.match(/^http/) # public URL for Sauce
+      if @app_path.match(/^\//) # absolute file path
+        raise "App doesn't exist. #{@app_path}" unless File.exist? @app_path
+        return @app_path
+      end
+      file = File.join(File.dirname(__FILE__), @app_path)
+      raise "App doesn't exist #{file}" unless File.exist? file
+      file
     end
 
     # Get the server url for sauce or local based on env vars.
@@ -234,6 +285,8 @@ module Appium
 
     # Takes a png screenshot and saves to the target path.
     #
+    # Example: screenshot '/tmp/hi.png'
+    #
     # @param png_save_path [String] the full path to save the png
     # @return [void]
     def screenshot png_save_path
@@ -249,14 +302,11 @@ module Appium
 
     # Creates a new global driver and quits the old one if it exists.
     #
-    # @param wait [Integer] seconds to wait before timing out a command. defaults to 30 seconds
     # @return [Selenium::WebDriver] the new global driver
-    def start_driver wait=30
+    def start_driver
       @client = @client || Selenium::WebDriver::Remote::Http::Default.new
       @client.timeout = 999999
 
-      @default_wait = wait
-
       begin
         @driver = Selenium::WebDriver.for :remote, http_client: @client, desired_capabilities: capabilities, url: server_url
         # Load touch methods. Required for Selendroid.
@@ -301,12 +351,13 @@ module Appium
     #
     # exists { button('sign in') } ? puts('true') : puts('false')
     #
+    # @param pre_check [Integer]  the amount in seconds to set the
+    #                             wait to before checking existance
+    # @param post_check [Integer] the amount in seconds to set the
+    #                             wait to after checking existance
     # @param search_block [Block] the block to call
     # @return [Boolean]
-    def exists &search_block
-      pre_check = 0
-      post_check = @default_wait
-
+    def exists pre_check=0, post_check=@default_wait, &search_block
       set_wait pre_check # set wait to zero
 
       # the element exists unless an error is raised.
@@ -319,7 +370,7 @@ module Appium
       end
 
       # restore wait
-      set_wait post_check
+      set_wait post_check if post_check != pre_check
 
       exists
     end

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v0.4.2 2013-05-20
+
+- [be814c2](https://github.com/appium/ruby_lib/commit/be814c286bd55fb133f333738da9b0dcd6146b69) Release 0.4.2
+- [9d2cfe8](https://github.com/appium/ruby_lib/commit/9d2cfe86b3367fd3f4551962a042fe25da1e31bd) Add page_window for Apptentive
+- [e9b5e97](https://github.com/appium/ruby_lib/commit/e9b5e97baf7b6a417dc3865b7cc0c163c0165d70) Update docs
+
+
 #### v0.4.1 2013-05-20
 
 - [cd8dd73](https://github.com/appium/ruby_lib/commit/cd8dd73461d6bdb8903a8b3f5bba9ce554a44789) Release 0.4.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: toml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,12 +98,12 @@ files:
 - docs_gen/docs_from_js.md
 - docs_gen/make_docs.rb
 - lib/appium_lib.rb
+- lib/appium_lib/android/dynamic.rb
 - lib/appium_lib/android/element/alert.rb
 - lib/appium_lib/android/element/generic.rb
 - lib/appium_lib/android/element/textfield.rb
 - lib/appium_lib/android/helper.rb
 - lib/appium_lib/android/patch.rb
-- lib/appium_lib/common/dynamic.rb
 - lib/appium_lib/common/element/button.rb
 - lib/appium_lib/common/element/text.rb
 - lib/appium_lib/common/element/window.rb