calabash 2.0.0.pre1 → 2.0.0.prelegacy2

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
 
@@ -22,12 +23,14 @@ module Calabash
             when '.apk'
               set_platform!(:android)
 
-              # Create the test server if it does not exist
-              test_server = Android::Build::TestServer.new(application_path)
+              unless Environment::TEST_SERVER_PATH
+                # Create the test server if it does not exist
+                test_server = Android::Build::TestServer.new(application_path)
 
-              unless test_server.exists?
-                Logger.info('Test server does not exist. Creating test server.')
-                Calabash::Android::Build::Builder.new(application_path).build
+                unless test_server.exists?
+                  Logger.info('Test server does not exist. Creating test server.')
+                  Calabash::Android::Build::Builder.new(application_path).build
+                end
               end
 
               enter_console(application_path)
@@ -45,6 +48,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]
@@ -64,7 +68,7 @@ EOF
       #{HELP[:resign]}
         resigns the app with the currently configured keystore.
 
-      #{HELP[:build]}
+      #{HELP[:build]} [-o <output_file>]
         builds the test server that will be used when testing the app.
 
     iOS specific commands
@@ -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
 
@@ -30,12 +31,14 @@ module Calabash
             when '.apk'
               set_platform!(:android)
 
-              # Create the test server if it does not exist
-              test_server = Android::Build::TestServer.new(application_path)
+              unless Environment::TEST_SERVER_PATH
+                # Create the test server if it does not exist
+                test_server = Android::Build::TestServer.new(application_path)
 
-              unless test_server.exists?
-                Logger.info('Test server does not exist. Creating test server.')
-                Calabash::Android::Build::Builder.new(application_path).build
+                unless test_server.exists?
+                  Logger.info('Test server does not exist. Creating test server.')
+                  Calabash::Android::Build::Builder.new(application_path).build
+                end
               end
 
               run(application_path, @arguments)
@@ -54,6 +57,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def run(application_path, cucumber_arguments)
         cucumber_environment = {}
         cucumber_environment['CAL_DEBUG'] = Environment::DEBUG ? '1' : '0'
@@ -88,7 +92,7 @@ module Calabash
           end
         end
 
-        arguments = ['-S', 'cucumber', '-p', @platform.to_s, *cucumber_arguments]
+        arguments = ['-S', 'cucumber', *cucumber_arguments]
 
         Logger.debug("Starting Ruby with arguments: #{arguments.join(', ')} and environment #{cucumber_environment.to_s}")
 

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
 
@@ -251,6 +253,11 @@ module Calabash
       abstract_method!
     end
 
+    # @!visibility private
+    def keyboard_visible?
+      abstract_method!
+    end
+
     private
 
     # @!visibility private

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

data/lib/calabash/ios.rb

@@ -31,6 +31,7 @@ module Calabash
     require 'calabash/ios/runtime'
     require 'calabash/ios/gestures'
     require 'calabash/ios/slider'
+    require 'calabash/ios/date_picker'
 
     include Calabash::IOS::Conditions
     include Calabash::IOS::Orientation
@@ -41,6 +42,7 @@ module Calabash
     include Calabash::IOS::Runtime
     include Calabash::IOS::Gestures
     include Calabash::IOS::Slider
+    include Calabash::IOS::DatePicker
 
   end
 end

data/lib/calabash/ios/application.rb

@@ -27,7 +27,7 @@ module Calabash
         application_path = Environment::APP_PATH
 
         if application_path.nil?
-          raise 'No application path is set'
+          raise 'No application path is set. Specify application with environment variable CAL_APP'
         end
 
         Application.new(application_path)
@@ -67,6 +67,13 @@ module Calabash
         @device_binary
       end
 
+      # Is this application an iOS application
+      #
+      # @return [Boolean] Always returns true
+      def ios_application?
+        true
+      end
+
       # Returns the sha1 of the directory or binary of this app's path.
       # @return [String] A checksum.
       def sha1

data/lib/calabash/ios/conditions.rb

@@ -1,5 +1,8 @@
 module Calabash
   module IOS
+
+    # Methods for waiting for things to happen on iOS, like animations to
+    # complete.
     module Conditions
 
       # Waits for all elements to stop animating.

data/lib/calabash/ios/date_picker.rb

@@ -0,0 +1,412 @@
+require 'date'
+
+module Calabash
+  module IOS
+
+    # A collection of methods for interacting with UIDatePicker.
+    module DatePicker
+
+      # The API has been tested in various time zones and tested
+      # once while crossing the international date line (on a boat).
+      # With that said, the API makes some assumptions about locales
+      # and time zones.  It is possible to customize the ruby date
+      # format and Objective-C date format to get the behavior you
+      # need.  You will need to monkey patch the following methods:
+      #
+      #  * date_picker_ruby_date_format
+      #  * date_picker_objc_date_format
+      #
+      # Before going down this path, we recommend that you ask for
+      # advice on the Calabash support channels.
+
+      # @!visibility private
+      # Provided for monkey patching, but not part of the public API.
+      def date_picker_ruby_date_format
+        RUBY_DATE_AND_TIME_FMT
+      end
+
+      # @!visibility private
+      # Provided for monkey patching, but not part of the public API.
+      def date_picker_objc_date_format
+        OBJC_DATE_AND_TIME_FMT
+      end
+
+      # @!visibility private
+      # Returns the picker mode of the first UIDatePicker match by `query`.
+      #
+      # @see #time_mode?
+      # @see #date_mode?
+      # @see #date_and_time_mode?
+      # @see #countdown_mode?
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      # @return [String] Returns the picker mode which will be one of
+      #  `{'0', '1', '2', '3'}`
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If an unknown mode is returned.
+      # @raise [RuntimeError] If first view matched by query does not responde
+      #   to 'datePickerMode'.
+      def date_picker_mode(query)
+        Query.ensure_valid_query(query)
+
+        message = "Timed out waiting for picker with #{query}"
+        mode = nil
+
+        wait_for(message) do
+          result = query(query, :datePickerMode)
+          if result.empty?
+            false
+          else
+            mode = result.first
+            if [0, 1, 2, 3].include?(mode)
+              mode
+            else
+              if mode == '*****'
+                raise RuntimeError,
+                  "Query #{query} matched a view that does not respond 'datePickerMode'"
+              else
+                raise RuntimeError,
+                  "Query #{query} returned an unknown mode '#{mode}' for 'datePickerMode'"
+              end
+            end
+          end
+        end
+      end
+
+      # Is the date picker in time mode?
+      #
+      # @see #time_mode?
+      # @see #date_mode?
+      # @see #date_and_time_mode?
+      # @see #countdown_mode?
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [Boolean] True if the picker is in time mode.
+      #
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If an unknown mode is returned.
+      # @raise [RuntimeError] If first view matched by query does not responde
+      #   to 'datePickerMode'.
+      def time_mode?(query)
+        date_picker_mode(query) == UI_DATE_PICKER_MODE_TIME
+      end
+
+      # Is the date picker in date mode?
+      #
+      # @see #time_mode?
+      # @see #date_mode?
+      # @see #date_and_time_mode?
+      # @see #countdown_mode?
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [Boolean] True if the picker is in date mode.
+      #
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If an unknown mode is returned.
+      # @raise [RuntimeError] If first view matched by query does not responde
+      #   to 'datePickerMode'.
+      def date_mode?(query)
+        date_picker_mode(query) == UI_DATE_PICKER_MODE_DATE
+      end
+
+      # Is the date picker in date and time mode?
+      #
+      # @see #time_mode?
+      # @see #date_mode?
+      # @see #date_and_time_mode?
+      # @see #countdown_mode?
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [Boolean] True if the picker is in date and time mode.
+      #
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If an unknown mode is returned.
+      # @raise [RuntimeError] If first view matched by query does not responde
+      #   to 'datePickerMode'.
+      def date_and_time_mode?(query)
+        date_picker_mode(query) == UI_DATE_PICKER_MODE_DATE_AND_TIME
+      end
+
+      # Is the date picker in countdown mode?
+      #
+      # @see #time_mode?
+      # @see #date_mode?
+      # @see #date_and_time_mode?
+      # @see #countdown_mode?
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [Boolean] True if the picker is in countdown mode.
+      #
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If an unknown mode is returned.
+      # @raise [RuntimeError] If first view matched by query does not responde
+      #   to 'datePickerMode'.
+      def countdown_mode?(query)
+        date_picker_mode(query) == UI_DATE_PICKER_MODE_COUNT_DOWN_TIMER
+      end
+
+      # The maximum date for a picker.  If there is no maximum date, this
+      # method returns nil.
+      #
+      # @note
+      #  From the Apple docs:
+      #  `The property is an NSDate object or nil (the default)`.
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [DateTime] The maximum date on the picker or nil if no maximum
+      #  exists
+      #
+      # @raise [RuntimeError] If the picker is in countdown mode.
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If the date returned by the server cannot be
+      #   converted to a DateTime object.
+      def maximum_date_time_from_picker(query)
+        Query.ensure_valid_query(query)
+
+        wait_for_view(query)
+
+        if countdown_mode?(query)
+          fail('Countdown pickers do not have a maximum date.')
+        end
+
+        result = query(query, :maximumDate)
+
+        if result.empty?
+          fail("Expected '#{query}' to return a visible UIDatePicker")
+        else
+          if result.first.nil?
+            nil
+          else
+            date_str = result.first
+            begin
+              date_time = DateTime.parse(date_str)
+            rescue TypeError, ArgumentError => _
+              raise RuntimeError,
+                "Could not convert string '#{date_str}' into a valid DateTime object"
+            end
+            date_time
+          end
+        end
+      end
+
+      # The minimum date for a picker.  If there is no minimum date, this
+      # method returns nil.
+      #
+      # @note
+      #  From the Apple docs:
+      #  `The property is an NSDate object or nil (the default)`.
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [DateTime] The minimum date on the picker or nil if no minimum
+      #  exists
+      #
+      # @raise [RuntimeError] If the picker is in countdown mode.
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If the date returned by the server cannot be
+      #   converted to a DateTime object.
+      def minimum_date_time_from_picker(query)
+        Query.ensure_valid_query(query)
+
+        wait_for_view(query)
+
+        if countdown_mode?(query)
+          fail('Countdown pickers do not have a minimum date.')
+        end
+
+        result = query(query, :minimumDate)
+
+        if result.empty?
+          fail("Expected '#{query}' to return a visible UIDatePicker")
+        else
+          if result.first.nil?
+            nil
+          else
+            date_str = result.first
+            begin
+              date_time = DateTime.parse(date_str)
+            rescue TypeError, ArgumentError => _
+              raise RuntimeError,
+                "Could not convert string '#{date_str}' into a valid DateTime object"
+            end
+            date_time
+          end
+        end
+      end
+
+      # Returns the date and time from the picker as DateTime object.
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      #
+      # @return [DateTime] The date on the picker
+      #
+      # @raise [RuntimeError] If the picker is in countdown mode.
+      # @raise [RuntimeError] If no picker can be found.
+      # @raise [RuntimeError] If the date returned by the server cannot be
+      #   converted to a DateTime object.
+      def date_time_from_picker(query)
+        Query.ensure_valid_query(query)
+
+        wait_for_view(query)
+
+        if countdown_mode?(query)
+          fail('This method is available for pickers in countdown mode.')
+        end
+
+        result = query(query, :date)
+
+        if result.empty?
+          fail("Expected '#{query}' to return a visible UIDatePicker")
+        else
+          if result.first.nil?
+            nil
+          else
+            date_str = result.first
+            date_time = DateTime.parse(date_str)
+            if date_time.nil?
+              raise RuntimeError,
+                "Could not convert string '#{date_str}' into a valid DateTime object"
+            end
+            date_time
+          end
+        end
+      end
+
+      # Sets the date and time on the _first_ UIDatePicker matched by
+      # `query`.
+      #
+      # This method is not valid for UIDatePickers in _countdown_ mode.
+      #
+      # @param [DateTime] date_time The date and time you want to change to.
+      #
+      # @raise [RuntimeError] If `query` does match exactly one picker.
+      # @raise [RuntimeError] If `query` matches a picker in countdown mode.
+      # @raise [RuntimeError] If the target date is greater than the picker's
+      #  maximum date.
+      # @raise [RuntimeError] If the target date is less than the picker's
+      #  minimum date
+      # @raise [ArgumentError] If the target date is not a DateTime instance.
+      def picker_set_date_time(date_time)
+        picker_set_date_time_in("UIDatePicker index:0", date_time)
+      end
+
+      # Sets the date and time on the _first_ UIDatePicker matched by
+      # `query`.
+      #
+      # This method is not valid for UIDatePickers in _countdown_ mode.
+      #
+      # An error will be raised if more than on view is matched by `query`.
+      #
+      # To avoid matching more than one UIPickerView or subclass:
+      #  * Make the query more specific:    "UIPickerView marked:'alarm'"
+      #  * Use the index language feature:  "UIPickerView index:0"
+      #  * Query by custom class:           "view:'MyPickerView'"
+      #
+      # @param [String, Hash, Calabash::Query] query A query that can be used
+      #   to find UIDatePickers.
+      # @param [DateTime] date_time The date and time you want to change to.
+      #
+      # @raise [RuntimeError] If `query` does match exactly one picker.
+      # @raise [RuntimeError] If `query` matches a picker in countdown mode.
+      # @raise [RuntimeError] If the target date is greater than the picker's
+      #  maximum date.
+      # @raise [RuntimeError] If the target date is less than the picker's
+      #  minimum date
+      # @raise [ArgumentError] If the target date is not a DateTime instance.
+      def picker_set_date_time_in(query, date_time)
+        unless date_time.is_a?(DateTime)
+          raise ArgumentError,
+            "Date time argument '#{date_time}' must be a DateTime but found '#{date_time.class}'"
+        end
+
+        Query.ensure_valid_query(query)
+
+        message = "Timed out waiting for UIDatePicker with '#{query}'"
+
+        wait_for(message) do
+          result = query(query)
+          if result.length > 1
+            fail("Query '#{query}' matched more than on UIDatePicker")
+          else
+            !result.empty?
+          end
+        end
+
+        if countdown_mode?(query)
+          message =
+            [
+              "Query '#{query}' matched a picker in countdown mode.",
+              'Setting the date or time on a countdown picker is not supported'
+            ].join("\n")
+          fail(message)
+        end
+
+        minimum_date = minimum_date_time_from_picker(query)
+        if !minimum_date.nil? && minimum_date > date_time
+          message = [
+            "Cannot set the date on the picker matched by '#{query}'",
+            "Picker minimum date:  '#{minimum_date}'",
+            "  Date to change to:  '#{date_time}'",
+            "Target date comes before the minimum date."].join("\n")
+          fail(message)
+        end
+
+        maximum_date = maximum_date_time_from_picker(query)
+        if !maximum_date.nil? && maximum_date < date_time
+          message = [
+            "Cannot set the date on the picker matched by '#{query}'",
+            "Picker maximum date:  '#{maximum_date}'",
+            "  Date to change to:  '#{date_time}'",
+            "Target date comes after the maximum date."].join("\n")
+          fail(message)
+        end
+
+        ruby_format = date_picker_ruby_date_format
+        objc_format = date_picker_objc_date_format
+        target_date_string = date_time.strftime(ruby_format).squeeze(' ').strip
+
+        Device.default.map_route(query,
+                                 :changeDatePickerDate,
+                                 target_date_string,
+                                 objc_format,
+                                 # notify targets
+                                 true,
+                                 # animate
+                                 true)
+      end
+
+      private
+
+      # @!visibility private
+      OBJC_DATE_AND_TIME_FMT = 'yyyy_MM_dd_HH_mm'
+
+      # @!visibility private
+      RUBY_DATE_AND_TIME_FMT = '%Y_%m_%d_%H_%M'
+
+      # UIDatePicker modes
+
+      # @!visibility private
+      UI_DATE_PICKER_MODE_TIME = 0
+      # @!visibility private
+      UI_DATE_PICKER_MODE_DATE = 1
+      # @!visibility private
+      UI_DATE_PICKER_MODE_DATE_AND_TIME = 2
+      # @!visibility private
+      UI_DATE_PICKER_MODE_COUNT_DOWN_TIMER = 3
+    end
+  end
+end
+