compaa 0.0.1.1

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+results.html
+pkg
+html
+Gemfile.lock
+coverage
+tags
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 1.9.3
+  - 1.8.7
+  - jruby-19mode
+  - rbx-19mode
+  - rbx-18mode

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end
+
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/compaa/(.*)\.rb|)  { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|) { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jamie English
+
+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,32 @@
+[![Build Status](https://secure.travis-ci.org/jamienglish/compaa.png?branch=master)](https://travis-ci.org/jamienglish/compaa)
+
+# compaa
+
+As a companion to `Symilaa`, `Compaa` compares screenshots and presents the user
+with a prompt to accept or reject the new screenshot.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'compaa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compaa
+
+## Usage
+
+See cucumber features.
+
+## Contributing
+
+1. Fork it
+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,18 @@
+require 'bundler'
+
+require 'rake'
+require 'rake/testtask'
+require 'cucumber/rake/task'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new :spec do |t|
+  t.libs   << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+Cucumber::Rake::Task.new :features do |t|
+  t.cucumber_opts = 'features --format pretty'
+end
+
+task :default => [:spec, :features]

data/app.rb

@@ -0,0 +1,9 @@
+require 'sinatra'
+
+module Compaa
+  class Screenshots < Sinatra::Base
+    get '/' do
+      haml :index
+    end
+  end
+end

data/bin/compaa

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'compaa'
+require 'sinatra'
+require 'watir-webdriver'
+require 'cgi'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  PORT = '7788'
+
+  main do
+    
+    sinatra_pid = fork do
+      user_project_path = Dir.pwd
+
+      Dir.chdir(File.dirname(__FILE__))
+      Dir.chdir("../")
+      puts Dir.pwd
+
+      puts "ln -s  #{user_project_path} #{Dir.pwd}/public"
+
+      exec "thin start -p #{PORT}"
+    end
+
+    browser = Watir::Browser.new
+    browser.window.resize_to 1368, 1200
+
+    sleep 3
+
+    Compaa::DifferenceImage.all.each do |difference_image|
+      browser.goto "http://localhost:#{PORT}/?filepath=#{CGI::escape(difference_image.path)}"
+      puts "Comparing: #{difference_image.path}"
+      puts "Would you like to make this the reference image?"
+
+      difference_image.create_reference_image if screenshot_approved?
+    end
+
+    Compaa::GeneratedImage.all.each do |generated_image|
+      next if generated_image.has_reference_image?
+
+      puts "Approving: #{generated_image.path}"
+      generated_image.create_reference_image if screenshot_approved?
+    end
+
+    `kill -9 #{sinatra_pid}`
+
+    browser.close
+
+  end
+
+  def self.screenshot_approved?
+      STDIN.gets.chomp.downcase.start_with? 'y'
+  end
+
+  version Compaa::VERSION
+
+  use_log_level_option
+
+  go!
+end

data/compaa.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path 'lib', File.dirname(__FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+require 'compaa/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'compaa'
+  gem.version       = Compaa::VERSION
+  gem.authors       = ['BSkyB Helpcentre']
+  gem.email         = ['skyhelpcentre@gmail.com']
+  gem.summary       = <<-SUMMARY
+    Command line tool to compare screenshots outputted from our
+    screenshot_comparison gem
+  SUMMARY
+  gem.homepage      = 'https://github.com/bskyb-commerce-helpcentre/compaa'
+
+  gem.files         = `git ls-files`.split $/
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename f }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  %w[rake aruba simplecov wrong minitest guard-minitest guard-cucumber].each do |lib|
+    gem.add_development_dependency lib
+  end
+
+  gem.add_development_dependency 'rb-inotify' if RUBY_PLATFORM =~ /linux/
+
+  if RUBY_PLATFORM =~ /darwin/
+    gem.add_development_dependency 'rb-fsevent'
+    gem.add_development_dependency 'terminal-notifier-guard'
+  end
+
+  gem.add_dependency 'methadone', '~> 1.2.2'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'thin'
+  gem.add_dependency 'haml'
+  gem.add_dependency 'watir-webdriver'
+end

data/config.ru

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler.require
+
+require './app'
+
+run Compaa::Screenshots

data/features/compaa.feature

@@ -0,0 +1,38 @@
+Feature: Generate Rake Artifacts Tasks
+
+  In order to be able to view screenshot failures and decide whether accept or reject them
+  As a Help Centre developer
+  I want to be able to compare screenshots
+
+  Scenario: App just runs
+    When I get help for "compaa"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      | --version |
+    And the banner should document that this app takes no arguments
+
+  Scenario: Compare screenshots and approve
+    Given a sample reference screenshot
+    And a sample generated screenshot
+    And a sample difference screenshot
+    When I run `compaa` interactively
+    And I approve the screenshot
+    Then the new reference screenshot should be the same as the sample generated screenshot
+    And the difference image should have been deleted
+
+  Scenario: Compare screenshots and reject
+    Given a sample reference screenshot
+    And a sample generated screenshot
+    And a sample difference screenshot
+    When I run `compaa` interactively
+    And I reject the screenshot
+    Then the new reference screenshot should be the same as the original reference screenshot
+
+	Scenario: Generated images without corresponding reference images require approval
+    Given a sample generated screenshot
+		And no reference images or difference images
+    When I run `compaa` interactively
+    And I approve the screenshot
+    Then the new reference screenshot should be the same as the sample generated screenshot

data/features/step_definitions/compaa_steps.rb

@@ -0,0 +1,51 @@
+Given /^no reference images or difference images$/ do
+  # do nothing
+end
+
+Given /^a sample reference screenshot$/ do
+  write_file 'artifacts/reference_screenshots/dir/image.png',
+    sample_reference_image
+end
+
+Given /^a sample generated screenshot$/ do
+  write_file 'artifacts/screenshots_generated_this_run/dir/image.png',
+    sample_generated_image
+end
+
+Given /^a sample difference screenshot$/ do
+  write_file 'artifacts/differences_in_screenshots_this_run/dir/image.png_difference.gif',
+    sample_difference_image
+end
+
+When /^I reject the screenshot$/ do
+  type 'No'
+end
+
+When /^I approve the screenshot$/ do
+  type 'Yes'
+end
+
+Then /^the new reference screenshot should be the same as the sample generated screenshot$/ do
+  sample_generated_file_path = File.join fixture_image_path, 'sample_generated.png'
+  new_reference_file_path = File.join current_dir, *%w[artifacts reference_screenshots dir image.png]
+
+  eventually :timeout => RUBY_PLATFORM == 'java' ? 20 : 3 do
+    new_reference_file_path.should be_the_same_file_as sample_generated_file_path
+  end
+end
+
+Then /^the new reference screenshot should be the same as the original reference screenshot$/ do
+  original_reference_file_path = File.join fixture_image_path, 'sample_reference.png'
+  new_reference_file_path = File.join current_dir, *%w[artifacts reference_screenshots dir image.png]
+
+  eventually :timeout => RUBY_PLATFORM == 'java' ? 20 : 3 do
+    new_reference_file_path.should be_the_same_file_as original_reference_file_path
+  end
+end
+
+Then /^the difference image should have been deleted$/ do
+  difference_image = File.join current_dir,
+		*%w[artifacts differences_in_screenshots_this_run dir image.png_difference.gif]
+
+	difference_image.should_not exist
+end

data/features/support/env.rb

@@ -0,0 +1,29 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+require 'wrong'
+
+include Wrong
+
+ENV['APP_ENV'] = 'test'
+
+bin_dir     = File.expand_path File.dirname(__FILE__), '../../bin'
+ENV['PATH'] = bin_dir + File::PATH_SEPARATOR + ENV['PATH']
+LIB_DIR     = File.expand_path File.dirname(__FILE__), '../../lib'
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB']    = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+  @aruba_timeout_seconds = RUBY_PLATFORM == 'java' ? 20 : 5
+end
+
+Aruba.configure do |config|
+  config.before_cmd do |cmd|
+    set_env('JRUBY_OPTS', "-X-C #{ENV['JRUBY_OPTS']}") # disable JIT since these processes are so short lived
+  end
+end if RUBY_PLATFORM == 'java'
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/features/support/file_helpers.rb

@@ -0,0 +1,23 @@
+module FileHelpers
+  def sample_reference_image
+    fixture_image('sample_reference.png').read
+  end
+
+  def sample_generated_image
+    fixture_image('sample_generated.png').read
+  end
+
+  def sample_difference_image
+    fixture_image('sample_generated.png_difference.gif').read
+  end
+
+  def fixture_image file_name
+    File.new File.join(fixture_image_path, file_name)
+  end
+
+  def fixture_image_path
+    File.expand_path "../../fixtures", File.dirname(__FILE__)
+  end
+end
+
+World FileHelpers

data/features/support/matchers.rb

@@ -0,0 +1,13 @@
+require 'fileutils'
+
+RSpec::Matchers.define :be_the_same_file_as do |expected|
+  match do |actual|
+    FileUtils.cmp actual, expected
+  end
+end
+
+RSpec::Matchers.define :exist do
+  match do |path|
+    File.exists? path 
+  end
+end

data/lib/compaa.rb

@@ -0,0 +1,3 @@
+require 'compaa/version'
+require 'compaa/difference_image'
+require 'compaa/generated_image'

data/lib/compaa/difference_image.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+
+module Compaa
+  class DifferenceImage < Struct.new(:path)
+    attr_writer :file_manager
+
+    def self.all
+      Dir.glob(File.join %w[artifacts differences_in_screenshots_this_run ** *.gif]).map { |path|
+        new path
+      }
+    end
+
+    def create_reference_image
+      file_manager.mkdir_p File.dirname reference_path
+      file_manager.cp generated_path, reference_path
+      file_manager.rm path
+    end
+
+    def reference_path
+      path.gsub(
+        'differences_in_screenshots_this_run', 'reference_screenshots'
+      ).gsub('_difference.gif', '')
+    end
+
+    def generated_path
+      path.gsub(
+        'differences_in_screenshots_this_run', 'screenshots_generated_this_run'
+      ).gsub('_difference.gif', '')
+    end
+
+    private
+
+    def file_manager
+      @file_manager ||= FileUtils
+    end
+  end
+end