green_onion 0.0.5 → 0.1.0

data/README.md

@@ -3,7 +3,7 @@
 
 # GreenOnion
 
-Regression issues make you cry.
+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.
 
@@ -25,9 +25,34 @@ Or install it yourself as:
 
 ## Usage
 
-### RSpec
+### Command Line Interface
 
-For RSpec, `require 'green_onion'` in your spec_helper.rb file. Place this block in the file also:
+#### Skinning
+
+To just run a comparison between skins in your shell, you can use the command below:
+
+    green_onion skin <url> [options]
+
+Options
+* `<url>` - is the screen you want tested. Must include http://, example - 'http://yourSite.com'
+* `--dir=DIR` - 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'
+* `--method=[p, v, vp]` - the method in which you'd like to compare the skins. `p` is for percentage, `v` is for visual. The default is visual and percentage.
+* `--threshold=[1-100]` is the percentage of acceptable change that the screenshots can take. This number can always be overwritten for an instance.
+* `--width=[number]` is the width of the browser window. The default width is 1024.
+* `--height=[number]` is the height of the browser window. The default height is 768.
+
+#### Generating skinner file
+
+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]
+
+* `--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"
+
+### Adding GreenOnion to integration tests with RSpec
+
+For adding GreenOnion to your integration tests in RSpec, add `require 'green_onion'` to your spec_helper.rb file. Place this block in the file also:
 
     GreenOnion.configure do |c|
       c.skins_dir = 'your/path/to/skins'
@@ -41,22 +66,22 @@ For RSpec, `require 'green_onion'` in your spec_helper.rb file. Place this block
 
 Then use one of the three methods below in a test...
 
-### Percentage of change
+#### 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'
 * `threshold` can be overwritten here, or if not given in the configure block – it will default to a threshold of 100%
 
-### Viewing screenshot diffs
+#### Viewing screenshot diffs
 
     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
+#### 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.
@@ -75,7 +100,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
-* Run through all paths in a Rails app
+* Skinner generator needs love <3
 * More robust tests, especially around the visual diffs themselves
 * More documentation
 * More configuration/customizable settings
@@ -90,5 +115,5 @@ This is the post that got the wheels in motion: http://jeffkreeftmeijer.com/2011
 ### 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
+### Capybara, ChunkyPNG, Thor, and OilyPNG
 The land on which we sow our bulbs.

data/bin/green_onion

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "green_onion/cli"
+
+GreenOnion::CLI.start

data/green_onion.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "oily_png", "1.0.2"
   gem.add_dependency "rainbow", "1.1.4"
   gem.add_dependency "fileutils", "0.7"
+  gem.add_dependency "thor", "0.15.4"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/green_onion.rb

@@ -69,9 +69,9 @@ module GreenOnion
     # This is used in skin_percentage to better alert if a set of skins are ok or not
     def threshold_alert(actual, threshold)
       if actual > threshold
-        puts "#{actual - threshold}% above threshold set @ #{threshold}%".color(:red)
-        puts "pixels changed (%):     #{@compare.percentage_changed}%"
-        puts "pixels changed/total:  #{@compare.changed_px}/#{@compare.total_px}"
+        $stderr.puts "#{actual - threshold}% above threshold set @ #{threshold}%".color(:red)
+        $stderr.puts "pixels changed (%):     #{@compare.percentage_changed}%"
+        $stderr.puts "pixels changed/total:  #{@compare.changed_px}/#{@compare.total_px}"
       else
         puts "pixels changed/total:  #{@compare.changed_px}/#{@compare.total_px}"
       end

data/lib/green_onion/cli.rb

@@ -0,0 +1,41 @@
+require "thor"
+require "green_onion"
+
+module GreenOnion
+  class CLI < Thor
+    include Thor::Actions
+
+    self.source_root("lib/green_onion/generators")
+
+    class_option :dir, :aliases => "-d", :type => :string
+
+    desc "skin <url>", "Creates skins from <url> and compares them"
+    method_option :method, :aliases => "-m", :type => :string
+    method_option :threshold, :aliases => "-t", :type => :numeric
+    method_option :width, :aliases => "-w", :type => :numeric
+    method_option :height, :aliases => "-h", :type => :numeric
+    def skin(url)
+      GreenOnion.configure do |c|
+        c.skins_dir = options[:dir] if options[:dir]
+        c.threshold = options[:threshold] if options[:threshold]
+        c.dimensions = { :width => options[:width], :height => options[:height] } if options[:width] && options[:height]
+      end
+      case options[:method]
+      when "v"
+        GreenOnion.skin_visual(url)
+      when "p"
+        GreenOnion.skin_percentage(url)
+      else
+        GreenOnion.skin_visual_and_percentage(url)
+      end
+    end
+
+    desc "generate", "Generates a 'skinner' file to test a Rails app at <url> with 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")
+    end
+  end
+end

data/lib/green_onion/compare.rb

@@ -16,7 +16,14 @@ module GreenOnion
       ]
 
       @diff_index = []
+      begin
+        diff_iterator
+      rescue ChunkyPNG::OutOfBounds
+        puts "Skins are different sizes. Please delete #{org} and/or #{fresh}.".color(:yellow)
+      end
+    end
 
+    def diff_iterator
       @images.first.height.times do |y|
         @images.first.row(y).each_with_index do |pixel, x|
           unless pixel == @images.last[x,y]

data/lib/green_onion/configuration.rb

@@ -4,7 +4,7 @@ module GreenOnion
     attr_writer :threshold, :skins_dir
 
     def dimensions=(options)
-      @dimensions = { :width => options[:width], :height => options[:height] }
+      @dimensions = options
     end
     
     def dimensions

data/lib/green_onion/generators/skinner.erb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'green_onion'
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+
+GreenOnion.configure do |c|
+  # You can use and customize these configuration options
+  # c.skins_dir = "#{::Rails.root}/spec/skins"
+  # c.threshold = 100
+  # c.dimensions = { :width => 1024, :height => 768 }
+end
+
+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)
+end

data/lib/green_onion/screenshot.rb

@@ -48,10 +48,14 @@ module GreenOnion
 
     def destroy(url)
       get_path(url)
-      if File.exist?( @paths_hash[:original] )
-        FileUtils.rm( @paths_hash[:original] )
-        if File.exist?( @paths_hash[:fresh] )
-          FileUtils.rm( @paths_hash[:fresh] ) 
+      destroy_files(@paths_hash[:original], @paths_hash[:fresh])
+    end
+
+    def destroy_files(org, fresh)
+      if File.exist?(org)
+        FileUtils.rm(org)
+        if File.exist?(fresh)
+          FileUtils.rm(fresh) 
         end
       end
     end

data/lib/green_onion/version.rb

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

data/spec/unit/cli_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "bin/green_onion" do
+
+  before(:all) do
+    @tmp_path = './spec/tmp'
+    @url = 'http://localhost:8070'
+    @file1 = "#{@tmp_path}/root.png"
+    @skinner_file = "#{@tmp_path}/skinner.rb"
+  end
+
+  describe "Skin Utility" do
+
+    before(:each) do  
+      FileUtils.mkdir(@tmp_path)
+    end
+
+    after(:each) do
+      FileUtils.rm_r(@tmp_path, :force => true)
+    end     
+
+    it "should run the skin task w/o any flags (need the --dir flag to keep spec directory clean)" do
+      `bin/green_onion skin #{@url} -d=#{@tmp_path}`
+      File.exist?(@file1).should be_true
+    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}`
+      File.exist?(@skinner_file).should be_true
+    end
+    
+  end
+end

data/spec/unit/compare_spec.rb

@@ -8,6 +8,7 @@ describe GreenOnion::Compare do
       @comparison = GreenOnion::Compare.new
       @spec_shot1 = './spec/skins/spec_shot.png'
       @spec_shot2 = './spec/skins/spec_shot_fresh.png'
+      @spec_shot_resize = './spec/skins/spec_shot_resize.png'
       @diff_shot = './spec/skins/spec_shot_diff.png'
     end
 
@@ -24,5 +25,10 @@ describe GreenOnion::Compare do
       @comparison.visual_diff(@spec_shot1, @spec_shot2)
       File.exist?(@diff_shot).should be_true
     end
+
+    it "should not throw error when dimensions are off" do
+      expect { @comparison.visual_diff(@spec_shot1, @spec_shot_resize) }.to_not raise_error
+    end
+
   end
 end

data/spec/unit/green_onion_spec.rb

@@ -117,7 +117,7 @@ describe GreenOnion do
     end
 
     it "should alert when diff percentage threshold is surpassed" do
-      $stdout.should_receive(:puts).exactly(5).times
+      $stderr.should_receive(:puts).exactly(3).times
       2.times do
         GreenOnion.skin_percentage(@url)
       end

metadata

@@ -2,7 +2,7 @@
 name: green_onion
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ted O'Meara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-31 00:00:00 Z
+date: 2012-08-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -122,11 +122,22 @@ dependencies:
         version: "0.7"
   type: :runtime
   version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.15.4
+  type: :runtime
+  version_requirements: *id011
 description: UI testing/screenshot diffing tool
 email: 
 - ted@intridea.com
-executables: []
-
+executables: 
+- green_onion
 extensions: []
 
 extra_rdoc_files: []
@@ -140,16 +151,21 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/green_onion
 - green_onion.gemspec
 - lib/green_onion.rb
+- lib/green_onion/cli.rb
 - lib/green_onion/compare.rb
 - lib/green_onion/configuration.rb
+- lib/green_onion/generators/skinner.erb
 - lib/green_onion/screenshot.rb
 - lib/green_onion/version.rb
 - spec/sample_app/sample_app.rb
 - spec/skins/spec_shot.png
 - spec/skins/spec_shot_fresh.png
+- spec/skins/spec_shot_resize.png
 - spec/spec_helper.rb
+- spec/unit/cli_spec.rb
 - spec/unit/compare_spec.rb
 - spec/unit/green_onion_spec.rb
 - spec/unit/screenshot_spec.rb
@@ -184,7 +200,9 @@ test_files:
 - spec/sample_app/sample_app.rb
 - spec/skins/spec_shot.png
 - spec/skins/spec_shot_fresh.png
+- spec/skins/spec_shot_resize.png
 - spec/spec_helper.rb
+- spec/unit/cli_spec.rb
 - spec/unit/compare_spec.rb
 - spec/unit/green_onion_spec.rb
 - spec/unit/screenshot_spec.rb