calabash 2.0.0.pre2 → 2.0.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 819df5d6b1278e724b9cbf4696f96a1ffe75557c
-  data.tar.gz: 1ed7899450830880d379bf2f1ee5cd2e8f98bbbe
+  metadata.gz: 99f4bb2a90e0b3d0e826f6afe73b213a36e984e0
+  data.tar.gz: 2056799cd44ee3504b986351da16bb834f72e382
 SHA512:
-  metadata.gz: 2b0bf17b2a8965ffe07883a4c371a4f9d14dbad9b824b3547bd3d490bb02b117b66da057cb868bc30d2b5dced1e97066991aef1ee3a9edfa31b390e25c6600ff
-  data.tar.gz: 25db11e28ba856c6cf3e7646173e483793172c80fd0bcbbd71dd65c7e3d70f7cd610ce04e6bb3e60ed0674f8d2dad304f2ff3b01d3ebfc7d14265fb74b62a518
+  metadata.gz: 1ba0e8c86de9a8682affd9712cbfc4d7b50bf472bc285c8375e210ae5f99146910f6229ff140cc316ab6dea697ecfbc0bc75e415f750b8706940981080bfa2a1
+  data.tar.gz: 2a71fcf01eb79e7cb15d294a70b7cd9ba42111c09ef82966e4b9d7522221e7b726df29483683b6ef6640412b75f2e2edc80c0e4084567d57a02b1a1c68102140

data/README.md

@@ -27,8 +27,6 @@ $ rake -T
 rake android:build     # Build the Android test server
 rake build             # Build calabash-1.9.9.pre2.gem into the pkg directory
 rake ctags             # Generate ctags in ./git/tags
-rake cucumber:android  # Run Android cucumber tests
-rake cucumber:ios      # Run iOS cucumber tests
 rake install           # Build and install calabash-1.9.9.pre2.gem into system gems
 rake release           # Create tag v1.9.9.pre2 and build and push calabash-1.9.9.pre2.gem to Rubygems
 rake spec              # Run RSpec code examples
@@ -63,28 +61,5 @@ $ be cucumber
 
 ### Cucumber iOS
 
-```
-$ cd cucumber/ios
-$ bundle update
-$ rake ensure_app  # Optional. See note below.
-$ be cucumber
-```
-
-The rake task `ensure_app` checks the `cucumber/ios` directory for
-CalSmoke-cal.app. If it exists, it will do nothing.  If it does not exist,
-it will pull the latest sources from the CalSmoke repo, build the
-CalSmoke-cal.app from the master branch, and install it in the
-`cucumber/ios` directory.
-
-If you want to use a different CalSmoke-cal.app, drop it into `cucumber/ios`
-or call cucumber with `CAL\_APP` set.
-
-```
-$ CAL_APP=/path/to/your/CalSmoke-cal.app be cucumber
-```
-
-The rake task `ensure_ipa` does the same thing, but for the CalSmoke-cal.ipa.
-
-Testing against physical devices requires that you have ideviceinstaller
-installed in /usr/local/bin/ideviceinstaller.
+See `cucumber/ios/README.md`.
 

data/lib/calabash/android/adb.rb

@@ -17,8 +17,10 @@ module Calabash
         end
       end
 
+      # @!visibility private
       PROCESS_WAIT_TIME = 10
 
+      # @!visibility private
       def self.open_pipe_with_timeout(timeout, *cmd, &block)
         begin
           i, o, e, t, pid = nil
@@ -52,6 +54,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def self.open_adb_pipe(*cmd, **options, &block)
         timeout = options.fetch(:timeout, PROCESS_WAIT_TIME)
 
@@ -60,8 +63,10 @@ module Calabash
         end
       end
 
+      # @!visibility private
       DAEMON_STARTED_MESSAGE = "* daemon not running. starting it now on port 5037 *\n* daemon started successfully *\n"
 
+      # @!visibility private
       def self.command(*cmd, **args)
         Logger.debug("ADB Command: #{cmd.join(', ')}")
         Logger.debug("ADB input: #{args[:input]}")
@@ -121,10 +126,12 @@ module Calabash
 
       attr_reader :serial
 
+      # @!visibility private
       def initialize(serial)
         @serial = serial
       end
 
+      # @!visibility private
       def command(*argv, **args)
         cmd = argv.dup
 
@@ -135,8 +142,10 @@ module Calabash
         ADB.command(*cmd, args)
       end
 
+      # @!visibility private
       END_STRING = '__CAL_END__'
 
+      # @!visibility private
       def shell(shell_cmd, options={})
         if shell_cmd.nil? || shell_cmd.empty?
           raise ArgumentError, "Invalid shell command '#{shell_cmd}'"

data/lib/calabash/android/build/builder.rb

@@ -16,6 +16,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def build
           apk_fingerprint = fingerprint_from_apk
           @logger.log "#{@application_path} was signed with a certificate with fingerprint #{apk_fingerprint}", :debug
@@ -83,6 +84,7 @@ module Calabash
           @logger.log "Done signing the test server. Moved it to #{test_server_file_name}"
         end
 
+        # @!visibility private
         def fingerprint_from_apk
           application_path = File.expand_path(@application_path)
 

data/lib/calabash/android/build/java_keystore.rb

@@ -5,6 +5,7 @@ module Calabash
     module Build
       # @!visibility private
       class JavaKeystore
+        # @!visibility private
         CALABASH_KEYSTORE_SETTINGS_FILENAME = 'calabash_keystore_settings.json'
 
         attr_reader :errors, :location, :keystore_alias, :store_password
@@ -68,6 +69,7 @@ module Calabash
           @logger.log "Signature algorithm name: #{signature_algorithm_name}", :debug
         end
 
+        # @!visibility private
         def sign_apk(apk_path, dest_path)
           raise "Cannot sign with a miss configured keystore" if errors
           raise "No such file: #{apk_path}" unless File.exists?(apk_path)
@@ -86,6 +88,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def system_with_stdout_on_success(cmd, *args)
           a = Escape.shell_command(args)
           cmd = "#{cmd} #{a.gsub("'", '"')}"
@@ -98,10 +101,12 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def fail_wrong_info
           raise "Could not read keystore with the given credentials. Please ensure "
         end
 
+        # @!visibility private
         def self.read_keystore_with_default_password_and_alias(path)
           path = File.expand_path path
 
@@ -128,6 +133,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def self.get_keystores
           if keystore = keystore_from_settings
             [ keystore ]
@@ -141,6 +147,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def self.keystore_from_settings
           if File.exist?(CALABASH_KEYSTORE_SETTINGS_FILENAME)
             Logger.info "Reading keystore information specified in #{CALABASH_KEYSTORE_SETTINGS_FILENAME}"
@@ -157,16 +164,19 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def self.fail_if_key_missing(map, key)
           raise "Found #{CALABASH_KEYSTORE_SETTINGS_FILENAME} but no #{key} defined." unless map[key]
         end
 
+        # @!visibility private
         def self.extract_md5_fingerprint(fingerprints)
           m = fingerprints.scan(/MD5.*((?:[a-fA-F\d]{2}:){15}[a-fA-F\d]{2})/).flatten
           raise "No MD5 fingerprint found:\n #{fingerprints}" if m.empty?
           m.first
         end
 
+        # @!visibility private
         def self.extract_signature_algorithm_name(fingerprints)
           m = fingerprints.scan(/Signature algorithm name: (.*)/).flatten
           raise "No signature algorithm names found:\n #{fingerprints}" if m.empty?

data/lib/calabash/android/build/resigner.rb

@@ -14,6 +14,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def resign!
           Dir.mktmpdir do |tmp_dir|
             @logger.log 'Resigning apk', :debug
@@ -26,6 +27,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def unsign(unsigned_path)
           meta_files = `"#{Environment.aapt_path}" list "#{unsigned_path}"`.lines.collect(&:strip).grep(/^META-INF\//)
 
@@ -53,12 +55,14 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def zipalign(unaligned_path, app_path)
           cmd = %Q("#{Environment.zipalign_path}" -f 4 "#{unaligned_path}" "#{app_path}")
           @logger.log "Zipaligning using: #{cmd}", :debug
           system(cmd)
         end
 
+        # @!visibility private
         def sign(app_path, dest_path)
           java_keystore = JavaKeystore.get_keystores.first
 

data/lib/calabash/android/build/test_server.rb

@@ -7,10 +7,12 @@ module Calabash
           @application_path = application_path
         end
 
+        # @!visibility private
         def path
           File.expand_path("test_servers/#{checksum(@application_path)}_#{VERSION}.apk")
         end
 
+        # @!visibility private
         def exists?
           File.exists?(path)
         end

data/lib/calabash/android/defaults.rb

@@ -1,5 +1,6 @@
 module Calabash
   module Android
+    # Runtime defaults for Android.
     module Defaults
       # Sets up the default device and the default application based on the
       # environment.

data/lib/calabash/android/device.rb

@@ -22,6 +22,7 @@ module Calabash
         port_forward(new_server.endpoint.port, new_server.test_server_port)
       end
 
+      # @!visibility private
       def self.default_serial
         serials = list_serials
 
@@ -46,6 +47,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def self.list_serials
         output = ADB.command('devices')
         lines = output.lines
@@ -62,12 +64,14 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def installed_packages
         adb.shell('pm list packages').lines.map do |line|
           line.sub('package:', '').chomp
         end
       end
 
+      # @!visibility private
       def installed_apps
         adb.shell('pm list packages -f').lines.map do |line|
           # line will be package:<path>=<package>
@@ -80,6 +84,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def test_server_responding?
         begin
           http_client.get(HTTP::Request.new('ping'), retries: 1).body == 'pong'
@@ -88,6 +93,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def test_server_ready?
         begin
           http_client.get(HTTP::Request.new('ready')).body == 'true'
@@ -96,6 +102,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def port_forward(host_port, test_server_port = nil)
         if test_server_port.nil?
           test_server_port = server.test_server_port
@@ -105,6 +112,7 @@ module Calabash
         adb.command(*adb_forward_cmd)
       end
 
+      # @!visibility private
       def make_map_parameters(query, map_method_name, *method_args)
         converted_args = []
 
@@ -172,6 +180,7 @@ module Calabash
         Calabash::QueryResult.create(result['results'], query)
       end
 
+      # @!visibility private
       def perform_action(action, *arguments)
         @logger.log "Action: #{action} - Arguments: #{arguments.join(', ')}"
 
@@ -197,10 +206,12 @@ module Calabash
         result
       end
 
+      # @!visibility private
       def enter_text(text)
         perform_action('keyboard_enter_text', text)
       end
 
+      # @!visibility private
       def md5_checksum(file_path)
         result = adb.shell("#{md5_binary} '#{file_path}'")
         captures = result.match(/(\w+)/).captures
@@ -234,15 +245,18 @@ module Calabash
         result['result']
       end
 
+      # @!visibility private
       def go_home
         adb.shell("input keyevent 3")
       end
 
+      # @!visibility private
       def set_location(location)
         perform_action('set_gps_coordinates',
                        location[:latitude], location[:longitude])
       end
 
+      # @!visibility private
       def resume_app(path_or_application)
         application = parse_path_or_app_parameters(path_or_application)
 
@@ -263,6 +277,7 @@ module Calabash
         true
       end
 
+      # @!visibility private
       def resume_activity(package, activity)
         if package_running?(package)
           if info[:sdk_version] >= 11
@@ -279,12 +294,14 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def app_running?(path_or_application)
         application = parse_path_or_app_parameters(path_or_application)
 
         package_running?(application.identifier)
       end
 
+      # @!visibility private
       def current_focus
         # Example: mFocusedApp=AppWindowToken{42c52610 token=Token{42b5d048 ActivityRecord{42a7bcc8 u0 com.example/.MainActivity t3}}}
         result = adb.shell('dumpsys window windows')
@@ -314,6 +331,7 @@ module Calabash
         raise "Unexpected output from `dumpsys window windows`"
       end
 
+      # @!visibility private
       def evaluate_javascript_in(query, javascript)
         parameters =
             {

data/lib/calabash/android/interactions.rb

@@ -3,6 +3,8 @@ require 'time'
 
 module Calabash
   module Android
+
+    # Interactions with your app that are specific to Android.
     module Interactions
       # Go back. If the keyboard is shown, it will be dismissed.
       def go_back

data/lib/calabash/android/life_cycle.rb

@@ -1,5 +1,6 @@
 module Calabash
   module Android
+    # Android specific life cyle methods.
     module LifeCycle
       # Resume an application. If the application is already focused, nothing
       # will happen.

data/lib/calabash/android/physical_buttons.rb

@@ -7,35 +7,43 @@ module Calabash
     # @!visibility private
     module PhysicalButtons
 
+      # @!visibility private
       def press_button(key)
         Device.default.perform_action('press_key', key)
         true
       end
 
+      # @!visibility private
       def press_back_button
         press_button('KEYCODE_BACK')
       end
 
+      # @!visibility private
       def press_menu_button
         press_button('KEYCODE_MENU')
       end
 
+      # @!visibility private
       def press_down_button
         press_button('KEYCODE_DPAD_DOWN')
       end
 
+      # @!visibility private
       def press_up_button
         press_button('KEYCODE_DPAD_UP')
       end
 
+      # @!visibility private
       def press_left_button
         press_button('KEYCODE_DPAD_LEFT')
       end
 
+      # @!visibility private
       def press_right_button
         press_button('KEYCODE_DPAD_RIGHT')
       end
 
+      # @!visibility private
       def press_enter_button
         press_button('KEYCODE_ENTER')
       end

data/lib/calabash/android/screenshot.rb

@@ -2,6 +2,7 @@ module Calabash
   module Android
     # @!visibility private
     module Screenshot
+      # @!visibility private
       SCREENSHOT_JAR_PATH = File.join(File.dirname(__FILE__), 'lib', 'screenshot_taker.jar')
     end
   end

data/lib/calabash/android/server.rb

@@ -2,6 +2,7 @@ module Calabash
   module Android
     # A representation of the Calabash Android test server.
     class Server < ::Calabash::Server
+      # The default Android test server.
       def self.default
         Server.new(URI.parse('http://127.0.0.1:33765'))
       end

data/lib/calabash/android/text.rb

@@ -1,5 +1,6 @@
 module Calabash
   module Android
+    # Android specific text-related actions.
     module Text
       # Dismisses the current keyboard. This is equivalent to the user
       # pressing the back button if the keyboard is showing. If the keyboard is

data/lib/calabash/cli/build.rb

@@ -2,6 +2,7 @@ module Calabash
   module CLI
     # @!visibility private
     module Build
+      # @!visibility private
       def parse_build_arguments!
         fail('Should only build test-server for Android') unless @platform.nil? || @platform == :android
 

data/lib/calabash/cli/console.rb

@@ -3,6 +3,7 @@ module Calabash
   module CLI
     # @!visibility private
     module Console
+      # @!visibility private
       def parse_console_arguments!
         application = @arguments.shift
 
@@ -45,6 +46,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def enter_console(application_path)
         irbrc_path = Environment::IRBRC
 

data/lib/calabash/cli/generate.rb

@@ -5,6 +5,7 @@ module Calabash
   module CLI
     # @!visibility private
     module Generate
+      # @!visibility private
       def parse_generate_arguments!
         if File.exist?('features')
           puts "A features directory already exists. Please remove this to continue."
@@ -70,10 +71,12 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def file(file)
         File.join(Calabash::Environment::SKELETON_DIR_PATH, file)
       end
 
+      # @!visibility private
       def msg(title, &block)
         puts "\n" + "-"*10 + title + "-"*10
         block.call

data/lib/calabash/cli/helpers.rb

@@ -3,6 +3,7 @@ module Calabash
   module CLI
     # @!visibility private
     module Helpers
+      # @!visibility private
       HELP = {
           help: 'help',
           generate: 'generate',
@@ -14,6 +15,7 @@ module Calabash
           build: 'build <apk>'
       }
 
+      # @!visibility private
       def key_for_command(command)
         HELP.each do |key, value|
           if value.split(' ').first == command
@@ -24,6 +26,7 @@ module Calabash
         nil
       end
 
+      # @!visibility private
       def print_usage_for(key, output=STDOUT)
         if key.nil? || HELP[key].nil?
           output.write <<EOF
@@ -37,6 +40,7 @@ EOF
         end
       end
 
+      # @!visibility private
       def print_usage(output=STDOUT)
           output.write <<EOF
   Usage: calabash [options] <command-name> [command specific options]
@@ -101,11 +105,13 @@ EOF
 EOF
       end
 
+      # @!visibility private
       def help
         file_name = File.join(File.dirname(__FILE__), '..', 'doc', 'calabash_help.txt')
         system("less \"#{file_name}\"")
       end
 
+      # @!visibility private
       def fail(reason, command=nil)
         STDERR.write("#{reason}\n")
 

data/lib/calabash/cli/resign.rb

@@ -3,6 +3,7 @@ module Calabash
   module CLI
     # @!visibility private
     module Resign
+      # @!visibility private
       def parse_resign_arguments!
         fail('Can only resign Android applications') unless @platform.nil? || @platform == :android
 

data/lib/calabash/cli/run.rb

@@ -3,6 +3,7 @@ module Calabash
   module CLI
     # @!visibility private
     module Run
+      # @!visibility private
       def parse_run_arguments!
         first_argument = @arguments.first # Do not remove the entry from the arguments yet - it might be a cucumber arg
 
@@ -54,6 +55,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def run(application_path, cucumber_arguments)
         cucumber_environment = {}
         cucumber_environment['CAL_DEBUG'] = Environment::DEBUG ? '1' : '0'

data/lib/calabash/cli/setup_keystore.rb

@@ -6,6 +6,7 @@ module Calabash
   module CLI
     # @!visibility private
     module SetupKeystore
+      # @!visibility private
       def parse_setup_keystore_arguments!
         set_platform!(:android)
 
@@ -25,6 +26,7 @@ module Calabash
         puts "Saved your settings to '#{Android::Build::JavaKeystore::CALABASH_KEYSTORE_SETTINGS_FILENAME}'. You can edit the settings manually or run this setup script again"
       end
 
+      # @!visibility private
       def prompt(message, secure = false)
         puts message
 

data/lib/calabash/color.rb

@@ -1,30 +1,37 @@
 module Calabash
   # @!visibility private
   module Color
+    # @!visibility private
     def self.colorize(string, color)
       "\e[#{color}m#{string}\e[0m"
     end
 
+    # @!visibility private
     def self.red(string)
       colorize(string, 31)
     end
 
+    # @!visibility private
     def self.green(string)
       colorize(string, 32)
     end
 
+    # @!visibility private
     def self.yellow(string)
       colorize(string, 33)
     end
 
+    # @!visibility private
     def self.blue(string)
       colorize(string, 34)
     end
 
+    # @!visibility private
     def self.magenta(string)
       colorize(string, 35)
     end
 
+    # @!visibility private
     def self.cyan(string)
       colorize(string, 36)
     end

data/lib/calabash/defaults.rb

@@ -1,4 +1,5 @@
 module Calabash
+  # Runtime defaults.
   module Defaults
     # Get the default device. The device represents a physical device,
     # an emulator, or a simulator. Calabash will communicate with this

data/lib/calabash/device.rb

@@ -1,4 +1,6 @@
 module Calabash
+  # A model of the device under test.  Can be a physical Android or iOS device,
+  # an Android emulator, or an iOS simulator.
   class Device
     include Utility
 

data/lib/calabash/environment.rb

@@ -11,6 +11,7 @@ module Calabash
       ENV[name]
     end
 
+    # @!visibility private
     # Utility method to set the value of an environment variable.
     #
     # @param [String] name of the environment variable

data/lib/calabash/http/retriable_client.rb

@@ -57,10 +57,12 @@ module Calabash
         @on_error = {}
       end
 
+      # @!visibility private
       def on_error(type, &block)
         @on_error[type] = block
       end
 
+      # @!visibility private
       def change_server(new_server)
         @server = new_server
       end

data/lib/calabash/interactions.rb

@@ -1,4 +1,5 @@
 module Calabash
+  # Query, flash, backdoor, etc.
   module Interactions
     # Queries the view hierarchy to find all views matching `query`.
     # Optionally query takes a variable number of “invocation” arguments