iCuke 0.6.3 → 0.6.4

data/lib/icuke/configuration.rb

@@ -0,0 +1,19 @@
+module ICuke
+  class Configuration
+    def initialize(defaults = {})
+      @data = defaults
+    end
+    
+    def set(key, value)
+      @data[key] = value
+    end
+    
+    def get(key)
+      @data[key]
+    end
+    
+    def [](key)
+      get(key)
+    end
+  end
+end

data/lib/icuke/core_ext.rb

@@ -24,3 +24,30 @@ end
 if Net::HTTP::Revision.to_i == 25851
   Net::HTTP.send :include, RequestWithSocketCheck
 end
+
+
+class Hash
+
+  # Merges self with another hash, recursively.
+  # 
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  # 
+  # Thanks to whoever made it.
+
+  def deep_merge(hash)
+    target = dup
+    
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      
+      target[key] = hash[key]
+    end
+    
+    target
+  end
+
+end

data/lib/icuke/cucumber.rb

@@ -1,269 +1,33 @@
-require 'nokogiri'
-
-require 'icuke/sdk'
-require 'icuke/simulator'
-require 'icuke/simulate'
-require 'icuke/screen'
-
-class ICukeWorld
-  include ICuke::Simulate::Gestures
-  
-  attr_reader :response, :simulator
-  
-  def initialize
-    @simulator = ICuke::Simulator.new
-  end
-  
-  def launch(application, options = {})
-    process = ICuke::Simulator::Process.new(application, options)
-    @simulator.launch(process)
-  end
-  
-  def quit
-    @simulator.quit
-  end
-  
-  def suspend
-    @simulator.suspend
-  end
-  
-  def resume
-    @simulator.resume
-  end
-  
-  def screen
-    @screen ||= Screen.new(response)
-  end
-  
-  def response
-    @response ||= @simulator.view
-  end
-  
-  def record
-    @simulator.record
-  end
-  
-  def tap(label, options = {}, &block)
-    options = {
-      :pause => true
-    }.merge(options)
-    
-    element = screen.first_tappable_element(label)
-    x, y = screen.element_center(element)
-    
-    @simulator.fire_event(Tap.new(x, y, options))
-    
-    sleep(options[:pause] ? 2 : 0.2)
-    
-    refresh
-    
-    yield element if block_given?
-  end
-  
-  def swipe(direction, options = {})
-    x, y, x2, y2 = screen.swipe_coordinates(direction)
-    @simulator.fire_event(Swipe.new(x, y, x2, y2, 0.015, options))
-    sleep(1)
-    refresh
-  end
-
-  def drag(source_x, source_y, dest_x, dest_y, options = {})
-    @simulator.fire_event(Drag.new(source_x, source_y, dest_x, dest_y, 0.15, options))
-    sleep(1)
-    refresh
-  end
-
-  def drag_with_source(source, destination)
-    sources = source.split(',').collect {|val| val.strip.to_i}
-    destinations = destination.split(',').collect {|val| val.strip.to_i}
-    drag(sources[0], sources[1], destinations[0], destinations[1])
-  end
-  
-  def drag_slider_to(label, direction, distance)
-    element = screen.first_slider_element(label)
-    x, y = screen.find_slider_button(element)
-    
-    dest_x, dest_y = x, y
-    modifier = direction_modifier(direction)
-    
-    if [:up, :down].include?(direction)
-      dest_y += modifier * distance
-    else
-      dest_x += modifier * distance
-    end
-    
-    drag(x, y, dest_x, dest_y)
-  end
-
-  def drag_slider_to_percentage(label, percentage)
-    element = screen.first_slider_element(label)
-    x, y = screen.find_slider_button(element)
-    dest_x, dest_y = screen.find_slider_percentage_location(element, percentage)
-    drag(x, y, dest_x, dest_y)
-  end
-
-  def type(textfield, text, options = {})
-    tap(textfield, :hold_for => 0.75) do |field|
-      if field['value']
-        tap('Select All')
-        tap('Delete')
-      end
-    end
-    
-    # Without this sleep fields which have auto-capitilisation/correction can
-    # miss the first keystroke for some reason.
-    sleep(0.5)
-    
-    text.split('').each do |c|
-      begin
-        tap(c == ' ' ? 'space' : c, :pause => false)
-      rescue Exception => e
-        try_keyboards =
-          case c
-          when /[a-zA-Z]/
-            ['more, letters', 'shift']
-          when /[0-9]/
-            ['more, numbers']
-          else
-            ['more, numbers', 'more, symbols']
-          end
-        until try_keyboards.empty?
-          begin
-            tap(try_keyboards.shift, :pause => false)
-            retry
-          rescue
-          end
-        end
-        raise e
+require 'icuke/icuke_world'
+
+module ICukeWorld
+
+  # Blatantly ripped from Capybara: (http://github.com/jnicklas/capybara)
+  #
+  # This block rewrites each of the driver methods in ICukeWorld to make
+  # them available as "bare" methods on the World object.
+  #
+  # icuke_driver.screen becomes #screen, for example. icuke_driver.tap
+  # becomes #tap.  
+  #
+  # Obviously this is just syntactic sugar, but isn't that what makes life
+  # worth living?
+  #
+  # The trap with this is that some of the methods produced by this 
+  # rewriting may conflict with other methods that are already in the World
+  # object. For example, there is a #drag method added by Capybara that
+  # conflicts with the #drag method in ICukeWorld.
+  #
+  # If you're stuck with this conflict, require 'icuke/cucumber_compat' 
+  # instead of 'icuke/cucumber' to get the methods still scoped to an
+  # icuke_driver object.
+  #
+  ICuke::SimulatorDriver::DSL_METHODS.each do |method|
+    class_eval %Q{
+      def #{method}(*args, &block)
+        icuke_driver.#{method}(*args, &block)
       end
-    end
-
-    # From UIReturnKeyType
-    # Should probably sort these in rough order of likelyhood?
-    return_keys = ['return', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency call']
-    return_keys.each do |key|
-      begin
-        tap(key)
-        return
-      rescue
-      end
-    end
-  end
-  
-  def scroll_to(text, options = {})
-    x, y, x2, y2 = screen.swipe_coordinates(swipe_direction(options[:direction]))
-    previous_response = response.dup
-    until screen.visible?(text) do
-      @simulator.fire_event(Swipe.new(x, y, x2, y2, 0.15, options))
-      refresh
-      raise %Q{Content "#{text}" not found in: #{screen}} if response == previous_response
-    end
-  end
-  
-  def scroll(direction)
-    swipe(swipe_direction(direction))
+      }, __FILE__, __LINE__ 
   end
-  
-  def set_application_defaults(defaults)
-    @simulator.set_defaults(defaults)
-  end
-  
-  private
-  
-  def refresh
-    @response = nil
-    @screen = nil
-  end
-
-  def swipe_direction(direction)
-    swipe_directions = { :up => :down, :down => :up, :left => :right, :right => :left }
-    swipe_directions[direction]
-  end
-
-  def direction_modifier(direction)
-    [:up, :left].include?(direction) ? -1 : 1
-  end
-
-end
-
-World do
-  ICukeWorld.new
-end
-
-After do
-  quit
-end
-
-Given /^(?:"([^\"]*)" from )?"([^\"]*)" is loaded in the (?:(iphone|ipad) )?simulator(?: with SDK ([0-9.]+))?$/ do |target, project, platform, sdk_version|
-  if sdk_version
-    ICuke::SDK.use(sdk_version)
-  elsif platform
-    ICuke::SDK.use_latest(platform.downcase.to_sym)
-  else
-    ICuke::SDK.use_latest
-  end
-  
-  launch File.expand_path(project),
-         :target => target,
-         :platform => platform,
-         :env => {
-           'DYLD_INSERT_LIBRARIES' => ICuke::SDK.dylib_fullpath
-         }
-end
-
-Given /^the module "([^\"]*)" is loaded in the simulator$/ do |path|
-  path.sub!(/#{File.basename(path)}$/, ICuke::SDK.dylib(File.basename(path)))
-  simulator.load_module(File.expand_path(path))
-end
-
-Then /^I should see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, scope|
-  raise %Q{Content "#{text}" not found in: #{screen.xml}} unless screen.visible?(text, scope)
-end
-
-Then /^I should not see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, scope|
-  raise %Q{Content "#{text}" was found but was not expected in: #{screen.xml}} if screen.visible?(text, scope)
-end
-
-When /^I tap "([^\"]*)"$/ do |label|
-  tap(label)
-end
-
-When /^I type "([^\"]*)" in "([^\"]*)"$/ do |text, textfield|
-  type(textfield, text)
-end
-
-When /^I drag from (.*) to (.*)$/ do |source, destination|
-  drag_with_source(source, destination)
-end
-
-When /^I select the "(.*)" slider and drag (.*) pixels (down|up|left|right)$/ do |label, distance, direction|
-  drag_slider_to(label, direction.to_sym, distance.to_i)
-end
-
-When /^I move the "([^\"]*)" slider to (.*) percent$/ do |label, percent|
-  drag_slider_to_percentage(label, percent.to_i)
-end
-
-When /^I scroll (down|up|left|right)(?: to "([^\"]*)")?$/ do |direction, text|
-  if text
-    scroll_to(text, :direction => direction.to_sym)
-  else
-    scroll(direction.to_sym)
-  end
-end
-
-When /^I suspend the application/ do
-  suspend
-end
-
-When /^I resume the application/ do
-  resume
-end
-
-Then /^I put the phone into recording mode$/ do
-  record
-end
 
-Then /^show me the screen$/ do
-  puts screen.xml.to_s
 end

data/lib/icuke/cucumber_compat.rb

@@ -0,0 +1,4 @@
+# This file is just a stub to allow us to provide different methods
+# by requiring icuke/cucumber_compat or icuke/cucumber.  See the README
+# and icuke/cucumber.rb for the rationale for that.
+require 'icuke/icuke_world'

data/lib/icuke/icuke_world.rb

@@ -0,0 +1,149 @@
+require 'nokogiri'
+
+require 'icuke/sdk'
+require 'icuke/simulator_driver'
+
+module ICukeWorld
+  def icuke_driver
+    @icuke_driver ||= ICuke::SimulatorDriver.default_driver(icuke_configuration)
+  end
+  
+  def icuke_configuration
+    @icuke_configuration ||= ICuke::Configuration.new({
+      :build_configuration => 'Debug'
+    })
+  end
+end
+
+After do
+  icuke_driver.quit
+end
+
+##
+# :section: Loading the iOS Application
+#
+# Launching the application is the most difficult part.  Many parts can be
+# omitted, but the full form looks like this:
+#
+#   Given "iCuke" from "app/iCuke/iCuke.xcodeproj" with build configuration "Debug" is loaded in the retina iphone simulator with SDK 4.1
+#
+# In this case:
+# * "iCuke" is the name of the app to load.
+# * "app/iCuke/iCuke.xcodeproj" is the path to the Xcode project.
+# * "Debug" specifies the build configuration.  "Debug" is used if not
+#   specified.
+# * "retina" or "non-retina" can optionally be specified.  If specified, the
+#   simulator is configured for retina or non-retina version of the device
+#   before launching the application.  If not specified, the simulator
+#   chooses, which means that it will run with the last selected resolution.
+# * "iphone" or "ipad" selects the device type.  "iphone" is the default.
+# * The optional clause "with SDK 4.0" selects the version of the simulator
+#   used.  The iPhone simulator for that version of the SDK must be installed.
+#
+Given /^(?:"([^\"]*)" from )?"([^\"]*)"(?: with build configuration "([^\"]*)")? is loaded in the (?:(retina|non-retina) )?(?:(iphone|ipad) )?simulator(?: with SDK ([0-9.]+))?$/ do |target, project, configuration, retina, platform, sdk_version|
+  if sdk_version
+    ICuke::SDK.use(sdk_version)
+  elsif platform
+    ICuke::SDK.use_latest(platform.downcase.to_sym)
+  else
+    ICuke::SDK.use_latest
+  end
+  attrs = { :target => target,
+            :platform => platform,
+            :env => {
+              'DYLD_INSERT_LIBRARIES' => ICuke::SDK.dylib_fullpath
+            }
+          }
+  attrs.merge!(:retina => !(retina =~ /non/)) if retina
+  attrs.merge!(:build_configuration => configuration) if configuration
+  icuke_driver.launch(File.expand_path(project), attrs)
+end
+
+Given /^the module "([^\"]*)" is loaded in the simulator$/ do |path|
+  path.sub!(/#{File.basename(path)}$/, ICuke::SDK.dylib(File.basename(path)))
+  simulator.load_module(File.expand_path(path))
+end
+
+##
+# :section: Seeing What's on the Screen
+#
+# The two following rules detect accessibility text on the screen:
+#
+#   Then I should see "some text" within "some scope"
+#   Then I should not see "some text" within "some scope"
+#
+Then /^I should see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, scope|
+  raise %Q{Content "#{text}" not found in: #{screen.xml}} unless icuke_driver.screen.visible?(text, scope)
+end
+
+Then /^I should not see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, scope|
+  raise %Q{Content "#{text}" was found but was not expected in: #{screen.xml}} if icuke_driver.screen.visible?(text, scope)
+end
+
+##
+# :section: Sending Input to the App
+#
+# The following rules are available:
+#
+#   When I tap "some label"
+#   When I type "some text" in "some field label"
+#   When I drag from <source> to <destination>
+#   When I select the "some label" slider and drag <distance> pixels <direction>
+#   When I move the "label" slider to <n> percent
+#   When I scroll <direction> to "some text"
+#   When I suspend the application
+#   When I resume the application
+#
+When /^I tap "([^\"]*)"$/ do |label|
+  icuke_driver.tap(label)
+end
+
+When /^I type "([^\"]*)" in "([^\"]*)"$/ do |text, textfield|
+  icuke_driver.type(textfield, text)
+end
+
+When /^I drag from (.*) to (.*)$/ do |source, destination|
+  icuke_driver.drag_with_source(source, destination)
+end
+
+When /^I select the "(.*)" slider and drag (.*) pixels (down|up|left|right)$/ do |label, distance, direction|
+  icuke_driver.drag_slider_to(label, direction.to_sym, distance.to_i)
+end
+
+When /^I move the "([^\"]*)" slider to (.*) percent$/ do |label, percent|
+  icuke_driver.drag_slider_to_percentage(label, percent.to_i)
+end
+
+When /^I scroll (down|up|left|right)(?: to "([^\"]*)")?$/ do |direction, text|
+  if text
+    icuke_driver.scroll_to(text, :direction => direction.to_sym)
+  else
+    icuke_driver.scroll(direction.to_sym)
+  end
+end
+
+When /^I suspend the application/ do
+  icuke_driver.suspend
+end
+
+When /^I resume the application/ do
+  icuke_driver.resume
+end
+
+##
+# :section: Debugging Tools
+#
+#   Then I put the phone into recording mode
+#
+#   Then show me the screen
+#
+# "show me the screen" is the quintessential step used for debugging tests.  It dumps
+# the raw XML received from the iOS app.
+#
+Then /^I put the phone into recording mode$/ do
+  icuke_driver.record
+end
+
+Then /^show me the screen$/ do
+  puts icuke_driver.screen.xml.to_s
+end