green_onion 0.0.3 → 0.0.4

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
   - 1.9.2
+before_install:
+  - sudo apt-get install libqt4-dev libqtwebkit-dev
 before_script:
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"

data/README.md

@@ -9,17 +9,19 @@ GreenOnion is a testing library for the UI only. It alerts you when the appearan
 
 ## Installation
 
+You'll need to get Qt built in your testing environment. [Follow these steps](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit) to get it up and running.
+
 Add this line to your application's Gemfile:
 
-    `gem 'green_onion'`
+    gem 'green_onion'
 
 And then execute:
 
-    `bundle`
+    bundle
 
 Or install it yourself as:
 
-    `gem install green_onion`
+    gem install green_onion
 
 ## Usage
 
@@ -27,19 +29,21 @@ Or install it yourself as:
 
 For RSpec, `require 'green_onion'` in your spec_helper.rb file. Place this block in the file also:
 
-    `GreenOnion.configure do |c|
-	    c.skins_dir = 'spec/skins'
-	  	c.threshold = 20
-	  end`
+    GreenOnion.configure do |c|
+      c.skins_dir = 'your/path/to/skins'
+      c.threshold = 20
+      c.dimensions = { :width => 1440, :height => 768 }
+    end
 
-* `skins_dir` is the directory that GreenOnion will store all skins. The namespace for skins is {URI name}.png (original), {URI name}_fresh.png (testing), and {URI name}_diff.png
+* `skins_dir` is the directory that GreenOnion will store all skins. The namespace for skins is {URI name}.png (original), {URI name}_fresh.png (testing), and {URI name}_diff.png. The default directory will be './spec/skins'
 * `threshold` is the percentage of acceptable change that the screenshots can take. This number can always be overwritten for an instance.
+* `dimensions` is a hash with the height and width of the browser window. The default dimensions are 1024x768.
 
 Then use one of the three methods below in a test...
 
 ### Percentage of change
 
-    `GreenOnion.skin_percentage(url, threshold {optional})`
+    GreenOnion.skin_percentage(url, threshold {optional})
 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.
 
 * `url` is the screen you want tested. Must include http://, example - 'http://yourSite.com'
@@ -47,14 +51,15 @@ The primary feature of GreenOnion is seeing how much (if at all) a view has chan
 
 ### Viewing screenshot diffs
 
-    `GreenOnion.skin_visual(url)`
+    GreenOnion.skin_visual(url)
 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.
 
 * `url` is the screen you want tested. Must include http://, example - 'http://yourSite.com'
 
 ### Both viewing screenshot diffs and percentage of change
 
-
+    GreenOnion.skin_visual_and_percentage(url, threshold {optional})
+This is just a combination of the two methods above.
 
 ## Contributing
 
@@ -62,14 +67,15 @@ Once you are aware of a issue in the UI, you can also rip open your spec/skins d
 
 The best way to run the specs is with...
 
-    `bundle exec rake spec`
+    bundle exec rake spec
 
 ...this way a Sinatra WEBrick server will run concurrently with the test suite, and exit on completion. You can see the Sinatra app in spec/sample_app.
 
 ## Roadmap
 
 * Screenshots can either be viewed as a visual diff, or overlayed newest over oldest and viewed as an onion-skin with sliding transparency.
-* Allow for headless screenshooting
+* Allow for flexibility in picking browsers
+* Run through all paths in a Rails app
 * More robust tests, especially around the visual diffs themselves
 * More documentation
 * More configuration/customizable settings

data/green_onion.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "sinatra"
   
   gem.add_dependency "capybara"
+  gem.add_dependency "capybara-webkit"
   gem.add_dependency "oily_png"
   gem.add_dependency "rainbow"
 

data/lib/green_onion.rb

@@ -21,7 +21,8 @@ module GreenOnion
 		# Bring the Screenshot and Compare classes together to create a skin
 		def skin(url)
 			@screenshot = Screenshot.new(
-				:dir => @configuration.skins_dir
+				:dir => @configuration.skins_dir,
+				:dimensions => @configuration.dimensions
 			)
 			@compare = GreenOnion::Compare.new
 
@@ -31,12 +32,13 @@ module GreenOnion
 		# Finds the percentage of change between skins
 		# Threshold can be set in configuration, or as an argument itself, and can be specific to an instance
 		def skin_percentage(url, threshold=@configuration.threshold)
-			threshold ||= 100
 			skin(url)
 			if(@screenshot.paths_hash.length > 1)
 				puts "\n" + url.color(:cyan)
 				@compare.percentage_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
 				threshold_alert(@compare.percentage_changed, threshold)
+			else
+				puts "\n#{url}".color(:cyan) + " has been saved to #{@screenshot.paths_hash[:original]}".color(:yellow)
 			end
 		end
 
@@ -46,6 +48,8 @@ module GreenOnion
 			if(@screenshot.paths_hash.length > 1)
 				puts "\n" + url.color(:cyan)
 				@compare.visual_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
+			else
+				puts "\n#{url}".color(:cyan) + " has been saved to #{@screenshot.paths_hash[:original]}".color(:yellow)
 			end
 		end
 
@@ -57,6 +61,8 @@ module GreenOnion
 				@compare.percentage_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
 				@compare.visual_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
 				threshold_alert(@compare.percentage_changed, threshold)
+			else
+				puts "\n#{url}".color(:cyan) + " has been saved to #{@screenshot.paths_hash[:original]}".color(:yellow)
 			end
 		end
 

data/lib/green_onion/compare.rb

@@ -51,7 +51,7 @@ module GreenOnion
 			begin
 				@images.last.rect(x.min, y.min, x.max, y.max, ChunkyPNG::Color.rgb(0,255,0))
 			rescue NoMethodError
-				puts "#{org} and #{fresh} skins are the same.".color(:yellow)
+				puts "Both skins are the same.".color(:yellow)
 			end
 			
 			@images.last.save(@diffed_image)

data/lib/green_onion/configuration.rb

@@ -1,7 +1,23 @@
 module GreenOnion
 	class Configuration
-		
-		attr_accessor :skins_dir, :threshold
+
+		attr_writer :threshold, :skins_dir
+
+		def dimensions=(options)
+			@dimensions = { :width => options[:width], :height => options[:height] }
+		end
+
+		def dimensions
+			@dimensions ||= { :height => 768, :width => 1024 }
+		end
+
+		def threshold
+			@threshold ||= 100
+		end
+
+		def skins_dir
+			@skins_dir ||= './spec/skins'
+		end
 
 	end
 end

data/lib/green_onion/screenshot.rb

@@ -1,22 +1,25 @@
 require 'capybara/dsl'
+require 'capybara-webkit'
 require "fileutils"
+require "debugger"
 
 module GreenOnion
 	class Screenshot
 		include Capybara::DSL
 
-		attr_accessor :dir 
+		attr_accessor :dir, :dimensions 
 		attr_reader :paths_hash
 
 		def initialize(params = {})
-			Capybara.default_driver = :selenium
+			Capybara.default_driver = :webkit
+			@dimensions = params[:dimensions]
 			@dir = params[:dir]
 			@paths_hash = {}
 		end
 
 		def snap_screenshot(url, path)
 			visit url
-			Capybara.page.driver.browser.save_screenshot(path)
+			Capybara.page.driver.render(path, @dimensions)
 		end
 
 		def test_screenshot(url)
@@ -32,7 +35,6 @@ module GreenOnion
 			else
 				@shot_path = @paths_hash[:original]
 			end
-			return @shot_path
 		end	
 
 		def get_path(url)

data/lib/green_onion/version.rb

@@ -1,3 +1,3 @@
 module GreenOnion
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/unit/green_onion_spec.rb

@@ -2,17 +2,18 @@ require "spec_helper"
 
 describe GreenOnion do
 
+	before(:all) do
+		@tmp_path = './spec/tmp'
+		@url = 'http://localhost:8070'
+		@url_w_uri = @url + '/fake_uri'
+	end
+
 	describe "Skins" do
-	  
 	  before(:each) do	
-			@tmp_path = './spec/tmp'
-			@url = 'http://localhost:8070'
-			@url_w_uri = @url + '/fake_uri'
 			FileUtils.mkdir(@tmp_path)
 
 	    GreenOnion.configure do |c|
 	    	c.skins_dir = @tmp_path
-	    	c.threshold = 1
 	    end
 	  end
 
@@ -20,6 +21,11 @@ describe GreenOnion do
 			FileUtils.rm_r(@tmp_path, :force => true)
 		end
 
+		it "should default to 1024x768 browser dimensions" do
+			( (GreenOnion.configuration.dimensions[:height] == 768) && 
+				(GreenOnion.configuration.dimensions[:width] == 1024) ).should be_true
+	  end
+
 	  it "should set/get custom directory" do
 	    GreenOnion.configuration.skins_dir.should eq(@tmp_path)
 	  end
@@ -46,15 +52,8 @@ describe GreenOnion do
 		  GreenOnion.compare.percentage_changed.should be == 0
 		end
 
-		it "should alert when diff percentage threshold is surpassed" do
-			$stdout.should_receive(:puts).exactly(4).times
-		  2.times do
-			  GreenOnion.skin_percentage(@url)
-			end
-		end
-
 		it "should print just URL and changed/total when diff percentage threshold has not been surpassed" do
-			$stdout.should_receive(:puts).exactly(2).times
+			$stdout.should_receive(:puts).exactly(3).times
 		  2.times do
 			  GreenOnion.skin_percentage(@url, 6)
 			end
@@ -67,7 +66,6 @@ describe GreenOnion do
 			GreenOnion.compare.diffed_image.should eq("#{@tmp_path}/root_diff.png")
 		end
 
-
 		it "should create visual diff between skins (even when there is no change)" do	      
 		  2.times do
 			  GreenOnion.skin_visual(@url_w_uri)
@@ -82,6 +80,47 @@ describe GreenOnion do
 			( (GreenOnion.compare.diffed_image.should eq("#{@tmp_path}/root_diff.png")) &&
 		  	(GreenOnion.compare.percentage_changed.should be > 0) ).should be_true
 		end
+	end
+
+	describe "Skins with custom dimensions" do
+	  before(:each) do	
+			FileUtils.mkdir(@tmp_path)
+
+	    GreenOnion.configure do |c|
+	    	c.skins_dir = @tmp_path
+	    	c.dimensions = { :width => 1440, :height => 900 }
+	    end
+	  end
+
+		after(:each) do
+			FileUtils.rm_r(@tmp_path, :force => true)
+		end
+
+		it "should allow custom browser dimensions" do
+			( (GreenOnion.configuration.dimensions[:height] == 900) && 
+				(GreenOnion.configuration.dimensions[:width] == 1440) ).should be_true
+	  end
+	end
+
+	describe "Skins with custom threshold" do
+	  before(:each) do	
+			FileUtils.mkdir(@tmp_path)
 
+	    GreenOnion.configure do |c|
+	    	c.skins_dir = @tmp_path
+	    	c.threshold = 1
+	    end
+	  end
+
+		after(:each) do
+			FileUtils.rm_r(@tmp_path, :force => true)
+		end
+
+		it "should alert when diff percentage threshold is surpassed" do
+			$stdout.should_receive(:puts).exactly(5).times
+		  2.times do
+			  GreenOnion.skin_percentage(@url)
+			end
+		end
 	end
 end

data/spec/unit/screenshot_spec.rb

@@ -5,16 +5,18 @@ describe GreenOnion::Screenshot do
 	before(:all) do
 		@url = 'http://localhost:8070'
 		@url_w_uri = @url + '/fake_uri'
+		@tmp_path = './spec/tmp'
+		@dimensions = { :width => 1024, :height => 768 }
 	end
 
   describe 'Snap single screenshot' do
 
 		before(:each) do
-			@tmp_path = './spec/tmp'
 			FileUtils.mkdir(@tmp_path)
 
   		@screenshot = GreenOnion::Screenshot.new(
-				:dir => @tmp_path
+				:dir => @tmp_path,
+				:dimensions => @dimensions
   		)
 			@file = "#{@tmp_path}/fake_uri.png"
   	end
@@ -49,11 +51,11 @@ describe GreenOnion::Screenshot do
 	describe 'Snap two screenshots' do
 
 		before(:each) do
-			@tmp_path = './spec/tmp'
 			FileUtils.mkdir(@tmp_path)
 
 			@screenshot = GreenOnion::Screenshot.new(
-				:dir => @tmp_path
+				:dir => @tmp_path,
+				:dimensions => @dimensions
 			)
 			@file1 = "#{@tmp_path}/fake_uri.png"
 			@file2 = "#{@tmp_path}/fake_uri_fresh.png"

metadata

@@ -2,7 +2,7 @@
 name: green_onion
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ted O'Meara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-27 00:00:00 Z
+date: 2012-07-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -90,7 +90,7 @@ dependencies:
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: oily_png
+  name: capybara-webkit
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -101,7 +101,7 @@ dependencies:
   type: :runtime
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: rainbow
+  name: oily_png
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -111,6 +111,17 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id010
 description: UI testing/screenshot diffing tool
 email: 
 - ted@intridea.com