zucchini-ios 0.6.1 → 0.6.2

data/.gitignore

@@ -1,3 +1,19 @@
-.rvmrc
 .DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
 Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -1,13 +1,20 @@
+## 0.6.2 / 2013-08-07
+* Implement screen specific masks - [@phatmann][], [#24][]
+* Rearrange source files in a more conventional gem way - [@vaskas][], [#25][]
+* Fix report UI in Firefox - [@vaskas][], [#26][]
+* Do not squash landscape screenshots in the report - [@phatmann][]
+* Remove 1 second delay after screen is loaded - [@phatmann][], [#23][]
+
 ## 0.6.1 / 2013-07-28
-* Add Rotate device screen action - [@phatmann][], [#19][]
+* Add `Rotate device` screen action - [@phatmann][], [#19][]
 * Fix screenshot code to work with the latest version of ImageMagick - [@phatmann][], [#17][]
 * Raise error if screen anchor is not found - [@phatmann][], [#16][]
 
 ## 0.6.0 / 2013-03-30
 * Add a mask for retina iPad - [@phatmann][], [#8][]
-* Fix alert Confirm / Cancel actions so that they match to end of line - [@phatmann][], [#9][]
+* Fix alert `Confirm` / `Cancel` actions so that they match to end of line - [@phatmann][], [#9][]
 * Allow app path to be set via an environment variable - [@phatmann][], [#10][]
-* Screenshot orientation matching device orientation - [@Jaco][]-Pretorius, [#13][]
+* Screenshot orientation matching device orientation - [@Jaco-Pretorius][], [#13][]
 
 ## 0.5.9 / 2013-02-04
 * Add default device flag - [@insanehunter][], [#6][]
@@ -29,22 +36,28 @@
 * Fix Instruments template detection for Xcode 4.5 - [@vaskas][]
 * Fixed config to take relative paths to the app - [@coomans][]
 * Quote path params in call to instruments - [@kconnor][]
+
 <!--- The following link definition list is generated by PimpMyChangelog --->
-[#1]: https://github.com/src/zucchini/issues/1
-[#3]: https://github.com/src/zucchini/issues/3
-[#5]: https://github.com/src/zucchini/issues/5
-[#6]: https://github.com/src/zucchini/issues/6
-[#8]: https://github.com/src/zucchini/issues/8
-[#9]: https://github.com/src/zucchini/issues/9
-[#10]: https://github.com/src/zucchini/issues/10
-[#13]: https://github.com/src/zucchini/issues/13
-[#16]: https://github.com/src/zucchini/issues/16
-[#17]: https://github.com/src/zucchini/issues/17
-[#19]: https://github.com/src/zucchini/issues/19
+[#1]: https://github.com/zucchini-src/zucchini/issues/1
+[#3]: https://github.com/zucchini-src/zucchini/issues/3
+[#5]: https://github.com/zucchini-src/zucchini/issues/5
+[#6]: https://github.com/zucchini-src/zucchini/issues/6
+[#8]: https://github.com/zucchini-src/zucchini/issues/8
+[#9]: https://github.com/zucchini-src/zucchini/issues/9
+[#10]: https://github.com/zucchini-src/zucchini/issues/10
+[#13]: https://github.com/zucchini-src/zucchini/issues/13
+[#16]: https://github.com/zucchini-src/zucchini/issues/16
+[#17]: https://github.com/zucchini-src/zucchini/issues/17
+[#19]: https://github.com/zucchini-src/zucchini/issues/19
+[#23]: https://github.com/zucchini-src/zucchini/issues/23
+[#24]: https://github.com/zucchini-src/zucchini/issues/24
+[#25]: https://github.com/zucchini-src/zucchini/issues/25
+[#26]: https://github.com/zucchini-src/zucchini/issues/26
+
 [@Jaco-Pretorius]: https://github.com/Jaco-Pretorius
 [@NathanSudell]: https://github.com/NathanSudell
 [@coomans]: https://github.com/coomans
 [@insanehunter]: https://github.com/insanehunter
 [@kconnor]: https://github.com/kconnor
 [@phatmann]: https://github.com/phatmann
-[@vaskas]: https://github.com/vaskas
+[@vaskas]: https://github.com/vaskas

data/README.md

@@ -1,19 +1,23 @@
+# Zucchini
+
 [![Build Status](https://api.travis-ci.org/zucchini-src/zucchini.png)](http://travis-ci.org/zucchini-src/zucchini)
+[![Coverage Status](https://coveralls.io/repos/zucchini-src/zucchini/badge.png)](https://coveralls.io/r/zucchini-src/zucchini)
+[![Gem Version](https://badge.fury.io/rb/zucchini-ios.png)](http://badge.fury.io/rb/zucchini-ios)
+
+## Requirements
 
-Pre-requisites
---------------
- 1. Mac OS X >= 10.6
- 2. XCode >= 4.2
- 3. Ruby >= 1.9.2
- 4. A few command line tools:
+ 1. Mac OS X 10.6 or newer
+ 2. XCode 4.2 or newer
+ 3. Ruby 1.9.3 or newer
+ 4. A few command line tools which can be installed with [homebrew](http://brew.sh/):
 
 ```
 brew update && brew install imagemagick node
 npm install -g coffee-script
 ```
 
-Start using Zucchini
-----------------------
+## Start using Zucchini
+
 ```
 gem install zucchini-ios
 ```
@@ -33,13 +37,13 @@ Create a feature scaffold for your first feature:
 zucchini generate --feature /path/to/my_project/features/my_feature
 ```
 
-Start hacking by modifying features/my_feature/feature.zucchini and features/support/screens/welcome.coffee.
+Start hacking by modifying `features/my_feature/feature.zucchini` and `features/support/screens/welcome.coffee`.
 
 Alternatively, check out the [zucchini-demo](https://github.com/zucchini-src/zucchini-demo) project featuring an easy to explore Zucchini setup around Apple's CoreDataBooks sample.
 
-Running on the device
---------------------------------
-Add your device to features/support/config.yml.
+## Running on the device
+
+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`.
 
@@ -47,17 +51,17 @@ The [udidetect](https://github.com/vaskas/udidetect) utility comes in handy if y
 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.
+## Running on the iOS Simulator
+
+We encourage you to run your Zucchini features on real hardware. However you can also run them on the iOS Simulator.
 
-First off, modify your features/support/config.yml to include the 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: ./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:
+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:
 
 ```
 devices:
@@ -89,8 +93,8 @@ Run Zucchini and watch the simulator go!
 ZUCCHINI_DEVICE="iOS Simulator" zucchini run /path/to/my_feature
 ```
 
-See also
----------
+## See also
+
 ```
 zucchini --help
 zucchini run --help

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 desc "Run all RSpec tests"

data/bin/zucchini

@@ -3,20 +3,13 @@
 require 'clamp'
 require 'fileutils'
 
-$LOAD_PATH << File.expand_path("#{File.dirname(__FILE__)}/..")
-require 'lib/config'
-require 'lib/screenshot'
-require 'lib/report'
-require 'lib/feature'
-require 'lib/detector'
-require 'lib/runner'
-require 'lib/generator'
-require 'lib/approver'
-                
+$LOAD_PATH << File.expand_path("../..", __FILE__)
+require 'lib/zucchini'
+
 class Zucchini::App < Clamp::Command
   subcommand "generate", "Generate a project scaffold", Zucchini::Generator
   subcommand "run", "Run zucchini", Zucchini::Runner
   subcommand "approve", "Update reference screenshots", Zucchini::Approver
 end
 
-Zucchini::App.run
+Zucchini::App.run

data/lib/zucchini.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+
+module Zucchini
+  require 'zucchini/config'
+  require 'zucchini/screenshot'
+  require 'zucchini/report'
+  require 'zucchini/feature'
+  require 'zucchini/detector'
+  require 'zucchini/runner'
+  require 'zucchini/generator'
+  require 'zucchini/approver'
+end

data/lib/{feature.rb → zucchini/feature.rb}

@@ -3,20 +3,20 @@ class Zucchini::Feature
   attr_accessor :device
   attr_accessor :template
   attr_accessor :stats
-  
+
   attr_reader :succeeded
-  attr_reader :name   
-  
+  attr_reader :name
+
   def initialize(path)
     @path      = path
     @device    = nil
     @succeeded = false
     @name      = File.basename(path)
   end
-  
+
   def run_data_path
-     "#{@path}/run_data" 
-  end     
+     "#{@path}/run_data"
+  end
 
   def unmatched_pending_screenshots
     Dir.glob("#{@path}/pending/#{@device[:screen]}/[^0-9]*.png").map do |file|
@@ -26,53 +26,56 @@ class Zucchini::Feature
       screenshot
     end
   end
-  
+
   def screenshots(process = true)
     @screenshots ||= Dir.glob("#{run_data_path}/Run\ 1/*.png").map do |file|
       screenshot = Zucchini::Screenshot.new(file, @device)
       if process
-        screenshot.rotate
         screenshot.mask
         screenshot.compare
       end
       screenshot
     end + unmatched_pending_screenshots
   end
-  
+
   def stats
     @stats ||= screenshots.inject({:passed => [], :failed => [], :pending => []}) do |stats, s|
       stats[s.diff[0]] << s
       stats
     end
-  end                     
-  
+  end
+
   def compile_js
-    zucchini_base_path = File.expand_path("#{File.dirname(__FILE__)}/..")
-  
+    zucchini_base_path = File.expand_path(File.dirname(__FILE__))
+
     feature_text = File.open("#{@path}/feature.zucchini").read.gsub(/\#.+[\z\n]?/,"").gsub(/\n/, "\\n")
     File.open("#{run_data_path}/feature.coffee", "w+") { |f| f.write("Zucchini.run('#{feature_text}')") }
 
-    cs_paths  = "#{zucchini_base_path}/lib/uia #{@path}/../support/screens"
+    cs_paths  = "#{zucchini_base_path}/uia #{@path}/../support/screens"
     cs_paths += " #{@path}/../support/lib" if File.exists?("#{@path}/../support/lib")
     cs_paths += " #{run_data_path}/feature.coffee"
-    
-    `coffee -o #{run_data_path} -j #{run_data_path}/feature.js -c #{cs_paths}`
+
+    compile_cmd = "coffee -o #{run_data_path} -j #{run_data_path}/feature.js -c #{cs_paths}"
+    system compile_cmd
+    unless $?.exitstatus == 0
+      raise "Error compiling a feature file: #{compile_cmd}"
+    end
   end
 
   def collect
-    with_setup do      
+    with_setup do
       `rm -rf #{run_data_path}/*`
       compile_js
-    
+
       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`
         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\ :/ )
       ensure
-        `rm -rf instrumentscli*.trace`  
+        `rm -rf instrumentscli*.trace`
       end
     end
   end
@@ -84,8 +87,8 @@ class Zucchini::Feature
 
   def with_setup
     setup = "#{@path}/setup.rb"
-    if File.exists?(setup)             
-      require setup 
+    if File.exists?(setup)
+      require setup
       begin
         Setup.before { yield }
       ensure

data/lib/{generator.rb → zucchini/generator.rb}

@@ -1,13 +1,13 @@
 class Zucchini::Generator < Clamp::Command
   option %W(-p --project), :flag, "Generate a project"
   option %W(-f --feature), :flag, "Generate a feature"
-  
+
   parameter "PATH", "Path"
-  
+
   def templates_path
-    File.expand_path("#{File.dirname(__FILE__)}/../templates") 
+    File.expand_path("#{File.dirname(__FILE__)}/../../templates")
   end
-  
+
   def execute
     if project?
       FileUtils.mkdir_p(path)
@@ -15,4 +15,4 @@ class Zucchini::Generator < Clamp::Command
     elsif feature? then FileUtils.cp_r("#{templates_path}/feature", path)
     end
   end
-end
+end

data/lib/{report.rb → zucchini/report.rb}

@@ -1,5 +1,5 @@
 require 'erb'
-require 'lib/report/view'
+require 'zucchini/report/view'
 
 class Zucchini::Report
 
@@ -11,7 +11,7 @@ class Zucchini::Report
   def text
     @features.map do |f|
       failed_list = f.stats[:failed].empty? ? "" : "\n\nFailed:\n" + f.stats[:failed].map { |s| "   #{s.file_name}: #{s.diff[1]}" }.join
-      summary     = f.stats.map { |key, set| "#{set.length.to_s} #{key}" }.join(", ")
+      summary = f.stats.map { |key, set| "#{set.length.to_s} #{key}" }.join(", ")
 
       "#{f.name}:\n#{summary}#{failed_list}"
     end.join("\n\n")
@@ -19,7 +19,7 @@ class Zucchini::Report
 
   def html
     @html ||= begin
-      template_path = File.expand_path("#{File.dirname(__FILE__)}/report/template.erb")
+      template_path = File.expand_path("#{File.dirname(__FILE__)}/report/template.erb.html")
 
       view = Zucchini::ReportView.new(@features, @ci)
       compiled = (ERB.new(File.open(template_path).read)).result(view.get_binding)
@@ -37,5 +37,4 @@ class Zucchini::Report
   def open; system "open #{@html_path}"; end
 
   def log(buf); puts buf; end
-
 end

data/lib/zucchini/report/css/zucchini.report.css

@@ -0,0 +1,241 @@
+html {
+  font-family: Myriad Pro, sans-serif;
+}
+body {
+  margin: 0;
+}
+tr {
+  text-align: center;
+}
+td {
+  padding: 2px;
+}
+dl {
+  -webkit-margin-before: 0;
+}
+dd {
+  -webkit-margin-start: 0;
+}
+h1 {
+  margin: 16px;
+  font-weight: normal;
+  font-size: 24px;
+}
+h1 .time {
+  margin-left: 10px;
+  opacity: 0.5;
+}
+h3 {
+  margin: 0 0 6px 4px;
+  font-size: 24px;
+  width: 763px;
+  padding: 0;
+  float: left;
+  text-shadow: 1px 1px 1px white;
+}
+.indicators {
+  font-size: 12px;
+  width: 92px;
+  float: left;
+  margin: 5px 28px 5px 0;
+  -webkit-transition: all 0.1s ease-in-out;
+}
+.indicators div {
+  border-radius: 8px;
+  padding: 3px 8px;
+  margin-right: 5px;
+  float: right;
+  color: #FFF;
+  opacity: 0.8;
+  height: 11px;
+  line-height: 11px;
+  font-weight: bold;
+}
+.indicators div:hover {
+  -webkit-transition:opacity 0.3s ease-in-out;
+}
+.indicators .passed {
+  background: #65C400;
+}
+.indicators .failed {
+  background: #C20000;
+}
+.indicators .pending {
+  background: #F9E934;
+  color: #000;
+}
+.feature {
+  padding: 10px 9px 4px 9px;
+  border-radius: 5px;
+  width: 1012px;
+  margin: 15px 15px 24px 15px;
+  box-shadow: 0 0 4px rgba(0,0,0,0.2);
+}
+.ci .feature {
+  display: none;
+}
+.ci .first.feature {
+  display: block;
+}
+.buttons {
+  float: left;
+  width: 125px;
+  display: block;
+}
+.ci .buttons {
+  display: none;
+}
+.buttons a {
+  text-align: center;
+  width: 70px;
+  color: #484848;
+  text-decoration: none;
+  text-shadow: 0 1px 0 white;
+  font: bold 12px Helvetica, Arial, sans-serif;
+  margin-bottom: 6px;
+  line-height: 26px;
+  height: 25px;
+  display: block;
+  float: left;
+  padding: 0 5px;
+  background: -webkit-linear-gradient(top, #F4F4F4, #ECECEC);
+  border: solid 1px #D4D4D4;
+  border-radius: 5px;
+  box-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+  -webkit-transition: border-color .218s;
+  cursor: pointer;
+}
+.buttons a.left {
+  border-radius: 5px 0 0 5px;
+  width: 50px;
+  float: left;
+  margin: 0;
+}
+.buttons a.right {
+  border-radius: 0 5px 5px 0;
+  width: 50px;
+  float: left;
+  position: relative;
+  left: -1px;
+  margin: 0;
+}
+.buttons a:hover {
+    border: solid 1px #7f7f7f;
+    color: #282828;
+    background: -webkit-linear-gradient(top, #ffffff, #dfdfdf);
+}
+.buttons a:active {
+    border: solid 1px #7f7f7f;
+    background: #d0d0d0;
+    background: -webkit-gradient(linear, left top, left bottom, from(#a8a8a8), color-stop(0.15, #c6c6c6), to(#d8d8d8));
+    background: -webkit-linear-gradient(top, #a8a8a8, #c6c6c6 15%, #d8d8d8);
+}
+
+.screen {
+  -webkit-transition:all 0.2s ease-in-out;
+  width: 990px;
+  height: 15px;
+  padding: 5px 0 5px 9px;
+  margin-bottom: 6px;
+  border-radius: 5px;
+  cursor: pointer;
+  overflow: hidden;
+}
+.screen.passed {
+  color: #65C400;
+  background-color: #DBFFB4;
+  border: 1px #65C400 solid;
+  border-left: 10px #65C400 solid;
+}
+.screen.passed img {
+  box-shadow: 0px 0px 4px #65C400;
+}
+.screen.failed {
+  color: #C20000;
+  background-color: #FFD6D6;
+  border: 1px #C20000 solid;
+  border-left: 10px #C20000 solid;
+}
+.screen.failed img {
+  box-shadow: 0px 0px 4px #C20000;
+}
+.screen.pending {
+  color: #F2CF32;
+  background-color: #FFFDBC;
+  border: 1px solid #F9E934;
+  border-left: 10px solid #F9E934;
+}
+.screen.pending img {
+  box-shadow: 0px 0px 4px #F9E934;
+}
+.screen dt {
+  color: #000;
+  font-size: 13px;
+  line-height: 17px;
+  margin: 0;
+  font-weight: normal;
+}
+.ci .screen dt {
+  position: relative;
+  z-index: 2;
+}
+.screen dd {
+  float: left;
+  margin: 0 10px 0 0;
+  -webkit-transition:all 0.3s ease-in-out;
+  opacity: 0;
+  position: relative;
+  top: -30px;
+}
+.screen dd.hidden {
+  visibility: hidden;
+}
+.screen.expanded, .ci .screen {
+  -webkit-transition:all 0.2s ease-in-out;
+  height: 510px;
+}
+.screen.expanded dd, .ci .screen dd {
+  opacity: 1.0;
+  -webkit-transition:all 0.3s ease-in-out;
+}
+.screen p {
+  margin-bottom: -3px;
+  padding: 5px;
+  font-size: 13px;
+  text-align: center;
+  font-weight: bold;
+  background-color: rgba(255, 255, 255, 0.5);;
+  border-radius: 5px;
+  opacity: 0.0;
+  position: relative;
+  z-index: 0;
+}
+.screen dd:hover p {
+  opacity: 1.0;
+}
+.ci .screen dd p {
+  opacity: 1.0;
+  background: transparent;
+}
+.screen img {
+  width: 320px;
+  position: relative;
+}
+.viewport {
+  clear: both;
+}
+.ci .viewport {
+  width: 1018px;
+  height: 530px;
+  overflow: scroll;
+}
+.ci .surface {
+  height: 530px;
+  width: 100000px;
+  position: relative;
+}
+.ci .surface .screen {
+  float: left;
+  margin-right: 10px;
+  position: relative;
+}