goggles 0.1.4 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bd05fb9c67d3e55a5bb2d9a3c26d5c1ddd96636
+  data.tar.gz: 594c499843796017d18ca8d75588edc6ea3b7a8e
+SHA512:
+  metadata.gz: ead73b5e863e59e3fefcad08225f1b144a6e7a7572902c333ff1ce7774041d24c7eecbb202ba933b3dff7a212e5aaa19b58d84f66712a75ab1fc687c6e6935d1
+  data.tar.gz: 616fddeeddf282c24a3ad9eeebfeb1cb8c82f1e79b4656360b8a68bdaa2357c8b996e148c2ca41ecef625bb54a3aa6eb8c93b8ede4d5b8aaf318a9777f291b70

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# CHANGELOG
+
+## 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/README.md

@@ -1,98 +1,149 @@
 # goggles
 [![Gem Version](https://badge.fury.io/rb/goggles.png)](http://badge.fury.io/rb/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 allows you to compare screenshots of your web application in different browsers, and you can execute Ruby scripts to setup as many screenshots as you need.
+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.
 
-## Installation
+## Usage
 
-Install ImageMagick:
+### Configuration
 
-* OSX: `$ brew install imagemagick`
-* Linux: `$ sudo apt-get install imagemagick`
-* Windows: [Download](http://www.imagemagick.org/script/binary-releases.php#windows) installer and add to your PATH.
+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.
 
-Add this line to your application's Gemfile:
+The `fuzzing` and `color` attributes default to "blue" and "20%" respectively. 
 
-    gem 'goggles'
+```ruby
+Goggles.configure do |config|
+  config.directory = "/path/to/my/results"
+  config.browsers  = [:chrome, :firefox, :phantomjs]
+  config.sizes     = [1080, 600]
+  config.color     = "red"
+end
+```
 
-And then execute:
+### Scripting
 
-    $ bundle
+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.
 
-Or install it yourself with:
+```ruby
+Goggles.each do |browser|
+  browser.goto "http://www.google.com"
+  browser.text_field(id: "lst-ib").value = "Google"
+end
+```
 
-    $ gem install goggles
+#### Browsers and sizes
 
-## Usage
+You can pass additional browsers or browser sizes to `Goggles.each` as arrays. With version 0.8.0, these arguments will overwrite what you've configured through `Goggles.configure`.
+
+```ruby
+Goggles.each([:chrome, :firefox], [1080]) do |browser|
+  # ...
+end
+```
 
-Generate a config file with `swim --init` to point goggles in the right direction.
+**TODO**
 
-    $ swim -i /home/configs/config.yaml
+Before the 1.0.0 release, these arguments will act as additonal browsers/sizes to script against. That way, the base configuration can be extended for particular script instances.
 
-``` yaml
-# config.yaml
-# Directory where you want to store your results. Required.
-results_directory: "/home/example/results"
+#### Screenshots
 
-# Directory where you're storing your scripts. Optional.
-scripts_directory: "/home/example/scripts"
+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.
 
-# Scripts to execute in the scripts directory. Optional.
-scripts_to_execute:
-  - "first_script.rb"
-  - "second_script.rb"
+```ruby
+Goggles.each do |browser|
+  browser.goto "http://www.google.com"
+  browser.grab_screenshot "homepage"
+end
+```
 
-# Domain to test. Required.
-domain_under_test: "http://www.google.com"
+#### Closing the browser
 
-# Paths to pages you want to test. Label them with a page name. Required.
-paths_to_capture: 
-  home: "/"
-  gmail: "/gmail"
+There's no need to explicitly close the browser objects in your script blocks. Goggles will handle that.
 
-# Browsers you want to compare. Cannot specify more than two (yet). Required.
-browsers:
-  - "chrome"
-  - "firefox"
+#### Results
 
-# Widths at which you would like screenshots compared. All screenshots will be taken at a height of 768. Required.
-browser_widths:
-  - 1024
+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.
 
-# Fuzzing percentage. Play around with this to find the right fit. Required.
-image_fuzzing: "20%"
+```ruby
+Goggles.configure do |c|
+  c.directory = "/goggles/results"
+  c.browsers  = [:chrome, :firefox, :phantomjs]
+  c.sizes     = [1080, 600]
+end
 
-# Color for diffing images. Defaults to blue. Optional.
-diff_color: "blue"
+Goggles.each do |browser|
+  browser.goto "http://www.google.com"
+  browser.grab_screenshot "google"
+end
 ```
 
-If you pass scripts to goggles as part of your testing, you **must** specify when screenshots should be taken with the `#grab_screenshot` method. If you do not specify scripts in configuration, goggles will open each of your paths and take a screenshot.
 
-NOTE: I've tried to keep variable names as unlikely to interrupt your code as possible, but `@watir` is reserved for the browser instance currently executing scripts.
+```
+/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
+```
 
-``` ruby
-# script_to_execute.rb
-require 'goggles'
-@watir.cookies.add("cookie_name", "cookie_value")
+## Road to 1.0.0
 
-# Pass a short description to the method for naming the resultant screenshot
-Goggles.grab_screenshot("with_cookie_set")
-```
+I've made a lot of changes recently and bumped the version up to 0.8.0. Check the [/CHANGELOG.md](changelog) for more information about those changes.
+
+### v0.9.0
 
-Execute a goggles test through the command line with `swim --config CONFIG_FILE` or use `swim --help` to see command options.
+* Browser/size arguments against `Goggles.each` extend configuration instead of overwriting it.
+* End-to-end Cucumber tests
 
-    $ swim -c config.yml
+### 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. Code until specs pass (`rspec`)*
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
-
-\*Chrome and [ChromeDriver](http://code.google.com/p/selenium/wiki/ChromeDriver) are required to pass specs. Download the latest version and add it to your PATH before running `rspec`.
+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
-Easiest place to reach me is Twitter, [@jpdenen](http://twitter.com/jpdenen)
+Find me on Twitter ([@jpdenen](http://twitter.com/jpdenen)) or write up an issue.

data/goggles.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name          = "goggles"
   spec.version       = Goggles::VERSION
   spec.authors       = ["Johnson Denen"]
-  spec.email         = ["jdenen@manta.com"]
-  spec.summary       = %q{comparing responsive screenshots under watir-webdriver}
-  spec.description   = %q{comparing responsive screenshots under watir-webdriver}
+  spec.email         = ["johnson.denen@gmail.com"]
+  spec.summary       = %q{Compare screenshots in different browers at differnt sizes}
+  spec.description   = %q{Compare screenshots in different browers at differnt sizes}
   spec.homepage      = "http://github.com/jdenen/goggles"
   spec.license       = "MIT"
 
@@ -23,6 +23,4 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "watir-webdriver"
   spec.add_runtime_dependency "image_size"
-
-  spec.executables << "swim"
 end

data/lib/goggles.rb

@@ -1,81 +1,28 @@
-require "goggles/version"
+require "goggles/configuration"
 require "goggles/comparison"
-require "goggles/error"
-
-require "watir-webdriver"
-require "yaml"
-require "fileutils"
+require "goggles/iteration"
 
 module Goggles
   extend self
-
-  def swim(config_path)
-    conf = YAML::load(File.open(config_path))
-
-    @gg_result_dir = conf['results_directory']
-    @gg_script_dir = conf['scripts_directory']
-    @gg_domain = conf['domain_under_test']
-    @gg_paths = conf['paths_to_capture']
-    @gg_scripts = conf['scripts_to_execute']
-    @gg_platforms = conf['browsers']
-    @gg_widths = conf['browser_widths']
-    @gg_fuzz = conf['image_fuzzing']
-    @gg_color = conf['diff_color'] || 'blue'
-
-    embark!
-    diff_images
+  
+  def configure &block
+    configuration.tap { |conf| yield conf }
   end
 
-  def grab_screenshot(detail)
-    make_result_dir
-
-    image_dir = "#{@gg_result_dir}/#{@gg_label}"
-    image_name = "#{detail}_#{@gg_size}_#{@gg_browser}"
-
-    @watir.screenshot.save "#{image_dir}/#{image_name}.png"
-  end
-
-  private
-
-  def embark!
-    ensure_fresh_start
+  def each browsers = nil, sizes = nil, &block
+    browsers ||= configuration.browsers
+    sizes    ||= configuration.sizes
     
-    @gg_widths.each do |size|
-      @gg_size = size.to_i
-
-      @gg_platforms.each do |pf|
-        @gg_browser = pf
-        
-        @watir = Watir::Browser.new pf.to_sym
-        @watir.driver.manage.window.resize_to(@gg_size, 768)
-
-        @gg_paths.each do |label, path|
-          @gg_label = label
-          @gg_url = "#{@gg_domain}#{path}"
-
-          if @gg_scripts.nil?
-            @watir.goto @gg_url
-            grab_screenshot("screenshot")
-          else
-            @gg_scripts.each do |script|
-              script = "#{@gg_script_dir}/#{script}"
-              @watir.goto @gg_url
-              eval(File.read(script))
-            end
-          end
-        end
-
-        @watir.close
-      end
+    browsers.product(sizes).each do |browser, size|
+      Iteration.new browser, size, configuration, &block 
     end
+    
+    Comparison.new(configuration).tap { |comparison| comparison.make! }
   end
 
-  def ensure_fresh_start
-    FileUtils.rm_rf("#{@gg_result_dir}")
-  end
+  private
 
-  def make_result_dir
-    FileUtils.mkdir_p("#{@gg_result_dir}/#{@gg_label}")
+  def configuration
+    @configuration ||= Configuration.new
   end
-
 end

data/lib/goggles/comparison.rb

@@ -1,50 +1,84 @@
 require "image_size"
 
 module Goggles
+  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
+    
+    def make!
+      cut_to_common_size
+      highlight_differences
+    end
+    
+    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
 
-  def diff_images
-    images = Dir.glob("#{@gg_result_dir}/*/*.png").sort
-    raise Goggles::EmptyResultError, "No screenshots found in results directory: #{@gg_result_dir}" if images.empty?
-
-    size_to_smallest!
+        cut! collection, sizes
+      end
+    end
 
-    until images.empty?
-      one = images.slice!(0)
-      two = images.slice!(0)
+    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
 
-      out_path = one.gsub(/[^_]*$/, '')
+    def find_comparable description
+      Dir.glob("#{directory}/*.png").grep(/#{description}_/).sort
+    end
 
-      diff_out = "#{out_path}diff.png"
-      data_out = "#{out_path}data.txt"
+    def find_common_width array
+      array.collect(&:first).sort.first
+    end
 
-      `compare -fuzz #{@gg_fuzz} -metric AE -highlight-color #{@gg_color} #{one} #{two} #{diff_out} 2>#{data_out}`
+    def find_common_height array
+      array.collect(&:last).sort.first
     end
-  end
 
-  def size_to_smallest!
-    images = Dir.glob("#{@gg_result_dir}/*/*.png").sort
+    private
 
-    until images.empty?
-      pair = images.slice!(0..1)
-      widths = []
-      heights = []
+    attr_writer :results_dir
 
-      File.open(pair[0], 'rb') do |one|
-        size = ImageSize.new(one.read).size
-        widths << size[0]
-        heights << size[1]
+    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
 
-        File.open(pair[1], 'rb') do |two|
-          size = ImageSize.new(two.read).size
-          widths << size[0]
-          heights << size[1]
+    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
 
-          pair.each do |file|
-            `convert #{file} -background none -extent #{widths.sort[0]}x#{heights.sort[0]} #{file}`
-          end
-        end
-      end
+    def diffed img
+      File.basename(img).match(/\d+_(.*)\.png/)[1]
+    end
+
+    def read_size file
+      ImageSize.new(file.read).size
     end
-  end
 
+    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,20 @@
+module Goggles
+  class Configuration
+    attr_accessor :browsers, :sizes, :fuzzing, :color, :groups
+    attr_reader :directory
+
+    def initialize
+      @browsers  = []
+      @sizes     = []
+      @groups    = []
+      @directory = ""
+      @color     = "blue"
+      @fuzzing   = "20%"
+    end
+
+    def directory=(path)
+      @directory = path
+      FileUtils.mkdir_p path unless path.empty?
+    end
+  end
+end

data/lib/goggles/iteration.rb

@@ -0,0 +1,38 @@
+require "watir-webdriver"
+
+module Watir
+  class Browser
+    attr_accessor :goggles, :iteration
+
+    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
+  class Iteration
+    attr_reader :browser, :browser_name, :size, :config
+    
+    def initialize driver, width, config, &block
+      @browser_name = driver
+      @config       = config
+      @size         = width
+      build_browser
+      yield browser
+      browser.close
+    end
+
+    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

@@ -1,3 +1,3 @@
 module Goggles
-  VERSION = "0.1.4"
+  VERSION = "0.8.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,47 @@
+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
+  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

@@ -1,41 +1,68 @@
 require "spec_helper"
 
 describe Goggles do
-  Given(:config_path) { "./spec/support/configs" }
-  Given(:images) { Dir.glob("./spec/support/results/*/*.png") }
-  Given(:diffs) { Dir.glob("./spec/support/results/*/*diff.png") }
-  Given(:datas) { Dir.glob("./spec/support/results/*/*data.txt") }
+  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
 
-  context "swimming with one script at multiple sizes" do
-    describe "taking screenshots" do
-      Given(:sizes_config) { "#{config_path}/test_config_1024_600.yml" }
-      When { Goggles.swim(sizes_config) }
-      Then { images.size.should == 6 }
-      And { diffs.size.should == 2 }
-      And { datas.size.should == 2 }
+    it "returns a configuration object" do
+      expect(Goggles.configure { "foo" }).to be_a Goggles::Configuration
     end
 
-    describe "generating error" do
-      Given(:no_shot_config) { "#{config_path}/test_config_no_screenshot.yml" }
-      Then { expect{ Goggles.swim(no_shot_config) }.to raise_error(Goggles::EmptyResultError) }
+    it "memoizes the configuration object" do
+      expect(Goggles.configure { "foo" }).to equal Goggles.configure { "bar" }
     end
   end
 
-  context "swimming against multiple paths with no scripts" do
-    describe "taking screenshots when commanded" do
-      Given(:scriptless_config) { "#{config_path}/test_config_scriptless.yml" }
-      When { Goggles.swim(scriptless_config) }
-      Then { images.size.should == 6 }
-      And { diffs.size.should == 2 }
-      And { datas.size.should == 2 }
+  describe ".each" do
+    let(:config) do
+      Goggles.configure do |conf|
+        conf.browsers = [:foo]
+        conf.sizes    = [500]
+      end
     end
-  end
 
-  describe "creating empty configuration with --init" do
-    Given(:conf) { "spec/support/configs/empty_config.yml" }
-    Given { FileUtils.rm_f conf }
-    When { `swim -i #{conf}` }
-    Then { File.exists?(conf).should be_true }
-  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
+
+    it "accepts non-configured browser and size arguments" do
+      expect(Goggles::Iteration).to receive(:new).with(:bar, 300, config)
+      Goggles.each([:bar], [300]) { "foo" }
+    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

@@ -1,10 +1,2 @@
-require 'rspec'
-require 'rspec-given'
+require "goggles"
 
-require 'goggles'
-
-RSpec.configure do |config|
-  config.order = 'default'
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.filter_run_excluding :skip => true
-end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: goggles
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Johnson Denen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,124 +27,111 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: image_size
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: comparing responsive screenshots under watir-webdriver
+description: Compare screenshots in different browers at differnt sizes
 email:
-- jdenen@manta.com
-executables:
-- swim
+- johnson.denen@gmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/swim
 - goggles.gemspec
 - lib/goggles.rb
-- lib/goggles/cli.rb
 - lib/goggles/comparison.rb
-- lib/goggles/error.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
-- spec/support/configs/test_config_1024_600.yml
-- spec/support/configs/test_config_no_screenshot.yml
-- spec/support/configs/test_config_scriptless.yml
-- spec/support/scripts/google_search.rb
-- spec/support/scripts/no_screenshot.rb
 homepage: http://github.com/jdenen/goggles
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
-summary: comparing responsive screenshots under watir-webdriver
+specification_version: 4
+summary: Compare screenshots in different browers at differnt sizes
 test_files:
+- spec/goggles/comparison_spec.rb
+- spec/goggles/configuration_spec.rb
+- spec/goggles/iteration_spec.rb
 - spec/goggles_spec.rb
 - spec/spec_helper.rb
-- spec/support/configs/test_config_1024_600.yml
-- spec/support/configs/test_config_no_screenshot.yml
-- spec/support/configs/test_config_scriptless.yml
-- spec/support/scripts/google_search.rb
-- spec/support/scripts/no_screenshot.rb
+has_rdoc: 

data/bin/swim

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'goggles/cli'
-
-Goggles::CLI.new ARGV

data/lib/goggles/cli.rb

@@ -1,60 +0,0 @@
-require 'goggles'
-require 'optparse'
-require 'pathname'
-
-module Goggles
-  class CLI
-
-    def initialize(argv)
-      opt_parser = OptionParser.new do |opts|
-        opts.banner = "Goggles: Compare responsive screenshots in multiple browsers"
-        opts.separator ""
-        opts.separator "Options"
-
-        opts.on("-c", "--config CONFIG_FILE", "configuration to execute") do |config|
-          run_conf(config)
-        end
-
-        opts.on("-i", "--init CONFIG_FILE", "create empty config file") do |config|
-          file = Pathname.new(config)
-
-          if file.exist?
-            puts "Configuration file already exists: #{Pathname.new(config).realpath}"
-          else
-            File.open(file, 'w+') { |f| f.write(YAML::dump(EMPTY_CONFIG)) }
-          end
-        end
-
-        opts.on("-v", "--version", "Goggles::VERSION") do
-          puts Goggles::VERSION
-        end
-
-        opts.on("-h", "--help", "help text") do
-          puts opt_parser
-        end
-      end
-
-      opt_parser.parse!
-    end
-
-    def run_conf(config)
-      if File.exists? config
-        Goggles.swim config
-      else
-        puts "Not a valid configuration file: #{config}"
-      end
-    end
-
-    EMPTY_CONFIG = {
-      'results_directory' => "/home/example/results",
-      'scripts_directory' => "/home/example/scripts",
-      'scripts_to_execute' => ["first_example.rb", "second_example.rb"],
-      'domain_under_test' => "http://www.google.com",
-      'paths_to_capture' => { 'home' => "/", 'gmail' => "/gmail" },
-      'browsers' => ["chrome", "firefox"],
-      'browser_widths' => [1024, 600],
-      'image_fuzzing' => "20%",
-      'diff_color' => "blue"
-    }
-  end
-end

data/lib/goggles/error.rb

@@ -1,3 +0,0 @@
-module Goggles
-  class EmptyResultError < StandardError; end
-end

data/spec/support/configs/test_config_1024_600.yml

@@ -1,20 +0,0 @@
-results_directory: "spec/support/results"
-scripts_directory: "spec/support/scripts"
-
-domain_under_test: "http://www.google.com"
-
-paths_to_capture:
-  home: "/"
-
-scripts_to_execute:
-  - "google_search.rb"
-
-browsers:
-  - "firefox"
-  - "chrome"
-
-browser_widths: 
-  - 1024
-  - 600
-
-image_fuzzing: "20%"

data/spec/support/configs/test_config_no_screenshot.yml

@@ -1,19 +0,0 @@
-results_directory: "spec/support/results"
-scripts_directory: "spec/support/scripts"
-
-domain_under_test: "http://www.google.com"
-
-paths_to_capture:
-  home: "/"
-
-scripts_to_execute:
-  - "no_screenshot.rb"
-
-browsers:
-  - "firefox"
-  - "chrome"
-
-browser_widths: 
-  - 320
-
-image_fuzzing: "20%"

data/spec/support/configs/test_config_scriptless.yml

@@ -1,19 +0,0 @@
-results_directory: "spec/support/results"
-scripts_directory: "spec/support/scripts"
-
-domain_under_test: "http://www.google.com"
-
-paths_to_capture:
-  home: "/"
-  email: "/gmail"
-
-scripts_to_execute:
-
-browsers:
-  - "firefox"
-  - "chrome"
-
-browser_widths: 
-  - 1024
-
-image_fuzzing: "20%"

data/spec/support/scripts/google_search.rb

@@ -1,14 +0,0 @@
-require 'goggles'
-require 'page-object'
-
-class Search
-  include PageObject
-
-  text_field(:search_box, :id => "gbqfq")
-end
-
-Goggles.grab_screenshot("homepage")
-
-page = Search.new(@watir)
-page.search_box = "manta"
-sleep 1

data/spec/support/scripts/no_screenshot.rb

@@ -1,12 +0,0 @@
-require 'goggles'
-require 'page-object'
-
-class Search
-  include PageObject
-
-  text_field(:search_box, :id => "gbqfq")
-end
-
-page = Search.new(@watir)
-page.search_box = "manta"
-sleep 1