rspec-page-regression 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 989c90a06a9ad0ad6e5e69c61118c8960999019e
-  data.tar.gz: a1ef462d3075a522528bc39fb7b076a84ed9ba30
+  metadata.gz: 16be31d2cd913d4f1c0e4d8e8cfe17236478aafe
+  data.tar.gz: 3cfc21083eb4dc17b28f4ba4496d9d437eb76401
 SHA512:
-  metadata.gz: 07a4e7baeee04af73847b73030880baee7d6b06d81acc6edbad15f5a3ea65ae4c94e8da465ec4ed9584b81053038227430b4fcb053a22c7a6d77dcaa99714006
-  data.tar.gz: 195e79f35b7e35511be05af0bb01a3a177a919f7f48197efe6ed3401b15f2373abc59901770e6977200c3762ef2c5172b9a3d17895d27f2174586d68e38333b2
+  metadata.gz: bbe34659c64d36c19ae203ea9ce0bbea48505009ec7cc9b984c45412a9e17e2602954eac59892b67e7582960a638e490b619217cf8985f275a865f46949eec75
+  data.tar.gz: 9a271da665070a549833b805294f5ddf8d6a8495d3c986debdd72d2d045f99a133bee974a00e3885ee9466ef63e1a705badde5e86ceb2ab9bd0769dcffac4576

data/Gemfile

@@ -4,4 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'awesome_print'
-gem 'byebug'
+gem 'byebug' if RUBY_VERSION >= "2.0.0"

data/README.md

@@ -1,6 +1,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/rspec-page-regression.png)](http://badge.fury.io/rb/rspec-page-regression)
-[![Build Status](https://secure.travis-ci.org/ronen/rspec-page-regression.png)](http://travis-ci.org/ronen/rspec-page-regression) 
+[![Build Status](https://secure.travis-ci.org/ronen/rspec-page-regression.png)](http://travis-ci.org/ronen/rspec-page-regression)
 [![Dependency Status](https://gemnasium.com/ronen/rspec-page-regression.png)](https://gemnasium.com/ronen/rspec-page-regression)
 
 # rspec-page-regression
@@ -27,7 +27,7 @@ And in your spec_helper:
 
     require 'rspec'  # or 'rspec/rails' if you're using Rails
     require 'rspec/page-regression'
-    
+
 	require 'capybara/rspec'
 	require 'capybara/poltergeist'
 	Capybara.javascript_driver = :poltergeist
@@ -37,7 +37,7 @@ Rspec-page-regression presupposes the convention that your spec files are somwhe
 To install for use with Selenium, [see instructions below](#selenium).
 
 #### Note on versions:
-Rspec-page-regression has multiple versions that work in concert with the [significant changes in RSpec version 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3).  If you're using bundler, the gem dependencies should automatically find the proper version of rspec-page-regression for your chosen version of RSpec. 
+Rspec-page-regression has multiple versions that work in concert with the [significant changes in RSpec version 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3).  If you're using bundler, the gem dependencies should automatically find the proper version of rspec-page-regression for your chosen version of RSpec.
 
 | Rspec Version | Rspec-page-regression |
 | ------------- | --------------------- |
@@ -52,7 +52,7 @@ Rspec-page-regression provides a matcher that renders the page and compares
 the resulting image against an expected image.  To use it, you need to enable Capybara and Poltergeist by specifying `:type => :feature` and `:js => true`:
 
     require 'spec_helper'
-    
+
     describe "my page", :type => :feature, :js => true do
 
       before(:each) do
@@ -69,7 +69,7 @@ the resulting image against an expected image.  To use it, you need to enable Ca
         it { expect(page).to match_expectation }
       end
     end
-    
+
 The spec will pass if the test rendered image contains the  exact same pixel values as the expectated image.  Otherwise it will fail with an error message along the lines of:
 
     Test image does not match expected image
@@ -110,6 +110,8 @@ Everything will work normally, and the failure messages will refer to your path.
 
 ## Configuration
 
+### Window size
+
 The default window size for the renders is 1024 x 768 pixels.  You can specify another size as `[height, width]` in pixels:
 
      # in spec_helper.rb:
@@ -119,9 +121,19 @@ The default window size for the renders is 1024 x 768 pixels.  You can specify a
 
 Note that this specifies the size of the browser window viewport; but rspec-page-regression requests a render of the full page, which might extend beyond the window.  So the rendered file dimensions may be larger than this configuration value.
 
+### Image difference threshold
+
+By default, a test fails if only a single pixel in the screenshot differs from the expectation image. To account for minor rendering differences, you can set a threshold value that allows a certain amount of differences. The threshold value is the fraction of pixels that are allowed to differ before the test fails.
+
+    RSpec::PageRegression.configure do |config|
+      config.threshold = 0.01
+    end
+
+This setting means that 1% of pixels are allowed to differ between the rendering result and the expectation image. For example, for an image size of 1024 x 768 and a threshold of 0.01, the maximum number of pixel differences between the images is 7864.
+
 ## [Using the selenium driver](id:selenium)
 
-You can also use the selenium driver with capybara. This offers the possiblity to visually test your pages against a range of real browsers. 
+You can also use the selenium driver with capybara. This offers the possiblity to visually test your pages against a range of real browsers.
 
 Add the [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver) to your Gemfile:
 
@@ -156,6 +168,8 @@ Don't forget to include specs (`rake spec`) to verify your functionality.  Code
 
 Release Notes:
 
+* 0.4.0 - Add difference threshold.  Thanks to [@abersager](https://github.com/abersager)
+
 * 0.3.0 - Compatibility with rspec 3.0
 
 * 0.2.99 - Compatibility with rspec 2.99
@@ -168,4 +182,3 @@ Release Notes:
 
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ronen/rspec-page-regression/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/lib/rspec/page-regression.rb

@@ -16,4 +16,12 @@ module RSpec::PageRegression
   def self.page_size
     @@page_size ||= [1024, 768]
   end
+
+  def self.threshold= (threshold)
+    @@threshold = threshold
+  end
+
+  def self.threshold
+    @@threshold ||= 0.0
+  end
 end

data/lib/rspec/page-regression/image_comparison.rb

@@ -40,8 +40,13 @@ module RSpec::PageRegression
     end
 
     def pixels_match?
+      max_count = RSpec::PageRegression.threshold * @itest.width * @itest.height
+      count = 0
       @itest.height.times do |y|
-        return false if @itest.row(y) != @iexpected.row(y)
+        next if @itest.row(y) == @iexpected.row(y)
+        diff = @itest.row(y).zip(@iexpected.row(y)).select { |x, y| x != y }
+        count += diff.count
+        return false if count > max_count
       end
       return true
     end

data/lib/rspec/page-regression/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module PageRegression
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/match_expectation_spec.rb

@@ -62,6 +62,40 @@ describe "match_expectation" do
       Then { expect(difference_path.read).to eq fixture_image("ABdiff").read }
     end
 
+    context "when difference threshold is set" do
+      context "when difference threshold is configured below image difference" do
+        Given do
+          RSpec::PageRegression.configure do |config|
+            config.threshold = 0.01
+          end
+        end
+        Given { use_test_image "A" }
+        Given { use_expected_image "B" }
+
+        Then { expect(@error).to_not be_nil }
+        Then { expect(@error.message).to include "Test image does not match expected image" }
+        Then { expect(@error.message).to match viewer_pattern(test_path, expected_path, difference_path) }
+
+        Then { expect(difference_path.read).to eq fixture_image("ABdiff").read }
+      end
+
+      context "when difference threshold is configured above image difference" do
+        Given do
+          RSpec::PageRegression.configure do |config|
+            config.threshold = 0.02
+          end
+        end
+        Given { use_test_image "A" }
+        Given { use_expected_image "B" }
+
+        Then { expect(@error).to be_nil }
+      end
+
+      after :each do
+        RSpec::PageRegression.class_variable_set :@@threshold, nil
+      end
+    end
+
     context "when test image is missing" do
       Given { use_expected_image "A" }
 

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'simplecov'
 require 'simplecov-gem-adapter'
 SimpleCov.start "gem"

metadata

@@ -1,181 +1,181 @@
 --- !ruby/object:Gem::Specification
 name: rspec-page-regression
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oily_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: which_works
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-given
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Rspec-page-regression provides a mechanism for headless regression testing
@@ -189,9 +189,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -221,17 +221,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Web page rendering (HTML, CSS, and JavasSript) regression for RSpec