jaredly/wraith

Wraith — A screenshot comparison tool

Wraith

• Website: http://responsivenews.co.uk
• Source: http://github.com/bbc-news/wraith

Wraith is a screenshot comparison tool, created by developers at BBC News.

What is it?

Wraith uses either PhantomJS or SlimerJS to create screenshots of different environments and then creates a diff of the two images, the affected areas are highlighted in blue

Requirements

You'll need either PhantomJS or SlimerJS, ImageMagick & Ruby 1.9.3 or greater. It's up to you to decide which browser engine you want to run it against.

On Mac OS X, the install script will install PhantomJS & ImageMagick for you, assuming you have homebrew installed, otherwise it'll tell you to install them.

Installation

curl -fsSL https://raw.github.com/bbc-news/wraith/go | bash

Config

All config will be placed in config.yml. You can specify domains, paths, screen widths & HTTP headers.

# Add only 2 domains, key will act as a label
domains:
  uk: "http://google.com"
  france: "http://google.fr"

#Type screen widths below, here are a couple of examples
screen_widths:
  - 320
  - 600
  - 768
  - 1024
  - 1280

#Type page URL paths below, here are a couple of examples
paths:
  search_page: /imghp
  map_page: /maps

Using Wraith

rake

Contributing

If you want to add functionality to this project, pull requests are welcome.

• Create a branch based off master and do all of your changes with in it.
• If it you have to pause to add a 'and' anywhere in the title, it should be two pull requests.
• Make commits of logical units and describe them properly
• Check for unnecessary whitespace with git diff --check before committing.
• If possible, submit tests to your patch / new feature so it can be tested easily.
• Assure nothing is broken by running all the test
• Please ensure that it complies with coding standards.

Please raise any issues with this project as a GitHub issue.

Licence

Wraith is available to everyone under the terms of the MIT open source licence. Take a look at the LICENSE file in the code.

Credits

• Dave Blooman
• John Cleveley
• Simon Thulbourn