calabash 2.0.0.pre10 → 2.0.0.pre11

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)
-        Device.default.evaluate_uia(script)
+        Calabash::Internal.with_default_device(required_os: :ios) {|device| device.evaluate_uia(script)}
       end
 
       # Evaluates `script` after prefixing with "UIATarget.localTarget()"

data/lib/calabash/ios/web.rb

@@ -0,0 +1,10 @@
+module Calabash
+  module IOS
+    module Web
+      # @!visibility private
+      define_method(:_evaluate_javascript_in) do |query, javascript|
+        query(query, calabashStringByEvaluatingJavaScript: javascript)
+      end
+    end
+  end
+end

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

@@ -1,10 +1,10 @@
 Given(/^I have done a specific thing$/) do
   # Sample step definition
   # Example: (Given I am logged in)
-  #  enter_text("* marked:'username'", USERNAME)
-  #  enter_text("* marked:'password'", PASSWORD)
-  #  touch("* marked:'login'")
-  #  wait_for_view("* text:'Welcome #{USERNAME}'")
+  #  cal.enter_text({marked: 'username'}, USERNAME)
+  #  cal.enter_text({marked: 'password'}, PASSWORD)
+  #  cal.tap({marked: 'login'}")
+  #  cal.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
-  #  touch("* marked:'new_entry'")
-  #  enter_text("* marked:'entry_title'", 'My Entry')
-  #  touch("* marked:'submit'")
+  #  cal.tap({marked:'new_entry'})
+  #  cal.enter_text({marked: 'entry_title'}, 'My Entry')
+  #  cal.tap({marked: 'submit'})
 end
 
 Then(/^something should happen$/) do
   # Sample step definition
   # Example: Then I should see the entry on my home page
-  #  wait_for_view("* text:'My Entry'")
+  #  cal.wait_for_view({text: 'My Entry'})
 end

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

@@ -1,8 +1,5 @@
 # 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.
+# we should require calabash stubs, which are empty scopes.
 
-if ARGV.include?('--dry-run')
-  require 'calabash/android'
-  require 'calabash/ios'
-end
+require 'calabash/stubs'

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

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

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

@@ -0,0 +1,34 @@
+require 'calabash'
+
+Before do |scenario|
+  if scenario.respond_to?(:scenario_outline)
+    scenario = scenario.scenario_outline
+  end
+
+  reset_between_scenarios(scenario) do
+    cal.reset_device_changes  # Resets changes Calabash has made to the device
+    cal.ensure_app_installed  # Installs the app unless it is already installed
+    cal.clear_app_data        # Clears the application data
+    cal.start_app             # Starts the application
+  end
+end
+
+After do |scenario|
+  if scenario.failed?
+    cal.screenshot_embed
+  end
+
+  cal.stop_app
+end
+
+def reset_between_scenarios(scenario, &block)
+  block.call
+end
+
+def reset_between_features(scenario, &block)
+  if scenario.feature != @last_feature
+    block.call
+  end
+
+  @last_feature = scenario.feature
+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
 
-      Device.default.start_app(path_or_application, options.dup)
+      Calabash::Internal.with_default_device {|device| device.start_app(path_or_application, options.dup)}
     end
 
     # Stop the app running on
     # {Calabash::Defaults#default_server Calabash.default_server}
     def stop_app
-      Device.default.stop_app
+      Calabash::Internal.with_default_device {|device| device.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
 
-      Device.default.install_app(path_or_application)
+      Calabash::Internal.with_default_device {|device| device.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
 
-      Device.default.ensure_app_installed(path_or_application)
+      Calabash::Internal.with_default_device {|device| device.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
 
-      Device.default.uninstall_app(path_or_application)
+      Calabash::Internal.with_default_device {|device| device.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
 
-      Device.default.clear_app_data(path_or_application)
+      Calabash::Internal.with_default_device {|device| device.clear_app_data(path_or_application)}
     end
 
     # Sends the current app to the background and resumes it after
@@ -150,9 +150,17 @@ 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
-    def _send_current_app_to_background(for_seconds)
-      abstract_method!
+    define_method(:_send_current_app_to_background) do |for_seconds|
+      abstract_method!(:_send_current_app_to_background)
     end
   end
 end

data/lib/calabash/location.rb

@@ -5,40 +5,39 @@ 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
-    #  set_location({latitude: 48.8567, longitude: 2.3508})
+    #  cal.set_location(latitude: 48.8567, longitude: 2.3508)
     #
     # @example
-    #  set_location(coordinates_for_place('The little mermaid, Copenhagen'))
+    #  cal.set_location(coordinates_for_place('The little mermaid, Copenhagen'))
     #
-    # @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}'"
+    # @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}'"
       end
 
-      unless location[:latitude] || location[:longitude]
-        raise ArgumentError, 'You must supply :latitude and :longitude'
+      unless longitude
+        raise ArgumentError, "Expected longitude to be a number, not '#{longitude.class}'"
       end
 
-      Device.default.set_location(location)
+      Calabash::Internal.with_default_device {|device| device.set_location(latitude: latitude, longitude: longitude)}
     end
 
     # Get the latitude and longitude for a certain place, resolved via Google
     # maps api. This hash can be used in `set_location`.
     #
     # @example
-    #  coordinates_for_place('The little mermaid, Copenhagen')
+    #  cal.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)
-      result = Geocoder.search(place)
+    def coordinates_for_place(place_name)
+      result = Geocoder.search(place_name)
 
       if result.empty?
         raise "No result found for '#{place}'"

data/lib/calabash/orientation.rb

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

data/lib/calabash/page.rb

@@ -8,9 +8,6 @@ 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
@@ -71,7 +68,7 @@ module Calabash
 
     # Waits for the page trait to appear.
     def await(options={})
-      wait_for_view(trait, options)
+      cal.wait_for_view(trait, options)
     end
 
     # @!visibility private

data/lib/calabash/retry.rb

@@ -0,0 +1,33 @@
+module Calabash
+  module Retry
+    DEFAULT_INTERVAL = 0.5
+
+    def self.retry(retries: nil, interval: DEFAULT_INTERVAL, timeout: nil, on_errors: [StandardError], &block)
+      if retries.nil?
+        raise ArgumentError, "Must supply retries"
+      end
+
+      if retries < 1
+        raise ArgumentError, "'retries' must be greater or equal to 1, it is #{retries}"
+      end
+
+      last_error = nil
+      start_time = Time.now
+
+      retries.times do
+        begin
+          return block.call
+        rescue *on_errors => e
+          last_error = e
+          sleep interval
+
+          if timeout && Time.now - start_time > timeout
+            break
+          end
+        end
+      end
+
+      raise last_error
+    end
+  end
+end

data/lib/calabash/screenshot.rb

@@ -38,7 +38,7 @@ module Calabash
     # If the name given is an absolute path, then Calabash will save the
     # screenshot to the absolute directory given.
     #
-    # If the name given starts with ./ (e.g. `screenshot('./foo.png')`) then
+    # If the name given starts with ./ (e.g. `cal.screenshot('./foo.png')`) then
     # the filename will be saved relative to the current working directory.
     #
     # If the file specified by `name` has no extension then the filename will
@@ -49,11 +49,11 @@ module Calabash
     # @param [String] name Name of the screenshot.
     # @return [String] Path to the screenshot
     def screenshot(name=nil)
-      Device.default.screenshot(name)
+      Calabash::Internal.with_default_device {|device| device.screenshot(name)}
     end
 
     # Takes a screenshot and embeds it in the test report. This method is only
-    # available/useful when running in the context of cucumber.
+    # available/useful when running in the context of Cucumber.
     # @see Screenshot#screenshot
     def screenshot_embed(name=nil)
       path = screenshot(name)

data/lib/calabash/stubs.rb

@@ -0,0 +1,21 @@
+# Stubs for Calabash. Used for example when running Cucumber's dry-run
+
+# Page class
+unless Object.const_defined?(:Calabash)
+  Object.const_set(:Calabash, Module.new)
+end
+
+unless Calabash.const_defined?(:Page)
+  Calabash.const_set(:Page, Class.new)
+end
+
+# Android module (used for pages)
+unless Object.const_defined?(:Android)
+  Object.const_set(:Android, Module.new)
+end
+
+# IOS module (used for pages)
+unless Object.const_defined?(:IOS)
+  Object.const_set(:IOS, Module.new)
+end
+

data/lib/calabash/text.rb

@@ -4,13 +4,19 @@ module Calabash
   module Text
     # Enter `text` into the currently focused view.
     #
+    # @see Calabash::Text#enter_text_in
+    #
     # @param [String] text The text to type.
     # @raise [RuntimeError] if the text cannot be typed.
     def enter_text(text)
       _enter_text(text.to_s)
     end
 
-    # Enter `text` into `query`.
+    # Enter `text` into the first view matched by `query`.
+    #
+    # @example
+    #  cal.enter_text_in({id: 'edit'}, "Hello World")
+    #
     # @see Calabash::Text#enter_text
     #
     # @param [String] text The text to type.
@@ -21,11 +27,18 @@ module Calabash
     end
 
     # Clears the text of the currently focused view.
+    #
+    # @see Calabash::Text#clear_text_in
+    #
     def clear_text
       _clear_text
     end
 
-    # Clears the text `view`
+    # Clears the text in the first view matched by `query`
+    #
+    # @example
+    #  cal.clear_text_in({id: 'edit'})
+    #
     # @see Calabash::Text#clear_text
     #
     # @param [String, Hash, Calabash::Query] query A query describing the view
@@ -56,10 +69,10 @@ module Calabash
     # See http://developer.android.com/reference/android/view/inputmethod/EditorInfo.html
     #
     # @example
-    #  tap_keyboard_action_key(:search)
-    #  tap_keyboard_action_key(:send)
-    #  tap_keyboard_action_key(:next)
-    #  tap_keyboard_action_key(:previous)
+    #  cal.tap_keyboard_action_key(:search)
+    #  cal.tap_keyboard_action_key(:send)
+    #  cal.tap_keyboard_action_key(:next)
+    #  cal.tap_keyboard_action_key(:previous)
     #
     # Notice that, for Android, Calabash does not ensure that this particular action key is
     # actually available on the current keyboard.
@@ -79,13 +92,13 @@ module Calabash
     # Escapes single quotes in `string`.
     #
     # @example
-    #   escape_single_quotes("Let's get this done.")
+    #   cal.escape_single_quotes("Let's get this done.")
     #   => "Let\\'s get this done."
     #
     # @example
-    #  query("* text:'#{escape_single_quotes("Let's go")}'")
+    #  cal.query("* text:'#{escape_single_quotes("Let's go")}'")
     #  # Equivalent to
-    #  query("* text:'Let\\'s go'")
+    #  cal.query("* text:'Let\\'s go'")
     #
     # @param [String] string The string to escape.
     # @return [String] A string with its single quotes properly escaped.
@@ -109,7 +122,7 @@ module Calabash
     # @param [Number] timeout How long to wait for the keyboard.
     # @raise [Calabash::Wait::TimeoutError] Raises error if no keyboard
     #  appears.
-    def wait_for_keyboard(timeout=nil)
+    def wait_for_keyboard(timeout: nil)
       keyboard_timeout = keyboard_wait_timeout(timeout)
       message = "Timed out after #{keyboard_timeout} seconds waiting for the keyboard to appear"
       wait_for(message, timeout: keyboard_timeout) do
@@ -124,7 +137,7 @@ module Calabash
     # @param [Number] timeout How log to wait for the keyboard to disappear.
     # @raise [Calabash::Wait::TimeoutError] Raises error if any keyboard is
     #  visible after the `timeout`.
-    def wait_for_no_keyboard(timeout=nil)
+    def wait_for_no_keyboard(timeout: nil)
       keyboard_timeout = keyboard_wait_timeout(timeout)
       message = "Timed out after #{keyboard_timeout} seconds waiting for the keyboard to disappear"
       wait_for(message, timeout: keyboard_timeout) do
@@ -132,33 +145,32 @@ module Calabash
       end
     end
 
-    # @!visibility private
-    def _enter_text(text)
+    define_method(:_enter_text) do |text|
       abstract_method!
     end
 
     # @!visibility private
-    def _enter_text_in(view, text)
+    define_method(:_enter_text_in) do |view, text|
       abstract_method!
     end
 
     # @!visibility private
-    def _clear_text
+    define_method(:_clear_text) do
       abstract_method!
     end
 
     # @!visibility private
-    def _clear_text_in(view)
+    define_method(:_clear_text_in) do |view|
       abstract_method!
     end
 
     # @!visibility private
-    def _tap_keyboard_action_key(action_key)
+    define_method(:_tap_keyboard_action_key) do |action_key|
       abstract_method!
     end
 
     # @!visibility private
-    def _keyboard_visible?
+    define_method(:_keyboard_visible?) do
       abstract_method!
     end
 
@@ -168,7 +180,7 @@ module Calabash
     end
 
     # @!visibility private
-    def keyboard_wait_timeout(timeout)
+    define_method(:keyboard_wait_timeout) do |timeout|
       if timeout.nil?
         Calabash::Gestures::DEFAULT_GESTURE_WAIT_TIMEOUT
       else