calabash 2.0.0.pre11 → 2.0.0.prelegacy

data/lib/calabash/ios/text.rb

@@ -3,21 +3,21 @@ module Calabash
     # Methods for entering text and interacting with iOS keyboards.
     module Text
       # @!visibility private
-      define_method(:_enter_text) do |text|
+      def _enter_text(text)
         wait_for_keyboard
         existing_text = text_from_keyboard_first_responder
         options = { existing_text: existing_text }
-        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.enter_text(text, options)}
+        Device.default.uia_type_string(text, options)
       end
 
       # @!visibility private
-      define_method(:_enter_text_in) do |view, text|
+      def _enter_text_in(view, text)
         tap(view)
         enter_text(text)
       end
 
       # @!visibility private
-      define_method(:_clear_text) do
+      def _clear_text
         unless view_exists?("* isFirstResponder:1")
           raise 'Cannot clear text. No view has focus'
         end
@@ -26,7 +26,7 @@ module Calabash
       end
 
       # @!visibility private
-      define_method(:_clear_text_in) do |view|
+      def _clear_text_in(view)
         unless keyboard_visible?
           tap(view)
           wait_for_keyboard
@@ -35,7 +35,6 @@ module Calabash
         unless wait_for_view(view)['text'].empty?
           tap(view)
           tap("UICalloutBarButton marked:'Select All'")
-          sleep 0.5
           tap_keyboard_delete_key
         end
 
@@ -50,7 +49,7 @@ module Calabash
       #
       # @return [Boolean] Returns true if a keyboard is visible and docked.
       def docked_keyboard_visible?
-        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.docked_keyboard_visible?}
+        Device.default.docked_keyboard_visible?
       end
 
       # Returns true if an undocked keyboard is visible.
@@ -60,7 +59,7 @@ module Calabash
       # @return [Boolean] Returns false if the device is not an iPad; all
       # keyboards on the iPhone and iPod are docked.
       def undocked_keyboard_visible?
-        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.undocked_keyboard_visible?}
+        Device.default.undocked_keyboard_visible?
       end
 
       # Returns true if a split keyboard is visible.
@@ -71,7 +70,7 @@ module Calabash
       # @return [Boolean] Returns false if the device is not an iPad; all
       # keyboards on the Phone and iPod are docked and not split.
       def split_keyboard_visible?
-        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.split_keyboard_visible?}
+        Device.default.split_keyboard_visible?
       end
 
       # Touches the keyboard action key.
@@ -91,29 +90,86 @@ module Calabash
       # @todo Refactor uia_route to a public API call
       # @todo Move this documentation to the public method
       # @!visibility private
-      define_method(:_tap_keyboard_action_key) do |action_key|
+      def _tap_keyboard_action_key(action_key)
         unless action_key.nil?
           raise ArgumentError,
                 "An iOS keyboard does not have multiple action keys"
         end
 
-        wait_for_keyboard
-        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.tap_keyboard_action_key}
+        char_sequence = ESCAPED_KEYBOARD_CHARACTERS[:action]
+        Device.default.uia_route("uia.keyboard().typeString('#{char_sequence}')")
       end
 
       # @!visibility private
-      define_method(:_keyboard_visible?) do
+      def _keyboard_visible?
         docked_keyboard_visible? || undocked_keyboard_visible? || split_keyboard_visible?
       end
 
       # Touches the keyboard delete key.
+      #
+      # The 'delete' key difficult to find and touch because its behavior
+      # changes depending on the iOS version and keyboard type.  Consider the
+      # following:
+      #
+      # On iOS 6, the 'delete' char code is _not_ \b.
+      # On iOS 7: The Delete char code is \b on non-numeric keyboards.
+      #           On numeric keyboards, the delete key is a button on the
+      #           the keyboard.
+      #
+      # By default, Calabash uses a raw UIAutomaton JavaScript call to tap the
+      # element named 'Delete'.  This works well in English localizations for
+      # most keyboards.  If you find that it does not work, use the options
+      # pass either an translation of 'Delete' for your localization or use the
+      # default the escaped keyboard character.
+      #
       # @example
-      #   cal_ios.tap_keyboard_delete_key
+      #   # Uses UIAutomation to tap the 'Delete' key or button.
+      #   tap_keyboard_delete_key
+      #
+      #   # Types the \b key.
+      #   tap_keyboard_delete_key({:use_escaped_char => true})
       #
-      def tap_keyboard_delete_key
-        Calabash::Internal.with_default_device(required_os: :ios) do |device|
-          device.tap_keyboard_delete_key
+      #   # Types the \d key.
+      #   tap_keyboard_delete_key({:use_escaped_char => '\d'})
+      #
+      #   # Uses UIAutomation to tap the 'Slet' key or button.
+      #   tap_keyboard_delete_key({:delete_key_label => 'Slet'})
+      #
+      #   # Don't specify both options!  If :use_escape_sequence is truthy,
+      #   # Calabash will ignore the :delete_key_label and try to use an
+      #   # escaped character sequence.
+      #   tap_keyboard_delete_key({:use_escaped_char => true,
+      #                            :delete_key_label => 'Slet'})
+      #
+      # @param [Hash] options Alternative ways to tap the delete key.
+      # @option options [Boolean, String] :use_escaped_char (false) If true,
+      #  delete by typing the \b character.  If this value is truthy, but not
+      #  'true', they it is expected to be an alternative escaped character.
+      # @option options [String] :delete_key_label ('Delete') An alternative
+      #  localization of 'Delete'.
+      # @todo Need translations of 'Delete' key.
+      def tap_keyboard_delete_key(options = {})
+        default_options =
+            {
+                use_escaped_char: false,
+                delete_key_label: 'Delete'
+            }
+        merged_options = default_options.merge(options)
+
+        use_escape_sequence = merged_options[:use_escaped_char]
+        if use_escape_sequence
+          if use_escape_sequence.to_s == 'true'
+            # Use the default \b
+            char_sequence = ESCAPED_KEYBOARD_CHARACTERS[:delete]
+          else
+            char_sequence = use_escape_sequence
+          end
+          return Device.default.uia_route("uia.keyboard().typeString('#{char_sequence}')")
         end
+
+        delete_key_label = merged_options[:delete_key_label]
+        uia = "uia.keyboard().elements().firstWithName('#{delete_key_label}').tap()"
+        Device.default.uia_route(uia)
       end
 
       # Returns the the text in the first responder.
@@ -127,9 +183,7 @@ module Calabash
       #
       # @raise [RuntimeError] If there is no visible keyboard.
       def text_from_keyboard_first_responder
-        Calabash::Internal.with_default_device(required_os: :ios) do |device|
-          device.text_from_keyboard_first_responder
-        end
+        Device.default.text_from_keyboard_first_responder
       end
 
       private

data/lib/calabash/ios/uia.rb

@@ -17,7 +17,7 @@ module Calabash
       #  uia("UIATarget.localTarget().frontMostApp().keyboard().buttons()['Delete']")
       #  uia("UIATarget.localTarget().frontMostApp().mainWindow().elements()")
       def uia(script)
-        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.evaluate_uia(script)}
+        Device.default.evaluate_uia(script)
       end
 
       # Evaluates `script` after prefixing with "UIATarget.localTarget()"

data/lib/calabash/ios.rb

@@ -1,7 +1,21 @@
 module Calabash
-  # @!visibility private
-  module IOSInternal
+  # Contains the iOS implementations of the Calabash APIs.
+  module IOS
     require 'calabash'
+    include Calabash
+
+    # @!visibility private
+    def self.extended(base)
+      Calabash.send(:extended, base)
+    end
+
+    # @!visibility private
+    def self.included(base)
+      Calabash.send(:included, base)
+    end
+
+    require 'calabash/ios/defaults'
+    extend Calabash::IOS::Defaults
 
     require 'calabash/ios/environment'
     require 'calabash/ios/application'
@@ -18,8 +32,6 @@ module Calabash
     require 'calabash/ios/gestures'
     require 'calabash/ios/slider'
     require 'calabash/ios/date_picker'
-    require 'calabash/ios/automator'
-    require 'calabash/ios/web'
 
     include Calabash::IOS::Conditions
     include Calabash::IOS::Orientation
@@ -31,79 +43,6 @@ module Calabash
     include Calabash::IOS::Gestures
     include Calabash::IOS::Slider
     include Calabash::IOS::DatePicker
-    include Calabash::IOS::Web
-  end
-
-  # Contains the iOS implementations of the Calabash APIs.
-  module IOS
-    require 'calabash'
-    # Hide from documentation
-    send(:include, Calabash)
-
-    # @!visibility private
-    def self.extended(base)
-      Calabash.send(:extended, base)
-    end
 
-    # @!visibility private
-    def self.included(base)
-      Calabash.send(:included, base)
-    end
-
-    include ::Calabash::IOSInternal
-
-    require 'calabash/ios/defaults'
-    extend Calabash::IOS::Defaults
-
-    require 'calabash/ios/legacy'
   end
 end
-
-# @!visibility private
-class CalabashIOSMethodsInternal
-  include ::Calabash::IOS
-end
-
-# @!visibility private
-class CalabashIOSMethods < BasicObject
-  include ::Calabash::IOSInternal
-
-  instance_methods.each do |method_name|
-    define_method(method_name) do |*args, &block|
-      ::CalabashIOSMethodsInternal.new.send(method_name, *args, &block)
-    end
-  end
-end
-
-# Returns a object that exposes all of the public Calabash iOS API.
-# This method should *always* be used to access the Calabash API. By default,
-# all methods are executed using the default device and the default
-# application.
-#
-# For iOS specific methods use {cal_android}. For cross-platform methods use
-# {cal}.
-#
-# All iOS API methods are available with documentation in {Calabash::IOS}
-#
-# @see Calabash::IOS
-#
-# @return [Object] Instance responding to all Calabash iOS methods
-#  in the API.
-def cal_ios
-  CalabashIOSMethods.new
-end
-
-# We also want to patch `cal` to invoke the iOS implementations
-class CalabashMethodsInternal
-  include ::Calabash::IOS
-
-  instance_methods.each do |method_name|
-    define_method(method_name) do |*args, &block|
-      ::CalabashIOSMethodsInternal.new.send(method_name, *args, &block)
-    end
-  end
-end
-
-if defined?(::Calabash::AndroidInternal)
-  raise Calabash::RequiredBothPlatformsError, "Cannot require both calabash/android and calabash/ios"
-end

data/lib/calabash/legacy.rb

@@ -1,10 +1,7 @@
-if Calabash::Environment.variable('TEST_APP_PATH')
-  Calabash::Logger.warn("Deprecated use of old ENV variable 'TEST_APP_PATH'")
-  Calabash::Environment::TEST_SERVER_PATH =
-      Calabash::Environment.variable('TEST_APP_PATH')
-end
-
-if Calabash::Environment.variable('APP_PATH')
-  Calabash::Logger.warn("Deprecated use of old ENV variable 'APP_PATH'")
-  Calabash::Environment::APP_PATH = Calabash::Environment.variable('APP_PATH')
+module Calabash
+  class Application
+    def md5_checksum
+      'samplechecksum'
+    end
+  end
 end

data/lib/calabash/lib/skeleton/features/step_definitions/{sample_steps.rb.skeleton → calabash_steps.rb}

@@ -1,10 +1,10 @@
 Given(/^I have done a specific thing$/) do
   # Sample step definition
   # Example: (Given I am logged in)
-  #  cal.enter_text({marked: 'username'}, USERNAME)
-  #  cal.enter_text({marked: 'password'}, PASSWORD)
-  #  cal.tap({marked: 'login'}")
-  #  cal.wait_for_view("* text:'Welcome #{USERNAME}'")
+  #  enter_text("* marked:'username'", USERNAME)
+  #  enter_text("* marked:'password'", PASSWORD)
+  #  touch("* marked:'login'")
+  #  wait_for_view("* text:'Welcome #{USERNAME}'")
 
   # Remember: any Ruby is allowed in your step definitions
   did_something = true
@@ -17,13 +17,13 @@ end
 When(/^I do something$/) do
   # Sample step definition
   # Example: When I create a new entry
-  #  cal.tap({marked:'new_entry'})
-  #  cal.enter_text({marked: 'entry_title'}, 'My Entry')
-  #  cal.tap({marked: 'submit'})
+  #  touch("* marked:'new_entry'")
+  #  enter_text("* marked:'entry_title'", 'My Entry')
+  #  touch("* marked:'submit'")
 end
 
 Then(/^something should happen$/) do
   # Sample step definition
   # Example: Then I should see the entry on my home page
-  #  cal.wait_for_view({text: 'My Entry'})
+  #  wait_for_view("* text:'My Entry'")
 end

data/lib/calabash/lib/skeleton/features/support/{dry_run.rb.skeleton → dry_run.rb}

@@ -1,5 +1,8 @@
 # Cucumber does not load env.rb when running a dry-run. As the pages inherit
 # from Calabash::Page and assert that the scopes IOS and Android are defined,
-# we should require calabash stubs, which are empty scopes.
+# we should require calabash.
 
-require 'calabash/stubs'
+if ARGV.include?('--dry-run')
+  require 'calabash/android'
+  require 'calabash/ios'
+end

data/lib/calabash/lib/skeleton/features/support/{env.rb.skeleton → env.rb}

@@ -1,4 +1,6 @@
 require 'calabash'
+require 'calabash/android/application'
+require 'calabash/ios/application'
 
 platform = ENV['PLATFORM']
 
@@ -10,7 +12,7 @@ unless platform
   elsif application.ios_application?
     platform = 'ios'
   else
-    raise "Application '#{application}' is neither an Android app nor an iOS app"
+    raise "Application '#{application}' is neither an Android app or an iOS app"
   end
 end
 
@@ -18,10 +20,14 @@ case platform
   when 'android'
     require 'calabash/android'
 
+    World(Calabash::Android)
+
     Calabash::Android.setup_defaults!
   when 'ios'
     require 'calabash/ios'
 
+    World(Calabash::IOS)
+
     Calabash::IOS.setup_defaults!
   else
     message = if platform.nil? || platform.empty?
@@ -34,7 +40,7 @@ case platform
         [
             'ERROR! Unable to start the cucumber test:',
             message,
-            "Run cucumber with the ENV variable 'CAL_APP' set to the path of the application under test, or specify 'PLATFORM'"
+            "Run cucumber with the ENV variable 'CAL_APP', or run cucumber using $ calabash run"
         ]
 
     Calabash::Logger.error(failure_messages.join("\n"))

data/lib/calabash/lib/skeleton/features/support/hooks.rb

@@ -0,0 +1,83 @@
+require 'calabash'
+
+Before do |scenario|
+  if scenario.respond_to?(:scenario_outline)
+    scenario = scenario.scenario_outline
+  end
+
+  AppLifeCycle.on_new_scenario(scenario)
+
+  start_app
+end
+
+After do
+  stop_app
+end
+
+module AppLifeCycle
+  # Since this is a module, the methods in the Cucumber World are not
+  # available inside the scope of this module. We can safely include Calabash
+  # because we will not affect the scope outside this module. The methods are
+  # loaded as class (static) methods.
+  class << self
+    include Calabash
+  end
+
+  DEFAULT_RESET_BETWEEN = #!DEFAULT_RESET_BETWEEN#! # Filled in by calabash generate
+  DEFAULT_RESET_METHOD = #!DEFAULT_RESET_METHOD#! # Filled in by calabash generate
+
+  RESET_BETWEEN = if Calabash::Environment.variable('RESET_BETWEEN')
+                    Calabash::Environment.variable('RESET_BETWEEN').downcase.to_sym
+                  else
+                    DEFAULT_RESET_BETWEEN
+                  end
+
+  RESET_METHOD = if Calabash::Environment.variable('RESET_METHOD')
+                   Calabash::Environment.variable('RESET_METHOD').downcase.to_sym
+                 else
+                   DEFAULT_RESET_METHOD
+                 end
+
+  def self.on_new_scenario(scenario)
+    # Ensure the app is installed at the beginning of the test,
+    # if we never reset
+    if @last_feature.nil? && RESET_BETWEEN == :never
+      ensure_app_installed
+    end
+
+    if should_reset?(scenario)
+      reset
+    end
+
+    @last_feature = scenario.feature
+  end
+
+  private
+
+  def self.should_reset?(scenario)
+    case RESET_BETWEEN
+      when :scenarios
+        true
+      when :features
+        scenario.feature != @last_feature
+      when :never
+        false
+      else
+        raise "Invalid reset between option '#{RESET_BETWEEN}'"
+    end
+  end
+
+  def self.reset
+    case RESET_METHOD
+      when :reinstall
+        install_app
+      when :clear
+        ensure_app_installed
+        clear_app_data
+      when '', nil
+        raise 'No reset method given'
+      else
+        raise "Invalid reset method '#{RESET_METHOD}'"
+    end
+  end
+end

data/lib/calabash/life_cycle.rb

@@ -38,13 +38,13 @@ module Calabash
         raise 'No application given, and Calabash.default_application is not set'
       end
 
-      Calabash::Internal.with_default_device {|device| device.start_app(path_or_application, options.dup)}
+      Device.default.start_app(path_or_application, options.dup)
     end
 
     # Stop the app running on
     # {Calabash::Defaults#default_server Calabash.default_server}
     def stop_app
-      Calabash::Internal.with_default_device {|device| device.stop_app}
+      Device.default.stop_app
     end
 
     # Installs the given application. If the application is already installed,
@@ -67,7 +67,7 @@ module Calabash
         raise 'No application given, and Calabash.default_application is not set'
       end
 
-      Calabash::Internal.with_default_device {|device| device.install_app(path_or_application)}
+      Device.default.install_app(path_or_application)
     end
 
     # Installs the given application *if it is not already installed*. If no
@@ -90,7 +90,7 @@ module Calabash
         raise 'No application given, and Calabash.default_application is not set'
       end
 
-      Calabash::Internal.with_default_device {|device| device.ensure_app_installed(path_or_application)}
+      Device.default.ensure_app_installed(path_or_application)
     end
 
     # Uninstalls the given application. Does nothing if the application is
@@ -108,7 +108,7 @@ module Calabash
         raise 'No application given, and Calabash.default_application is not set'
       end
 
-      Calabash::Internal.with_default_device {|device| device.uninstall_app(path_or_application)}
+      Device.default.uninstall_app(path_or_application)
     end
 
     # Clears the contents of the given application. This is roughly equivalent to
@@ -126,7 +126,7 @@ module Calabash
         raise 'No application given, and Calabash.default_application is not set'
       end
 
-      Calabash::Internal.with_default_device {|device| device.clear_app_data(path_or_application)}
+      Device.default.clear_app_data(path_or_application)
     end
 
     # Sends the current app to the background and resumes it after
@@ -150,17 +150,9 @@ module Calabash
       true
     end
 
-    # Attempts to reset the changes Calabash has made to the device.
-    #
-    # This method does nothing at the moment, but will be required to reset the
-    # device changes in the future.
-    def reset_device_changes
-      true
-    end
-
     # @!visibility private
-    define_method(:_send_current_app_to_background) do |for_seconds|
-      abstract_method!(:_send_current_app_to_background)
+    def _send_current_app_to_background(for_seconds)
+      abstract_method!
     end
   end
 end

data/lib/calabash/location.rb

@@ -5,39 +5,40 @@ module Calabash
   # An API for setting the location of your app.
   module Location
     # Simulates gps location of the device/simulator.
+    # @note Seems UIAutomation is broken here on physical devices on iOS 7.1
     #
     # @example
-    #  cal.set_location(latitude: 48.8567, longitude: 2.3508)
+    #  set_location({latitude: 48.8567, longitude: 2.3508})
     #
     # @example
-    #  cal.set_location(coordinates_for_place('The little mermaid, Copenhagen'))
+    #  set_location(coordinates_for_place('The little mermaid, Copenhagen'))
     #
-    # @param [Number] latitude The latitude of the location to simulate.
-    # @param [Number] longitude The longitude of the location to simulate.
-    # @raise [ArgumentError] If not given a latitude or longitude key.
-    def set_location(latitude: nil, longitude: nil)
-      unless latitude
-        raise ArgumentError, "Expected latitude to be a number, not '#{latitude.class}'"
+    # @param [Hash] location The location to simulate.
+    # @raise [ArgumentError] If location is not a hash and does not contain a
+    #  latitude and longitude key.
+    def set_location(location)
+      unless location.is_a?(Hash)
+        raise ArgumentError, "Expected location to be a Hash, not '#{location.class}'"
       end
 
-      unless longitude
-        raise ArgumentError, "Expected longitude to be a number, not '#{longitude.class}'"
+      unless location[:latitude] || location[:longitude]
+        raise ArgumentError, 'You must supply :latitude and :longitude'
       end
 
-      Calabash::Internal.with_default_device {|device| device.set_location(latitude: latitude, longitude: longitude)}
+      Device.default.set_location(location)
     end
 
     # Get the latitude and longitude for a certain place, resolved via Google
     # maps api. This hash can be used in `set_location`.
     #
     # @example
-    #  cal.coordinates_for_place('The little mermaid, Copenhagen')
+    #  coordinates_for_place('The little mermaid, Copenhagen')
     #  # => {:latitude => 55.6760968, :longitude => 12.5683371}
     #
     # @return [Hash] Latitude and longitude for the given place
     # @raise [RuntimeError] If the place cannot be found
-    def coordinates_for_place(place_name)
-      result = Geocoder.search(place_name)
+    def coordinates_for_place(place)
+      result = Geocoder.search(place)
 
       if result.empty?
         raise "No result found for '#{place}'"

data/lib/calabash/orientation.rb

@@ -62,23 +62,23 @@ module Calabash
     end
 
     # @!visibility private
-    define_method(:_portrait?) do
-      abstract_method!(:_portrait?)
+    def _portrait?
+      abstract_method!
     end
 
     # @!visibility private
-    define_method(:_landscape?) do
-      abstract_method!(:_landscape?)
+    def _landscape?
+      abstract_method!
     end
 
     # @!visibility private
-    define_method(:_set_orientation_portrait) do
-      abstract_method!(:_set_orientation_portrait)
+    def _set_orientation_portrait
+      abstract_method!
     end
 
     # @!visibility private
-    define_method(:_set_orientation_landscape) do
-      abstract_method!(:_set_orientation_landscape)
+    def _set_orientation_landscape
+      abstract_method!
     end
   end
 end

data/lib/calabash/page.rb

@@ -8,6 +8,9 @@ module Calabash
   #   * https://github.com/calabash/calabash/tree/develop/samples/wordpress
   #   * https://github.com/calabash/calabash/tree/develop/samples/shared-page-logic
   class Page
+    # For auto-completion
+    include Calabash
+
     # @!visibility private
     def self.inherited(subclass)
       # Define the page into global scope
@@ -68,7 +71,7 @@ module Calabash
 
     # Waits for the page trait to appear.
     def await(options={})
-      cal.wait_for_view(trait, options)
+      wait_for_view(trait, options)
     end
 
     # @!visibility private