rspec-page-regression 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72a4f9ee17017a996fd72fd83a81a9dfeb49d4cb
+  data.tar.gz: 0000e7eb2782beb039debe4e6a30a89f7134c95f
+SHA512:
+  metadata.gz: 37300c7d8d06f07905aecf5ca5030d2b07fc549ccb6408e1908827ad5e58b9e368357216a1cc4bee4cb8b596d15726cee81397c2981e6a32c356e3b20b1e0227
+  data.tar.gz: 4be3fb7c2998990b62c3736a4cb6c163d83b5dec047f29b0bb8adaf2769fc24c727a0d2f1cef973ec1901e8e3821910e20184dc3cd56650ac1795c47a194c905

data/README.md

@@ -1,14 +1,22 @@
 # rspec-page-regression
 
 Rspec-page-regression is an [RSpec](https://github.com/rspec/rspec) plugin
-that makes it easy to regression test your web application pages, to make
-sure the pages continue to look the way you expect them to look.
+that makes it easy to headlessly regression test your web application pages to make sure the pages continue to look the way you expect them to look, taking into account HTML, CSS, and JavaScript.
+
+It provides an RSpec matcher that compares the test snapshot to an expected image, and facilitates management of the images.
+
+Rspec-page-regression uses [PhantomJS](http://www.phantomjs.org/) to headlessly render web page snapshots, by virtue of the [Poltergeist](https://github.com/jonleighton/poltergeist) driver for [Capybara](https://github.com/jnicklas/capybara).  
+
+
+[![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) 
+[![Dependency Status](https://gemnasium.com/ronen/rspec-page-regression.png)](https://gemnasium.com/ronen/rspec-page-regression)
 
-[<img src="https://secure.travis-ci.org/ronen/rspec-page-regression.png"/>](http://travis-ci.org/ronen/rspec-page-regression)[<img src="https://gemnasium.com/ronen/rspec-page-regression.png" alt="Dependency Status" />](https://gemnasium.com/ronen/rspec-page-regression)
 
 ## Installation
 
-Rspec-page-regression uses [PhantomJS](http://www.phantomjs.org/) to render web page snapshots, by virtue of the [Poltergeist](https://github.com/jnicklas/capybara) driver for [Capybara](https://github.com/jnicklas/capybara).  Assuming you have those installed and ready to go...
+
+Install PhantomJS as per [PhantomJS: Download and Install](http://phantomjs.org/download.html) and/or [Poltergeist: Installing PhantomJS](https://github.com/jonleighton/poltergeist#installing-phantomjs).  There are no other external dependencies (no need for Qt, nor an X server, nor ImageMagick, etc.)
 
 In your Gemfile:
 
@@ -16,17 +24,22 @@ In your Gemfile:
 
 And in your spec_helper:
 
-    require 'rspec'
+    require 'rspec'  # or 'rspec/rails' if you're using Rails
     require 'rspec/page-regression'
+    
+	require 'capybara/rspec'
+	require 'capybara/poltergeist'
+	Capybara.javascript_driver = :poltergeist
 
-Rspec-page-regression presupposes the convention that your spec files are under a directory named `spec` (checked in to your repo), with a sibling directory `tmp` (.gitignore'd)
+Rspec-page-regression presupposes the convention that your spec files are somwhere under a directory named `spec` (checked in to your repo), which has a sibling directory `tmp` (.gitignore'd)
 
 ## Usage
 
 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`:
+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
@@ -53,24 +66,24 @@ Notice that the second line gives a command you can copy and paste in order to v
 
 It also shows a "difference image" in which each pixel contains the per-channel absolute difference between the test and expected images.  That is, the difference images is black everywhere except has some funky colored pixels where the test and expected images differ.  To help you locate those, it also has a red bounding box drawn around the region with differences.
 
-### How do you create expectation images?
+### How do I create expectation images?
 
-The easiest way to create an expected image is to run the test for the first time and let it fail.  You'll then get a failure message like:
+The easiest way to create an expectation image is to run the test for the first time and let it fail.  You'll then get a failure message like:
 
     Missing expectation image spec/expectation/my_page/popup_help/expected.png
         $ open tmp/spec/expectation/my_page/popup_help/test.png
     To create it:
         $ mkdir -p spec/expectation/my_page/popup_help && cp tmp/spec/expectation/my_page/popup_help/test.png spec/expectation/my_page/popup_help/expected.png
 
-First view the image to make sure it really is what you expect.  Then copy and past the last line to install it.  (And then of course commit it into your repository.)
+First view the test image to make sure it really is what you expect.  Then copy and paste the last line to install it as the expected image.  (And then of course commit the expected image into your repository.)
 
-### How do you update expectation images?
+### How do I update expectation images?
 
-If you've deliberatly changed something that affects the look of your web page, then your regression test will fail.  The "test" image will contain the new look, and the "expected" image will contain the old.
+If you've deliberatly changed something that affects the look of your web page, your regression test will fail.  The "test" image will contain the new look, and the "expected" image will contain the old.
 
-Once you've visually checked the test image to make sure it's really what you want, then simply copy the test image over the old expected image.  (And then of course commit it it into your repository.)
+Once you've visually checked the test image to make sure it's really what you want, then simply copy the test image over the old expectation image.  (And then of course commit it it into your repository.)
 
-The failure message doesn't include a ready-to-copy-and-paste `$ cp` command, but you can copy and past the individual file paths from the "does not match" message.  (The reason not to have a ready-to-copy-and-paste command is that in most cases the failure will be real, and it shouldn't be too easy to mindlessly copy and past to make it go away.)
+The failure message doesn't include a ready-to-copy-and-paste `cp` command, but you can copy and paste the individual file paths from the message.  (The reason not to have a ready-to-copy-and-paste command is if the failure is real, it shouldn't be too easy to mindlessly copy and paste to make it go away.)
 
 ### Where are the expectation images?
 
@@ -80,18 +93,18 @@ If that default scheme doesn't suit you, you can pass a path to where the expect
 
     page.should match_expectation "/path/to/my/file.png"
 
-Everything else will work normally, and the failure messages will refer to your path.
+Everything will work normally, and the failure messages will refer to your path.
 
 ## Configuration
 
-The default window size for the renders is 1024 x 768.  You can specify another size as `[height, width]` in pixels:
+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:
-     RSpec::PageRecression.configure do |config|
+     RSpec::PageRegression.configure do |config|
        config.page_size = [1280, 1024]
      end
 
-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 sizes may be larger than this configuration value.
+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.
 
 
 ## Contributing
@@ -104,4 +117,10 @@ Contributions are welcome!  As usual, here's the drill:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-Don't forget to include specs (`rake spec`)!  Code coverage should be 100%
+Don't forget to include specs (`rake spec`) to verify your functionality.  Code coverage should be 100%
+
+## History
+
+Release Notes:
+
+* 0.1.2 - Remove existing difference images so they won't be shown in cases where files couldn't be differenced.

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

@@ -23,6 +23,8 @@ module RSpec::PageRegression
     private
 
     def compare
+      @filepaths.difference_image.unlink if @filepaths.difference_image.exist?
+
       return :missing_expected unless @filepaths.expected_image.exist?
       return :missing_test unless @filepaths.test_image.exist?
 

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

@@ -1,5 +1,5 @@
 module RSpec
   module PageRegression
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/rspec-page-regression.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = RSpec::PageRegression::VERSION
   spec.authors       = ["ronen barzel"]
   spec.email         = ["ronen@barzel.org"]
-  spec.summary       = %q{Web page rendering (html, css, and javascript) regression for RSpec}
-  spec.description   = %q{Rspec-page-regression provides a mechanism for regression testing of web page renders in RSpec.  It takes into account html, css, and javascript, by virtue of using phantomjs (via the poltergeist gem) to render snapshots.  It provides an RSpec matcher that compares the test snapshot to an expected image, and facilitates management of the images.}
+  spec.summary       = %q{Web page rendering (HTML, CSS, and JavasSript) regression for RSpec}
+  spec.description   = %q{Rspec-page-regression provides a mechanism for headless regression testing of web page renders in RSpec.  It takes into account HTML, CSS, and JavaScript, by virtue of using PhantomJS (via the Poltergeist gem) to render snapshots.  It provides an RSpec matcher that compares the test snapshot to an expected image, and facilitates management of the images.}
   spec.homepage      = "https://github.com/ronen/rspec-page-regression"
   spec.license       = "MIT"
 

data/spec/match_expectation_spec.rb

@@ -53,6 +53,10 @@ describe "match_expectation" do
       Then { @error.should_not be_nil }
       Then { @error.message.should include "Missing test image #{test_path}" }
       Then { @error.message.should =~ viewer_pattern(expected_path) }
+      context "with previously-created difference image" do
+        Given { preexisting_difference_image }
+        Then { difference_path.should_not be_exist }
+      end
     end
 
     context "when expected image is missing" do
@@ -62,6 +66,10 @@ describe "match_expectation" do
       Then { @error.message.should include "Missing expectation image #{expected_path}" }
       Then { @error.message.should =~ viewer_pattern(test_path) }
       Then { @error.message.should include "mkdir -p #{expected_path.dirname} && cp #{test_path} #{expected_path}" }
+      context "with previously-created difference image" do
+        Given { preexisting_difference_image }
+        Then { difference_path.should_not be_exist }
+      end
     end
 
     context "when sizes mismatch" do
@@ -71,11 +79,19 @@ describe "match_expectation" do
       Then { @error.should_not be_nil }
       Then { @error.message.should include "Test image size 256x167 does not match expectation 512x334" }
       Then { @error.message.should =~ viewer_pattern(test_path, expected_path) }
+      context "with previously-created difference image" do
+        Given { preexisting_difference_image }
+        Then { difference_path.should_not be_exist }
+      end
     end
 
     context "with match argument" do
       Given { @match_argument = "/this/is/a/test.png" }
       Then { @error.message.should include "Missing expectation image /this/is/a/test.png" }
+      context "with previously-created difference image" do
+        Given { preexisting_difference_image }
+        Then { difference_path.should_not be_exist }
+      end
     end
 
     context "with trivial example description" do
@@ -135,6 +151,9 @@ describe "match_expectation" do
     FileUtils.cp fixture_image(name), path
   end
 
+  def create_existing_difference_image
+  end
+
   def use_test_image(name)
     use_fixture_image(name, test_path)
   end
@@ -143,6 +162,11 @@ describe "match_expectation" do
     use_fixture_image(name, expected_path)
   end
 
+  def preexisting_difference_image
+    difference_path.dirname.mkpath unless difference_path.dirname.exist?
+    FileUtils.touch difference_path
+  end
+
   def viewer_pattern(*paths)
     %r{
       \b

metadata

@@ -1,116 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: rspec-page-regression
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oily_png
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: which_works
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,88 +111,78 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-given
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Rspec-page-regression provides a mechanism for regression testing of
-  web page renders in RSpec.  It takes into account html, css, and javascript, by
-  virtue of using phantomjs (via the poltergeist gem) to render snapshots.  It provides
-  an RSpec matcher that compares the test snapshot to an expected image, and facilitates
-  management of the images.
+description: Rspec-page-regression provides a mechanism for headless regression testing
+  of web page renders in RSpec.  It takes into account HTML, CSS, and JavaScript,
+  by virtue of using PhantomJS (via the Poltergeist gem) to render snapshots.  It
+  provides an RSpec matcher that compares the test snapshot to an expected image,
+  and facilitates management of the images.
 email:
 - ronen@barzel.org
 executables: []
@@ -239,28 +214,27 @@ files:
 homepage: https://github.com/ronen/rspec-page-regression
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Web page rendering (html, css, and javascript) regression for RSpec
+specification_version: 4
+summary: Web page rendering (HTML, CSS, and JavasSript) regression for RSpec
 test_files:
 - spec/fixtures/A.png
 - spec/fixtures/ABdiff.png
@@ -270,4 +244,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/matchers.rb
-has_rdoc: