wraith 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf63697eac76217c8011ef49428c9699433a6e89
-  data.tar.gz: 28179715439e86a3102ec17113e9d2e9ae878997
+  metadata.gz: 322bea139215b0b76a3fbee69b95ca2e715b2229
+  data.tar.gz: d0c66b25dafb3df3fe601dad9a618c2e924c573c
 SHA512:
-  metadata.gz: 8ab5d69ea95075c115620d955f807e507f5f20d481278a3c30b30281d61cf6458bf690958376d08e7d5f9cdf77729425e21838d2b2fd85225c8bb90509d49f2f
-  data.tar.gz: 88c70548dace9ca18d2210cca2bd3438e18fa2b507383228f1135bb031b739cc4409e93cefe51c87c59da4faa4c569e7b5458226b53b848548f74c0200cace09
+  metadata.gz: dd04184a6fc39dd9cedb1a8f099abb4567d740b3650b69ef31ef7c53eea2db97e8cb49e96eb29452e82dfb725695155458b4c3bd96924e3e73062d0e3e7933b2
+  data.tar.gz: 22cd83978f44aecb5bbaaf9b72792d9114c6104c9bfd79e41bc884aeb9be49da52d1b9059ea6d723894bfe6983586f420b2df65355a7d23c63b3ba6e68550ab2

data/.travis.yml

@@ -6,7 +6,6 @@ script: bundle exec rspec
 notifications:
   email:
     recipients:
-    - david.blooman@bbc.co.uk
     - chris.ashton@bbc.co.uk
     on_failure: change
     on_success: never

data/README.md

@@ -11,122 +11,78 @@
 <p align="center">
   Wraith is a screenshot comparison tool, created by developers at BBC News.
   <br>
-  <a href="http://responsivenews.co.uk" target="_blank">Website</a> • <a href="http://github.com/bbc-news/wraith" target="_blank">Source</a>
+  <a href="http://bbc-news.github.io/wraith/index.html" target="_blank">Documentation</a> • <a href="http://github.com/bbc-news/wraith" target="_blank">Source</a> • <a href="http://responsivenews.co.uk" target="_blank">Responsive News Website</a>
 </p>
 
 ## What is it?
 
-Wraith uses either [PhantomJS](http://phantomjs.org), [CasperJS](http://casperjs.org/) or
-[SlimerJS](http://slimerjs.org) to create screen-shots of webpages on different environments
-and then creates a diff of the two images, the affected areas are highlighted in
-blue
+Wraith uses a headless browser to create screenshots of webpages on different environments (or at different moments in time) and then creates a diff of the two images; the affected areas are highlighted in blue.
 
-![Photo of BBC News with a
-diff](http://bbc-news.github.io/wraith/img/wraith.png)
+![Photo of BBC News with a diff](http://bbc-news.github.io/wraith/img/wraith.png)
 
 ## Documentation
 
-[The main documentation can be found here, this will cover all the features and options for Wraith as well as sample configs.](http://bbc-news.github.io/wraith/index.html)
+For instructions on how to install, set up and use Wraith and all of its features, [visit the Wraith documentation](http://bbc-news.github.io/wraith/index.html).
 
+A brief overview of how Wraith works is provided below.
 
-## Requirements
-
-Imagemagick and PhantomJS are required to use Wraith, install via your favourite package manager. You can also use SlimerJS and CasperJS, CasperJS can be used to target specific selectors. To read our detailed instructions for setup and install, as well as example configs, visit [wraith docs](http://bbc-news.github.io/wraith/index.html)
-
-```sh
-brew install phantomjs
-brew install imagemagick
-```
-
-## Installation
-
-Open terminal and run
-
-    gem install wraith
-
-You can then run the following to create a template snap.js and config file:
-
-    wraith setup
+## Wraith modes
 
-## Using Wraith
-You can type `wraith` into terminal to bring up the list of commands, but the one to start Wraith is
+There are several ways in which Wraith can be used:
 
-```sh
-wraith capture config_name
-```
+1. Comparison of 2 domains (`wraith capture`). There are also some specialist options within this mode:
+    * Spidering 2 domains for changes (`wraith capture` when no `paths` property is provided in the configuration file)
+    * Running several comparisons at once (`wraith multi_capture`)
+2. Comparing the same domain over time (`wraith history`, then `wraith latest`)
 
-This assumes that your snap.js and config.yaml are in the folders that were created on setup. To run the setup, create a folder and inside run
+Whichever mode you decide to run Wraith in, the process it follows is generally the same:
 
-```sh
-wraith setup
-```
+* takes screenshots of your webpages
+* runs a comparison task across them
+* outputs a diff PNG file comparing the two images, and a data.txt file which contains the percentage of pixels that have changed
+* packages all of this up into a gallery.html, ready for you to view
+* if any screenshot's diff is above the threshold you specified in your configuration file, the task exits with a system error code (useful for CI)
+* the failed screenshot will also be highlighted in the gallery
 
-### CLI
-
-There are other commands also available, these all expect a config_name to be passed as an option. Wraith will look for the config file at `configs/[config_name].yaml`.
-
-```sh
-  wraith capture [config_name]              # A full Wraith job
-  wraith compare_images [config_name]       # compares images to generate diffs
-  wraith crop_images [config_name]          # crops images to the same height
-  wraith generate_gallery [config_name]     # create page for viewing images
-  wraith generate_thumbnails [config_name]  # create thumbnails for gallery
-  wraith history [config_name]              # Setup a baseline set of shots
-  wraith latest [config_name]               # Capture new shots to compare with baseline
-  wraith multi_capture [filelist]           # A Batch of Wraith Jobs
-  wraith reset_shots [config_name]          # removes all the files in the shots folder
-  wraith save_images [config_name]          # captures screenshots
-  wraith setup                              # creates config folder and default config
-  wraith setup_folders [config_name]        # create folders for images
-```
-
-## Output
-
-After each screenshot is captured, the compare task will run, this will output a diff.png and a data.txt.  The data.txt for each file will show the number of pixels that have changed.  There is a main data.txt which is in the root of the output folder that will combine all of these values to easier view all the pixel changes.
+## Requirements
 
-## Gallery
+[ImageMagick](http://www.imagemagick.org/) is required to compare the screenshots.
 
-A gallery is available to view each of the images and the respective diff images located in the shots folder once all the images have been compared.  You can set thresholds in the config file, if above this value, the gallery will indicate the shots above the threshold.
+Wraith also requires at least one of these headless browsers:
 
-## Changelog - updated 2014-12-09
-In the latest release I have implemented thresholds for Wraith, this makes finding failed shots easier.  Set the threshold value in the config to a value you want, by default it is 0.  When a failure is detected, the terminal will show a failure message and the gallery will have a red cross next to the set of shots.
+* [PhantomJS](http://phantomjs.org)
+* [CasperJS](http://casperjs.org/) (which can be used to target specific selectors)
+* [SlimerJS](http://slimerjs.org)
 
 ## 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 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
+ * Fork a branch based off BBC-News/wraith:master and do all of your changes within it.
+ * 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
+ * Assure nothing is broken by running all the tests (`bundle exec rspec`).
  * Please ensure that it complies with coding standards.
+ * When writing the title of your Pull Request, if you have to pause to add an 'and' anywhere in the title - it should be two pull requests.
 
 **Please raise any issues with this project as a GitHub issue.**
 
 ## License
 
-Wraith is available to everyone under the terms of the Apache 2.0 open source license.
-Take a look at the LICENSE file in the code.
+Wraith is available to everyone under the terms of the Apache 2.0 open source license. [Take a look at Wraith's LICENSE file](https://github.com/BBC-News/wraith/blob/master/LICENSE).
 
 ## Credits
 
  * [Dave Blooman](https://twitter.com/dblooman)
  * [John Cleveley](https://twitter.com/jcleveley)
  * [Simon Thulbourn](https://twitter.com/sthulb)
+ * [Chris Ashton](https://twitter.com/chrisbashton)
 
 ## Selenium-Wraith
 
-Anyone interested in integrating selenium capability with Wraith should check out
-Selenium-Wraith by Andrew Tekle-Cadman of Future Visible.
-
-Selenium-Wraith was forked from the BBC repo on 16/04/14 and adds the following capabilities to Wraith
+Anyone interested in integrating selenium capability with Wraith should check out [Selenium-Wraith](https://github.com/andrewccadman/wraith-selenium) (by Andrew Tekle-Cadman of Future Visible), which was forked from BBC's Wraith on 16/04/14 and adds the following capabilities:
 
 1. Selenium integration, both running locally on a desktop or on a selenium grid
 2. Browser to browser screenshot comparison
 3. Page component-based comparison
-
-You can check out Andrew's Project on GitHub here:
-
-https://github.com/andrewccadman/wraith-selenium

data/lib/wraith/gallery.rb

@@ -64,11 +64,15 @@ class Wraith::GalleryGenerator
   def figure_out_url(group, category)
     root = wraith.domains["#{group}"]
     return '' if root.nil?
-    path = wraith.paths["#{category}"]['path']
+    path = get_path(category)
     url  = root + path
     url
   end
 
+  def get_path(category)
+    wraith.paths[category]['path'] || wraith.paths[category]
+  end
+
   def get_group_from_match(match)
     group = match[2]
     dash = match[2].rindex('-')

data/lib/wraith/gallery_template/basic_template.erb

@@ -49,7 +49,9 @@
             <a href="<%=file[:filename]%>">
               <img class="short-screenshot img-thumbnail" src="<%=path%><%=file[:thumb]%>">
             </a>
-            <p class="text-center"><%=file[:name]%></p>
+            <p class="text-center">
+              <a href="<%=file[:url]%>" target="_blank"><%=file[:name]%></a>
+            </p>
           </div>
           <% end %>
           <div class="col-lg-3">
@@ -76,4 +78,4 @@
     </div>
   </div>
 </body>
-</html>
+</html>

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "2.8.0"
+  VERSION = "2.8.1"
 end

data/spec/wraith_spec.rb

@@ -109,27 +109,27 @@ describe Wraith do
 
       images = [
         {
-          :filename => 'test/test_image-1.png',
-          :thumb    => 'thumbnails/test/test_image-1.png'
+          :filename => 'home/test_image-afrique.png',
+          :thumb    => 'thumbnails/home/test_image-afrique.png'
         },
         {
-          :filename => 'test/test_image-2.png',
-          :thumb    => 'thumbnails/test/test_image-2.png'
+          :filename => 'home/test_image-russian.png',
+          :thumb    => 'thumbnails/home/test_image-russian.png'
         }
       ]
 
-      dirs['test'][0][:variants].each_with_index do |image, i|
+      dirs['home'][0][:variants].each_with_index do |image, i|
         expect(image[:filename]).to eq images[i][:filename]
         expect(image[:thumb]).to eq images[i][:thumb]
       end
 
       diff = {
-        :filename => 'test/test_image-diff.png',
-        :thumb    => 'thumbnails/test/test_image-diff.png'
+        :filename => 'home/test_image-diff.png',
+        :thumb    => 'thumbnails/home/test_image-diff.png'
       }
 
-      expect(dirs['test'][0][:diff][:filename]).to eq 'test/test_image-diff.png'
-      expect(dirs['test'][0][:diff][:thumb]).to eq 'thumbnails/test/test_image-diff.png'
+      expect(dirs['home'][0][:diff][:filename]).to eq 'home/test_image-diff.png'
+      expect(dirs['home'][0][:diff][:thumb]).to eq 'thumbnails/home/test_image-diff.png'
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Dave Blooman
@@ -10,160 +10,160 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   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
   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: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: image_size
   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: anemone
   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: robotex
   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: nokogiri
   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: log4r
   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: thor
   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: parallel
   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: casperjs
   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'
 description: Wraith is a screenshot comparison tool, created by developers at BBC
@@ -177,11 +177,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gemset
-- .gitignore
-- .rubocop.yml
-- .ruby-version
-- .travis.yml
+- ".gemset"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -210,9 +210,9 @@ files:
 - spec/helpers.rb
 - spec/js/global.js
 - spec/js/path.js
-- spec/thumbnails/test/test_image-1.png
-- spec/thumbnails/test/test_image-2.png
-- spec/thumbnails/test/test_image-diff.png
+- spec/thumbnails/home/test_image-afrique.png
+- spec/thumbnails/home/test_image-diff.png
+- spec/thumbnails/home/test_image-russian.png
 - spec/wraith_spec.rb
 - templates/README.md
 - templates/configs/component.yaml
@@ -237,17 +237,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.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Wraith is a screenshot comparison tool, created by developers at BBC News.
@@ -259,7 +259,7 @@ test_files:
 - spec/helpers.rb
 - spec/js/global.js
 - spec/js/path.js
-- spec/thumbnails/test/test_image-1.png
-- spec/thumbnails/test/test_image-2.png
-- spec/thumbnails/test/test_image-diff.png
+- spec/thumbnails/home/test_image-afrique.png
+- spec/thumbnails/home/test_image-diff.png
+- spec/thumbnails/home/test_image-russian.png
 - spec/wraith_spec.rb