calabash-cucumber 0.18.2 → 0.19.0.pre1

data/features-skeleton/support/01_launch.rb

@@ -25,7 +25,6 @@ Before do |scenario|
   }
 
   launcher.relaunch(options)
-  launcher.calabash_notify(self)
 end
 
 After do |scenario|
@@ -33,11 +32,11 @@ After do |scenario|
   # in the UIApplicationDelegate.  This is really nice for CI environments, but
   # not so good for local development.
   #
-  # See the documentation for NO_STOP for a nice debugging workflow
+  # See the documentation for QUIT_APP_AFTER_SCENARIO for a nice debugging workflow
   #
-  # http://calabashapi.xamarin.com/ios/file.ENVIRONMENT_VARIABLES.html#label-NO_STOP
+  # http://calabashapi.xamarin.com/ios/file.ENVIRONMENT_VARIABLES.html#label-QUIT_APP_AFTER_SCENARIO
   # http://calabashapi.xamarin.com/ios/Calabash/Cucumber/Core.html#console_attach-instance_method
-  unless launcher.calabash_no_stop?
+  if launcher.quit_app_after_scenario?
     calabash_exit
   end
 end

data/features/step_definitions/calabash_steps.rb

@@ -85,7 +85,7 @@ Then /^I touch (?:the)? user location$/ do
 end
 
 Then /^I (?:touch|press) (?:done|search)$/ do
-  done
+  tap_keyboard_action_key
   sleep(STEP_PAUSE)
 end
 
@@ -138,12 +138,6 @@ Then /^I use the native keyboard to enter "([^\"]*)" into (?:input|text) field n
   sleep(STEP_PAUSE)
 end
 
-When /^I clear "([^\"]*)"$/ do |name|
-  msg = "When I clear <name>' will be deprecated because it is ambiguous - what should be cleared?"
-  _deprecated('0.9.151', msg, :warn)
-  clear_text("textField marked: '#{name}'")
-end
-
 Then /^I clear (?:input|text) field number (\d+)$/ do |index|
   index = index.to_i
   screenshot_and_raise("Index should be positive (was: #{index})") if index <= 0

data/lib/calabash-cucumber.rb

@@ -4,6 +4,7 @@ require "calabash-cucumber/dot_dir"
 require "calabash-cucumber/store/preferences"
 require "calabash-cucumber/usage_tracker.rb"
 require "calabash-cucumber/dylibs"
+require "calabash-cucumber/http/http"
 require 'calabash-cucumber/core'
 require 'calabash-cucumber/tests_helpers'
 require 'calabash-cucumber/keyboard_helpers'
@@ -13,8 +14,6 @@ require 'calabash-cucumber/operations'
 require 'calabash-cucumber/version'
 require 'calabash-cucumber/date_picker'
 require 'calabash-cucumber/ipad_1x_2x'
-require 'calabash-cucumber/utils/logging'
-require 'calabash-cucumber/deprecated'
 
 # stubs for documentation
 

data/lib/calabash-cucumber/actions/instruments_actions.rb

@@ -116,17 +116,16 @@ class Calabash::Cucumber::InstrumentsActions
   def normalize_rect_for_orientation!(orientation, rect)
     orientation = orientation.to_sym
     launcher = Calabash::Cucumber::Launcher.launcher
+    device = launcher.device
 
     # Coordinate translations for orientation is handled in the server for iOS 8+
-    # https://developer.apple.com/library/ios/documentation/UIKit/Reference/UICoordinateSpace_protocol/index.html
-    if launcher.ios_major_version.to_i >= 8
+    if device.ios_major_version.to_i >= 8
       return
     end
 
     # We cannot use Device#screen_dimensions here because on iPads the height
     # and width are the opposite of what we expect.
     # @todo Move all coordinate/orientation translation into the server.
-    device = launcher.device
     if device.ipad?
       screen_size = { :width => 768, :height => 1024 }
     elsif device.iphone_4in?

data/lib/calabash-cucumber/core.rb

@@ -5,19 +5,11 @@ require 'calabash-cucumber/uia'
 require 'calabash-cucumber/environment_helpers'
 require 'calabash-cucumber/connection'
 require 'calabash-cucumber/connection_helpers'
-require 'calabash-cucumber/launch/simulator_launcher'
 require 'calabash-cucumber/query_helpers'
-require 'calabash-cucumber/playback_helpers'
 require 'calabash-cucumber/failure_helpers'
 require 'calabash-cucumber/status_bar_helpers'
 require 'calabash-cucumber/rotation_helpers'
 require 'calabash-cucumber/map'
-require 'calabash-cucumber/utils/logging'
-
-
-# legacy support - module was deprecated 0.9.169
-# replaced with simulator-launcher
-require 'calabash-cucumber/launch/simulator_helper'
 
 module Calabash
   module Cucumber
@@ -25,7 +17,6 @@ module Calabash
     # A collection of methods that provide the core calabash behaviors.
     module Core
 
-      include Calabash::Cucumber::Logging
       include Calabash::Cucumber::EnvironmentHelpers
       include Calabash::Cucumber::ConnectionHelpers
       include Calabash::Cucumber::QueryHelpers
@@ -34,7 +25,6 @@ module Calabash
       include Calabash::Cucumber::UIA
       include Calabash::Cucumber::StatusBarHelpers
       include Calabash::Cucumber::RotationHelpers
-      include Calabash::Cucumber::PlaybackHelpers
 
       # @!visibility private
       # @deprecated Use Cucumber's step method (avoid this: using step is not considered best practice).
@@ -48,6 +38,46 @@ module Calabash
         end
       end
 
+      # Prints a blue warning message.
+      # @param [String] msg the message to print
+      # @return [void]
+      def calabash_warn(msg)
+        require "run_loop/logging"
+        RunLoop.log_warn(msg)
+      end
+
+      # Prints a green info message.
+      # @param [String] msg the message to print
+      # @return [void]
+      def calabash_info(msg)
+        require "run_loop/logging"
+        RunLoop.log_info2(msg)
+      end
+
+      # Prints a deprecated message that includes the line number.
+      #
+      # @param [String] version indicates when the feature was deprecated
+      # @param [String] msg deprecation message (possibly suggesting alternatives)
+      # @param [Symbol] type { :warn | :pending } - :pending will raise a
+      #   cucumber pending error
+      # @return [void]
+      def deprecated(version, msg, type)
+        allowed = [:pending, :warn]
+        unless allowed.include?(type)
+          raise ArgumentError, "Expected type '#{type}' to be one of #{allowed.join(", ")}"
+        end
+
+        stack = Kernel.caller(0, 6)[1..-1].join("\n")
+
+        msg = "deprecated '#{version}' - #{msg}\n#{stack}"
+
+        if type.eql?(:pending)
+          pending(msg)
+        else
+          calabash_warn(msg)
+        end
+      end
+
       # The core method for querying into the current visible view
       # of the app under test. The query method takes as first parameter
       # a String `:uiquery`. This string must follow the query syntax
@@ -146,16 +176,6 @@ module Calabash
         Calabash::Cucumber::VERSION
       end
 
-      # Queries all views in view hierarchy, even if not visible.
-      # @deprecated use the 'all' or 'visible' modifier in query syntax
-      def query_all(uiquery, *args)
-        msg0 = "use the 'all' or 'visible' query language feature"
-        msg1 = 'see: https://github.com/calabash/calabash-ios/wiki/05-Query-syntax'
-        msg = "#{msg0}\n#{msg1}"
-        _deprecated('0.9.133', msg, :warn)
-        map("all #{uiquery}", :query, *args)
-      end
-
       # Performs the `tap` gesture on the (first) view that matches
       # query `uiquery`. Note that `touch` assumes the view is visible and not animating.
       # If the view is not visible `touch` will fail. If the view is animating
@@ -746,15 +766,7 @@ details => '#{result["details"]}'
 
         raise 'Wheel index must be non negative' if wheel < 0
         raise "Only up and down supported :dir (#{dir})" unless [:up, :down].include?(dir)
-
-        if ENV['OS'] == 'ios4'
-          playback "wheel_#{dir}", :query => "#{q} pickerTable index:#{wheel}"
-        elsif ios7?
-          raise NotImplementedError
-        else
-          playback "wheel_#{dir}", :query => "#{q} pickerTableView index:#{wheel}"
-        end
-
+        raise NotImplementedError
       end
 
       # @!visibility private
@@ -939,9 +951,9 @@ arguments => '#{arguments}'
       # @return {Calabash::Cucumber::Launcher} the launcher object in use
       def start_test_server_in_background(args={})
         stop_test_server
-        @calabash_launcher = Calabash::Cucumber::Launcher.new()
-        @calabash_launcher.relaunch(args)
-        @calabash_launcher
+        launcher = Calabash::Cucumber::Launcher.new
+        launcher.relaunch(args)
+        launcher
       end
 
       # Helper method to easily create page object instances from a cucumber execution context.
@@ -1006,23 +1018,6 @@ arguments => '#{arguments}'
         tap_mark(label, *args)
       end
 
-      # taps a view with mark `hash_or_string`
-      # @deprecated In later Calabash versions we will change the semantics of `tap` to take a general query
-      #   (instead of a 'mark' now). We're deprecating this now to prepare people for a breaking change.
-      # @param {String} hash_or_string mark to pass to call `tap_mark(hash_or_string)`.
-      # @return {Array<Hash>} array containing the serialized version of the tapped view.
-      def tap(hash_or_string, *args)
-        deprecation_msg = 'Use tap_mark instead. In later Calabash versions we will change the semantics of `tap` to take a general query.'
-        _deprecated('0.10.0', deprecation_msg, :warn)
-        if hash_or_string.is_a?(String)
-          tap_mark(hash_or_string, *args)
-        elsif hash_or_string.respond_to?(:[])
-          wait_tap(hash_or_string[:query], hash_or_string)
-        else
-          raise(ArgumentError, "first parameter to tap must be a string or a hash. Was: #{hash_or_string.class}, #{hash_or_string}")
-        end
-      end
-
       # taps a view with mark `label`. Equivalent to `touch("* marked:'#{label}'")`
       # @param {String} label the mark of the view to tap
       # @param {Array} args optional additional arguments to pass to `touch`.
@@ -1038,38 +1033,48 @@ arguments => '#{arguments}'
         query(q).map { |e| e['html'] }
       end
 
-      # sets the text value of the views matched by +uiquery+ to +txt+
+      # Sets the text value of the views matched by +uiquery+ to +txt+.
       #
-      # @deprecated since 0.9.145
+      # You should always try to enter text "like the user would" using the
+      # `keyboard_enter_text` method.  There are cases, however, when this does
+      # not work or is very slow.
       #
-      # we have stopped testing this method.  you have been warned.
+      # Please note that if you use this method, the UITextFieldDelegate and
+      # UITextViewDelegate methods ***will not be called*** if you use this
+      # method of text entry.  This means that if you have UI elements that
+      # respond to text changes, they ***will not be updated***.
       #
-      # * to enter text using the native keyboard use 'keyboard_enter_text'
-      # * to delete text use 'keyboard_enter_text('Delete')"
-      # * to clear a text field or text view:
-      #   - RECOMMENDED: use queries and touches to replicate what the user would do
-      #     - for text fields, implement a clear text button and touch it
-      #     - for text views, use touches to reveal text editing popup
-      #       see https://github.com/calabash/calabash-ios/issues/151
-      #   - use 'clear_text'
-      #  https://github.com/calabash/calabash-ios/wiki/03.5-Calabash-iOS-Ruby-API
+      # UIAutomation's keyboard.typeString is incredibly buggy.  Calabash goes
+      # to great lengths to provide a stable typing interface.  However, there
+      # are cases where our patches cause problems.  If your app crashes or
+      # hangs when calling `keyboard_enter_text` there are a couple of options.
       #
-      # raises an error if the +uiquery+ finds no matching queries or finds
+      # 1. Try `fast_enter_text`.  This may or may not cause delegate methods
+      #    to be called (see the note above).
+      # 2. Call `keyboard.typeString` directly.  This will bypass the Calabash
+      #    fixes (which sometimes cause hanging and/or crashes).
+      #
+      # ```
+      # touch(" < touch a text field or text view > ")
+      # wait_for_keyboard
+      # uia("UIATarget.localTarget().frontMostApp().keyboard().typeString('your string')")
+      # ```
+      #
+      # Please be aware that keyboard.typeString is prone to errors.  We
+      # recommend using `keyboard_enter_text` or `fast_enter_text` whenever
+      # possible.
+      #
+      # One valid use of this method is on WebViews.  Find examples in the
+      # [CalWebApp features/steps/set_text_steps.rb](https://github.com/calabash/ios-webview-test-app/blob/master/CalWebViewApp/features/steps/set_text_steps.rb).
+      #
+      # @param [String] uiquery used to find the text input views
+      # @param [String] txt the new text
+      #
+      # @raise[RuntimeError] If the +uiquery+ finds no matching queries or finds
       # a view that does not respond to the objc selector 'setText'
+      #
+      # @return [Array<String>] The text fields that were modified.
       def set_text(uiquery, txt)
-        msgs = ["'set_text' is deprecated and its behavior is now unpredictable",
-                "* to enter text using the native keyboard use 'keyboard_enter_text'",
-                "* to delete text use 'keyboard_enter_text('Delete')",
-                '* to clear a text field or text view:',
-                '  - RECOMMENDED: use queries and touches to replicate what the user would do',
-                '    * for text fields, implement a clear text button and touch it',
-                '    * for text views, use touches to reveal text editing popup',
-                '    see https://github.com/calabash/calabash-ios/issues/151',
-                "  - use 'clear_text'",
-                'https://github.com/calabash/calabash-ios/wiki/03.5-Calabash-iOS-Ruby-API']
-        msg = msgs.join("\n")
-        _deprecated('0.9.145', msg, :warn)
-
         text_fields_modified = map(uiquery, :setText, txt)
 
         msg = "query '#{uiquery}' returned no matching views that respond to 'setText'"
@@ -1077,30 +1082,18 @@ arguments => '#{arguments}'
         text_fields_modified
       end
 
-      # sets the text value of the views matched by +uiquery+ to <tt>''</tt>
+      # Sets the text value of the views matched by +uiquery+ to <tt>''</tt>
       # (the empty string)
       #
-      # using this sparingly and with caution
-      #
-      #
-      # it is recommended that you instead do some combination of the following
-      #
-      # * use queries and touches to replicate with the user would
-      #   - for text fields, implement a clear text button and touch it
-      #   - for text views, use touches to reveal text editing popup
-      #   see https://github.com/calabash/calabash-ios/issues/151
-      #
-      #  https://github.com/calabash/calabash-ios/wiki/03.5-Calabash-iOS-Ruby-API
+      # Using this sparingly and with caution.  We recommend using queries and
+      # touches to replicate what the _user would do_.
       #
-      # raises an error if the +uiquery+ finds no matching queries or finds
-      # a _single_ view that does not respond to the objc selector 'setText'
+      # @param [String] uiquery used to find the text input views
       #
-      # IMPORTANT
-      # calling:
-      #
-      #     > clear_text("view")
+      # @raise[RuntimeError] If the +uiquery+ finds no matching queries or finds
+      # a view that does not respond to the objc selector 'setText'
       #
-      # will clear the text on _all_ visible views that respond to 'setText'
+      # @return [Array<String>] The text fields that were modified.
       def clear_text(uiquery)
         views_modified = map(uiquery, :setText, '')
         msg = "query '#{uiquery}' returned no matching views that respond to 'setText'"
@@ -1108,7 +1101,6 @@ arguments => '#{arguments}'
         views_modified
       end
 
-
       # Sets user preference (NSUserDefaults) value of key `key` to `val`.
       # @example
       #   set_user_pref 'foo', {lastname: "Krukow"}
@@ -1153,8 +1145,8 @@ arguments => '#{arguments}'
       # @!visibility private
       # @todo broken currently
       def stop_test_server
-        l = @calabash_launcher || Calabash::Cucumber::Launcher.launcher_if_used
-        l.stop if l
+        launcher = Calabash::Cucumber::Launcher.launcher_if_used
+        launcher.stop if launcher
       end
 
       # @!visibility private
@@ -1182,15 +1174,19 @@ arguments => '#{arguments}'
       #   when starting the console.
       # @return [Calabash::Cucumber::Launcher,nil] the currently active
       #  calabash launcher
+      #
+      # @raise [RuntimeError] This method is not available on the Xamarin Test
+      #  Cloud
       def console_attach(uia_strategy = nil)
-        # setting the @calabash_launcher here for backward compatibility
-        @calabash_launcher = launcher.attach({:uia_strategy => uia_strategy})
+        if Calabash::Cucumber::Environment.xtc?
+          raise "This method is not available on the Xamarin Test Cloud"
+        end
+        launcher.attach({:uia_strategy => uia_strategy})
       end
 
       # @!visibility private
       def launcher
-        # setting the @calabash_launcher here for backward compatibility
-        @calabash_launcher = Calabash::Cucumber::Launcher.launcher
+        Calabash::Cucumber::Launcher.launcher
       end
 
       # @!visibility private

data/lib/calabash-cucumber/device.rb

@@ -1,6 +1,3 @@
-require 'json'
-require 'calabash-cucumber/utils/logging'
-
 module Calabash
   module Cucumber
 
@@ -9,8 +6,6 @@ module Calabash
     # app that is running on the current device.
     class Device
 
-      include Calabash::Cucumber::Logging
-
       # @!visibility private
       GESTALT_IPHONE = 'iPhone'
 
@@ -166,44 +161,27 @@ module Calabash
           end
         end
 
-        # Deprecated 0.16.2 server
-        @system = version_data['system']
-
-        # 0.16.2 server adds 'device_family' key.
-        unless @device_family
-          # Deprecated 0.16.2 server
-          simulator_device = version_data['simulator_device']
-          if @system == GESTALT_SIM_SYS
-            @device_family = simulator_device
-          else
-            @device_family = @system.split(/[\d,.]/).first
-          end
-        end
-
         # 0.16.2 server adds 'ios_version' key
         unless @ios_version
           @ios_version = version_data['iOS_version']
         end
-
-        # Deprecated 0.13.0
-        @iphone_4in = version_data['4inch']
       end
 
       # Is this device a simulator or physical device?
       # @return [Boolean] true if this device is a simulator
       def simulator?
-        # Post 0.16.2 server
-        unless simulator_details.nil? || simulator_details.empty?
-          true
+        details = simulator_details
+        if details
+          details != ""
         else
-          system == GESTALT_SIM_SYS
+          false
         end
       end
 
       # Is this device a device or simulator?
       # @return [Boolean] true if this device is a physical device
       def device?
-        not simulator?
+        !simulator?
       end
 
       # Is this device an iPhone?
@@ -290,19 +268,6 @@ module Calabash
         ios_version_object.major == 5
       end
 
-      # @deprecated 0.11.2 Replaced with screen_dimensions.
-      #
-      # The screen size of the device.
-      #
-      # @return [Hash] representation of the screen size
-      def screen_size
-        _deprecated('0.11.2', 'Replaced with screen_dimensions', :warn)
-        return screen_dimensions if screen_dimensions
-        return { :width => 768, :height => 1024 } if ipad?
-        return { :width => 320, :height => 568 } if iphone_4in?
-        { :width => 320, :height => 480 }
-      end
-
       # Is the app that is running an iPhone-only app emulated on an iPad?
       #
       # @note If the app is running in emulation mode, there will be a 1x or 2x
@@ -314,84 +279,6 @@ module Calabash
         iphone_app_emulated_on_ipad
       end
 
-      # @deprecated 0.9.169 replaced with `server_version`
-      #
-      # @see #server_version
-      #
-      # The version of the embedded Calabash server running in the app under
-      # test on this device.
-      # @see #server_version
-      # @return [String] the version of the embedded Calabash server
-      def framework_version
-        _deprecated('0.9.169', "use 'server_version', instead", :warn)
-        @server_version
-      end
-
-      # @deprecated 0.10.0 no replacement
-      def udid
-        _deprecated('0.10.0', 'no replacement', :warn)
-        @udid
-      end
-
-      # @deprecated 0.10.0 no replacement
-      def udid=(value)
-        _deprecated('0.10.0', 'no replacement', :warn)
-        @udid = value
-      end
-
-      # @deprecated 0.9.168 replaced with iphone_4in?
-      #
-      # @see #iphone_4in?
-      #
-      # Is this device an iPhone 5?
-      # @note Deprecated because the iPhone 5S reports as an iPhone6,*.
-      # @return [Boolean] true if this device is an iPhone 5
-      def iphone_5?
-        _deprecated('0.9.168', "use 'iphone_4in?' instead", :warn)
-        iphone_4in?
-      end
-
-      # @deprecated 0.13.1 - Call `iphone_4in?` instead.
-      #
-      # @see #iphone_4in?
-      #
-      # @note Deprecated after introducing new `form_factor` behavior.
-      # @return [Boolean] true if this device is an iPhone 5 or 5s
-      def iphone_4in
-        _deprecated('0.13.1', "use 'iphone_4in?' instead", :warn)
-        @iphone_4in
-      end
-
-      # @deprecated 0.16.2 No replacement.
-      #
-      # @example
-      #  # simulator
-      #  i386
-      #  x86_64
-      #
-      # @example
-      #  # examples from physical devices
-      #  iPhone7,1
-      #  iPhone5,2
-      #
-      # @attribute [r] system
-      # @return [String] The model of this device.
-      #  this device.
-      attr_reader :system
-
-      # @deprecated 0.13.1 no replacement
-      #
-      # Indicates whether or not this device has a 4in screen.
-      # @attribute [r] iphone_4in
-      # @return [Boolean] `true` if this device has a 4in screen.
-      attr_reader :iphone_4in
-
-      # @deprecated 0.10.0 no replacement
-      #
-      # @!attribute [rw] udid
-      # @return [String] The udid of this device.
-      attr_accessor :udid
-
       private
 
       # @!visibility private