wraith 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3735eab07e34d5a2e488049294f8fe6575a0d21
-  data.tar.gz: 3a6941bc0b2585405ad105a7c859e0a5119df216
+  metadata.gz: 2b1ef3f4e6afe88d801486999230f8f3284d57ec
+  data.tar.gz: e4635f5a2433c7951cf2ce13374cfb37f9d6a47c
 SHA512:
-  metadata.gz: d09341a03356355aec1ab2deda45bfd66c1b21f3f0e7e124167927df15df2f25897e10ea8230244ba5b71659294c1b6351521c82d9a64431904cbab046f0b09c
-  data.tar.gz: b050424d3765a08775990554b641ac650453365987dfa5d5ec10f480b09345407aeb80ee8e9f6e3366b59fc638a9419c95c62404be8695483ca360a8543d7cf6
+  metadata.gz: f2e3b5f04d9387bfdc9877bc58e7a5769bd0f261a2e23a68a02f6a1a95555761bd85b83283a3015c49bcc2cf7ab324cd0ad2eef8d6da65359ab38c00d8fdcd57
+  data.tar.gz: 32ba015605d4b92c53da0f70efbb72e37ee45cc43665512d48a75670636135a541d6ed63fdd9fd1ad4a9f3b5616ca1a1766f06fee988ce96071aa516b092e50d

data/Dockerfile

@@ -3,9 +3,9 @@ FROM ruby:2.1.2
 # some of ruby's build scripts are written in ruby
 # we purge this later to make sure our final image uses what we just built
 RUN apt-get update
-RUN curl -o phantomjs.tar.gz -L https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2
+RUN curl -o phantomjs.tar.gz -L https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-linux-x86_64.tar.bz2
 RUN tar -xvf phantomjs.tar.gz
-RUN mv phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin
+RUN mv phantomjs-1.9.8-linux-x86_64/bin/phantomjs /usr/bin
 RUN echo "export phantomjs=/usr/bin/phantomjs" > .bashrc
 RUN apt-get install -y libfreetype6 libfontconfig1
 RUN gem install wraith --no-rdoc --no-ri

data/README.md

@@ -19,6 +19,10 @@ blue
 ![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)
+
 
 ## Requirements
 
@@ -39,12 +43,6 @@ You can then run the following to create a template snap.js and config file:
 
     wraith setup
 
-Alternatively you can clone the repo.
-
-    git clone https://github.com/BBC-News/wraith
-    cd wraith
-    bundle install
-
 ## Using Wraith
 You can type `wraith` into terminal to bring up the list of commands, but the one to start Wraith is
 
@@ -84,45 +82,10 @@ After each screenshot is captured, the compare task will run, this will output a
 
 ## Gallery
 
-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.
-
-## CasperJS
-
-There is an example [component config file](https://github.com/BBC-News/wraith/blob/master/configs/component.yaml) which indicates how to target a specific selector on a page.  Pass in a label for the shot, path and selector.  This will be handed to CasperJS and will only screenshot that component on the page.  This is faster way to verify smaller changes to specific components during development.  You must install [CasperJS](http://casperjs.org/) to use.
-
-For a quick setup for CasperJS, you can run :
-
-```sh
-wraith setup_casper
-```
-
-## History usage
-
-In Wraith 2.0 we introduced a new way for using Wraith in development and testing, historical shots.  Rather than capture 2 domains, you capture 1 domain, probably your local copy of the latest code, then later on after development is in progress, run Wraith again to compare.  This makes working against an isolated dev environment much easier as you wont need an internet connection.  
-
-The usage is different in that you need 1 domain in your config and you will need to set a historical shots folder.  You will need to specify a `history_dir` in addition to the `directory` key in your `config.yml` file. An example of this can be found in the [`history.yaml`](https://github.com/BBC-News/wraith/blob/31406956bfc465d087f1d40304630e18dc0f857e/configs/history.yaml#L9-L11) file of the `configs` directory of this repository.  The way this works is that shots are captured as normal with the history command below.  This will create 2 folders with the labels you have specified in the config file, for example, shots and shots_history.  The original shots will be copied into your 'history' folder, then copied back into the shots folder once you have run your latest job.  This workflow will essentially mean your history folder is your baseline, being copied back into the shots folder every time you run the 'latest command'
-
-```sh
-wraith history history.yaml
-```
-After some development, run the latest command
-```sh
-wraith latest history.yaml
-```
-You will now be able to run the latest command over and over without having to do clear up.
-
-## Docker
-At BBC, we use Docker and AWS in our workflow.  The Dockerfile is in the repo, but you can pull from the registry here`docker pull bbcnews/wraith`.  There is no quick way to get up and running with OSX and no way to use it on Windows.  For a CI environment, it has a really good use case though.  To run, specify your workspace and the command you want.  If you want to use the Ruby AWS-SDK gem to upload your images to s3, it is built into the container.  I recommend writing a simple ruby script that runs once you have completed a Wraith run.
-
-```sh
-docker run -d bbcnews/wraith -w /wraith -v path/to/dir:/wraith capture configs/config.yaml
-```
-
-## Changelog - updated 2014-10-20
-We have combined CasperJS with Wraith to enable component screen shots and comparison.  This allows for developers to check only a small part of a page for regressions allowing for quicker and smaller 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.
 
-Notice : We have deprecated the ability to not use labels on URLs in config files and have Wraith create them for you.  Ensure that you update your config with labels before running again.
+## 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.
 
 ## Contributing
 

data/lib/wraith/cli.rb

@@ -83,13 +83,13 @@ class Wraith::CLI < Thor
   end
 
   desc 'generate_gallery [config_name]', 'create page for viewing images'
-  def generate_gallery(config_name)
-    gallery = Wraith::GalleryGenerator.new(config_name)
+  def generate_gallery(config_name, multi)
+    gallery = Wraith::GalleryGenerator.new(config_name, multi)
     gallery.generate_gallery
   end
 
   desc 'capture [config_name]', 'A full Wraith job'
-  def capture(config)
+  def capture(config, multi = false)
     reset_shots(config)
     check_for_paths(config)
     setup_folders(config)
@@ -97,14 +97,14 @@ class Wraith::CLI < Thor
     crop_images(config)
     compare_images(config)
     generate_thumbnails(config)
-    generate_gallery(config)
+    generate_gallery(config, multi)
   end
 
   desc 'multi_capture [filelist]', 'A Batch of Wraith Jobs'
   def multi_capture(filelist)
     config_array = IO.readlines(filelist)
     config_array.each do |config|
-      capture(config.chomp)
+      capture(config.chomp, true)
     end
   end
 

data/lib/wraith/gallery.rb

@@ -12,9 +12,10 @@ class Wraith::GalleryGenerator
   TEMPLATE_BY_DOMAIN_LOCATION = File.expand_path('gallery_template/gallery_template.erb', File.dirname(__FILE__))
   BOOTSTRAP_LOCATION = File.expand_path('gallery_template/bootstrap.min.css', File.dirname(__FILE__))
 
-  def initialize(config)
+  def initialize(config, multi)
     @wraith = Wraith::Wraith.new(config)
     @location = wraith.directory
+    @mutli = multi
     @folder_manager = Wraith::FolderManager.new(config)
   end
 
@@ -129,9 +130,13 @@ class Wraith::GalleryGenerator
   end
 
   def check_failed_shots
-    if @failed_shots == false
+    if @mutli
+      return true
+    elsif @failed_shots == false
       puts 'Failures detected'
       exit 1
+    else
+      true
     end
   end
 

data/lib/wraith/gallery_template/gallery_template.erb

@@ -4,8 +4,7 @@
         <link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
         <style type="text/css">
             .short-screenshot {
-                height: 200px;
-                width: 200px;
+              max-width: 200px;
             }
         </style>
     </head>

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '2.3.0'
+  VERSION = '2.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry