goggles 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7191925cf0b72ef1e287a2f9f5d3206c7206763
-  data.tar.gz: af89e5f439fa552780efd31f1aea1a8f19286707
+  metadata.gz: 2a461694240042737a93be6b6431a638bc7add76
+  data.tar.gz: 5651d5328ba134942e7f9e7a5d09a162b954c247
 SHA512:
-  metadata.gz: c4be6b93b9fac5088771f6329143d4b282e5252690929664639f44d6db4938e1204552aaaea93f80ee832abf03ff9e153ca4b043d5e1fd030be00c8cc83a6621
-  data.tar.gz: 17fa964ae31c6a90fed3fcdf6f4bfadf46fe6f6233bf90b59429a9f06695223888f9d0470d121164c88fddd157f3debaa56a2d5bf712f8ecd5607d92e099b0af
+  metadata.gz: 96a924a64413611a034f06bf262ed2f0123810c5b85c2c42b6204e318a5dc5f050320fe9e3dc0482ac277d3b1d6f836483cea151ae80f14cc541363c2910f113
+  data.tar.gz: d9f08ed3a405f18ff049d4491a22b28d6c9e120ff1dc32e2aca34323411f469ffd9ea9bbafa1ca89d66139111cba46e5e672043544c79c2fd8320c736070bba1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.png
+*_data.txt
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+empty_config.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# CHANGELOG
+
+## v0.10.0 (Apr 16, 2015)
+* Throw EmptyDirectoryError on iteration with unconfigured directory setting.
+
+## v0.9.1 (Apr 14, 2015)
+* Add YARD documentation.
+
+## v0.9.0 (Apr 14, 2015)
+* `Goggles.each` accepts Array, Integer, String, and Symbol arguments.
+* Arguments passed to `Goggles.each` extend configured settings instead of replacing them.
+* Add Cucumber tests.
+
+## v0.8.2 (Apr 10, 2015)
+* Fix another typo in the gem description.
+
+## v0.8.1 (Apr 10, 2015)
+* Fix typo in gem description.
+
+## v0.8.0 (Apr 10, 2015)
+* Remove `swim` executable.
+* Remove YAML configuration.
+* Add `Goggles.configure` for configuration through a block (like RSpec).
+* Remove reserved instance variables like `@gg_url`.
+* Scripts are executed via blocks passed to `Goggles.each`. 
+* `Goggles.each` yields a browser instance with the `#grab_screenshot` method.
+* README updates.
+* Add this CHANGELOG.
+
+## v0.1.4 (Jan 28, 2014)
+* Small code enhancements with no user impact.
+
+## v0.1.3 (Jan 23, 2014)
+* Do not delete cookies before each script.
+* Make `@gg_url` variable available to scripts.
+
+## v0.1.2 (Jan 21, 2014)
+* Add diff color configuration setting.
+* Default color setting to blue.
+* Prepend all instance variables with `gg_`.
+
+## v0.1.1 (Jan 20, 2014)
+* Add command line option for generating default project
+
+## v0.1.0 (Jan 20, 2014)
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in goggles.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Johnson Denen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# goggles
+[![Gem Version](https://badge.fury.io/rb/goggles.png)](http://badge.fury.io/rb/goggles)
+[![Build Status](https://travis-ci.org/jdenen/goggles.svg?branch=master)](https://travis-ci.org/jdenen/goggles)
+
+Goggles is a visual testing tool inspired by [wraith](http://github.com/bbc-news/wraith) and powered by [watir-webdriver](http://github.com/watir/watir-webdriver). It compares screenshots of your web applications in different browsers at differents sizes.
+
+## Usage
+
+### Configuration
+
+Configure Goggles with a block passed to the `Goggles.configure` method, which will yield a config object to your block for manipulation. The `directory` setting must be configured for Goggles to work. You'll also need to provide `browsers` and `sizes` that you'd like to compare, but those can be configured with the script.
+
+The `fuzzing` and `color` attributes default to "blue" and "20%" respectively. 
+
+```ruby
+Goggles.configure do |config|
+  config.directory = "/path/to/my/results"
+  config.browsers  = [:chrome, :firefox, :phantomjs]
+  config.sizes     = [1080, 600]
+  config.color     = "red"
+end
+```
+
+### Scripting
+
+Your Scripts are passed to `Goggles.each` as blocks. Goggles will iterate over the block with each combination of browser/browser size configured, and the method will yield a browser object to your script block.
+
+```ruby
+Goggles.each do |browser|
+  browser.goto "http://www.google.com"
+  browser.text_field(id: "lst-ib").value = "Google"
+end
+```
+
+#### Browsers and sizes
+
+You can pass additional browsers or browser sizes to `Goggles.each` as arrays. These arguments extend your configuration for this instance's script block only.
+
+```ruby
+Goggles.configure do |c|
+  c.directory = "/some/directory"
+  c.browsers = [:chrome, :firefox]
+  c.sizes = [1080]
+end
+
+Goggles.each(:phantomjs, 500) do |browser|
+  # Script to be executed with Chrome, Firefox,
+  # and PhantomJS at widths of 1080 and 500.
+end
+
+Goggles.each do |browser|
+  # Script to be executed with Chrome and
+  # Firefox at a width of 1080.
+end
+```
+
+#### Screenshots
+
+Your script blocks should include the `Watir::Browser#grab_screenshot` method, which has been patched onto the browser objects yielded to your blocks. Simply give the method a description argument and the screenshot will be saved to your configured directory.
+
+```ruby
+Goggles.each do |browser|
+  browser.goto "http://www.google.com"
+  browser.grab_screenshot "homepage"
+end
+```
+
+#### Closing the browser
+
+There's no need to explicitly close the browser objects in your script blocks. Goggles will handle that.
+
+#### Results
+
+Screenshots are saved to your configured directory. Screenshot comparison results are saved to a sub-folder based on the screenshot description and browser size. Results include a diff image and data file.
+
+```ruby
+Goggles.configure do |c|
+  c.directory = "/goggles/results"
+  c.browsers  = [:chrome, :firefox, :phantomjs]
+  c.sizes     = [1080, 600]
+end
+
+Goggles.each do |browser|
+  browser.goto "http://www.google.com"
+  browser.grab_screenshot "google"
+end
+```
+
+
+```
+/goggles/results
+ |- google_1080_chrome.png
+ |- google_1080_firefox.png
+ |- google_1080_phantomjs.png
+ |- google_600_chrome.png
+ |- google_600_firefox.png
+ |- google_600_phantomjs.png
+ |- /google_1080
+     |- chrome_firefox_data.txt
+     |- chrome_firefox_diff.png
+     |- chrome_phantomjs_data.txt
+     |- chrome_phantomjs_diff.png
+     |- firefox_phantomjs_data.txt
+     |- firefox_phantomjs_diff.png
+ |- /google_600
+     |- chrome_firefox_data.txt
+     |- chrome_firefox_diff.png
+     |- chrome_phantomjs_data.txt
+     |- chrome_phantomjs_diff.png
+     |- firefox_phantomjs_data.txt
+     |- firefox_phantomjs_diff.png
+```
+
+## Road to 1.0.0
+
+I've made a lot of changes recently and bumped the version up to 0.9.1. Check the [CHANGELOG](CHANGELOG.md) for more information about those changes.
+
+### v1.0.0
+
+* Documentation
+* Examples
+* TravisCI integration for specs (but not features)
+
+## Installation
+
+Install ImageMagick:
+
+* OSX: `$ brew install imagemagick`
+* Ubuntu: `$ sudo apt-get install imagemagick`
+* Windows: [Download](http://www.imagemagick.org/script/binary-releases.php#windows) installer and add to your PATH.
+
+Add this line to your application's Gemfile:
+
+    gem 'goggles'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install goggles
+
+## Contributing
+
+1. Fork it ( http://github.com/jdenen/goggles/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Questions, Comments, Concerns
+Find me on Twitter ([@jpdenen](http://twitter.com/jpdenen)) or write up an issue.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :spec do
+  sh "bundle exec rspec spec"
+end
+
+task :feature do
+  sh "bundle exec cucumber"
+end

data/features/goggles.feature

@@ -0,0 +1,23 @@
+Feature: Screenshot comparison
+  As a software professional
+  I want to automate the collection and comparison of screenshots on my application
+  So I can efficiently assess visual regression
+
+  Background:
+    Given I have configured Goggles with a valid directory
+    Given I have configured Goggles for browsers at 1080 width
+
+  Scenario: Compare screenshots in two browsers at one size
+    When I use "repo" to describe my screenshot of "github.com/jdenen/goggles"
+    Then file "repo_1080/chrome_firefox_diff.png" exists
+    And file "repo_1080/chrome_firefox_data.txt" exists
+
+  Scenario: Extending a script with more browsers and sizes
+    When I extend configuration with arguments "phantomjs, 500"
+    And I use "search" to describe my screenshot of "google.com"
+    Then file "search_1080/chrome_firefox_diff.png" exists
+    And file "search_1080/chrome_firefox_data.txt" exists
+    And file "search_1080/chrome_phantomjs_diff.png" exists
+    And file "search_1080/chrome_phantomjs_data.txt" exists
+    And file "search_1080/firefox_phantomjs_diff.png" exists
+    And file "search_1080/firefox_phantomjs_data.txt" exists

data/features/step_definitions/goggles_steps.rb

@@ -0,0 +1,27 @@
+Given /^I have configured Goggles with a valid directory$/ do
+  @results = Pathname.new("./results").realdirpath.to_s 
+  Goggles.configure { |c| c.directory = @results }
+end
+
+Given /^I have configured Goggles for browsers at (\d+) width$/ do |width| 
+  Goggles.configure do |c|
+    c.browsers = [:chrome, :firefox]
+    c.sizes    = [width]
+  end
+end
+
+When /^I extend configuration with arguments "(.*)"$/ do |args|
+  @args = args.split(/,/).map(&:strip)
+end
+
+When /^I use "(.*)" to describe my screenshot of "(.*)"$/ do |desc, site|
+  Goggles.each(@args) do |browser|
+    browser.goto "http://#{site}"
+    browser.grab_screenshot desc
+  end
+end
+
+Then /^file "(.*)" exists$/ do |file|
+  filepath = "#{@results}/#{file}"
+  File.exists? filepath
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require "goggles"
+
+After do
+  FileUtils.rm_rf @results
+end

data/goggles.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goggles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goggles"
+  spec.version       = Goggles::VERSION
+  spec.authors       = ["Johnson Denen"]
+  spec.email         = ["johnson.denen@gmail.com"]
+  spec.summary       = %q{Compare screenshots in different browsers at different sizes}
+  spec.description   = %q{Compare screenshots in different browsers at different sizes}
+  spec.homepage      = "http://github.com/jdenen/goggles"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "yard"
+
+  spec.add_runtime_dependency "watir-webdriver"
+  spec.add_runtime_dependency "image_size"
+end

data/lib/goggles.rb

@@ -0,0 +1,62 @@
+require "goggles/configuration"
+require "goggles/comparison"
+require "goggles/iteration"
+
+module Goggles
+  extend self
+
+  #
+  # Raise when the configuration attribute is unconfigured at runtime.
+  #
+  class EmptyDirectoryError < StandardError; end
+
+  #
+  # Yields the global configuration object to a block.
+  #
+  # @yield  [Goggles::Configuration] global configuration
+  # @return [Goggles::Configuration] global configuration
+  #
+  def configure &block
+    configuration.tap { |conf| yield conf }
+  end
+
+  #
+  # Creates an Iteration object for each combination of browser and width derived from global
+  #  configuration and given arguments. 
+  #
+  # @param instance [Array<String,Fixnum,Symbol>, String, Fixnum, Symbol] configuration extension
+  # @return [Goggles::Comparison]
+  # @see Goggles::Iteration
+  #
+  def each *instance, &block
+    validate_directory_setting
+    args = instance.flatten.map(&:to_s)
+    
+    sizes = configuration.sizes + args.grep(/\d+/).map(&:to_i)
+    browsers = configuration.browsers + args.grep(/[^\d+]/).map(&:to_sym)
+    
+    browsers.product(sizes).each do |browser, size|
+      Iteration.new browser, size, configuration, &block 
+    end
+    
+    Comparison.new(configuration).tap { |comparison| comparison.make! }
+  end
+
+  private
+
+  #
+  # @api private
+  #
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  #
+  # @api private
+  #
+  def validate_directory_setting
+    message = "Expected configured directory setting, got: #{configuration.directory}"
+    raise EmptyDirectoryError, message if configuration.directory.nil?
+    raise EmptyDirectoryError, message if configuration.directory.empty?
+  end
+end

data/lib/goggles/comparison.rb

@@ -0,0 +1,186 @@
+require "image_size"
+
+module Goggles
+
+  #
+  # Generates a diff image and data file from two images.
+  #
+  # Results are saved to a new directory derived from the configured directory setting,
+  #  a description given to `Watir::Browser.grab_screenshot`, browser size, and the
+  #  browsers used to take the screenshots.
+  #
+  # @example Results
+  #     Goggles.configure do |c|
+  #       c.directory = "/path/results"
+  #       c.browsers = [:chrome, :firefox]
+  #       c.sizes = [100]
+  #     end
+  #
+  #     Goggles.each do |b|
+  #       b.goto "www.google.com"
+  #       b.grab_screenshot "search"
+  #     end
+  #
+  #     #=> /path/results
+  #     #   |- /search_100
+  #     #    |- chrome_firefox_data.txt
+  #     #    |- chrome_firefox_diff.png
+  #
+  class Comparison
+    attr_reader :directory, :fuzzing, :color, :groups, :results_dir
+    
+    def initialize config
+      @directory = config.directory
+      @fuzzing   = config.fuzzing
+      @color     = config.color
+      @groups    = config.groups
+    end
+
+    #
+    # Sizes and compare screenshots.
+    #
+    # @return [nil]
+    #
+    def make!
+      cut_to_common_size
+      highlight_differences
+    end
+
+    #
+    # Sizes comparable screenshots to a common height and width.
+    #
+    # @return [nil]
+    #
+    def cut_to_common_size
+      groups.each_with_object([]) do |group, sizes|
+        collection = find_comparable group
+        
+        collection.each do |img|
+          File.open(img, 'rb'){ |file| sizes << read_size(file) }
+        end
+
+        cut! collection, sizes
+      end
+    end
+
+    #
+    # Generates diff images for comparable screenshots.
+    #
+    # @return [nil]
+    #
+    def highlight_differences
+      groups.each do |desc|
+        ensure_result_directory desc
+        find_comparable(desc).combination(2).to_a.each { |imgs| diff imgs[0], imgs[1]  }
+      end
+    end
+
+    #
+    # Finds comparable screenshots for sizing and comparing.
+    #
+    # @param description [String] screenshot description
+    # @return [Array<String>] paths to comparable screenshots
+    #
+    def find_comparable description
+      Dir.glob("#{directory}/*.png").grep(/#{description}_/).sort
+    end
+
+    #
+    # Finds the smallest first element for all arrays in the given array. This is 
+    #  the screenshot width attribute. Used for resizing.
+    #
+    # @param array [Array<Array>] collection of screenshot sizes
+    # @return [Fixnum] smallest width
+    #
+    def find_common_width array
+      array.collect(&:first).sort.first
+    end
+
+    #
+    # Finds the smallest second element for all arrays in the given array. This is
+    #  the screenshot height attribute. Used for resizing.
+    #
+    # @param array [Array<Array>] collection of screenshot sizes
+    # @return [Fixnum] smallest screenshot height
+    #
+    def find_common_height array
+      array.collect(&:last).sort.first
+    end
+
+    private
+
+    attr_writer :results_dir
+
+    #
+    # @api private
+    #
+    # Cuts comparable screenshots to smallest width by smallest height with ImageMagick.
+    #
+    # @param images [Array<String>] comparable screenshots
+    # @param sizes  [Array<Fixnum>] sizes (width, height) of comparable screenshots
+    # @return [nil]
+    #
+    def cut! images, sizes
+      w = find_common_width sizes
+      h = find_common_height sizes
+      images.each { |img| `convert #{img} -background none -extent #{w}x#{h} #{img}` }
+    end
+
+    #
+    # @api private
+    #
+    # Generates comparison data for two screenshots with ImageMagick.
+    #
+    # @param img_one [String] first screenshot path
+    # @param img_two [String] second screenshot path
+    # @return [nil]
+    #
+    def diff img_one, img_two
+      b1 = diffed img_one
+      b2 = diffed img_two
+      
+      fuzz = "#{results_dir}/#{b1}_#{b2}_diff.png"
+      data = "#{results_dir}/#{b1}_#{b2}_data.txt"
+      
+      `compare -fuzz #{fuzzing} -metric AE -highlight-color #{color} #{img_one} #{img_two} #{fuzz} 2>#{data}`
+    end
+
+    #
+    # @api private
+    #
+    # Parses a browser from a screenshot filepath.
+    #
+    # @param img [String] screenshot path
+    # @return [String] browser
+    #
+    def diffed img
+      File.basename(img).match(/\d+_(.*)\.png/)[1]
+    end
+
+    #
+    # @api private
+    #
+    # Finds the width and height of an image.
+    #
+    # @param file [File] image
+    # @return [Array<Fixnum>] width and height
+    #
+    def read_size file
+      ImageSize.new(file.read).size
+    end
+
+    #
+    # @api private
+    #
+    # Ensures the results directory for comparable screenshots exists.
+    #
+    # @param description [String] screenshot description
+    # @return [nil]
+    #
+    def ensure_result_directory description
+      self.results_dir = "#{directory}/#{description}"
+      FileUtils.rm_rf   results_dir
+      FileUtils.mkdir_p results_dir
+    end
+  end
+end

data/lib/goggles/configuration.rb

@@ -0,0 +1,37 @@
+module Goggles
+
+  #
+  # Stores configuration information for runtime.
+  #
+  # The `directory` setting +must+ be configured.
+  #
+  # The `browsers` and `sizes` settings can be extended through `Goggles.each` as arguments.
+  # 
+  # @see Goggles.each
+  # @see Goggles.configure
+  #
+  class Configuration
+    attr_accessor :browsers, :sizes, :fuzzing, :color, :groups
+    attr_reader :directory
+
+    def initialize
+      @browsers  = []
+      @sizes     = []
+      @groups    = []
+      @directory = ""
+      @color     = "blue"
+      @fuzzing   = "20%"
+    end
+
+    #
+    # Ensures the configured path exists, but otherwise acts as a normal
+    #  attr_accessor. Path argument must be an absolute path.
+    #
+    # @param path [String] directory path
+    #
+    def directory=(path)
+      @directory = path
+      FileUtils.mkdir_p path unless path.nil? or path.empty?
+    end
+  end
+end

data/lib/goggles/iteration.rb

@@ -0,0 +1,64 @@
+require "watir-webdriver"
+
+module Watir
+  class Browser
+    attr_accessor :goggles, :iteration
+
+    #
+    # Saves a screenshot as "given-description_width.png" in the configured results
+    #  directory.
+    #
+    # @param name [String] screenshot description
+    # @return [nil]
+    #
+    def grab_screenshot name
+      description = "#{name}_#{iteration.size}"
+      goggles.groups << description unless goggles.groups.include? description
+      screenshot.save "#{goggles.directory}/#{description}_#{iteration.browser_name}.png"
+    end
+  end
+end
+
+module Goggles
+
+  #
+  # Executes the block passed to `Goggles.each` with every configured combination of browser
+  #  and browser size. 
+  #
+  # @see Goggles.each
+  #
+  class Iteration
+    attr_reader :browser, :browser_name, :size, :config
+
+    #
+    # Creates a script iteration instance, building yielded browser object from the
+    #  given arguments. Closes the browser instance after yielding to the block.
+    #
+    # @param driver [String, Symbol] browser name
+    # @param width  [Fixnum] browser width
+    # @param config [Goggles::Configuration] global configuration
+    # @yield [Watir::Browser] browser object
+    #
+    def initialize driver, width, config, &block
+      @browser_name = driver
+      @config       = config
+      @size         = width
+      build_browser
+      yield browser
+      browser.close
+    end
+
+    private
+
+    #
+    # @api private
+    #
+    def build_browser
+      @browser = Watir::Browser.new(browser_name).tap do |engine|
+        engine.goggles   = config
+        engine.iteration = self
+        engine.driver.manage.window.resize_to size, 768
+      end
+    end
+  end
+end

data/lib/goggles/version.rb

@@ -0,0 +1,3 @@
+module Goggles
+  VERSION = "0.10.0"
+end

data/spec/goggles/comparison_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe Goggles::Comparison do
+  let(:config){ instance_double "configuration" }
+  let(:comparison){ Goggles::Comparison.new config }
+
+  before do
+    allow(config).to receive_messages(
+                       directory: "dir",
+                       fuzzing: "20%",
+                       color: "blue",
+                       groups: [1])
+  end
+
+  it "reads attributes from a given configuration object" do
+    expect(config).to receive(:directory)
+    expect(config).to receive(:fuzzing)
+    expect(config).to receive(:color)
+    Goggles::Comparison.new config
+  end
+  
+  describe "#make!" do
+    it "cuts images and highlights their differences" do
+      expect(comparison).to receive(:cut_to_common_size)
+      expect(comparison).to receive(:highlight_differences)
+      comparison.make!
+    end
+  end
+
+  describe "#cut_to_common_size" do
+    it "iterates over screenshot descriptions" do
+      groups = instance_double "[groups]"
+      expect(comparison).to receive(:groups).and_return groups
+      expect(groups).to receive(:each_with_object).with([])
+      comparison.cut_to_common_size
+    end
+
+    it "collects comparable screenshots" do
+      expect(comparison).to receive(:groups).and_return [1, 2]
+      expect(comparison).to receive(:find_comparable).with(1).and_return([])
+      expect(comparison).to receive(:find_comparable).with(2).and_return([])
+      comparison.cut_to_common_size
+    end
+
+    context "with collection of comparable screenshots" do
+      it "iterates over the collection" do
+        screens = instance_double "[screenshots]"
+        expect(comparison).to receive(:groups).and_return ["foo"]
+        expect(comparison).to receive(:find_comparable).and_return screens
+        expect(screens).to receive(:each)
+        expect(comparison).to receive(:cut!).with(screens, [])
+        comparison.cut_to_common_size
+      end
+    end
+
+    context "while iterating over collected comparable images" do
+      it "opens each image in binary mode" do
+        expect(comparison).to receive(:find_comparable).and_return [:foo]
+        expect(File).to receive(:open).with(:foo, 'rb')
+        expect(comparison).to receive(:cut!)
+        comparison.cut_to_common_size
+      end
+    end
+  end
+
+  describe "#highlight_differences" do
+    it "diffs every combination of comparable screenshots" do
+      images = ["foo_1.png", "foo_2.png", "foo_3.png"]
+      expect(comparison).to receive(:groups).and_return ["foo"]
+      expect(comparison).to receive(:find_comparable).with("foo").and_return images
+      images.combination(2).to_a.each do |i|
+        expect(comparison).to receive(:diff).with i[0], i[1]
+      end
+      comparison.highlight_differences
+    end
+  end
+
+  describe "#find_comparable" do
+    it "returns an array of file paths" do
+      array = ["/foo_chrome.png", "/bar_chrome.png", "/foo_ff.png", "/bar_ff.png"]
+      expect(Dir).to receive(:glob).and_return array
+      expect(comparison.find_comparable "foo").to eq ["/foo_chrome.png", "/foo_ff.png"]
+    end
+  end
+
+  describe "#find_common_width" do
+    it "returns the smallest number from first items in an array of arrays" do
+      arrays = [[100,40], [68,300], [104,98]]
+      expect(comparison.find_common_width arrays).to eq 68
+    end
+  end
+
+  describe "#find_common_height" do
+    it "returns the smallest number from second items in an array of arrays" do
+      arrays = [[100,40], [68,300], [104,98]]
+      expect(comparison.find_common_height arrays).to eq 40
+    end
+  end
+end

data/spec/goggles/configuration_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe Goggles::Configuration do
+  let(:config) { Goggles::Configuration.new }
+
+  it "has attributes by default" do
+    expect(config).to have_attributes(
+                        :browsers  => [],
+                        :sizes     => [],
+                        :groups    => [],
+                        :directory => "",
+                        :color     => "blue",
+                        :fuzzing   => "20%"
+                      )
+  end
+
+  it "has attributes that can be set" do
+    config.browsers << "chrome"
+    config.sizes << 100
+    config.groups << "foo"
+    config.color = "red"
+    config.fuzzing = "10%"
+
+    expect(config).to have_attributes(
+                        :browsers  => ["chrome"],
+                        :sizes     => [100],
+                        :groups    => ["foo"],
+                        :color     => "red",
+                        :fuzzing   => "10%"
+                      )
+  end
+
+  describe "#directory=" do
+    it "ensures the directory exists" do
+      expect(FileUtils).to receive(:mkdir_p).with "/foo/bar"
+      config.directory = "/foo/bar"
+      expect(config.directory).to eq "/foo/bar"
+    end
+
+    context "when attribute is empty" do
+      it "does not create the directory" do
+        expect(FileUtils).to_not receive(:mkdir_p)
+        config.directory = ""
+      end
+    end
+
+    context "when attribute is nil" do
+      it "does not create the directory" do
+        expect(FileUtils).to_not receive(:mkdir_p)
+        config.directory = nil
+      end
+    end
+  end
+end

data/spec/goggles/iteration_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Goggles::Iteration do
+  let(:watir) { instance_double("browser") }
+
+  before do
+    allow(watir).to receive_messages(
+                      :driver => watir,
+                      :manage => watir,
+                      :window => watir,
+                      :goggles= => nil,
+                      :iteration= => nil,
+                      :resize_to => nil,
+                      :close => nil)
+  end
+
+  it "yields an instantiated browser" do
+    expect(Watir::Browser).to receive(:new).and_return watir
+    expect { |b| Goggles::Iteration.new "", "", "", &b }.to yield_with_args watir
+  end
+
+  it "yields the browser based on the browser_name attribute" do
+    expect(Watir::Browser).to receive(:new).with(:foo).and_return watir
+    Goggles::Iteration.new(:foo, "", ""){ "bar" }
+  end
+
+  it "resizes the browser based on the size attribute" do
+    expect(Watir::Browser).to receive(:new).with(:foo).and_return watir
+    expect(watir).to receive(:resize_to).with(500, 768)
+    Goggles::Iteration.new(:foo, 500, ""){ "bar" }
+  end
+end

data/spec/goggles_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+
+describe Goggles do
+  before { allow(FileUtils).to receive(:mkdir_p) }
+  
+  describe ".configure" do
+    it "yields a configuration object" do
+      expect { |b| Goggles.configure &b }.to yield_with_args Goggles::Configuration
+    end
+
+    it "returns a configuration object" do
+      expect(Goggles.configure { "foo" }).to be_a Goggles::Configuration
+    end
+
+    it "memoizes the configuration object" do
+      expect(Goggles.configure { "foo" }).to equal Goggles.configure { "bar" }
+    end
+  end
+
+  describe ".each" do
+    let(:config) do
+      Goggles.configure do |conf|
+        conf.browsers = [:foo]
+        conf.sizes    = [500]
+      end
+    end
+
+    before do
+      allow(config).to receive_messages(directory: "/dir", fuzzing: "20%", color: "blue", groups: [])
+    end
+    
+    it "passes browser, width, and configuration to an iteration object" do
+      expect(Goggles::Iteration).to receive(:new).with(:foo, 500, config)
+      Goggles.each { "foo" }
+    end
+
+    context "when directory setting is nil" do
+      it "throws an EmptyDirectoryError" do
+        allow(config).to receive(:directory).and_return(nil)
+        expect do
+          Goggles.each { "foo" }
+        end.to raise_error(Goggles::EmptyDirectoryError)
+      end
+    end
+
+    context "when directory setting is empty" do
+      it "throws an EmptyDirectoryError" do
+        allow(config).to receive(:directory).and_return("")
+        expect do
+          Goggles.each { "foo" }
+        end.to raise_error(Goggles::EmptyDirectoryError)
+      end
+    end
+
+    context "when given a browser argument" do
+      it "extends the configured browser list with the given browser" do
+        expect(Goggles::Iteration).to receive(:new).with(:foo, 500, config)
+        expect(Goggles::Iteration).to receive(:new).with(:bar, 500, config)
+        Goggles.each(:bar) { "foo" }
+      end
+    end
+
+    context "when given a size argument" do
+      it "extends the configured size list with the given size" do
+        expect(Goggles::Iteration).to receive(:new).with(:foo, 500, config)
+        expect(Goggles::Iteration).to receive(:new).with(:foo, 250, config)
+        Goggles.each(250) { "foo" }
+      end      
+    end
+
+    context "when given multiple browser and size arguments" do
+      it "extends the configuration with correctly" do
+        [:foo, :bar, :baz].product([500, 1000, 250]).each do |b, s|
+          expect(Goggles::Iteration).to receive(:new).with(b, s, config)
+        end
+        Goggles.each(:bar, :baz, 1000, 250) { "foo" }
+      end
+
+      context "in no particular order" do
+        it "extends the configuration with the correct arguments" do
+          [:foo, :bar, :baz].product([500, 1000, 250]).each do |b, s|
+            expect(Goggles::Iteration).to receive(:new).with(b, s, config)
+          end
+          Goggles.each(1000, :bar, :baz, 250) { "foo" }
+        end
+      end
+    end
+
+    context "when given arguments in arrays" do
+      it "extends the configuration correctly" do
+        [:foo, :bar, :baz].product([500, 1000, 250]).each do |b, s|
+          expect(Goggles::Iteration).to receive(:new).with(b, s, config)
+        end
+        Goggles.each([:bar, :baz], [250, 1000]) { "foo" }
+      end
+    end
+
+    context "when given arguments of various classes" do
+      it "extends the configuration correctly" do
+        [:foo, :bar, :baz].product([500, 1000, 250]).each do |b, s|
+          expect(Goggles::Iteration).to receive(:new).with(b, s, config)
+        end
+        Goggles.each([:bar, "baz"], 250, "1000") { "foo" }
+      end
+    end
+    
+    it "returns a comparison object" do
+      expect(Goggles::Iteration).to receive(:new).with(:foo, 500, config)
+      expect(Goggles.each { "foo" }).to be_a Goggles::Comparison
+    end
+
+    context "when configured for browsers at one size" do
+      it "creates an iteration for each browser with the width" do
+        config.browsers << :bar
+        [:foo, :bar].each { |browser| expect(Goggles::Iteration).to receive(:new).with browser, 500, config }
+        Goggles.each { "foo" }
+      end
+    end
+
+    context "when configured for browsers at different sizes" do
+      it "creates an iteration for every browser and width combination" do
+        config.browsers << :bar
+        config.sizes << 1000
+
+        [:foo, :bar].product([500, 1000]).each do |browser, width|
+          expect(Goggles::Iteration).to receive(:new).with browser, width, Object
+        end
+
+        Goggles.each { "foo" }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "goggles"
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goggles
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Johnson Denen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,28 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/goggles.feature
+- features/step_definitions/goggles_steps.rb
+- features/support/env.rb
+- goggles.gemspec
+- lib/goggles.rb
+- lib/goggles/comparison.rb
+- lib/goggles/configuration.rb
+- lib/goggles/iteration.rb
+- lib/goggles/version.rb
+- spec/goggles/comparison_spec.rb
+- spec/goggles/configuration_spec.rb
+- spec/goggles/iteration_spec.rb
+- spec/goggles_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/jdenen/goggles
 licenses:
 - MIT
@@ -139,5 +160,13 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Compare screenshots in different browsers at different sizes
-test_files: []
+test_files:
+- features/goggles.feature
+- features/step_definitions/goggles_steps.rb
+- features/support/env.rb
+- spec/goggles/comparison_spec.rb
+- spec/goggles/configuration_spec.rb
+- spec/goggles/iteration_spec.rb
+- spec/goggles_spec.rb
+- spec/spec_helper.rb
 has_rdoc: