zucchini-ios 0.6.2 → 0.7.0

data/lib/zucchini/uia/lib/uia.coffee

@@ -0,0 +1,14 @@
+# Expose global objects to the user
+target = UIATarget.localTarget()
+app    = target.frontMostApp()
+view   = app.mainWindow()
+
+# Prevent UIA from auto handling alerts
+UIATarget.onAlert = (alert) -> return true
+
+# Prepend screenshot names with numbers
+screensCount = 0
+target.captureScreenWithName_ = target.captureScreenWithName
+target.captureScreenWithName = (name) ->
+  number = (if (++screensCount < 10) then "0#{screensCount}" else screensCount)
+  @captureScreenWithName_ "#{number}_#{name}"

data/lib/zucchini/uia/lib/util.coffee

@@ -0,0 +1,41 @@
+Function::bind = (context) ->
+  return this unless context
+  fun = this
+  -> fun.apply context, arguments
+
+String::camelCase = ->
+  @replace /([\-\ ][A-Za-z])/g, ($1) ->
+    $1.toUpperCase().replace /[\-\ ]/g, ''
+
+# Instruments >= 4.5 crash when a JS primitive is thrown
+# http://apple.stackexchange.com/questions/69484/unknown-xcode-instruments-crash
+raise = (message) -> throw new Error(message)
+
+# A finder could return an UIAElement or an array from a mechanic.js selector
+# Handle both cases
+_elementFrom = (finder) ->
+  res = finder()
+  res = res[0] if (typeof res.length is 'number')
+  res
+
+# Execute a finder function until the element appears
+wait = (finder) ->
+  found   = false
+  counter = 0
+  element = null
+
+  while not found and (counter < 10)
+    element = _elementFrom finder
+
+    if element? and element.isValid() and element.isVisible()
+      found = true
+    else
+      target.delay 0.5
+      counter++
+  if found then element else false
+
+rotateTo = (orientation) ->
+  target.setDeviceOrientation(
+    if orientation is 'portrait' then UIA_DEVICE_ORIENTATION_PORTRAIT
+    else UIA_DEVICE_ORIENTATION_LANDSCAPERIGHT
+  )

data/lib/zucchini/uia/screen.coffee

@@ -1,5 +1,6 @@
 class Screen
-  takeScreenshot: (screenshot_name) ->
+  takeScreenshot: (screenshotName) ->
+    $.delay 0.5
     orientation = switch app.interfaceOrientation()
       when 0 then 'Unknown'
       when 1 then 'Portrait'
@@ -8,51 +9,53 @@ class Screen
       when 4 then 'LandscapeRight'
       when 5 then 'FaceUp'
       when 6 then 'FaceDown'
-    puts "Screenshot of screen '#{@name}' taken"
-    target.captureScreenWithName("#{orientation}_#{@name}-screen_#{screenshot_name}")
+    $.log "Screenshot of screen '#{@name}' taken"
+    target.captureScreenWithName("#{orientation}_#{@name}-screen_#{screenshotName}")
+
+  element: (name) ->
+    finder = @elements[name] || -> $('#' + name)
+
+    unless el = wait finder
+      raise "Element '#{name}' was not found on '#{@name}'"
+    el
 
   constructor: (@name) ->
 
   elements: {}
-  actions :
-    'Take a screenshot$' : ->
-      @takeScreenshot(@name)
+  actions:
+    'Take a screenshot$': -> @takeScreenshot(@name)
+
+    'Take a screenshot named "([^"]*)"$': (name) -> @takeScreenshot(name)
 
-    'Take a screenshot named "([^"]*)"$' : (screenshot_name) ->
-      @takeScreenshot(screenshot_name)
+    'Show elements' : -> view.logElementTree()
 
-    'Tap "([^"]*)"$' : (element) ->
-      raise "Element '#{element}' not defined for the screen '#{@name}'" unless @elements[element]
-      @elements[element]().tap()
+    'Show elements for "([^"]*)"$': (name) -> @element(name).logElementTree()
 
-    'Confirm "([^"]*)"$' : (element) ->
-      @actions['Tap "([^"]*)"$'].bind(this)(element)
+    'Tap "([^"]*)"$': (name) -> @element(name).tap()
 
-    'Wait for "([^"]*)" second[s]*$' : (seconds) ->
-      target.delay(seconds)
+    'Confirm "([^"]*)"$': (element) -> @actions['Tap "([^"]*)"$'].bind(this)(element)
 
-    'Type "([^"]*)" in the "([^"]*)" field$': (text,element) ->
-      raise "Element '#{element}' not defined for the screen '#{@name}'" unless @elements[element]
-      @elements[element]().tap()
+    'Wait for "([^"]*)" second[s]*$': (seconds) -> target.delay(seconds)
+
+    'Type "([^"]*)" in the "([^"]*)" field$': (text, name) ->
+      @element(name).tap()
       app.keyboard().typeString text
 
-    'Clear the "([^"]*)" field$': (element) ->
-      raise "Element '#{element}' not defined for the screen '#{@name}'" unless @elements[element]
-      @elements[element]().setValue ""
+    'Clear the "([^"]*)" field$': (name) -> @element(name).setValue ''
 
     'Cancel the alert$' : ->
       alert = app.alert()
-      raise "No alert found to dismiss on screen '#{@name}'" if isNullElement alert
+      raise "No alert found to dismiss on screen '#{@name}'" unless alert.isValid()
       alert.cancelButton().tap()
 
     'Confirm the alert$' : ->
       alert = app.alert()
-      raise "No alert found to dismiss on screen '#{@name}'" if isNullElement alert
+      raise "No alert found to dismiss on screen '#{@name}'" unless alert.isValid()
       alert.defaultButton().tap()
 
     'Select the date "([^"]*)"$' : (dateString) ->
       datePicker = view.pickers()[0]
-      raise "No date picker available to enter the date #{dateString}" unless (not isNullElement datePicker) and datePicker.isVisible()
+      raise "No date picker available to enter the date #{dateString}" unless datePicker.isValid() and datePicker.isVisible()
       dateParts = dateString.match(/^(\d{2}) (\D*) (\d{4})$/)
       raise "Date is in the wrong format. Need DD Month YYYY. Got #{dateString}" unless dateParts?
       # Set Day
@@ -64,13 +67,8 @@ class Screen
           counter++
           monthWheel.tapWithOptions({tapOffset:{x:0.5, y:0.33}})
           target.delay(0.4)
-      raise "Counldn't find the month #{dateParts[2]}" unless counter <12
+      raise "Couldn't find the month #{dateParts[2]}" unless counter < 12
       # Set Year
       view.pickers()[0].wheels()[2].selectValue(dateParts[3])
 
-    'Show elements' : ->
-      view.logElementTree()
-
-    'Rotate device to "([^"]*)"$': (orientation) ->
-      orientation = if orientation == "landscape" then UIA_DEVICE_ORIENTATION_LANDSCAPERIGHT else UIA_DEVICE_ORIENTATION_PORTRAIT
-      target.setDeviceOrientation(orientation)
+    'Rotate device to "([^"]*)"$': (orientation) -> rotateTo(orientation)

data/lib/zucchini/uia/zucchini.coffee

@@ -0,0 +1,32 @@
+# Run a Zucchini feature
+Zucchini = (featureText, orientation) ->
+  rotateTo(orientation)
+
+  sections = featureText.trim().split(/\n\s*\n/)
+
+  for section in sections
+    lines = section.split(/\n/)
+
+    screenMatch = lines[0].match(/.+ on the "([^"]*)" screen:$/)
+    raise "Line '#{lines[0]}' doesn't define a screen context" unless screenMatch
+
+    screenName = screenMatch[1]
+    try
+      screen = eval("new #{screenName.camelCase()}Screen")
+    catch e
+      raise "Screen '#{screenName}' not defined"
+
+    if screen.anchor
+      if wait(screen.anchor)
+        $.log "Found anchor for screen '#{screenName}'"
+      else
+        raise "Could not find anchor for screen '#{screenName}'"
+
+    for line in lines.slice(1)
+       functionFound = false
+       for regExpText, func of screen.actions
+          match = line.trim().match(new RegExp(regExpText))
+          if match
+            functionFound = true
+            func.bind(screen)(match[1],match[2])
+       raise "Action for line '#{line}' not defined" unless functionFound

data/lib/zucchini/version.rb

@@ -1,3 +1,3 @@
 module Zucchini
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/spec/lib/zucchini/compiler_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Zucchini::Compiler do
+  let(:path)    { './spec/sample_setup/feature_one' }
+  let(:feature) { Zucchini::Feature.new(path) }
+
+  after(:all) { FileUtils.rm_rf Dir.glob("#{path}/run_data/feature.*") }
+
+  describe "#compile_js" do
+    before { feature.compile_js 'landscape' }
+
+    it "should strip comments from the feature file" do
+      File.read("#{feature.run_data_path}/feature.coffee").index('#').should be_nil
+    end
+
+    describe "feature.js output" do
+      subject { File.read("#{feature.run_data_path}/feature.js") }
+
+      it "should include mechanic.js" do
+        should match /mechanic\.js UIAutomation Library/
+      end
+
+      it "should include screen definitions" do
+        should match /SplashScreen = \(function/
+      end
+
+      it "should include Zucchini runtime" do
+        should match /Zucchini = function/
+      end
+
+      it "should include custom libraries from support/lib" do
+        should match /Helpers.example = /
+      end
+
+      it "should include screen orientation" do
+        should match /Zucchini\(.+\'landscape\'\)/
+      end
+    end
+  end
+end

data/spec/lib/zucchini/config_spec.rb

@@ -16,25 +16,25 @@ describe Zucchini::Config do
       end
     end
   end
-  
+
   describe "device" do
     before(:all) { Zucchini::Config.base_path = "spec/sample_setup" }
 
     context "device present in config.yml" do
       it "should return the device hash" do
-        Zucchini::Config.device("My iDevice").should eq({:name =>"My iDevice", :udid =>"lolffb28d74a6fraj2156090784avasc50725dd0", :screen =>"ipad_ios5"})
+        Zucchini::Config.device("My iDevice").should eq({:name =>"My iDevice", :udid =>"lolffb28d74a6fraj2156090784avasc50725dd0", :screen =>"ipad_ios5", :simulator=>nil, :orientation=> 'portrait'})
       end
     end
-   
+
     context "device not present in config.yml" do
       it "should raise an error" do
-        expect { Zucchini::Config.device("My Android Phone")}.to raise_error "Device not listed in config.yml"
+        expect { Zucchini::Config.device("My Android Phone")}.to raise_error "Device 'My Android Phone' not listed in config.yml"
       end
     end
 
     context "default device" do
       it "should use default device if device name argument is nil" do
-        Zucchini::Config.device(nil).should eq({:name =>"Default Device", :screen =>"low_ios5", :udid => nil})
+        Zucchini::Config.device(nil).should eq({:name =>"Default Device", :screen =>"low_ios5", :udid => nil, :simulator=>nil, :orientation=> 'portrait'})
       end
 
       it "should raise error if no default device provided" do
@@ -43,12 +43,4 @@ describe Zucchini::Config do
       end
     end
   end
-  
-  describe "url" do
-    before(:all) { Zucchini::Config.base_path = "spec/sample_setup" }
-
-    it "should return a full URL string for a given server name" do
-      Zucchini::Config.url('backend', '/api').should eq "http://192.168.1.2:8080/api"
-    end
-  end
-end
+end

data/spec/lib/zucchini/detector_spec.rb

@@ -18,7 +18,7 @@ describe Zucchini::Detector do
 
     context "device hasn't been found" do
       before { ENV['ZUCCHINI_DEVICE'] = 'My Android Phone' }
-      it     { should raise_error "Device not listed in config.yml" }
+      it     { should raise_error "Device 'My Android Phone' not listed in config.yml" }
     end
   end
 

data/spec/lib/zucchini/feature_spec.rb

@@ -3,32 +3,8 @@ require 'spec_helper'
 describe Zucchini::Feature do
   let(:path)    { './spec/sample_setup/feature_one' }
   let(:feature) { Zucchini::Feature.new(path) }
-  
+
   after(:all) { FileUtils.rm_rf Dir.glob("#{path}/run_data/feature.*") }
-  
-  describe "#compile_js" do
-    before { feature.compile_js }
-    
-    it "should strip comments from the feature file" do
-      File.read("#{feature.run_data_path}/feature.coffee").index('#').should be_nil
-    end
-    
-    describe "feature.js output" do
-      subject { File.read("#{feature.run_data_path}/feature.js") }
-    
-      it "should include screen definitions" do
-        should match /SplashScreen = \(function/
-      end
-      
-      it "should include Zucchini runtime" do
-        should match /Zucchini.run = /
-      end
-      
-      it "should include custom libraries from support/lib" do
-        should match /Helpers.example = /
-      end
-    end
-  end
 
   describe "approve" do
     subject { lambda { feature.approve "reference" } }

data/spec/spec_helper.rb

@@ -1,13 +1,10 @@
 require 'coveralls'
 require 'simplecov'
 
-if ENV['COVERAGE'] == 'coveralls'
-  Coveralls.wear!
-else
-  SimpleCov.start do
-    add_filter "/spec/"
-  end
+SimpleCov.start do
+  add_filter "/spec/"
 end
+Coveralls.wear! if ENV['COVERAGE'] == 'coveralls'
 
 require 'clamp'
 require 'fileutils'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zucchini-ios
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -96,8 +96,10 @@ files:
 - bin/zucchini
 - lib/zucchini.rb
 - lib/zucchini/approver.rb
+- lib/zucchini/compiler.rb
 - lib/zucchini/config.rb
 - lib/zucchini/detector.rb
+- lib/zucchini/device.rb
 - lib/zucchini/feature.rb
 - lib/zucchini/generator.rb
 - lib/zucchini/report.rb
@@ -110,9 +112,14 @@ files:
 - lib/zucchini/report/view.rb
 - lib/zucchini/runner.rb
 - lib/zucchini/screenshot.rb
-- lib/zucchini/uia/base.coffee
+- lib/zucchini/uia/lib/compat.coffee
+- lib/zucchini/uia/lib/mechanic.js
+- lib/zucchini/uia/lib/uia.coffee
+- lib/zucchini/uia/lib/util.coffee
 - lib/zucchini/uia/screen.coffee
+- lib/zucchini/uia/zucchini.coffee
 - lib/zucchini/version.rb
+- spec/lib/zucchini/compiler_spec.rb
 - spec/lib/zucchini/config_spec.rb
 - spec/lib/zucchini/detector_spec.rb
 - spec/lib/zucchini/feature_spec.rb
@@ -176,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2489194857369851293
+      hash: -3527198499352191037
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -184,6 +191,7 @@ signing_key:
 specification_version: 3
 summary: Functional testing framework for iOS-powered devices
 test_files:
+- spec/lib/zucchini/compiler_spec.rb
 - spec/lib/zucchini/config_spec.rb
 - spec/lib/zucchini/detector_spec.rb
 - spec/lib/zucchini/feature_spec.rb

data/lib/zucchini/uia/base.coffee

@@ -1,89 +0,0 @@
-Function::bind = (context) ->
-  return this unless context
-  fun = this
-  ->
-    fun.apply context, arguments
-
-String::camelCase = ->
-  @replace /([\-\ ][A-Za-z])/g, ($1) ->
-    $1.toUpperCase().replace /[\-\ ]/g, ""
-
-extend = (obj, mixin) ->
-  obj[name] = method for name, method of mixin
-  obj
-
-puts = (text) -> UIALogger.logMessage text
-
-# Instruments 4.5 crash when a JS primitive is thrown
-# http://apple.stackexchange.com/questions/69484/unknown-xcode-instruments-crash
-raise = (message) -> throw new Error(message)
-
-# Prevent UIA from auto handling alerts
-UIATarget.onAlert = (alert) -> return true
-
-target = UIATarget.localTarget()
-app    = target.frontMostApp()
-view   = app.mainWindow()
-
-UIAElement.prototype.$ = (name) ->
-  target.pushTimeout(0)
-  elem = null
-  for el in this.elements()
-    elem = if el.name() == name then el else el.$(name)
-    break if elem
-  target.popTimeout()
-  elem
-
-target.waitForElement = (element) ->
-  return false unless element
-  found = false
-  counter = 0
-  while not found and (counter < 10)
-    if element.isValid() and element.isVisible()
-      found = true
-    else
-      @delay 0.5
-      counter++
-  return found
-
-isNullElement = (elem) -> elem.toString() == "[object UIAElementNil]"
-
-screensCount = 0
-target.captureScreenWithName_ = target.captureScreenWithName
-target.captureScreenWithName = (screenName) ->
-  screensCountText = (if (++screensCount < 10) then "0" + screensCount else screensCount)
-  @captureScreenWithName_ screensCountText + "_" + screenName
-
-class Zucchini
-  @run: (featureText) ->
-    sections = featureText.trim().split(/\n\s*\n/)
-
-    for section in sections
-      lines = section.split(/\n/)
-
-      screenMatch = lines[0].match(/.+ on the "([^"]*)" screen:$/)
-      raise "Line '#{lines[0]}' doesn't define a screen context" unless screenMatch
-
-      screenName = screenMatch[1]
-      try
-        screen = eval("new #{screenName.camelCase()}Screen")
-      catch e
-        raise "Screen '#{screenName}' not defined"
-
-      if screen.anchor
-        element = screen.anchor()
-        found = target.waitForElement(element)
-
-        if found
-          puts "Found anchor for screen '#{screenName}'"
-        else
-          raise "Could not find anchor for screen '#{screenName}'"
-
-      for line in lines.slice(1)
-         functionFound = false
-         for regExpText, func of screen.actions
-            match = line.trim().match(new RegExp(regExpText))
-            if match
-              functionFound = true
-              func.bind(screen)(match[1],match[2])
-         raise "Action for line '#{line}' not defined" unless functionFound