calabash-android 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab5733515ddd130e9c0c76ab7207162e7bcb213e
-  data.tar.gz: 642d7b1943c6c8a9d49e8bef19c370772f557946
+  metadata.gz: d2a8f40cc923ffd3e00e326102619222cbd23ce2
+  data.tar.gz: d9e809beffef802866484fb292b6fb4eea89c4ab
 SHA512:
-  metadata.gz: e80aa1202cb318db16557b8537a05507f07504d0ab3f88c9375a3251e3647194171f79f8a4a090d463201a943834b4f434db085ec1c0242458da4dd3ec02ec89
-  data.tar.gz: cc68982bc3fe7266db0fbb737ec9a17dd45321ec16cfa8efa1871756ddb7c82a4eaf36346cafcda8b7c17757e6f0331b87cb4e7cb9445dedf3477287e94b7a6b
+  metadata.gz: a4105c7a57cc3f5afa07bc1ce2e557d2fe34e9a8fd1b267e0233061e4ed574e22fb991b77c447da992484235b15a1a837fa8edb3b643e413d9eee63066de6411
+  data.tar.gz: 1c0ca870547e096af29be9f29b265c484edb9674c43bd05ea5805bb2e296db74f04c92d9b37386f20d0f07fda25647d3fe55d4b4bb12b4fab8376f8dae94aaf9

data/.yardopts

@@ -0,0 +1,3 @@
+--markup=markdown
+--no-private
+lib/**/*.rb - LICENSE ENVIRONMENT_VARIABLES.md lib/**/*.md

data/CHANGES.txt

@@ -1,3 +1,12 @@
+0.5.3:
+      Added methods to clear text in a specified view or the view that has focus.
+
+      Added ability to invoke javascript in webviews specified by a query.
+
+      Improved keystore handling.
+
+      Fixed issue with a gemspec that was too loose (Cucumber beta is not supported).
+
 0.5.2:
       Added generic multi touch gestures and many predefined gestures.
 

data/ENVIRONMENT_VARIABLES.md

@@ -0,0 +1,106 @@
+## Calabash Android Environment Variables
+
+Calabash Android references Unix environment variables to control its runtime behavior.
+
+## Conventions
+
+Paths or values with spaces need double or single quotes.
+
+#### Example: Quoting values with spaces.
+
+```
+APP_PATH="~/path with/a spaces/in it"   # Correct!
+APP_PATH=~/path with/a spaces/in it     # Incorrect.
+```
+
+## Environment Variables
+
+### `ADB_DEVICE_ARG`
+
+#### Example
+
+```
+ADB_DEVICE_ARG=4df7ee16Xa083009
+ADB_DEVICE_ARG=C4F12B41QB6E89E
+```
+
+### `APP_PATH`
+
+The path to apk that is being tested.
+
+Use this variable if your apk is located in a non-default location or your environment requires special configuration (e.g. example a CI environment).
+
+### `MAIN_ACTIVITY`
+
+Calabash Android will automatically try to detect the main activity of
+the application.  Use this variable to specify an alternative main activity.
+
+#### Example
+
+```
+MAIN_ACTIVITY="com.example.myactivity" calabash-android run example.apk
+```
+
+### `CALABASH_IRBRC`
+
+Use this variable to load a custom .irbrc when opening calabash-ios console.  This is useful if you have multiple calabash projects and want to share an .irbrc across all of them.
+
+#### .irbrc load order rules
+
+1. If `CALABASH_IRBRC` is defined, then that .irbrc is loaded.
+2. If there is a .irbrc in the directory where `console` is called, then that file is loaded.
+3. Otherwise, the defaults scripts/.irbrc is loaded.
+
+#### Special
+
+Calling `calabash-ios console` sets the `IRBRC` environment variable.
+
+#### Example
+
+```
+$ CALABASH_IRBRC="~/.irbrc-calabash" calabash-ios console
+```
+
+### `RESET_BETWEEN_SCENARIOS`
+
+Use this variable to reset your app's data between cucumber Scenarios.
+
+#### Pro Tip:  Reset the app data before certain Scenarios.
+
+Use a `Before` hook + a `tag` to control when calabash will reset the app data.
+
+### `SCREENSHOT_PATH`
+
+Use this variable to apply a 'prefix' to a screenshot when saving.  See the examples.
+
+#### Note
+
+The behavior of this variable is subject to change.
+
+#### Special
+
+If the the *path* portion of SCREENSHOT_PATH does not exist, `screenshot` will raise an error.
+
+@see {Calabash::Android::Operations#screenshot}
+
+#### Example: Specify a prefix
+
+```
+SCREENSHOT_PATH=galaxy_s5_                   => galaxy_s5_screenshot_0.png
+SCREENSHOT_PATH="screenshots/nexus5-" => screenshots/nexus5-screenshot_0.png
+```
+
+#### Example: Specify a directory
+
+```
+# correct!
+SCREENSHOT_PATH=/path/to/a/directory/ => path/to/a/directory/screenshot_0.png
+# incorrect :(
+SCREENSHOT_PATH=/path/to/a/directory  => path/to/a/directoryscreenshot_0.png
+```
+
+### `TEST_APP_PATH`
+
+Calabash Android will detect the test-server apt based on the checksum of the application and the Calabash Android version.
+
+Use this variable if your test-server is located in a non-default location or environment requires special configuration (e.g. example a CI environment).

data/Gemfile

@@ -2,4 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in calabash-android.gemspec
 gemspec
-gem 'rake', '10.1.0'

data/README_YARDOC.md

@@ -0,0 +1,163 @@
+## Yard Docs
+
+This gem is documented with yard.
+
+### Build the Docs Locally
+
+```
+$ be rake yard
+Files:          38
+Modules:        26 (   13 undocumented)
+Classes:        14 (   11 undocumented)
+Constants:      31 (   21 undocumented)
+Methods:       466 (  242 undocumented)
+ 46.55% documented
+```
+
+Docs are generated in the `docs` directory.
+
+### See What is Undocumented
+
+```
+$ be yard stats --list-undoc
+```
+
+### Start a Local Server
+
+```
+$ be yard server
+> YARD 0.8.7.3 documentation server at http://0.0.0.0:8808
+[2014-02-25 13:17:46] INFO  WEBrick 1.3.1
+[2014-02-25 13:17:46] INFO  ruby 2.0.0 (2013-11-22) [x86_64-darwin13.0.0]
+[2014-02-25 13:17:46] INFO  WEBrick::HTTPServer#start: pid=54296 port=8808
+```
+
+View docs here: http://0.0.0.0:8808
+
+When writing docs, it is usual to run:
+
+```
+# Reparses the library code on each request
+$ be yard server --reload
+```
+
+### Documenting with Yard
+
+* http://yardoc.org/
+* https://github.com/lsegal/yard
+* http://yardoc.org/guides/index.html
+* http://yardoc.org/types.html
+
+The Yard syntax should be familiar to anyone who has used javadocs or doyxgen.
+
+This page has details about the Yard markup tags and is extremely useful:
+
+* [list of yard tags](http://rubydoc.info/gems/yard/file/docs/Tags.md#List_of_Available_Tags)
+
+### Examples
+
+```
+# method for interacting with instruments
+#
+# @example Find the instruments version
+#   instruments(:version)
+#
+# @example A list of known simulators
+#   instruments(:sims)
+#
+# @param [String] cmd controls the return value.  currently accepts nil,
+#   :sims, and :version as valid parameters
+# @return [String] based on the value of `cmd` version, a list known
+#   simulators, or the path to the instruments binary
+# @raise [ArgumentError] if invalid `cmd` is passed
+```
+
+#### code blocks
+
+
+```
+# ```
+#  def example_code
+#
+#  end
+# ```
+```
+
+#### tags that span multiple lines
+
+Indent subsequent lines by 2 or more spaces (prefer 2 spaces).
+
+```
+# @param [String] cmd controls the return value.  currently accepts nil,
+#   :sims, and :version as valid parameters
+```
+
+#### default argument values are auto-generated
+
+A method like this:
+
+```
+# @param [String] cmd controls the return value.  currently accepts nil,
+#   :sims, and :version as valid parameters
+def instruments(cmd=nil)
+```
+
+will generate:
+
+```
+cmd (String) (defaults to: nil) — controls the return value. currently accepts nil, :sims, and :version as valid parameters
+```
+
+#### documenting option hashes
+
+Default values can be specified by including them after the option key in `()`.
+
+```
+# @param [Hash] opts controls the content of the query string
+# @option opts [Integer,nil] :with_tag (true) if non-nil the query string includes tag filter
+# @option opts [Integer,nil] :with_clips_to_bounds (false) if non-nil the query string includes clipsToBounds filter
+```
+
+#### multiple return values
+
+You can list multiple return tags for a method in the case where a method has 
+distinct return cases.   Each case should begin with “if …”
+
+```
+# @return [nil] if `key` does not exist
+# @return [String] if the `key` exists then the value of +key+ (error)
+```
+
+You can also chain return values, but this freaks out RubyMine. :(
+
+```
+# Finds an object or list of objects in the db using a query
+# @return [String, Array<String>, nil] the object or objects to
+#   find in the database. Can be nil.
+def find(query) finder_code_here end
+```
+
+#### generics are allowed
+
+```
+# @param [Array<String, Integer, Float>] list a list of strings integers and floats
+```
+
+#### ignoring private APIs
+
+The [.yardopts](./.yardopts) file includes the `--no-private` option.
+
+To mark an object as private, use this tag.
+
+* `# @!visibility private`
+
+Objects that are within the (Ruby) scope of `private` will be recognized 
+automatically by yard as private.
+
+```
+# @!visibility private
+# Raises an error by raising a exception and conditionally takes a
+# screenshot based on the value of `screenshot_on_error`.
+# ...
+def handle_error_with_options(ex, timeout_message, screenshot_on_error)
+```

data/Rakefile

@@ -1,6 +1,15 @@
 require 'bundler'
 load 'lib/calabash-android/env.rb'
 
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    # see .yardopts for options
+  end
+rescue Exception => _
+  warn 'skipping yard requirement because it is a development dependency'
+end
+
 def build
   test_server_template_dir = File.join(File.dirname(__FILE__), 'test-server')
 

data/bin/calabash-android-helpers.rb

@@ -24,7 +24,7 @@ def print_usage
     build <apk>
       builds the test server that will be used when testing the app.
     run <apk>
-      runs Cucumber in the current folder with the enviroment needed.
+      runs Cucumber in the current folder with the environment needed.
     version
       prints the gem version
 
@@ -35,9 +35,6 @@ EOF
 end
 
 def print_help
-  file = File.join(File.dirname(__FILE__), '..', 'doc', 'calabash-android-help.txt')
-  #system("less #{file}")
-  #TODO
   print_usage
 end
 

data/calabash-android.gemspec

@@ -11,16 +11,20 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/calabash"
   s.summary     = %q{Client for calabash-android for automated functional testing on Android}
   s.description = %q{calabash-android drives tests for native  and hybrid Android apps. }
-  s.files         = `git ls-files`.split("\n") + Dir["test-server/calabash-js/src/*.js"] + ["lib/calabash-android/lib/TestServer.apk"]
+  s.files         = `git ls-files | grep -v "test-server/instrumentation-backend"`.split("\n") + Dir["test-server/calabash-js/src/*.js"] + ["lib/calabash-android/lib/TestServer.apk"]
   s.executables   = "calabash-android"
   s.require_paths = ["lib"]
 
-  s.add_dependency( "cucumber" )
-  s.add_dependency( "json" )
+  s.add_dependency( "cucumber", '~> 1.3.17' )
+  s.add_dependency( "json", '~> 1.8' )
   s.add_dependency( "retriable", "~> 1.3.3.1" )
-  s.add_dependency( "slowhandcuke" )
+  s.add_dependency( "slowhandcuke", '~> 0.0.3')
   s.add_dependency( "rubyzip", "~> 1.1" )
-  s.add_dependency( "awesome_print" )
+  s.add_dependency( "awesome_print", '~> 1.2.0')
   s.add_dependency( 'httpclient', '~> 2.3.2')
   s.add_dependency( 'escape', '~> 0.0.4')
+
+  s.add_development_dependency( 'rake', '~> 10.3' )
+  s.add_development_dependency( 'yard', '~> 0.8' )
+  s.add_development_dependency( 'redcarpet', '~> 3.1' )
 end

data/irbrc

@@ -14,6 +14,7 @@ IRB.conf[:SAVE_HISTORY] = 50
 # Store results in home directory with specified file name
 IRB.conf[:HISTORY_FILE] = ".irb-history"
 
+require 'calabash-android/defaults'
 require 'calabash-android/operations'
 extend Calabash::Android::Operations
 

data/lib/calabash-android/canned_steps.md

@@ -174,7 +174,7 @@ Waits for a particular screen (Android Activity) to appear with a timeout.
 Waits for one second.
 
     Then /^I wait$/
-Waits for two seonds.
+Waits for two seconds.
   
     Then /^I wait for (\d+) seconds$/ do |seconds|
 Waits for a specified number of seconds.

data/lib/calabash-android/defaults.rb

@@ -0,0 +1,9 @@
+module Calabash
+  module Android
+    module Defaults
+      def self.query_timeout
+        (ENV['CALABASH_DEFAULT_TIMEOUT'] && ENV['CALABASH_DEFAULT_TIMEOUT'].to_i) || 5
+      end
+    end
+  end
+end

data/lib/calabash-android/gestures.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'calabash-android/defaults'
 
 module Calabash
   module Android
@@ -7,15 +8,13 @@ module Calabash
         attr_reader :gestures
         attr_accessor :timeout
 
-        DEFAULT_TIMEOUT = 5
-
         def initialize(gestures = [])
           unless gestures.is_a?(Array)
             gestures = [gestures]
           end
 
           @gestures = gestures
-          @timeout = (ENV['CALABASH_DEFAULT_TIMEOUT'] && ENV['CALABASH_DEFAULT_TIMEOUT'].to_i) || DEFAULT_TIMEOUT
+          @timeout = Calabash::Android::Defaults.query_timeout
         end
 
         def +(gesture_collection)

data/lib/calabash-android/java_keystore.rb

@@ -1,17 +1,37 @@
 class JavaKeystore
   attr_reader :errors, :location, :keystore_alias, :password, :fingerprint
+
   def initialize(location, keystore_alias, password)
     raise "No such keystore file '#{location}'" unless File.exists?(File.expand_path(location))
     log "Reading keystore data from keystore file '#{File.expand_path(location)}'"
 
     keystore_data = system_with_stdout_on_success(Env.keytool_path, '-list', '-v', '-alias', keystore_alias, '-keystore', location, '-storepass', password, '-J"-Dfile.encoding=utf-8"')
+
     if keystore_data.nil?
-      error = "Could not list certificates in keystore. Probably because the password was incorrect."
-      @errors = [{:message => error}]
-      log error
-      raise error
-      #TODO: Handle the case where password is correct but the alias is missing.
+      if keystore_alias.empty?
+        log "Could not obtain keystore data. Will try to extract alias automatically"
+
+        keystore_data = system_with_stdout_on_success(Env.keytool_path, '-list', '-v', '-keystore', location, '-storepass', password, '-J"-Dfile.encoding=utf-8"')
+        aliases = keystore_data.scan(/Alias name\:\s*(.*)/).flatten
+
+        if aliases.length == 0
+          raise 'Could not extract alias automatically. Please specify alias using calabash-android setup'
+        elsif aliases.length > 1
+          raise 'Multiple aliases found in keystore. Please specify alias using calabash-android setup'
+        else
+          keystore_alias = aliases.first
+          log "Extracted keystore alias '#{keystore_alias}'. Continuing"
+
+          return initialize(location, keystore_alias, password)
+        end
+      else
+        error = "Could not list certificates in keystore. Probably because the password was incorrect."
+        @errors = [{:message => error}]
+        log error
+        raise error
+      end
     end
+
     @location = location
     @keystore_alias = keystore_alias
     @password = password