calabash 1.9.9.pre3 → 2.0.0.prelegacy

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

@@ -3,6 +3,7 @@ module Calabash
     # @!visibility private
     module TextMixin
 
+      # @!visibility private
       def enter_text(text)
         wait_for_keyboard(Calabash::Wait.default_options[:timeout])
         existing_text = text_from_keyboard_first_responder
@@ -10,6 +11,7 @@ module Calabash
         uia_type_string(text, options)
       end
 
+      # @!visibility private
       def _enter_text_in(query, text)
         _tap(query)
         enter_text(text)

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

@@ -43,6 +43,7 @@ module Calabash
 
       private
 
+      # @!visibility private
       def uia_type_string_handler(string, escaped_string, existing_text, result, logger)
         UIATypeStringHandler.new(string,
                                  escaped_string,
@@ -73,6 +74,7 @@ module Calabash
           @logger = logger
         end
 
+        # @!visibility private
         def self.escape_backslashes_in_string(string)
           return string if string.index(/\\/)
 
@@ -95,10 +97,12 @@ module Calabash
           result['value']
         end
 
+        # @!visibility private
         def log(message)
           logger.log(Color.blue(message), :info)
         end
 
+        # @!visibility private
         def log_preamble
           log('When typing:')
           log("   raw string: #{string}")
@@ -106,6 +110,7 @@ module Calabash
           log("existing text: #{existing_text}")
         end
 
+        # @!visibility private
         def log_epilogue
           log("       result: #{result}")
           log('')
@@ -113,6 +118,7 @@ module Calabash
           log('https://github.com/calabash/calabash-ios/issues/374')
         end
 
+        # @!visibility private
         def handle_result
           the_status = status
           if the_status == 'error'
@@ -130,6 +136,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def handle_error
           log_preamble
           if result.has_key? 'value'
@@ -161,6 +168,7 @@ module Calabash
           end
         end
 
+        # @!visibility private
         def handle_success_with_incident
           log_preamble
           if value.nil?
@@ -176,6 +184,7 @@ module Calabash
           false
         end
 
+        # @!visibility private
         def handle_unknown_status
           log_preamble
           log("receive response with an unknown value for 'status' key: '#{status}'")

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

@@ -4,6 +4,7 @@ module Calabash
     # @!visibility private
     module UIAMixin
 
+      # @!visibility private
       def evaluate_uia(script)
         uia_route(script)
       end

data/lib/calabash/ios/gestures.rb

@@ -4,6 +4,7 @@ module Calabash
     # @!visibility private
     module Gestures
 
+      # @!visibility private
       # Concrete implementation of pan_screen_up gesture.
       def _pan_screen_up(options={})
 
@@ -11,8 +12,8 @@ module Calabash
         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
+        points_from_top = gesture_points_from_top
+        points_from_bottom = gesture_points_from_bottom
 
         top_view = query('*').first
 
@@ -29,6 +30,7 @@ module Calabash
         Device.default.pan_screen(top_view, from_offset, to_offset, gesture_options)
       end
 
+      # @!visibility private
       # Concrete implementation of pan_screen_down gesture.
       def _pan_screen_down(options={})
 
@@ -36,8 +38,8 @@ module Calabash
         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
+        points_from_top = gesture_points_from_top
+        points_from_bottom = gesture_points_from_bottom
 
         top_view = query('*').first
 
@@ -54,10 +56,82 @@ module Calabash
         Device.default.pan_screen(top_view, from_offset, to_offset, gesture_options)
       end
 
+      # @!visibility private
+      # Concrete implementation of flick_screen_up gesture.
+      def _flick_screen_up(options={})
+
+        gesture_options = options.dup
+        gesture_options[:duration] ||= 0.5
+        gesture_options[:timeout] ||= Calabash::Gestures::DEFAULT_GESTURE_WAIT_TIMEOUT
+
+        points_from_top = gesture_points_from_top
+        points_from_bottom = gesture_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.flick_screen(top_view, from_offset, to_offset, gesture_options)
+      end
+
+      # @!visibility private
+      # Concrete implementation of flick_screen_down gesture.
+      def _flick_screen_down(options={})
+
+        gesture_options = options.dup
+        gesture_options[:duration] ||= 0.5
+        gesture_options[:timeout] ||= Calabash::Gestures::DEFAULT_GESTURE_WAIT_TIMEOUT
+
+        points_from_top = gesture_points_from_top
+        points_from_bottom = gesture_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.flick_screen(top_view, from_offset, to_offset, gesture_options)
+      end
+
+      # @!visibility private
+      # Concrete implementation of pinch_screen
+      def _pinch_screen(direction, options={})
+        Device.default.pinch(direction, '*', options)
+      end
+
+      # @!visibility private
+      # Concrete implementation of pinch_to_zoom
+      def _pinch_to_zoom(direction, query, options={})
+        gesture_direction = direction == :in ? :out : :in
+        Device.default.pinch(gesture_direction, query, options)
+      end
+
+      # @!visibility private
+      # Concrete implementation of pinch_screen_to_zoom
+      def _pinch_screen_to_zoom(direction, options={})
+        gesture_direction = direction == :in ? :out : :in
+        Device.default.pinch(gesture_direction, '*', options)
+      end
+
       private
 
-      # Number of points from the top to start a full-screen vertical pan.
-      def pan_points_from_top
+      # Number of points from the top to start a full-screen vertical gesture.
+      def gesture_points_from_top
         # 20 pixels for status bar in portrait; status bar is usually missing
         # in landscape @todo route for status bar height
 
@@ -79,8 +153,8 @@ module Calabash
         points_from_top
       end
 
-      # Number of points from the bottom to start a full-screen vertical pan.
-      def pan_points_from_bottom
+      # Number of points from the bottom to start a full-screen vertical gesture.
+      def gesture_points_from_bottom
         # Dragging from the bottom will lift the transport controls.
         points_from_bottom = 10
 

data/lib/calabash/ios/interactions.rb

@@ -1,7 +1,36 @@
 module Calabash
   module IOS
-    # @!visibility private
+
+    # Interactions with your app that are specific to iOS
     module Interactions
+
+      # @!visibility private
+      # Sends app to background. Simulates pressing the home button.
+      #
+      # @note Cannot be more than 60 seconds.
+      #
+      # @param [Numeric] seconds The number of seconds to keep the app
+      #   in the background
+      # @raise [ArgumentError] If number of seconds is less than 1 and more
+      #   than 60 seconds.
+      def _send_current_app_to_background(seconds)
+        unless (1..60).member?(seconds)
+          raise ArgumentError,
+            "Number of seconds: '#{seconds}' must be between 1 and 60"
+        end
+
+        javascript = %Q(
+          var x = target.deactivateAppForDuration(#{seconds});
+          var MAX_RETRY=5, retry_count = 0;
+          while (!x && retry_count < MAX_RETRY) {
+            x = target.deactivateAppForDuration(#{seconds});
+            retry_count += 1
+          };
+          x
+        )
+        uia(javascript)
+      end
+
       # @!visibility private
       def _evaluate_javascript_in(query, javascript)
         query(query, calabashStringByEvaluatingJavaScript: javascript)

data/lib/calabash/ios/orientation.rb

@@ -4,7 +4,6 @@ module Calabash
     # On iOS, the presenting view controller must respond to rotation events.
     # If the presenting view controller does not respond to rotation events,
     # then no rotation will be performed.
-    # @!visibility private
     module Orientation
 
       # Returns the home button position relative to the status bar.
@@ -17,30 +16,31 @@ module Calabash
         Device.default.status_bar_orientation
       end
 
-      # Rotates the device in the direction indicated by `direction`.
-      #
-      # @example
-      #  > rotate('left')
-      #  > rotate('right')
+      # Rotate the device left - clockwise relative to the home button.
       #
       # @note
       #   The presenting view controller must respond to rotation events.
       #   If the presenting view controller does not respond to rotation events,
       #   then no rotation will be performed.
       #
-      # @param [String] direction The direction in which to rotate.
-      #  Valid arguments are :left and :right
-      #
-      # @raise [ArgumentError] If an invalid direction is given.
       # @return [String] The position of the home button relative to the status
       #  bar after the rotation. Can be one of 'down', 'left', 'right', 'up'.
-      def rotate(direction)
-        unless direction == 'left' || direction == 'right'
-          raise ArgumentError, "Expected '#{direction}' to be 'left' or 'right'"
-        end
+      def rotate_device_left
+        Device.default.rotate(:left)
+        status_bar_orientation
+      end
 
-        Device.default.rotate(direction.to_sym)
-        wait_for_animations
+      # Rotate the device right - counterclockwise relative to the home button.
+      #
+      # @note
+      #   The presenting view controller must respond to rotation events.
+      #   If the presenting view controller does not respond to rotation events,
+      #   then no rotation will be performed.
+      #
+      # @return [String] The position of the home button relative to the status
+      #  bar after the rotation. Can be one of 'down', 'left', 'right', 'up'.
+      def rotate_device_right
+        Device.default.rotate(:right)
         status_bar_orientation
       end
 
@@ -73,15 +73,15 @@ module Calabash
       # @return [String] The position of the home button relative to the status
       #  bar after the rotation. Can be one of 'down', 'left', 'right', 'up'.
       def rotate_home_button_to(position)
-        valid_positions = ['down', 'bottom', 'top', 'up', 'left', 'right']
-        unless valid_positions.include?(position)
+        valid_positions = [:down, :bottom, :top, :up, :left, :right]
+        unless valid_positions.include?(position.to_sym)
           raise ArgumentError,
                 "Expected '#{position}' to be one of #{valid_positions.join(', ')}"
         end
 
-        canonical_position = position
-        canonical_position = 'down' if position == 'bottom'
-        canonical_position = 'up' if position == 'top'
+        canonical_position = position.to_sym
+        canonical_position = :down if position.to_sym == :bottom
+        canonical_position = :up if position.to_sym == :top
 
         Calabash::Device.default.rotate_home_button_to(canonical_position)
       end

data/lib/calabash/ios/runtime.rb

@@ -1,16 +1,168 @@
 module Calabash
   module IOS
-    # @!visibility private
+
+    # Methods that describe the runtime attributes of the device under test.
+    #
+    # @note The key/value pairs in the Hash returned by #runtime_details are
+    #  not stable and can change at any time.  Don't write tests that rely on
+    #  specific keys or values in this Hash.  Instead, use the API methods
+    #  defined in this class.
     module Runtime
 
-      # @todo Complete and document the Runtime API
+      # Is the device under test a simulator?
       def simulator?
         Calabash::IOS::Device.default.simulator?
       end
 
+      # Is the device under test a physical device?
       def physical_device?
         Calabash::IOS::Device.default.physical_device?
       end
+
+      # Is the device under test an iPad?
+      def ipad?
+        Calabash::IOS::Device.default.device_family == 'iPad'
+      end
+
+      # Is the device under test an iPhone?
+      def iphone?
+        Calabash::IOS::Device.default.device_family == 'iPhone'
+      end
+
+      # Is the device under test an iPod?
+      def ipod?
+        Calabash::IOS::Device.default.device_family == 'iPod'
+      end
+
+      # Is the device under test an iPhone or iPod?
+      def device_family_iphone?
+        iphone? or ipod?
+      end
+
+      # Is the app that is being tested an iPhone app emulated on an iPad?
+      #
+      # An iPhone only app running on an iPad will be displayed in an emulated
+      # mode.  Starting in iOS 7, such apps will always be launched in 2x mode.
+      def iphone_app_emulated_on_ipad?
+        Calabash::IOS::Device.default.iphone_app_emulated_on_ipad?
+      end
+
+      # Is the device under test have a 4 inch screen?
+      def iphone_4in?
+        Calabash::IOS::Device.default.form_factor == 'iphone 4in'
+      end
+
+      # Is the device under test an iPhone 6.
+      def iphone_6?
+        Calabash::IOS::Device.default.form_factor == 'iphone 6'
+      end
+
+      # Is the device under test an iPhone 6+?
+      def iphone_6_plus?
+        Calabash::IOS::Device.default.form_factor == 'iphone 6 +'
+      end
+
+      # Is the device under test an iPhone 3.5in?
+      #
+      # @note If the app under test is an iPhone app emulated on an iPad then
+      #  the form factor will _always_ be 'iphone 3.5.in'.  If you need to
+      #  branch on the actual device the app is running on, use the #ipad?
+      #  method.
+      #
+      # @see #iphone_app_emulated_on_ipad?
+      # @see #ipad?
+      def iphone_35in?
+        Calabash::IOS::Device.default.form_factor == 'iphone 3.5in'
+      end
+
+      # The screen dimensions and details about scale and sample rates.
+      #
+      # @example
+      #  > app_screen_details
+      #  => {
+      #        :height => 1,
+      #        :height => 1334,
+      #        :width => 750,
+      #        :scale => 2
+      #      }
+      #
+      # @return [Hash] See the example.
+      def app_screen_details
+        Calabash::IOS::Device.default.screen_dimensions
+      end
+
+      # The version of iOS running on the test device.
+      #
+      # @example
+      #  > ios_version.major
+      #  > ios_version.minor
+      #  > ios_version.patch
+      #
+      # @return [RunLoop::Version] A version object.
+      def ios_version
+        Calabash::IOS::Device.default.ios_version
+      end
+
+      # Is the device under test running iOS 6?
+      def ios6?
+        ios_version.major == 6
+      end
+
+      # Is the device under test running iOS 7?
+      def ios7?
+        ios_version.major == 7
+      end
+
+      # Is the device under test running iOS 8?
+      def ios8?
+        ios_version.major == 8
+      end
+
+      # Is the device under test running iOS 9?
+      def ios9?
+        ios_version.major == 9
+      end
+
+      # The version of the Calabash iOS Server running in the app.
+      #
+      # @example
+      #  > server_version.major
+      #  > server_version.minor
+      #  > server_version.patch
+      #
+      # @return [RunLoop::Version] A version object.
+      def server_version
+        Calabash::IOS::Device.default.server_version
+      end
+
+      # Details about the version of the app under test.
+      #
+      # Will always contain these two keys:
+      #
+      #  * :bundle_version => CFBundleVersion
+      #  * :short_version => CFBundleShortVersionString
+      #
+      # It may contain other key/value pairs.
+      #
+      # @return [Hash] Key/value pairs that describe the version of the app
+      #  under test.
+      def app_version_details
+        hash = runtime_details
+        {
+              :bundle_version => hash['app_version'],
+              :short_version => hash['short_version_string']
+        }
+      end
+
+      # A hash of all the details about the runtime environment.
+      #
+      # @note The key/value pairs in this Hash are subject to change.  Don't
+      #  write tests that rely on a specific key appearing in the Hash.  Use
+      #  the methods in the {Calabash::IOS::Runtime} module instead.
+      # @return[Hash] Key/value pairs that describe the runtime environment.
+      def runtime_details
+        Calabash::IOS::Device.default.runtime_details
+      end
     end
   end
 end