calabash 1.2.1 → 1.9.9.pre1

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

@@ -0,0 +1,17 @@
+module Calabash
+  module IOS
+    # @!visibility private
+    module StatusBarMixin
+
+      # Returns the home button position relative to the status bar.
+      #
+      # @note This method works even if a status bar is not visible.
+      #
+      # @return [String] Returns the device orientation as one of
+      #  `{'down' | 'up' | 'left' | 'right'}`.
+      def status_bar_orientation
+        map_route(nil, :orientation, :status_bar).first
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Calabash
+  module IOS
+    # @!visibility private
+    module TextMixin
+
+      def enter_text(text)
+        wait_for_keyboard(Calabash::Wait.default_options[:timeout])
+        existing_text = text_from_keyboard_first_responder
+        options = { existing_text: existing_text }
+        uia_type_string(text, options)
+      end
+
+      def _enter_text_in(query, text)
+        _tap(query)
+        enter_text(text)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+module Calabash
+  module IOS
+
+    # @!visibility private
+    module UIAKeyboardMixin
+
+      # @param [Hash] options Control behavior of this method.
+      # @option options [String] :existing_text ('') Text that exists in the
+      #  view before this method is called.  Passing this option ensures that
+      #  the existing text is _appended_ rather than cleared and helps the
+      #  underlying JavaScript handle various bugs in UIAutomation's
+      #  typeString JavaScript API.
+      # @option options [Boolean] :escape_backslashes (true) When try, this
+      #  method escapes '\'  characters in the `string` before sending the
+      #  string over UIA.  The only time you don't want to escape the '\'
+      #  character is when you are trying to send a single character like '\n'
+      #  or '\d'.
+      def uia_type_string(string, options={})
+        default_options =
+              {
+                    existing_text: '',
+                    escape_backslashes: true
+              }
+        merged_options = default_options.merge(options)
+
+        if merged_options[:escape_backslashes]
+          string_to_type = UIATypeStringHandler.escape_backslashes_in_string(string)
+        else
+          string_to_type = string.dup
+        end
+
+        existing_text = merged_options[:existing_text]
+
+        result = uia_serialize_and_call(:typeString, string_to_type, existing_text)
+
+        handler = uia_type_string_handler(string,
+                                          string_to_type,
+                                          existing_text,
+                                          result,
+                                          logger)
+        handler.handle_result
+      end
+
+      private
+
+      def uia_type_string_handler(string, escaped_string, existing_text, result, logger)
+        UIATypeStringHandler.new(string,
+                                 escaped_string,
+                                 existing_text,
+                                 result,
+                                 logger)
+      end
+
+      # @!visibility private
+      class UIATypeStringHandler
+
+        attr_reader :string, :escaped_string, :existing_text, :result, :logger
+
+        # The result returned should be a Hash.
+        #
+        # The result should have these keys.  The 'value' key may or may not
+        # exist.  The range of the 'value' key is not well understood; it varies
+        # depending on the context in which you are typing.
+        #
+        # :status => 'success' or 'error'
+        # :value => A hash of the view that was typed in, :nil', or nil.
+        # :index => This value is not important; ignore it.
+        def initialize(string, escaped_string, existing_text, result, logger)
+          @string = string
+          @escaped_string = escaped_string
+          @existing_text = existing_text
+          @result = result
+          @logger = logger
+        end
+
+        def self.escape_backslashes_in_string(string)
+          return string if string.index(/\\/)
+
+          escaped_string = string.dup
+
+          indexes = escaped_string.enum_for(:scan, /\\/).map { Regexp.last_match.begin(0) }
+          indexes.reverse.each { |idx| escaped_string = escaped_string.insert(idx, '\\') }
+
+          escaped_string
+        end
+
+        # Valid values: 'success' or 'error'
+        def status
+          result['status']
+        end
+
+        # A Hash of the view that was typed in or :nil.  Other values are
+        # possible, but we don't have an enumeration of the possible values.
+        def value
+          result['value']
+        end
+
+        def log(message)
+          logger.log(Color.blue(message), :info)
+        end
+
+        def log_preamble
+          log('When typing:')
+          log("   raw string: #{string}")
+          log("      escaped: #{escaped_string}")
+          log("existing text: #{existing_text}")
+        end
+
+        def log_epilogue
+          log("       result: #{result}")
+          log('')
+          log('Please report this!')
+          log('https://github.com/calabash/calabash-ios/issues/374')
+        end
+
+        def handle_result
+          the_status = status
+          if the_status == 'error'
+            handle_error
+          elsif the_status == 'success'
+            handle_success
+          elsif result.is_a? Hash
+            if ['label', 'hit-point', 'el', 'rect'].all? { |key| result.has_key?(key) }
+              result
+            else
+              handle_unknown_status
+            end
+          else
+            handle_unknown_status
+          end
+        end
+
+        def handle_error
+          log_preamble
+          if result.has_key? 'value'
+            raise "Could not type '#{string}' - UIAutomation returned an error: '#{result['error']}'"
+          else
+            raise "Could not type '#{string}' - UIAutomation returned '#{result}'"
+          end
+        end
+
+        # When 'status' == 'success', we can get a variety of valid 'values'
+        #
+        # For example, typing on UIWebViews returns['value'] => ':nil'.
+        #
+        # The expected value is a Hash representation of the view that was
+        # typed in.
+        #
+        # We are interested in loggin situations where:
+        #
+        # 1. The 'value' key is not present in the result.
+        # 2. The 'value' key has a nil value.
+        def handle_success
+          the_value = value
+          if the_value.is_a? Hash
+            the_value
+          elsif the_value == ':nil'
+            true
+          else
+            handle_success_with_incident
+          end
+        end
+
+        def handle_success_with_incident
+          log_preamble
+          if value.nil?
+            if result.has_key? 'value'
+              log("received a 'success' response with no key for 'value'")
+            else
+              log("received a 'success' response with a 'nil' for key 'value'")
+            end
+          else
+            log("received a 'success' response with an unknown value for key 'value' => '#{value}'")
+          end
+          log_epilogue
+          false
+        end
+
+        def handle_unknown_status
+          log_preamble
+          log("receive response with an unknown value for 'status' key: '#{status}'")
+          log_epilogue
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Calabash
+  module IOS
+
+    # !@visibility private
+    module UIAMixin
+
+      def evaluate_uia(script)
+        uia_route(script)
+      end
+    end
+  end
+end

data/lib/calabash/ios/environment.rb

@@ -0,0 +1,41 @@
+module Calabash
+  module IOS
+
+    # Constants that describe the iOS test environment.
+    class Environment < Calabash::Environment
+
+      # A URI that points to the embedded Calabash server in the app under test.
+      #
+      # The default value is 'http://localhost:37265'.
+      #
+      # You can control the value of this variable by setting the `CAL_ENDPOINT`
+      # variable.
+      #
+      # @todo Maybe rename this to CAL_SERVER_URL or CAL_SERVER?
+      DEVICE_ENDPOINT = URI.parse((variable('CAL_ENDPOINT') || 'http://localhost:37265'))
+
+      # The strategy use when interacting with UIAutomation.  Calabash iOS
+      # supports 3 strategies:
+      #
+      # 1. preferences: Fast, but only works on simulators and on devices < 8.0.
+      # 2. shared:  Fast, but has limited functionality.  For example, you
+      #             can't send apps to the background.
+      # 3. host: Slow, but the only option for devices >= 8.0.
+      #
+      # Calabash and run-loop will work together to figure out the fastest,
+      # most feature complete strategy to use at runtime.
+      #
+      # This is an advanced feature.  Don't set this variable unless you know
+      # what you are doing.
+      UIA_STRATEGY = lambda do
+        strategy = variable('CAL_UIA_STRATEGY')
+        if strategy
+          strategy.to_sym
+        else
+          nil
+        end
+      end.call
+    end
+  end
+end
+

data/lib/calabash/ios/interactions.rb

@@ -0,0 +1,10 @@
+module Calabash
+  module IOS
+    module Interactions
+      # @!visibility private
+      def _evaluate_javascript_in(query, javascript)
+        query(query, calabashStringByEvaluatingJavaScript: javascript)
+      end
+    end
+  end
+end

data/lib/calabash/ios/lib/.irbrc

@@ -0,0 +1,55 @@
+begin
+    require 'irb/completion'
+    require 'irb/ext/save-history'
+
+    begin
+        require 'awesome_print'
+    rescue LoadError => e
+        msg = ["Caught a LoadError: could not load 'awesome_print'",
+             "#{e}",
+             '',
+             'Use bundler (recommended) or uninstall awesome_print.',
+             '',
+             '# Use bundler (recommended)',
+             '$ bundle update',
+             '$ bundle exec calabash console [path to apk]',
+             '',
+             '# Uninstall',
+             '$ gem update --system',
+             '$ gem uninstall -Vax --force --no-abort-on-dependent awesome_print']
+        puts msg
+        exit(1)
+    end
+
+    AwesomePrint.irb!
+
+    ARGV.concat [ '--readline',
+                  '--prompt-mode',
+                  'simple']
+
+    # 50 entries in the list
+    IRB.conf[:SAVE_HISTORY] = 50
+
+    # Store results in home directory with specified file name
+    IRB.conf[:HISTORY_FILE] = '.irb-history'
+
+    require 'calabash/ios'
+
+    extend Calabash::IOS
+    extend Calabash::ConsoleHelpers
+
+    Calabash::Application.default = Calabash::IOS::Application.default_from_environment
+
+    identifier = Calabash::IOS::Device.default_identifier_for_application(Calabash::Application.default)
+    server = Calabash::IOS::Server.default
+
+    Calabash::Device.default = Calabash::IOS::Device.new(identifier, server)
+
+    Calabash.new_embed_method!(lambda {|*_| Calabash::Logger.info 'Embed is not available in the console.'})
+    Calabash::Screenshot.screenshot_directory_prefix = 'console_'
+rescue Exception => e
+    puts 'Unable to start console:'
+    puts "#{e.class}: #{e.message}"
+    puts "#{e.backtrace.join("\n")}"
+    exit(1)
+end

data/lib/calabash/ios/lib/recordings/rotate_left_home_down_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQDAAAAoFRUaW1lEwAAAbhNBUVUVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_down_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQDAAAAoFRUaW1lEwAAAbhNBUVUVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_left_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQBAAAAoFRUaW1lEwAAAbCIbyvaVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_left_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQBAAAAoFRUaW1lEwAAAbCIbyvaVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_right_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQCAAAAoFRUaW1lEwAAAbpMnOcWVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_right_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQCAAAAoFRUaW1lEwAAAbpMnOcWVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_up_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQEAAAAoFRUaW1lEwAAAa01e7C+VFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_left_home_up_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQEAAAAoFRUaW1lEwAAAa01e7C+VFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_down_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQEAAAAoFRUaW1lEwAAAaVlqJreVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_down_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQEAAAAoFRUaW1lEwAAAaVlqJreVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_left_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQCAAAAoFRUaW1lEwAAAaoeCDODVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_left_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQCAAAAoFRUaW1lEwAAAaoeCDODVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_right_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQBAAAAoFRUaW1lEwAAAcBXpQXHVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_right_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQBAAAAoFRUaW1lEwAAAcBXpQXHVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_up_ipad.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQDAAAAoFRUaW1lEwAAAbyCAvDjVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/lib/recordings/rotate_right_home_up_iphone.base64

@@ -0,0 +1,2 @@
+YnBsaXN0MDChAdMCBAYDBQdURGF0YUQDAAAAoFRUaW1lEwAAAbyCAvDjVFR5cGUQ
+MggKERYcISovAAAAAAAAAQEAAAAAAAAACAAAAAAAAAAAAAAAAAAAADE=

data/lib/calabash/ios/orientation.rb

@@ -0,0 +1,117 @@
+module Calabash
+  module IOS
+
+    # 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.
+    module Orientation
+
+      # Returns the home button position relative to the status bar.
+      #
+      # @note This method works even if a status bar is not visible.
+      #
+      # @return [String] Returns the device orientation as one of
+      #  `{'down' | 'up' | 'left' | 'right'}`.
+      def status_bar_orientation
+        Device.default.status_bar_orientation
+      end
+
+      # Rotates the device in the direction indicated by `direction`.
+      #
+      # @example
+      #  > rotate('left')
+      #  > rotate('right')
+      #
+      # @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
+
+        Device.default.rotate(direction.to_sym)
+        wait_for_animations
+        status_bar_orientation
+      end
+
+      # Rotates the home button to a position relative to the status bar.
+      #
+      # @example portrait
+      #  rotate_home_button_to 'down'
+      #  rotate_home_button_to 'bottom'
+      #
+      # @example upside down
+      #  rotate_home_button_to 'top'
+      #  rotate_home_button_to 'up'
+      #
+      # @example landscape with left home button AKA: _right_ landscape
+      #  rotate_home_button_to 'left'
+      #
+      # @example landscape with right home button AKA: _left_ landscape
+      #  rotate_home_button_to 'right'
+      #
+      # @note Refer to Apple's documentation for clarification about left vs.
+      #  right landscape orientations.
+      #
+      # @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.
+      #
+      # @raise [ArgumentError] If an invalid position 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_home_button_to(position)
+        valid_positions = ['down', 'bottom', 'top', 'up', 'left', 'right']
+        unless valid_positions.include?(position)
+          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'
+
+        Calabash::Device.default.rotate_home_button_to(canonical_position)
+      end
+
+      # @!visibility private
+      def _set_orientation_landscape
+        orientation = status_bar_orientation
+        return orientation if landscape?
+
+        rotate_home_button_to 'right'
+      end
+
+      # @!visibility private
+      def _set_orientation_portrait
+        orientation = status_bar_orientation
+        return orientation if portrait?
+
+        rotate_home_button_to 'down'
+      end
+
+      # @!visibility private
+      def _portrait?
+        orientation = status_bar_orientation
+        orientation.eql?('up') || orientation.eql?('down')
+      end
+
+      # @!visibility private
+      def _landscape?
+        orientation = status_bar_orientation
+        orientation.eql?('right') || orientation.eql?('left')
+      end
+    end
+  end
+end