green_onion 0.1.0 → 0.1.1

data/README.md

@@ -1,5 +1,5 @@
 
-[<img src="https://secure.travis-ci.org/tomeara/green_onion.png" />](http://travis-ci.org/#!/tomeara/green_onion)
+[<img src="https://secure.travis-ci.org/tomeara/green_onion.png" />](http://travis-ci.org/#!/tomeara/green_onion) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tomeara/green_onion)
 
 # GreenOnion
 
@@ -7,6 +7,10 @@ Regression issues in the view 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.
 
+## Documentation
+
+[RDoc](http://rdoc.info/gems/green_onion/frames)
+
 ## 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.
@@ -45,7 +49,7 @@ Options
 
 To generate a "skinner" file, which will test a Rails application with the routes without params included (this is an area that could be worked on a lot more :) ); use the command below:
 
-  green_onion generate [options]
+    green_onion generate [options]
 
 * `--url=URL` - the domain that you will be testing your Rails app. The default is "http://localhost:3000".
 * `--dir=DIR` - the directory in which you would like to generate the skinner. The default is "spec/skinner.rb"
@@ -101,6 +105,7 @@ The best way to run the specs is with...
 * 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 flexibility in picking browsers
 * Skinner generator needs love <3
+** Should allow for testing using fixtures/factories
 * More robust tests, especially around the visual diffs themselves
 * More documentation
 * More configuration/customizable settings
@@ -116,4 +121,13 @@ This is the post that got the wheels in motion: http://jeffkreeftmeijer.com/2011
 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, ChunkyPNG, Thor, and OilyPNG
-The land on which we sow our bulbs.
+The land on which we sow our bulbs.
+
+## Contributor
+[Ted O'Meara](http://www.intridea.com/about/team/ted-o-meara)
+
+## License
+MIT License. See LICENSE for details.
+
+## Copyright
+Copyright (c) 2012 Intridea, Inc.

data/lib/green_onion/cli.rb

@@ -5,7 +5,7 @@ module GreenOnion
   class CLI < Thor
     include Thor::Actions
 
-    self.source_root("lib/green_onion/generators")
+    source_root File.expand_path('../generators', __FILE__)
 
     class_option :dir, :aliases => "-d", :type => :string
 
@@ -30,12 +30,12 @@ module GreenOnion
       end
     end
 
-    desc "generate", "Generates a 'skinner' file to test a Rails app at <url> with routes without params"
+    desc "generate", "Generates a 'skinner' file to test only Rails routes without params"
     method_option :url, :aliases => "-u", :type => :string
     def generate_skinner
       options[:dir] ? dir = options[:dir] : dir = "spec"
-      options[:url] ? url = options[:url] : url = "http://localhost:3000"
-      template('skinner.erb', "#{dir}/skinner.rb")
+      options[:url] ? config = { :url => options[:url] } : config = { :url => "http://localhost:3000" }
+      template('skinner.erb', "#{dir}/skinner.rb", config)
     end
   end
 end

data/lib/green_onion/compare.rb

@@ -19,7 +19,7 @@ module GreenOnion
       begin
         diff_iterator
       rescue ChunkyPNG::OutOfBounds
-        puts "Skins are different sizes. Please delete #{org} and/or #{fresh}.".color(:yellow)
+        warn "Skins are different sizes. Please delete #{org} and/or #{fresh}.".color(:yellow)
       end
     end
 
@@ -28,16 +28,24 @@ module GreenOnion
         @images.first.row(y).each_with_index do |pixel, x|
           unless pixel == @images.last[x,y]
             @diff_index << [x,y] 
-            @images.last[x,y] = ChunkyPNG::Color.rgb(
-              ChunkyPNG::Color.r(pixel) + ChunkyPNG::Color.r(@images.last[x,y]) - 2 * [ChunkyPNG::Color.r(pixel), ChunkyPNG::Color.r(@images.last[x,y])].min,
-              ChunkyPNG::Color.g(pixel) + ChunkyPNG::Color.g(@images.last[x,y]) - 2 * [ChunkyPNG::Color.g(pixel), ChunkyPNG::Color.g(@images.last[x,y])].min,
-              ChunkyPNG::Color.b(pixel) + ChunkyPNG::Color.b(@images.last[x,y]) - 2 * [ChunkyPNG::Color.b(pixel), ChunkyPNG::Color.b(@images.last[x,y])].min
-            )
+            pixel_difference_filter(pixel, x, y)
           end
         end
       end
     end
 
+    def pixel_difference_filter(pixel, x, y)
+      chans = []
+      [:r, :b, :g].each do |chan| 
+        chans << channel_difference(chan, pixel, x, y)
+      end
+      @images.last[x,y] = ChunkyPNG::Color.rgb(chans[0], chans[1], chans[2])
+    end
+
+    def channel_difference(chan, pixel, x, y)
+      ChunkyPNG::Color.send(chan, pixel) + ChunkyPNG::Color.send(chan, @images.last[x,y]) - 2 * [ChunkyPNG::Color.send(chan, pixel), ChunkyPNG::Color.send(chan, @images.last[x,y])].min
+    end
+
     def percentage_diff(org, fresh)
       diff_images(org, fresh)
       @total_px = @images.first.pixels.length
@@ -47,19 +55,11 @@ module GreenOnion
 
     def visual_diff(org, fresh)
       diff_images(org, fresh)
-      diff_iterating(org, fresh)
-    end
-
-    def percentage_and_visual_diff(org, fresh)
-      diff_images(org, fresh)
-      @total_px = @images.first.pixels.length
-      @changed_px = @diff_index.length
-      @percentage_changed = ( (@diff_index.length.to_f / @images.first.pixels.length) * 100 ).round(2)
+      save_visual_diff(org, fresh)
     end
 
-    def diff_iterating(org, fresh)
+    def save_visual_diff(org, fresh)
       x, y = @diff_index.map{ |xy| xy[0] }, @diff_index.map{ |xy| xy[1] }
-
       @diffed_image = org.insert(-5, '_diff')
 
       begin

data/lib/green_onion/errors.rb

@@ -0,0 +1,10 @@
+module GreenOnion
+  class Errors
+    #Base class for all errors
+    class Error < StandardError; end
+
+    class IllformattedURL < Error; end
+
+    class ThresholdOutOfRange < Error; end
+  end
+end

data/lib/green_onion/generators/skinner.erb

@@ -17,5 +17,5 @@ all_routes = Rails.application.routes.routes
 routes = all_routes.collect { |r| r.path.spec.to_s.gsub(/\/*(\(\.)*:(\w*)(\))*\/*/, "") }.delete_if(&:empty?)
 
 routes.each do |route|
-  GreenOnion.skin_percentage(url + route)
+  GreenOnion.skin_visual_and_percentage("<%= config[:url] %>" + route)
 end

data/lib/green_onion/screenshot.rb

@@ -36,8 +36,17 @@ module GreenOnion
       end
     end  
 
+    def url_matcher(url)
+      url_match = url.match(/^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/).to_a.compact
+      if url_match.length >= 5
+        @filename = url_match[5]
+      else
+        raise Errors::IllformattedURL.new "Your URL is incorrectly formatted. Please make sure to use http://"
+      end
+    end
+
     def get_path(url)
-      @filename = url.match(/^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/)[5]
+      url_matcher(url)
       if @filename.empty? || @filename == '/' 
         @paths_hash[:original] = "#{@dir}/root.png"
       else

data/lib/green_onion/version.rb

@@ -1,3 +1,3 @@
 module GreenOnion
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/green_onion.rb

@@ -2,6 +2,7 @@ require "green_onion/version"
 require "green_onion/screenshot"
 require "green_onion/compare"
 require "green_onion/configuration"
+require "green_onion/errors"
 require "rainbow"
 
 module GreenOnion
@@ -32,35 +33,34 @@ 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)
+      raise Errors::ThresholdOutOfRange.new "The threshold need to be a number between 1 and 100" if 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
+      skin_picker(url, { :percentage => true }, threshold)
     end
 
     # Creates a diffed screenshot between skins
     def skin_visual(url)
       skin(url)
-      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
+      skin_picker(url, { :visual => true })
     end
 
     # Creates a diffed screenshot between skins AND prints percentage changed
     def skin_visual_and_percentage(url, threshold=@configuration.threshold)
+      raise Errors::ThresholdOutOfRange.new "The threshold need to be a number between 1 and 100" if threshold > 100
       skin(url)
+      skin_picker(url, { :percentage => true, :visual => true }, threshold)
+    end
+
+    def skin_picker(url, type, threshold=100)
       if(@screenshot.paths_hash.length > 1)
         puts "\n" + url.color(:cyan)
-        @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)
+        if type[:percentage]
+          @compare.percentage_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
+          threshold_alert(@compare.percentage_changed, threshold)
+        end
+        if type[:visual]
+          @compare.visual_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
+        end
       else
         puts "\n#{url}".color(:cyan) + " has been saved to #{@screenshot.paths_hash[:original]}".color(:yellow)
       end

data/spec/unit/cli_spec.rb

@@ -11,10 +11,6 @@ describe "bin/green_onion" do
 
   describe "Skin Utility" do
 
-    before(:each) do  
-      FileUtils.mkdir(@tmp_path)
-    end
-
     after(:each) do
       FileUtils.rm_r(@tmp_path, :force => true)
     end     
@@ -24,22 +20,30 @@ describe "bin/green_onion" do
       File.exist?(@file1).should be_true
     end
 
+    it "should run the skin task w/ --method=p flag to run only percentage diff" do
+      stdin, stdout, stderr = Open3.popen3("bin/green_onion skin #{@url} --dir=#{@tmp_path} --method=p --threshold=1 &&
+                                            bin/green_onion skin #{@url} --dir=#{@tmp_path} --method=p --threshold=1")
+      stderr.readlines.to_s.should include("above threshold set @")
+    end
+
   end
 
   describe "Generator" do
 
-    before(:each) do  
-      FileUtils.mkdir(@tmp_path)
-    end
-
     after(:each) do
       FileUtils.rm_r(@tmp_path, :force => true)
     end     
 
     it "should build the skinner file" do
-      `bin/green_onion generate --url=#{@url} --dir=#{@tmp_path}`
+      `bin/green_onion generate --dir=#{@tmp_path}`
       File.exist?(@skinner_file).should be_true
     end
+
+    it "should build the skinner file with the url included correctly" do
+      `bin/green_onion generate --url=#{@url} --dir=#{@tmp_path}`
+      skinner = IO.read(@skinner_file)
+      skinner.should include("GreenOnion.skin_visual_and_percentage(\"http://localhost:8070\" + route)")
+    end
     
   end
 end

data/spec/unit/green_onion_spec.rb

@@ -10,8 +10,6 @@ describe GreenOnion do
 
   describe "Skins" do
     before(:each) do  
-      FileUtils.mkdir(@tmp_path)
-
       GreenOnion.configure do |c|
         c.skins_dir = @tmp_path
       end
@@ -84,8 +82,6 @@ describe GreenOnion do
 
   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 }
@@ -104,8 +100,6 @@ describe GreenOnion do
 
   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
@@ -123,4 +117,28 @@ describe GreenOnion do
       end
     end
   end
+
+  describe "Errors" do
+    before(:each) do  
+      GreenOnion.configure do |c|
+        c.skins_dir = @tmp_path
+      end
+    end
+
+    after(:each) do
+      FileUtils.rm_r(@tmp_path, :force => true)
+    end
+
+    it "should raise error for when ill-formatted URL is used" do
+      expect { GreenOnion.skin_percentage("localhost") }.to raise_error(GreenOnion::Errors::IllformattedURL)
+    end
+
+    it "should raise error for when threshold is out of range for skin_percentage" do
+      expect { GreenOnion.skin_percentage(@url, 101) }.to raise_error(GreenOnion::Errors::ThresholdOutOfRange)
+    end
+
+    it "should raise error for when threshold is out of range for skin_visual_and_percentage" do
+      expect { GreenOnion.skin_visual_and_percentage(@url, 101) }.to raise_error(GreenOnion::Errors::ThresholdOutOfRange)
+    end
+  end
 end

data/spec/unit/screenshot_spec.rb

@@ -12,8 +12,6 @@ describe GreenOnion::Screenshot do
   describe 'Snap single screenshot' do
 
     before(:each) do
-      FileUtils.mkdir(@tmp_path)
-
       @screenshot = GreenOnion::Screenshot.new(
         :dir => @tmp_path,
         :dimensions => @dimensions
@@ -51,8 +49,6 @@ describe GreenOnion::Screenshot do
   describe 'Snap two screenshots' do
 
     before(:each) do
-      FileUtils.mkdir(@tmp_path)
-
       @screenshot = GreenOnion::Screenshot.new(
         :dir => @tmp_path,
         :dimensions => @dimensions

metadata

@@ -2,7 +2,7 @@
 name: green_onion
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ted O'Meara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-02 00:00:00 Z
+date: 2012-08-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -157,6 +157,7 @@ files:
 - lib/green_onion/cli.rb
 - lib/green_onion/compare.rb
 - lib/green_onion/configuration.rb
+- lib/green_onion/errors.rb
 - lib/green_onion/generators/skinner.erb
 - lib/green_onion/screenshot.rb
 - lib/green_onion/version.rb