calabash 1.9.9.pre2 → 1.9.9.pre3

data/lib/calabash/gestures.rb

@@ -113,9 +113,9 @@ module Calabash
     # @see Calabash::IOS::Scroll#scroll_to_item_with_mark
     #
     # @param [String] query A query describing the view to pan inside.
-    # @param [Hash] from ({:x, :y}) The point at which the gesture
+    # @param [Hash] from `({:x, :y})` The point at which the gesture
     #   originates from.
-    # @param [Hash] to ({:x, :y}) The point at which the gesture
+    # @param [Hash] to `({:x, :y})` The point at which the gesture
     #   ends.
     #
     # @param [Hash] options Options for modifying the details of the pan.
@@ -239,13 +239,13 @@ module Calabash
     #
     # @param [String,Hash,Query] query A query describing the view to flick
     #  inside of.
-    # @param [Hash] from ({:x, :y}) The point at which the gesture
+    # @param [Hash] from `({:x, :y})` The point at which the gesture
     #   originates from.
-    # @param [Hash] to ({:x, :y}) The point at which the gesture
+    # @param [Hash] to `({:x, :y})` The point at which the gesture
     #   ends.
     #
     # @param [Hash] options Options for controlling the flick.
-    # @options options [Numeric] :duration The duration of the flick. On iOS,
+    # @option options [Numeric] :duration The duration of the flick. On iOS,
     #   the duration must be between 0.5 and 60.
     #
     # @raise [ViewNotFoundError] If the `query` returns no results.
@@ -346,37 +346,37 @@ module Calabash
       _pinch_screen_to_zoom(:out, options)
     end
 
-    # !@visibility private
+    # @!visibility private
     def _pan_screen_up(options={})
       abstract_method!
     end
 
-    # !@visibility private
+    # @!visibility private
     def _pan_screen_down(options={})
       abstract_method!
     end
 
-    # !@visibility private
+    # @!visibility private
     def _flick_screen_up(options={})
       abstract_method!
     end
 
-    # !@visibility private
+    # @!visibility private
     def _flick_screen_down(options={})
       abstract_method!
     end
 
-    # !@visibility private
+    # @!visibility private
     def _pinch_screen(direction, options={})
       abstract_method!
     end
 
-    # !@visibility private
+    # @!visibility private
     def _pinch_to_zoom(direction, query, options={})
       abstract_method!
     end
 
-    # !@visibility private
+    # @!visibility private
     def _pinch_screen_to_zoom(direction, options={})
       abstract_method!
     end

data/lib/calabash/http/request.rb

@@ -3,6 +3,7 @@ module Calabash
 
     # A representation of an HTTP request that can be passed passed to the HTTP
     # client as an argument for `get` or `post`.
+    # @!visibility private
     class Request
       attr_reader :route, :params
 

data/lib/calabash/http/retriable_client.rb

@@ -4,6 +4,7 @@ module Calabash
   module HTTP
 
     # An HTTP client that retries its connection on errors and can time out.
+    # @!visibility private
     class RetriableClient
       attr_reader :client
 

data/lib/calabash/interactions.rb

@@ -1,4 +1,5 @@
 module Calabash
+  # @!visibility private
   module Interactions
     # @todo Needs docs!
     def query(query, *args)
@@ -89,7 +90,7 @@ module Calabash
     #   backdoor('calabashBackdoor', 'first argument', 2)
     #
     # @param [String] name The selector/method name.
-    # @param [Object] *arguments A comma separated list of arguments to be
+    # @param [Object] arguments A comma separated list of arguments to be
     #  passed to the backdoor selector/method.
     # @return [Object] the result of performing the selector/method with the
     #  arguments (serialized)

data/lib/calabash/ios.rb

@@ -29,6 +29,7 @@ module Calabash
     require 'calabash/ios/uia'
     require 'calabash/ios/scroll'
     require 'calabash/ios/runtime'
+    require 'calabash/ios/gestures'
 
     include Calabash::IOS::Conditions
     include Calabash::IOS::Orientation
@@ -37,6 +38,7 @@ module Calabash
     include Calabash::IOS::UIA
     include Calabash::IOS::Scroll
     include Calabash::IOS::Runtime
+    include Calabash::IOS::Gestures
 
   end
 end

data/lib/calabash/ios/conditions.rb

@@ -1,5 +1,6 @@
 module Calabash
   module IOS
+    # @!visibility private
     module Conditions
 
       # Waits for all elements to stop animating.

data/lib/calabash/ios/console_helpers.rb

@@ -1,4 +1,5 @@
 module Calabash
+  # @!visibility private
   module ConsoleHelpers
     def self.render(data, indentation)
       if visible?(data)

data/lib/calabash/ios/defaults.rb

@@ -1,27 +1,42 @@
 module Calabash
   module IOS
-    def self.setup_defaults!
-      setup_default_application!
-      setup_default_device!
-    end
-
-    def self.setup_default_device!
-      if Calabash.default_application.nil?
-        raise 'Cannot setup default device for iOS, as no default Application has been set'
+    module Defaults
+      # Sets up the default application based on the
+      # environment, and the default device based on the default application
+      # and the environment.
+      #
+      # @see Calabash::IOS::Defaults#setup_default_application!
+      # @see Calabash::IOS::Defaults#setup_default_device!
+      # @see Calabash::Environment
+      def setup_defaults!
+        setup_default_application!
+        setup_default_device!
       end
 
-      # Setup the default device
-      identifier =
-          Device.default_identifier_for_application(Calabash.default_application)
+      # Sets up the default device based on the default application and the
+      # environment.
+      #
+      # @raise [RuntimeError] Raises an error if the default application has
+      #  not been set.
+      def setup_default_device!
+        if Calabash.default_application.nil?
+          raise 'Cannot setup default device for iOS, as no default Application has been set'
+        end
 
-      server = Server.default
+        # Setup the default device
+        identifier =
+            Device.default_identifier_for_application(Calabash.default_application)
 
-      Calabash.default_device = Device.new(identifier, server)
-    end
+        server = Server.default
 
-    def self.setup_default_application!
-      # Setup the default application
-      Calabash.default_application = Application.default_from_environment
+        Calabash.default_device = Device.new(identifier, server)
+      end
+
+      # Sets up the default application based on the environment.
+      def setup_default_application!
+        # Setup the default application
+        Calabash.default_application = Application.default_from_environment
+      end
     end
   end
 end

data/lib/calabash/ios/device/device_implementation.rb

@@ -2,6 +2,7 @@ module Calabash
   module IOS
 
     # An iOS Device is an iOS Simulator or physical device.
+    # @!visibility private
     class Device < ::Calabash::Device
 
       include Calabash::IOS::PhysicalDeviceMixin
@@ -467,7 +468,10 @@ module Calabash
             if installed_app.same_sha1_as?(application)
               true
             else
-              @logger.log("The sha1 checksum has changed (#{installed_app.sha1} != #{application.sha1}.", :info)
+              @logger.log("The installed app and the target app are different.", :info)
+              @logger.log("   The target app has SHA: #{application.sha1}", :info)
+              @logger.log("The installed app has SHA: #{installed_app.sha1}", :info)
+              @logger.log("Installing the target app.", :info)
               install_app_on_simulator(application, @run_loop_device, bridge)
             end
           else

data/lib/calabash/ios/device/gestures_mixin.rb

@@ -88,22 +88,25 @@ module Calabash
         begin
           _expect_valid_duration(options)
         rescue ArgumentError => e
-          raise ArgumentError e
+          raise ArgumentError, e
         end
 
         gesture_waiter = _gesture_waiter
         view_to_pan = gesture_waiter.wait_for_view(query, options)
 
-        if Device.default.simulator?
-
+        # * will never match a UIScrollView or subclass.
+        if Device.default.simulator? && query.to_s != '*'
           should_raise = false
 
           content_offset = gesture_waiter.query(query, :contentOffset).first
-
           if content_offset != '*****'
             # Panning on anything with a content offset is broken.
             should_raise = true
+          elsif view_to_pan['class'][/TableViewCell/, 0]
+            should_raise = true
           else
+            new_query = "#{query} parent UITableViewCell"
+            should_raise = !gesture_waiter.query(new_query).empty?
             # TODO: Identify other conditions
             # TODO: Can we detect UITableViewCells?
             # The gist is that if the view is a UIScrollView or in a UIScrollView
@@ -112,9 +115,20 @@ module Calabash
 
           if should_raise
             message = [
+                  '',
                   "Apple's public UIAutomation API `dragInsideWithOptions` is broken for iOS Simulators >= 7",
-                  'Try using the scroll_* methods or test on a device.'
-            ].join("\n")
+                  '',
+                  'If you are trying to swipe-to-delete on a simulator, it will only work on a device.',
+                  '',
+                  'If you are trying to manipulate a table, collection or scroll view, try using the Scroll API.',
+                  '  * scroll                    # Scroll in a direction.',
+                  '  * scroll_to_row             # Scroll to a row with row / section indexes.',
+                  '  * scroll_to_row_with_mark   # Scroll to table row with a mark.',
+                  '  * scroll_to_item            # Scroll to collection item with item / section indexes.',
+                  '  * scroll_to_item_with_mark  # Scroll to collection item with a mark.',
+                  '',
+                  'All gestures work on physical devices.'
+            ].map { |msg| Color.red(msg) }.join("\n")
             raise message
           end
         end
@@ -134,9 +148,15 @@ module Calabash
         Calabash::QueryResult.create([view_to_pan], query)
       end
 
+      def pan_screen(view_to_pan, from_offset, to_offset, options)
+        uia_serialize_and_call(:panOffset, from_offset, to_offset, options)
+
+        Calabash::QueryResult.create([view_to_pan], '*')
+      end
+
       private
 
-      # !@visibility private
+      # @!visibility private
       #
       # Unlike the Calabash Android server, the iOS server does not wait
       # before gestures, so the client must do the waiting.  The _gesture_waiter

data/lib/calabash/ios/device/rotation_mixin.rb

@@ -1,7 +1,7 @@
 module Calabash
   module IOS
 
-    # !@visibility private
+    # @!visibility private
     module RotationMixin
 
       def rotate(direction)
@@ -58,7 +58,7 @@ module Calabash
         playback_route(recording_name, form_factor)
       end
 
-      # !@visibility private
+      # @!visibility private
       # Caller must pass position one of these positions down, left, right, up
       def rotate_home_button_to(position)
 

data/lib/calabash/ios/device/routes/error.rb

@@ -1,6 +1,7 @@
 module Calabash
   module IOS
 
+    # @!visibility private
     # Raised when there is a problem handling an HTTP route.
     class RouteError < StandardError; end
 

data/lib/calabash/ios/device/routes/playback_route_mixin.rb

@@ -2,7 +2,7 @@ module Calabash
   module IOS
     module Routes
 
-      # !@visibility private
+      # @!visibility private
       module PlaybackRouteMixin
 
         # This is a Legacy API and is only used to support rotations.

data/lib/calabash/ios/device/routes/uia_route_mixin.rb

@@ -25,7 +25,7 @@ module Calabash
               logger.log('', :info)
               logger.log(Color.cyan('> console_attach                # Attaches with the default strategy.'),
                          :info)
-              logger.log(Color.cyan('> console_attach(uia_strategy) # Attaches with a specific strategy.'),
+              logger.log(Color.cyan('> console_attach(uia_strategy)  # Attaches with a specific strategy.'),
                          :info)
               logger.log('', :info)
               logger.log('', :info)

data/lib/calabash/ios/device/uia_mixin.rb

@@ -1,7 +1,7 @@
 module Calabash
   module IOS
 
-    # !@visibility private
+    # @!visibility private
     module UIAMixin
 
       def evaluate_uia(script)

data/lib/calabash/ios/gestures.rb

@@ -0,0 +1,107 @@
+module Calabash
+  module IOS
+
+    # @!visibility private
+    module Gestures
+
+      # Concrete implementation of pan_screen_up gesture.
+      def _pan_screen_up(options={})
+
+        gesture_options = options.dup
+        gesture_options[:duration] ||= 0.5
+        gesture_options[:timeout] ||= Calabash::Gestures::DEFAULT_GESTURE_WAIT_TIMEOUT
+
+        points_from_top = pan_points_from_top
+        points_from_bottom = pan_points_from_bottom
+
+        top_view = query('*').first
+
+        height = top_view['frame']['height'].to_f
+        width = top_view['frame']['width'].to_f
+
+        start_y = height - points_from_bottom
+        end_y = points_from_top
+        x = width/2.0
+
+        from_offset = coordinate(x, start_y)
+        to_offset = coordinate(x, end_y)
+
+        Device.default.pan_screen(top_view, from_offset, to_offset, gesture_options)
+      end
+
+      # Concrete implementation of pan_screen_down gesture.
+      def _pan_screen_down(options={})
+
+        gesture_options = options.dup
+        gesture_options[:duration] ||= 0.5
+        gesture_options[:timeout] ||= Calabash::Gestures::DEFAULT_GESTURE_WAIT_TIMEOUT
+
+        points_from_top = pan_points_from_top
+        points_from_bottom = pan_points_from_bottom
+
+        top_view = query('*').first
+
+        height = top_view['frame']['height'].to_f
+        width = top_view['frame']['width'].to_f
+
+        start_y = points_from_top
+        end_y = height - points_from_bottom
+        x = width/2.0
+
+        from_offset = coordinate(x, start_y)
+        to_offset = coordinate(x, end_y)
+
+        Device.default.pan_screen(top_view, from_offset, to_offset, gesture_options)
+      end
+
+      private
+
+      # Number of points from the top to start a full-screen vertical pan.
+      def pan_points_from_top
+        # 20 pixels for status bar in portrait; status bar is usually missing
+        # in landscape @todo route for status bar height
+
+        # Swiping from top will pull down the notification center.
+        # Touching the status bar can cause table views to scroll to the top.
+        orientation = status_bar_orientation
+        if orientation == 'down' || orientation == 'up'
+          points_from_top = 20
+        else
+          points_from_top = 10
+        end
+
+        # Navigation bar will intercept touches.
+        result = query('UINavigationBar')
+        if !result.empty?
+          navbar = result.first
+          points_from_top = points_from_top + navbar['frame']['height'] + 10
+        end
+        points_from_top
+      end
+
+      # Number of points from the bottom to start a full-screen vertical pan.
+      def pan_points_from_bottom
+        # Dragging from the bottom will lift the transport controls.
+        points_from_bottom = 10
+
+        # Tab bar will intercept touches _and_ its hit box is larger than its
+        # visible rect!
+        result = query('UITabBar')
+        if !result.empty?
+          tabbar = result.first
+          points_from_bottom = points_from_bottom + tabbar['frame']['height']
+        end
+
+        # @todo toolbars might not be anchored to the bottom of the screen
+
+        # Toolbars will intercept touches.
+        result = query('UIToolBar')
+        if !result.empty?
+          toolbar = result.first
+          points_from_bottom = points_from_bottom + toolbar['frame']['height']
+        end
+        points_from_bottom
+      end
+    end
+  end
+end