green_onion 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@green_onion --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ted O'Meara
+
+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,42 @@
+# GreenOnion
+
+Regression issues make you cry.
+
+GreenOnion is a testing library for the UI only. It alerts you when the appearance of a view has changed, let's you know the percentage of total change, and allows you to visualize the areas that have been changed. It fits right into your test suite, and is dependent on familiar tools like Capybara.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'green_onion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install green_onion
+
+## Usage
+
+### Partnering up with RSpec
+
+The primary feature of GreenOnion is seeing how much (if at all) a view has changed from one instance to the next, and being alerted when a view has surpassed into an unacceptable threshold.
+
+### Viewing screenshot diffs
+
+Once you are aware of a issue in the UI, you can also rip open your spec/skins directory and manually see what the differences are from one screenshot to the next. Screenshots can either be viewed as a visual diff, or overlayed newest over oldest and viewed as an green_onion-skin with sliding transparency.
+
+## THANK YOU
+
+Much of this work could not be completed without these people and projects
+
+### Jeff Kreeftmeijer
+This is the post that got the wheels in motion: http://jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/. Most of the GreenOnion::Compare class is based on this work alone. Great job Jeff!
+
+### Compatriot
+Carol Nichols saw the same post, and worked on an excellent gem for cross-browser testing. That gem greatly influenced design decisions with GreenOnion.
+
+### Capybara and ChunkyPNG
+The land on which we sow our bulbs.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/green_onion.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/green_onion/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ted O'Meara"]
+  gem.email         = ["ted@intridea.com"]
+  gem.description   = %q{UI testing/screenshot diffing tool}
+  gem.summary       = %q{Regressions in the view making you cry? Have more confidence with GreenOnion.}
+  gem.homepage      = ""
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "fileutils"
+  gem.add_development_dependency "pry"
+  
+  gem.add_dependency "capybara"
+  gem.add_dependency "chunky_png"
+
+  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.name          = "green_onion"
+  gem.require_paths = ["lib"]
+  gem.version       = GreenOnion::VERSION
+end

data/lib/green_onion/compare.rb

@@ -0,0 +1,45 @@
+require "chunky_png"
+
+module GreenOnion
+	class Compare
+
+		attr_accessor :percentage_changed, :total_px, :changed_px
+
+		# Pulled from Jeff Kreeftmeijer's post here: http://jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/
+		# Thanks Jeff!
+		def diff_images(org, fresh)
+			@images = [
+				ChunkyPNG::Image.from_file(org),
+				ChunkyPNG::Image.from_file(fresh)
+			]
+
+			@diff = []
+
+			@images.first.height.times do |y|
+				@images.first.row(y).each_with_index do |pixel, x|
+					@diff << [x,y] unless pixel == @images.last[x,y]
+				end
+			end
+		end
+
+		def percentage_diff(org, fresh)
+			diff_images(org, fresh)
+			self.total_px = @images.first.pixels.length
+			self.changed_px = @diff.length
+			self.percentage_changed = (@diff.length.to_f / @images.first.pixels.length) * 100
+
+			puts "pixels (total):     #{@total_px}"
+			puts "pixels changed:     #{@changed_px}"
+			puts "pixels changed (%): #{@percentage_changed}%"
+		end
+
+		def visual_diff(org, fresh)
+			diff_images(org, fresh)
+			x, y = diff.map{ |xy| xy[0] }, diff.map{ |xy| xy[1] }
+
+			images.last.rect(x.min, y.min, x.max, y.max, ChunkyPNG::Color.rgb(0,255,0))
+			images.last.save('diff.png')
+		end
+
+	end
+end

data/lib/green_onion/screenshot.rb

@@ -0,0 +1,58 @@
+require 'capybara/dsl'
+require "fileutils"
+
+module GreenOnion
+	class Screenshot
+		include Capybara::DSL
+
+		attr_accessor :dir
+
+		def initialize(params = {})
+			Capybara.default_driver = :selenium
+			@dir = params[:dir]
+		end
+
+		def snap_screenshot(url, path)
+			visit url
+			Capybara.page.driver.browser.save_screenshot(path)
+		end
+
+		def test_screenshot(url)
+			url_to_path(url)
+			snap_screenshot(url, @path)
+		end
+
+		def url_to_path(url)
+			@filename = url.match(/^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/)[5]
+			if @filename.empty?
+				@path = "#{@dir}/root.png"
+			else
+				@filename = @filename.gsub(/[\/]/, '')
+				@path = "#{@dir}/#{@filename}.png"
+			end
+			accepted?(@path)
+			return @path
+		end
+
+		def accepted?(path)
+			if File.exist?(path)
+				return path.insert(-5, '_fresh')
+			else
+				return path
+			end
+		end
+
+		def destroy(url)
+			url_to_path(url)
+			fresh_path = @path.insert(-5, '_fresh') 
+
+			if File.exist?(fresh_path)
+				FileUtils.rm(fresh_path) 
+			end
+			if File.exist?(@path)
+				FileUtils.rm(@path)
+			end
+		end
+
+	end
+end

data/lib/green_onion/version.rb

@@ -0,0 +1,3 @@
+module GreenOnion
+  VERSION = "0.0.1"
+end

data/lib/green_onion.rb

@@ -0,0 +1,9 @@
+require "green_onion/version"
+require "green_onion/screenshot"
+require "green_onion/compare"
+
+module GreenOnion
+	class << self
+
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'fileutils'
+
+require 'green_onion'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/unit/compare_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe GreenOnion::Compare do
+
+	describe 'Comparing Screenshots' do
+
+		before(:each) do
+			@comparison = GreenOnion::Compare.new
+			@spec_shot1 = './spec/skins/spec_shot.png'
+			@spec_shot2 = './spec/skins/spec_shot_fresh.png'
+		end
+
+		it 'should get a percentage of difference between two shots' do
+			@comparison.percentage_diff(@spec_shot1, @spec_shot2)
+			@comparison.percentage_changed.should eq(66.0)
+		end
+
+		it 'should create a new file with a visual diff between two shots' do
+			@comparison.visual_diff(@spec_shot1, @spec_shot2)
+		end
+	end
+end

data/spec/unit/screenshot_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe GreenOnion::Screenshot do
+
+  describe 'Snap single screenshot' do
+
+		before(:each) do
+			@tmp_path = './spec/tmp'
+			FileUtils.mkdir(@tmp_path)
+
+  		@screenshot = GreenOnion::Screenshot.new(
+				:dir => @tmp_path
+  		)
+			@url = 'http://www.google.com/maps'
+			@file = "#{@tmp_path}/maps.png"
+  	end
+
+		after(:each) do
+			FileUtils.rm_r(@tmp_path, :force => true)
+		end
+
+	  it 'should build the path from the URI' do
+  		@screenshot.url_to_path(@url).should eq(@file)
+	  end
+
+	  it 'should build the path from root' do
+  		@screenshot.url_to_path('http://www.google.com').should eq("#{@tmp_path}/root.png")
+	  end
+
+	  it 'should snap and save screenshot' do
+  		@screenshot.snap_screenshot(@url, @file)
+  		File.exist?(@file).should be_true
+	  end
+
+		it "should destroy a singular screenshot" do
+		  @screenshot.destroy(@url)
+  		File.exist?(@file).should be_false
+		end
+	end
+
+	describe 'Snap two screenshots' do
+
+		before(:each) do
+			@tmp_path = './spec/tmp'
+			FileUtils.mkdir(@tmp_path)
+
+			@screenshot = GreenOnion::Screenshot.new(
+				:dir => @tmp_path
+			)
+			@url = 'http://www.google.com/maps'
+			@file1 = "#{@tmp_path}/maps.png"
+			@file2 = "#{@tmp_path}/maps_fresh.png"
+			2.times do
+				@screenshot.test_screenshot(@url)
+			end
+		end
+
+		after(:each) do
+			FileUtils.rm_r(@tmp_path, :force => true)
+		end
+
+		it "should snap and save another screenshot if a screenshot already exists" do
+			if File.exist?(@file1)
+				File.exist?(@file2).should be_true
+			end
+		end
+
+		it "should destroy a set of screenshots" do
+		  @screenshot.destroy(@url)
+		  File.exist?(@file1).should be_false
+		end
+	end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: green_onion
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ted O'Meara
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fileutils
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: chunky_png
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+description: UI testing/screenshot diffing tool
+email: 
+- ted@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- green_onion.gemspec
+- lib/green_onion.rb
+- lib/green_onion/compare.rb
+- lib/green_onion/screenshot.rb
+- lib/green_onion/version.rb
+- spec/skins/spec_shot.png
+- spec/skins/spec_shot_fresh.png
+- spec/spec_helper.rb
+- spec/unit/compare_spec.rb
+- spec/unit/screenshot_spec.rb
+homepage: ""
+licenses: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: Regressions in the view making you cry? Have more confidence with GreenOnion.
+test_files: 
+- spec/skins/spec_shot.png
+- spec/skins/spec_shot_fresh.png
+- spec/spec_helper.rb
+- spec/unit/compare_spec.rb
+- spec/unit/screenshot_spec.rb