green_onion 0.1.3 → 0.1.4

data/README.md

@@ -13,7 +13,7 @@ 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.
+If you want to use [capybara-webkit](https://github.com/thoughtbot/capybara-webkit), 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) and `gem install capybara-webkit` to get it up and running. Overwise, you can just use `:driver => :selenium` in the configuration block.
 
 Add this line to your application's Gemfile:
 
@@ -42,8 +42,9 @@ Options
 * `--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.
+* `--width=[number]` is the width of the browser window. The default width is 1024. (only when using capybara-webkit)
+* `--height=[number]` is the height of the browser window. The default height is 768. (only when using capybara-webkit)
+* `--driver=DRIVER` is the browser driver for Capybara. It is `webkit` by default, but you can also pass in `selenium`.
 
 #### Generating skinner file
 
@@ -66,6 +67,7 @@ For adding GreenOnion to your integration tests in RSpec, add `require 'green_on
         :prefix => nil,
         :root => "root" 
       }
+      c.driver = :webkit
       c.dimensions = { 
         :width => 1440, 
         :height => 768 
@@ -79,6 +81,7 @@ For adding GreenOnion to your integration tests in RSpec, add `require 'green_on
     * `:replace` - the string that replaces what is matched. These options are just abstractions of String.gsub in GreenOnion::Screenshot.
     * `:prefix` - a value that will be concatenated to the front of the filename. A good example would be if you wanted to add a timestamp: `:prefix => Time.now.strftime("%m_%Y_")`.
     * `:root` - the string that will be used to name the root of a domain.
+* `driver` is a string for the browser driver to use. The default is `'webkit'`. You could also pass in `'selenium'` instead.
 * `dimensions` is a hash with the height and width of the browser window. The default dimensions are 1024x768.
 * `threshold` is the percentage of acceptable change that the screenshots can take. This number can always be overwritten for an instance.
 
@@ -128,13 +131,16 @@ The best way to run the specs is with...
 
 Much of this work could not be completed without these people and projects
 
-### Jeff Kreeftmeijer
+### [Jeff Kreeftmeijer](http://jeffkreeftmeijer.com)
 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
+### [Compatriot](https://github.com/carols10cents/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, ChunkyPNG, Thor, and OilyPNG
+### [VCR](https://github.com/myronmarston/vcr)
+Many patterns and ideas also came from VCR, because of its flexibility in allowing users to pick what gems to work with.
+
+### [Capybara](https://github.com/jnicklas/capybara), [ChunkyPNG](https://github.com/wvanbergen/chunky_png), [Thor](https://github.com/wycats/thor), and [OilyPNG](https://github.com/wvanbergen/oily_png)
 The land on which we sow our bulbs.
 
 ## Contributor

data/green_onion.gemspec

@@ -11,13 +11,13 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "sinatra"
+  gem.add_development_dependency "capybara-webkit"
   
-  gem.add_dependency "capybara", "1.1.2"
-  gem.add_dependency "capybara-webkit", "0.12.1"
-  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.add_dependency "capybara", " ~> 1.1"
+  gem.add_dependency "oily_png", "~> 1.0.2"
+  gem.add_dependency "rainbow"
+  gem.add_dependency "fileutils"
+  gem.add_dependency "thor", ">= 0.14.6"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/green_onion.rb

@@ -3,6 +3,7 @@ require "green_onion/screenshot"
 require "green_onion/compare"
 require "green_onion/configuration"
 require "green_onion/errors"
+require "green_onion/browser"
 require "rainbow"
 
 module GreenOnion
@@ -16,17 +17,17 @@ module GreenOnion
     end
 
     def configuration
-      @configuration ||= GreenOnion::Configuration.new
+      @configuration ||= Configuration.new
     end
 
     # Bring the Screenshot and Compare classes together to create a skin
     def skin(url)
       @screenshot = Screenshot.new(
         :dir => @configuration.skins_dir,
-        :dimensions => @configuration.dimensions,
-        :skin_name => @configuration.skin_name
+        :skin_name => @configuration.skin_name,
+        :browser => @configuration.browser
       )
-      @compare = GreenOnion::Compare.new
+      @compare = Compare.new
 
       @screenshot.test_screenshot(url)
     end

data/lib/green_onion/browser.rb

@@ -0,0 +1,27 @@
+module GreenOnion
+  class Browser
+
+    attr_reader :driver, :dimensions
+
+    def initialize(params={})
+      @driver = params[:driver]
+      @dimensions = params[:dimensions]
+      load_driver
+    end
+
+    def load_driver
+      begin
+        require "green_onion/drivers/#{driver}"
+        @driver_obj = GreenOnion.const_get(@driver.capitalize).new
+      rescue LoadError => e
+        raise e unless e.message.include?("green_onion/drivers")
+        raise ArgumentError.new("#{@driver} is not supported by GreenOnion.")
+      end
+    end
+
+    def snap_screenshot(url, path)
+      @driver_obj.record(url, path, @dimensions)
+    end
+
+  end
+end

data/lib/green_onion/cli.rb

@@ -12,6 +12,7 @@ module GreenOnion
     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 :browser, :aliases => "-b", :type => :string
     method_option :width, :aliases => "-w", :type => :numeric
     method_option :height, :aliases => "-h", :type => :numeric
     def skin(url)
@@ -19,6 +20,7 @@ module GreenOnion
         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]
+        c.driver = options[:driver].to_sym if options[:driver]
       end
       case options[:method]
       when "v"

data/lib/green_onion/compare.rb

@@ -23,6 +23,7 @@ module GreenOnion
       end
     end
 
+    # Run through all of the pixels on both org image, and fresh image. Change the pixel color accordingly.
     def diff_iterator
       @images.first.height.times do |y|
         @images.first.row(y).each_with_index do |pixel, x|
@@ -34,6 +35,7 @@ module GreenOnion
       end
     end
 
+    # Changes the pixel color to be the opposite RGB value
     def pixel_difference_filter(pixel, x, y)
       chans = []
       [:r, :b, :g].each do |chan| 
@@ -42,10 +44,12 @@ module GreenOnion
       @images.last[x,y] = ChunkyPNG::Color.rgb(chans[0], chans[1], chans[2])
     end
 
+    # Interface to run the R, G, B methods on ChunkyPNG
     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
 
+    # Returns the numeric results of the diff of 2 images
     def percentage_diff(org, fresh)
       diff_images(org, fresh)
       @total_px = @images.first.pixels.length
@@ -53,11 +57,13 @@ module GreenOnion
       @percentage_changed = ( (@diff_index.length.to_f / @images.first.pixels.length) * 100 ).round(2)
     end
 
+    # Returns the visual results of the diff of 2 images
     def visual_diff(org, fresh)
       diff_images(org, fresh)
       save_visual_diff(org, fresh)
     end
 
+    # Saves the visual diff as a separate file
     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')

data/lib/green_onion/configuration.rb

@@ -1,7 +1,7 @@
 module GreenOnion
   class Configuration
 
-    attr_writer :threshold, :skins_dir
+    attr_writer :threshold, :skins_dir, :driver
 
     def dimensions=(options)
       @dimensions = options
@@ -19,6 +19,18 @@ module GreenOnion
       @skins_dir ||= './spec/skins'
     end
 
+    def driver
+      @driver ||= :webkit
+    end
+
+    # Uses the driver and dimensions configuration vars to return a Browser object
+    def browser
+      @browser = Browser.new(
+        :dimensions => dimensions,
+        :driver => driver
+      )
+    end
+
     def skin_name=(options)
       @skin_name = skin_namespace_hash(options)
     end
@@ -27,6 +39,7 @@ module GreenOnion
       @skin_name ||= skin_namespace_hash
     end
 
+    # Serves as a template for skin_name getter/setter
     def skin_namespace_hash(options = {})
       { 
         :match   =>  options[:match] ? options[:match] : /[\/]/, 

data/lib/green_onion/drivers/selenium.rb

@@ -0,0 +1,17 @@
+require 'capybara/dsl'
+
+module GreenOnion
+  class Selenium
+    include Capybara::DSL
+
+    def initialize
+      Capybara.default_driver = :selenium
+    end
+
+    def record(url, path, dimensions=nil)
+      visit url
+      page.driver.browser.save_screenshot(path)
+    end
+
+  end
+end

data/lib/green_onion/drivers/webkit.rb

@@ -0,0 +1,18 @@
+require 'capybara/dsl'
+require 'capybara-webkit'
+
+module GreenOnion
+  class Webkit
+    include Capybara::DSL
+
+    def initialize
+      Capybara.default_driver = :webkit
+    end
+
+    def record(url, path, dimensions)
+      visit url
+      page.driver.render(path, dimensions)
+    end
+
+  end
+end

data/lib/green_onion/generators/skinner.erb

@@ -11,6 +11,12 @@ GreenOnion.configure do |c|
   # c.skins_dir = "#{::Rails.root}/spec/skins"
   # c.threshold = 100
   # c.dimensions = { :width => 1024, :height => 768 }
+  # c.skin_name = {
+  #   :match => /[\/]/, 
+  #   :replace => "_", 
+  #   :prefix => nil,
+  #   :root => "root" 
+  # }
 end
 
 all_routes = Rails.application.routes.routes

data/lib/green_onion/screenshot.rb

@@ -1,30 +1,21 @@
-require 'capybara/dsl'
-require 'capybara-webkit'
 require "fileutils"
 
 module GreenOnion
   class Screenshot
-    include Capybara::DSL
 
-    attr_accessor :dir, :dimensions, :skin_name
-    attr_reader :paths_hash
+    attr_reader :paths_hash, :browser, :dir, :skin_name, :dimensions
 
-    def initialize(params = {})
-      Capybara.default_driver = :webkit
-      @dimensions = params[:dimensions]
+    def initialize(params={})
       @dir = params[:dir]
       @skin_name = params[:skin_name]
+      @browser = params[:browser]
       @paths_hash = {}
     end
 
-    def snap_screenshot(url, path)
-      visit url
-      Capybara.page.driver.render(path, @dimensions)
-    end
-
     def test_screenshot(url)
       url_to_path(url)
-      snap_screenshot(url, @shot_path)
+      create_dir(@dir)
+      @browser.snap_screenshot(url, @shot_path)
     end
 
     def url_to_path(url)
@@ -53,6 +44,12 @@ module GreenOnion
       @paths_hash[:original] = "#{@dir}/#{@filename}.png"
     end
 
+    def create_dir(dir)
+      unless Dir.exist?(dir)
+        FileUtils.mkdir(dir)
+      end
+    end
+
     def get_path(url)
       url_matcher(url)
       if @filename.empty? || @filename == '/' 

data/lib/green_onion/version.rb

@@ -1,3 +1,3 @@
 module GreenOnion
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/unit/drivers/selenium_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe 'Using Selenium' do
+
+  before(:all) do
+    @url = 'http://localhost:8070'
+    @url_w_uri = @url + '/fake_uri'
+    @tmp_path = './spec/tmp'
+    @browser = GreenOnion::Browser.new(
+      :dimensions => { :width => 1024, :height => 768 },
+      :driver => "selenium"
+    )
+  end
+
+  before(:each) do
+    @screenshot = GreenOnion::Screenshot.new(
+      :browser => @browser,
+      :dir => @tmp_path,
+      :skin_name => { 
+        :match => /[\/]/,
+        :replace => "_",
+        :prefix => nil,
+        :root => "root"
+      }
+    )
+    @file = "#{@tmp_path}/fake_uri.png"
+  end
+
+  after(:each) do
+    FileUtils.rm_r(@tmp_path, :force => true)
+  end
+
+  it "should snap and save screenshot w/ Selenium" do
+    @screenshot.test_screenshot(@url_w_uri)
+    File.exist?(@file).should be_true
+  end
+end

data/spec/unit/drivers/webkit_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe 'Using Webkit' do
+
+  before(:all) do
+    @url = 'http://localhost:8070'
+    @url_w_uri = @url + '/fake_uri'
+    @tmp_path = './spec/tmp'
+    @browser = GreenOnion::Browser.new(
+      :dimensions => { :width => 1024, :height => 768 },
+      :driver => "webkit"
+    )
+  end
+
+  before(:each) do
+    @screenshot = GreenOnion::Screenshot.new(
+      :browser => @browser,
+      :dir => @tmp_path,
+      :skin_name => { 
+        :match => /[\/]/,
+        :replace => "_",
+        :prefix => nil,
+        :root => "root"
+      }
+    )
+    @file = "#{@tmp_path}/fake_uri.png"
+  end
+
+  after(:each) do
+    FileUtils.rm_r(@tmp_path, :force => true)
+  end
+
+  it "should snap and save screenshot w/ Webkit" do
+    @screenshot.test_screenshot(@url_w_uri)
+    File.exist?(@file).should be_true
+  end
+end

data/spec/unit/green_onion_spec.rb

@@ -176,5 +176,31 @@ describe GreenOnion do
     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
+
+    it "should raise error for when unknown driver is assigned" do
+      GreenOnion.configure do |c|
+        c.skins_dir = @tmp_path
+        c.driver = :foo
+      end
+      expect { GreenOnion.skin_percentage(@url) }.to raise_error(ArgumentError)
+    end
+  end
+
+
+  describe "Skins with custom driver" do
+    before(:each) do  
+      GreenOnion.configure do |c|
+        c.skins_dir = @tmp_path
+        c.driver = "selenium"
+      end
+    end
+
+    after(:each) do
+      FileUtils.rm_r(@tmp_path, :force => true)
+    end
+
+    it "should allow custom browser driver" do
+      GreenOnion.configuration.browser.driver.should eq("selenium")
+    end
   end
 end

data/spec/unit/screenshot_spec.rb

@@ -6,15 +6,18 @@ describe GreenOnion::Screenshot do
     @url = 'http://localhost:8070'
     @url_w_uri = @url + '/fake_uri'
     @tmp_path = './spec/tmp'
-    @dimensions = { :width => 1024, :height => 768 }
+    @browser = GreenOnion::Browser.new(
+      :dimensions => { :width => 1024, :height => 768 },
+      :driver => "webkit"
+    )
   end
 
   describe 'Snap single screenshot' do
 
     before(:each) do
       @screenshot = GreenOnion::Screenshot.new(
+        :browser => @browser,
         :dir => @tmp_path,
-        :dimensions => @dimensions,
         :skin_name => { 
           :match => /[\/]/,
           :replace => "",
@@ -42,7 +45,7 @@ describe GreenOnion::Screenshot do
     end
 
     it 'should snap and save screenshot' do
-      @screenshot.snap_screenshot(@url_w_uri, @file)
+      @screenshot.browser.snap_screenshot(@url_w_uri, @file)
       File.exist?(@file).should be_true
     end
 
@@ -56,8 +59,8 @@ describe GreenOnion::Screenshot do
 
     before(:each) do
       @screenshot = GreenOnion::Screenshot.new(
+        :browser => @browser,
         :dir => @tmp_path,
-        :dimensions => @dimensions,
         :skin_name => { 
           :match => /[\/]/,
           :replace => "",
@@ -100,6 +103,7 @@ describe GreenOnion::Screenshot do
 
     it "should allow users to create a naming convention" do
       @screenshot = GreenOnion::Screenshot.new(
+        :browser => @browser,
         :dir => @tmp_path,
         :skin_name => { 
           :match => /[\/]/, 
@@ -115,6 +119,7 @@ describe GreenOnion::Screenshot do
     it "should allow filenames to have a timestamp" do
       this_month = Time.now.strftime("%m_%Y_")
       @screenshot = GreenOnion::Screenshot.new(
+        :browser => @browser,
         :dir => @tmp_path,
         :skin_name => { 
           :match => /[\/]/,
@@ -129,6 +134,7 @@ describe GreenOnion::Screenshot do
 
      it "should allow renaming for root skins" do
       @screenshot = GreenOnion::Screenshot.new(
+        :browser => @browser,
         :dir => @tmp_path,
         :skin_name => { 
           :match => /[\/]/,
@@ -141,4 +147,5 @@ describe GreenOnion::Screenshot do
       @screenshot.paths_hash[:original].should eq("#{@tmp_path}/first.png")
     end
   end
+
 end

metadata

@@ -2,7 +2,7 @@
 name: green_onion
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Ted O'Meara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-08 00:00:00 Z
+date: 2012-08-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -46,25 +46,25 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: capybara
+  name: capybara-webkit
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.2
-  type: :runtime
+        version: "0"
+  type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: capybara-webkit
+  name: capybara
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.12.1
+        version: "1.1"
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -73,7 +73,7 @@ dependencies:
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         version: 1.0.2
   type: :runtime
@@ -84,9 +84,9 @@ dependencies:
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.4
+        version: "0"
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
@@ -95,9 +95,9 @@ dependencies:
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.7"
+        version: "0"
   type: :runtime
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
@@ -106,9 +106,9 @@ dependencies:
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.15.4
+        version: 0.14.6
   type: :runtime
   version_requirements: *id009
 description: UI testing/screenshot diffing tool
@@ -132,13 +132,18 @@ files:
 - bin/green_onion
 - green_onion.gemspec
 - lib/green_onion.rb
+- lib/green_onion/browser.rb
 - lib/green_onion/cli.rb
 - lib/green_onion/compare.rb
 - lib/green_onion/configuration.rb
+- lib/green_onion/drivers/selenium.rb
+- lib/green_onion/drivers/webkit.rb
 - lib/green_onion/errors.rb
 - lib/green_onion/generators/skinner.erb
 - lib/green_onion/screenshot.rb
 - lib/green_onion/version.rb
+- spec/sample_app/public/onion_face_0.jpg
+- spec/sample_app/public/onion_face_1.jpg
 - spec/sample_app/sample_app.rb
 - spec/skins/spec_shot.png
 - spec/skins/spec_shot_fresh.png
@@ -146,6 +151,8 @@ files:
 - spec/spec_helper.rb
 - spec/unit/cli_spec.rb
 - spec/unit/compare_spec.rb
+- spec/unit/drivers/selenium_spec.rb
+- spec/unit/drivers/webkit_spec.rb
 - spec/unit/green_onion_spec.rb
 - spec/unit/screenshot_spec.rb
 homepage: http://intridea.github.com/green_onion
@@ -176,6 +183,8 @@ signing_key:
 specification_version: 3
 summary: Regressions in the view making you cry? Have more confidence with GreenOnion.
 test_files: 
+- spec/sample_app/public/onion_face_0.jpg
+- spec/sample_app/public/onion_face_1.jpg
 - spec/sample_app/sample_app.rb
 - spec/skins/spec_shot.png
 - spec/skins/spec_shot_fresh.png
@@ -183,6 +192,8 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/cli_spec.rb
 - spec/unit/compare_spec.rb
+- spec/unit/drivers/selenium_spec.rb
+- spec/unit/drivers/webkit_spec.rb
 - spec/unit/green_onion_spec.rb
 - spec/unit/screenshot_spec.rb
 has_rdoc: