zucchini-ios 0.5.5 → 0.5.6

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    zucchini-ios (0.5.5)
+      clamp
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    clamp (0.5.0)
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  watchr
+  zucchini-ios!

data/README.md

@@ -1,10 +1,12 @@
 Pre-requisites
 --------------
- 1. XCode 4.2
- 2. A few command line tools:
+ 1. Mac OS X >= 10.6
+ 2. XCode >= 4.2
+ 3. Ruby >= 1.9.2
+ 4. A few command line tools:
 
 ```
-brew update && brew install imagemagick && brew install coffee-script 
+brew update && brew install imagemagick && brew install coffee-script
 ```
 
 Start using Zucchini
@@ -22,7 +24,7 @@ Start by creating a project scaffold:
 zucchini generate --project /path/to/my_project
 ```
 
-Create a feature scaffold for your first feature:  
+Create a feature scaffold for your first feature:
 
 ```
 zucchini generate --feature /path/to/my_project/features/my_feature
@@ -39,17 +41,17 @@ Add your device to features/support/config.yml.
 The [udidetect](https://github.com/vaskas/udidetect) utility comes in handy if you plan to add devices from time to time: `udidetect -z`.
 
 ```
-ZUCCHINI_DEVICE="My Device" zucchini run /path/to/my_feature 
+ZUCCHINI_DEVICE="My Device" zucchini run /path/to/my_feature
 ```
 
 Running on the iOS Simulator
 -------------------------------
 We strongly encourage you to run your Zucchini features on real hardware. However, you can run them on the iOS Simulator if you must.
 
-First off, modify your features/support/config.yml to include a full path to your compiled app, e.g.
+First off, modify your features/support/config.yml to include the path to your compiled app, e.g.
 
 ```
-app: /Users/vaskas/Library/Developer/Xcode/DerivedData/CoreDataBooks-ebeqiuqksrwwoscupvxuzjzrdfjz/Build/Products/Debug-iphonesimulator/CoreDataBooks.app
+app: ./Build/Products/Debug-iphonesimulator/CoreDataBooks.app
 ```
 
 Secondly, add an 'iOS Simulator' entry to the devices section (no UDID needed) and make sure you provide the actual value for 'screen' based on your iOS Simulator settings:
@@ -60,16 +62,29 @@ devices:
     screen: low_ios5
 ```
 
+Alternatively, you can specify the app path in the device section:
+
+```
+devices:
+  iOS Simulator:
+    screen: low_ios5
+    app: ./Build/Products/Debug-iphonesimulator/CoreDataBooks.app
+  iPad2:
+    screen: ipad_ios5
+    app: ./Build/Products/Debug-iphoneos/CoreDataBooks.app
+```
+
+
 Run it as usual:
 
 ```
-ZUCCHINI_DEVICE="iOS Simulator" zucchini run /path/to/my_feature 
+ZUCCHINI_DEVICE="iOS Simulator" zucchini run /path/to/my_feature
 ```
 
 See also
 ---------
 ```
-zucchini --help  
-zucchini run --help  
+zucchini --help
+zucchini run --help
 zucchini generate --help
 ```

data/lib/config.rb

@@ -1,29 +1,35 @@
 require 'yaml'
 
 module Zucchini
-  class Config 
-    
+  class Config
+
     def self.base_path
       @@base_path
     end
-  
+
     def self.base_path=(base_path)
       @@base_path = base_path
       @@config    = YAML::load_file("#{base_path}/support/config.yml")
     end
-                  
+
     def self.app
-      @@config['app']
+      device_name = ENV['ZUCCHINI_DEVICE']
+      app_path    = File.absolute_path(devices[device_name]['app'] || @@config['app'])
+
+      if device_name == 'iOS Simulator' && !File.exists?(app_path)
+        raise "Can't find application at path #{app_path}"
+      end
+      app_path
     end
-  
-    def self.resolution_name(dimension)   
+
+    def self.resolution_name(dimension)
       @@config['resolutions'][dimension.to_i]
     end
-  
+
     def self.devices
       @@config['devices']
     end
-  
+
     def self.device(device_name)
       raise "Device not listed in config.yml" unless (device = devices[device_name])
       {
@@ -32,16 +38,16 @@ module Zucchini
         :screen => device['screen']
       }
     end
-    
+
     def self.server(server_name)
       @@config['servers'][server_name]
     end
-  
+
     def self.url(server_name, href="")
       server_config = server(server_name)
       port = server_config['port'] ? ":#{server_config['port']}" : ""
-    
+
       "http://#{server_config['host']}#{port}#{href}"
     end
-  end                                   
-end
+  end
+end

data/lib/feature.rb

@@ -64,7 +64,7 @@ class Zucchini::Feature
       device_params = (@device[:name] == "iOS Simulator") ? "" : "-w #{@device[:udid]}"
       
       begin
-        out = `instruments #{device_params} -t #{@template} #{Zucchini::Config.app} -e UIASCRIPT #{run_data_path}/feature.js -e UIARESULTSPATH #{run_data_path} 2>&1`
+        out = `instruments #{device_params} -t "#{@template}" "#{Zucchini::Config.app}" -e UIASCRIPT "#{run_data_path}/feature.js" -e UIARESULTSPATH "#{run_data_path}" 2>&1`
         puts out
         # Hack. Instruments don't issue error return codes when JS exceptions occur
         raise "Instruments run error" if (out.match /JavaScript error/) || (out.match /Instruments\ .{0,5}\ Error\ :/ )

data/lib/runner.rb

@@ -1,56 +1,56 @@
 class Zucchini::Runner < Clamp::Command
   attr_reader :features
-  
+
   parameter "PATH", "a path to feature or a directory to run"
-  
+
   option %W(-c --collect), :flag, "only collect the screenshots from the device"
   option %W(-p --compare), :flag, "perform screenshots comparison based on the last collection"
   option "--ci",           :flag, "produce a CI version of the report after comparison"
 
   def execute
     raise "Directory #{path} does not exist" unless File.exists?(path)
-    
+
     @path = File.expand_path(path)
     Zucchini::Config.base_path = File.exists?("#{path}/feature.zucchini") ? File.dirname(path) : path
-      
+
     raise "ZUCCHINI_DEVICE environment variable not set" unless ENV['ZUCCHINI_DEVICE']
-    @device = Zucchini::Config.device(ENV['ZUCCHINI_DEVICE'])   
-    
+    @device = Zucchini::Config.device(ENV['ZUCCHINI_DEVICE'])
+
     @template = detect_template
-    
-    exit run 
+
+    exit run_features
   end
-  
-  def run
+
+  def run_features
     compare_threads = {}
-    
+
     features.each do |f|
       f.device   = @device
       f.template = @template
-      
+
       if    collect? then f.collect
       elsif compare? then f.compare
       else  f.collect; compare_threads[f.name] = Thread.new { f.compare }
       end
     end
-    
+
     compare_threads.each { |name, t| t.abort_on_exception = true; t.join }
-    
+
     Zucchini::Report.present(features, ci?) unless (collect? && !compare?)
     features.inject(true){ |result, feature| result &= feature.succeeded }
   end
-  
+
   def features
     @features ||= detect_features(@path)
   end
-  
+
   def detect_features(path)
     features = []
     if File.exists?("#{path}/feature.zucchini")
       features << Zucchini::Feature.new(path)
     else
       raise detection_error(path) if Dir["#{path}/*"].empty?
-      
+
       Dir.glob("#{path}/*").each do |dir|
           unless dir.match /support/
           if File.exists?("#{dir}/feature.zucchini")
@@ -63,15 +63,20 @@ class Zucchini::Runner < Clamp::Command
     end
     features
   end
-  
+
   def detection_error(path)
     "#{path} is not a feature directory"
   end
-  
+
   def detect_template
-    path  = `xcode-select -print-path`.gsub(/\n/, '')
-    path += "/Platforms/iPhoneOS.platform/Developer/Library/Instruments/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate"
-    raise "Instruments template at #{path} does not exist" unless File.exists? path
-    path
+    locations = [
+      `xcode-select -print-path`.gsub(/\n/, '') + "/Platforms/iPhoneOS.platform/Developer/Library/Instruments",
+       "/Applications/Xcode.app/Contents/Applications/Instruments.app/Contents" # Xcode 4.5
+    ].map do |start_path|
+      "#{start_path}/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate"
+    end
+
+    locations.each { |path| return path if File.exists?(path) }
+    raise "Can't find Instruments template (tried #{locations.join(', ')})"
   end
 end

data/lib/screenshot.rb

@@ -1,58 +1,54 @@
 class Zucchini::Screenshot
-  attr_reader :file_path
-  attr_reader :file_name 
-  
-  attr_accessor :diff
-  attr_accessor :masks_paths
-  attr_accessor :masked_paths
-  attr_accessor :test_path 
-  attr_accessor :diff_path
-  
+  attr_reader   :file_path, :file_name
+  attr_accessor :diff, :masks_paths, :masked_paths, :test_path, :diff_path, :compare_cmd
+
   def initialize(file_path, device, unmatched_pending = false)
     @file_path = file_path
     @file_name = File.basename(@file_path)
     @device    = device
-    
+
+    @compare_cmd = "compare -metric AE -fuzz 2% -dissimilarity-threshold 1 -subimage-search"
+
     unless unmatched_pending
       @file_base_path = File.dirname(@file_path)
-      
+
       @masks_paths = {
         :global   => "#{@file_base_path}/../../../support/masks/#{@device[:screen]}.png",
-        :specific => "#{@file_base_path}/../../masks/#{@device[:screen]}/#{@file_name}" 
+        :specific => "#{@file_base_path}/../../masks/#{@device[:screen]}/#{@file_name}"
       }
-    
+
       masked_path   = "#{@file_base_path}/../Masked/actual/#{@file_name}"
       @masked_paths = { :globally => masked_path, :specifically => masked_path }
-    
+
       @test_path = nil
       @pending   = false
       @diff_path = "#{@file_base_path}/../Diff/#{@file_name}"
-    end 
+    end
   end
-  
+
   def mask
     @masked_paths.each { |name, path| FileUtils.mkdir_p(File.dirname(path)) }
     `convert -page +0+0 \"#{@file_path}\" -page +0+0 \"#{@masks_paths[:global]}\" -flatten \"#{@masked_paths[:globally]}\"`
-    
+
     if File.exists?(@masks_paths[:specific])
       `convert -page +0+0 \"#{@masked_paths[:globally]}\" -page +0+0 \"#{@masks_paths[:specific]}\" -flatten \"#{@masked_paths[:specifically]}\"`
     end
   end
-  
+
   def compare
     mask_reference
-    
+
     if @test_path
       FileUtils.mkdir_p(File.dirname(@diff_path))
-      
-      out = `compare -metric AE -fuzz 2% -subimage-search \"#{@masked_paths[:specifically]}\" \"#{@test_path}\" \"#{@diff_path}\" 2>&1`
+
+      out = `#{@compare_cmd} \"#{@masked_paths[:specifically]}\" \"#{@test_path}\" \"#{@diff_path}\" 2>&1`
       @diff = (out == "0\n") ? [:passed, nil] : [:failed, out]
       @diff = [:pending, @diff[1]] if @pending
     else
       @diff = [:failed, "no reference or pending screenshot for #{@device[:screen]}\n"]
     end
   end
-  
+
   def result_images
     @result_images ||= {
       :actual     => @masked_paths && File.exists?(@masked_paths[:specifically]) ? @masked_paths[:specifically] : nil,
@@ -60,17 +56,17 @@ class Zucchini::Screenshot
       :difference => @diff_path    && File.exists?(@diff_path) ? @diff_path : nil
     }
   end
-  
+
   def mask_reference
     %W(reference pending).each do |reference_type|
       reference_file_path = "#{@file_base_path}/../../#{reference_type}/#{@device[:screen]}/#{@file_name}"
       output_path         = "#{@file_base_path}/../Masked/#{reference_type}/#{@file_name}"
-      
+
       if File.exists?(reference_file_path)
         @test_path = output_path
-        @pending   = (reference_type == "pending") 
+        @pending   = (reference_type == "pending")
         FileUtils.mkdir_p(File.dirname(output_path))
-        
+
         reference = Zucchini::Screenshot.new(reference_file_path, @device)
         reference.masks_paths  = @masks_paths
         reference.masked_paths = { :globally => output_path, :specifically => output_path }
@@ -78,5 +74,5 @@ class Zucchini::Screenshot
       end
     end
   end
-  
+
 end

data/lib/uia/base.coffee

@@ -19,6 +19,15 @@ 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  unless element
   found = false

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Zucchini
-  VERSION = "0.5.5"
+  VERSION = "0.5.6"
 end

data/spec/sample_setup/support/config.yml

@@ -1,7 +1,7 @@
 app: MyApp.app
 
 devices:
-  My iDevice: 
+  My iDevice:
     UDID  : lolffb28d74a6fraj2156090784avasc50725dd0
     screen: ipad_ios5
 

data/templates/project/features/support/config.yml

@@ -1,7 +1,7 @@
 app: MyApp.app
 
 devices:
-  My iDevice: 
+  My iDevice:
     UDID  : lolffb28d74a6fraj2156090784avasc50725dd0
     screen: retina_ios5
 

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: zucchini-ios
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.5.5
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 6
+  version: 0.5.6
 platform: ruby
 authors: 
 - Vasily Mikhaylichenko
@@ -12,16 +16,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-03 00:00:00 Z
+date: 2012-12-03 00:00:00 +11:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: clamp
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -29,10 +35,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -40,10 +47,11 @@ dependencies:
   name: watchr
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -57,6 +65,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - README.md
 - bin/zucchini
 - lib/config.rb
@@ -109,6 +120,7 @@ files:
 - templates/project/features/support/masks/retina_ios5.png
 - templates/project/features/support/screens/welcome.coffee
 - zucchini.gemspec
+has_rdoc: true
 homepage: http://www.zucchiniframework.org
 licenses: []
 
@@ -118,21 +130,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Functional testing framework for iOS-powered devices