goggles 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.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

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,86 @@
+# 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.
+
+## Installation
+
+Install ImageMagick:
+
+* OSX: `$ brew install imagemagick`
+* Linux: `$ sudo apt-get install imagemagick`
+
+Add this line to your application's Gemfile:
+
+    gem 'goggles'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install goggles
+
+## Usage
+
+Create a config file to point goggles in the right direction.
+``` yaml
+# config.yaml
+# Directory where you want to store your results. Required.
+results_directory: "/home/results"
+
+# Directory where you're storing your scripts. Optional.
+scripts_directory: "/home/scripts"
+
+# Scripts to execute in the scripts directory. Optional.
+scripts_to_execute:
+  - "search.rb"
+  - "login.rb"
+
+# Domain to test. Required.
+domain_under_test: "http://www.manta.com"
+
+# Paths to pages you want to test. Label them with a page name. Required.
+paths_to_capture: 
+  home: "/"
+  search: "/mb"
+
+# Browsers you want to compare. Cannot specify more than two (yet). Required.
+browsers:
+  - "chrome"
+  - "firefox"
+
+# Widths at which you would like screenshots compared. All screenshots will be taken at a height of 768. Required.
+browser_widths:
+  - 1024
+  - 600
+  - 320
+
+# Fuzzing percentage. Play around with this to find the right fit. Required.
+image_fuzzing: "20%"
+```
+
+If you pass scripts to goggles as part of your testing, you **must** specify when screenshots should be taken with the `#grab_screenshot` method. Otherwise, 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.
+
+``` ruby
+# script_to_execute.rb
+require 'goggles'
+@watir.cookies.add("cookie_name", "cookie_value")
+
+# Pass a short description to the method for naming the resultant screenshot
+Goggles.grab_screenshot("with_cookie_set")
+```
+
+Execute a goggles test through the command line with `swim --config CONFIG_FILE` or use `swim --help` to see command options.
+
+    $ swim -c config.yml
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/swim

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

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         = ["jdenen@manta.com"]
+  spec.summary       = %q{comparing responsive screenshots under watir-webdriver}
+  spec.description   = %q{comparing responsive screenshots under watir-webdriver}
+  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_runtime_dependency "watir-webdriver"
+  spec.add_runtime_dependency "image_size"
+
+  spec.executables << "swim"
+end

data/lib/goggles.rb

@@ -0,0 +1,80 @@
+require "goggles/version"
+require "goggles/comparison"
+require "goggles/scripter"
+require "goggles/error"
+
+require "watir-webdriver"
+require "yaml"
+require "fileutils"
+
+module Goggles
+  extend self
+
+  def swim(config_path)
+    conf = YAML::load(File.open(config_path))
+
+    @goggles_result_dir = conf['results_directory']
+    @goggles_script_dir = conf['scripts_directory']
+    @goggles_domain = conf['domain_under_test']
+    @goggles_paths = conf['paths_to_capture']
+    @goggles_scripts = conf['scripts_to_execute']
+    @goggles_platforms = conf['browsers']
+    @goggles_widths = conf['browser_widths']
+    @goggles_fuzz = conf['image_fuzzing']
+
+    embark!
+    diff_images
+  end
+
+  def grab_screenshot(detail)
+    make_result_dir
+
+    image_dir = "#{@goggles_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
+    
+    @goggles_widths.each do |size|
+      @gg_size = size.to_i
+
+      @goggles_platforms.each do |pf|
+        @gg_browser = pf
+        
+        @watir = Watir::Browser.new pf.to_sym
+        @watir.driver.manage.window.resize_to(@gg_size, 768)
+
+        @goggles_paths.each do |label, path|
+          @gg_label = label
+          url = "#{@goggles_domain}#{path}"
+
+          if @goggles_scripts.nil?
+            @watir.goto url
+            grab_screenshot("screenshot")
+          else
+            @goggles_scripts.each do |script|
+              script = "#{@goggles_script_dir}/#{script}"
+              execute_script(url, script)
+            end
+          end
+        end
+
+        @watir.close
+      end
+    end
+  end
+
+  def ensure_fresh_start
+    FileUtils.rm_rf("#{@goggles_result_dir}")
+  end
+
+  def make_result_dir
+    FileUtils.mkdir_p("#{@goggles_result_dir}/#{@gg_label}")
+  end
+
+end

data/lib/goggles/cli.rb

@@ -0,0 +1,38 @@
+require 'goggles'
+require 'optparse'
+
+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("-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
+
+  end
+end

data/lib/goggles/comparison.rb

@@ -0,0 +1,75 @@
+require "image_size"
+
+module Goggles
+
+  def diff_images
+    size_to_smallest!
+
+    images = Dir.glob("#{@goggles_result_dir}/*/*.png").sort
+
+    raise Goggles::EmptyResultError, "No screenshots found in results directory: #{@goggles_result_dir}" if images.empty?
+
+    until images.empty?
+      one = images.slice!(0)
+      two = images.slice!(0)
+
+      out_path = one.dup
+      discard = out_path.slice!(/[^_]*$/)
+
+      diff_out = "#{out_path}diff.png"
+      data_out = "#{out_path}data.txt"
+
+      `compare -fuzz #{@goggles_fuzz} -metric AE -highlight-color blue #{one} #{two} #{diff_out} 2>#{data_out}`
+    end
+  end
+
+  def size_to_smallest!
+    images = Dir.glob("#{@goggles_result_dir}/*/*.png").sort
+
+    until images.empty?
+      one = images.slice!(0)
+      two = images.slice!(0)
+
+      File.open(one, 'rb') do |file_one|
+        size_one = ImageSize.new(file_one.read).size
+        first_width = size_one[0]
+        first_height = size_one[1]
+
+        File.open(two, 'rb') do |file_two|
+          size_two = ImageSize.new(file_two.read).size
+          second_width = size_two[0]
+          second_height = size_two[1]
+
+          if first_width > second_width
+            width = second_width
+            w_file = one
+          else 
+            width = first_width
+            w_file = two
+          end
+
+          if first_height > second_height
+            height = second_height
+            h_file = one
+          else
+            height = first_height
+            h_file = two
+          end
+
+          cut_to_width(w_file, width)
+          cut_to_height(h_file, height)
+
+        end
+      end
+    end
+  end
+
+  def cut_to_width(file, w)
+    `convert #{file} -background none -extent #{w}x0 #{file}`
+  end
+
+  def cut_to_height(file, h)
+    `convert #{file} -background none -extent 0x#{h} #{file}`
+  end
+
+end

data/lib/goggles/error.rb

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

data/lib/goggles/scripter.rb

@@ -0,0 +1,10 @@
+module Goggles
+
+  def execute_script(url, script)
+    @watir.goto url
+    @watir.cookies.clear
+    @watir.refresh
+
+    eval(File.read(script))
+  end
+end

data/lib/goggles/version.rb

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

data/spec/goggles_spec.rb

@@ -0,0 +1,34 @@
+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") }
+
+  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 }
+    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) }
+    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 }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rspec-given'
+
+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

data/spec/support/configs/test_config_1024_600.yml

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,12 @@
+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

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: goggles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Johnson Denen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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
+email:
+- jdenen@manta.com
+executables:
+- swim
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- 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/scripter.rb
+- lib/goggles/version.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
+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
+signing_key: 
+specification_version: 3
+summary: comparing responsive screenshots under watir-webdriver
+test_files:
+- 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