wraith 3.0.4 → 3.1.0

data/templates/javascript/interact--casper.js

@@ -0,0 +1,11 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (casper, ready) {
+    // test interaction on the page
+    casper.wait(2000, function() {
+        casper.click('.ns-panel__hotspot--2');
+        ready();
+    });
+}

data/templates/javascript/interact--phantom.js

@@ -0,0 +1,17 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (phantom, ready) {
+
+    // test interaction on the page
+    phantom.evaluate(function(){
+        var a = document.querySelector('.ns-panel__hotspot--2');
+        var e = document.createEvent('MouseEvents');
+        e.initMouseEvent('click', true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
+        a.dispatchEvent(e);
+        waitforload = true;
+    });
+
+    ready();
+}

data/templates/javascript/wait--casper.js

@@ -0,0 +1,8 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (casper, ready) {
+    // make Wraith wait a bit longer before taking the screenshot
+    casper.wait(2000, ready); // you MUST call the ready() callback for Wraith to continue
+}

data/templates/javascript/wait--phantom.js

@@ -0,0 +1,8 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (phantom, ready) {
+    // make Wraith wait a bit longer before taking the screenshot
+    setTimeout(ready, 2000); // you MUST call the ready() callback for Wraith to continue
+}

data/wraith.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'image_size'
   spec.add_runtime_dependency 'anemone'
   spec.add_runtime_dependency 'robotex'
-  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'nokogiri', '1.6.7'
   spec.add_runtime_dependency 'log4r'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'parallel'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Dave Blooman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -100,16 +100,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
@@ -198,15 +198,18 @@ files:
 - lib/wraith/gallery.rb
 - lib/wraith/gallery_template/basic_template.erb
 - lib/wraith/gallery_template/slideshow_template.erb
+- lib/wraith/helpers/capture_options.rb
+- lib/wraith/helpers/custom_exceptions.rb
+- lib/wraith/helpers/logger.rb
+- lib/wraith/helpers/save_metadata.rb
+- lib/wraith/helpers/utilities.rb
 - lib/wraith/javascript/_helper.js
-- lib/wraith/javascript/_phantom__common.js
 - lib/wraith/javascript/casper.js
-- lib/wraith/javascript/phantom--nojs.js
 - lib/wraith/javascript/phantom.js
 - lib/wraith/save_images.rb
 - lib/wraith/spider.rb
 - lib/wraith/thumbnails.rb
-- lib/wraith/utilities.rb
+- lib/wraith/validate.rb
 - lib/wraith/version.rb
 - lib/wraith/wraith.rb
 - spec/_helpers.rb
@@ -216,6 +219,7 @@ files:
 - spec/config_spec.rb
 - spec/configs/test_config--casper.yaml
 - spec/configs/test_config--phantom.yaml
+- spec/construct_command_spec.rb
 - spec/gallery_spec.rb
 - spec/js/custom_snap_file.js
 - spec/js/global.js
@@ -225,12 +229,19 @@ files:
 - spec/thumbnails/home/test_image-afrique.png
 - spec/thumbnails/home/test_image-diff.png
 - spec/thumbnails/home/test_image-russian.png
+- spec/validate_spec.rb
 - templates/README.md
-- templates/configs/component.yaml
-- templates/configs/multiple_domains.yaml
+- templates/configs/capture.yaml
+- templates/configs/history.yaml
 - templates/configs/spider.yaml
-- templates/javascript/beforeCapture--casper_example.js
-- templates/javascript/beforeCapture--phantom_example.js
+- templates/javascript/cookies_and_headers--casper.js
+- templates/javascript/cookies_and_headers--phantom.js
+- templates/javascript/disable_javascript--casper.js
+- templates/javascript/disable_javascript--phantom.js
+- templates/javascript/interact--casper.js
+- templates/javascript/interact--phantom.js
+- templates/javascript/wait--casper.js
+- templates/javascript/wait--phantom.js
 - wraith.gemspec
 homepage: https://github.com/BBC-News/wraith
 licenses:
@@ -252,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Wraith is a screenshot comparison tool, created by developers at BBC News.
@@ -264,6 +275,7 @@ test_files:
 - spec/config_spec.rb
 - spec/configs/test_config--casper.yaml
 - spec/configs/test_config--phantom.yaml
+- spec/construct_command_spec.rb
 - spec/gallery_spec.rb
 - spec/js/custom_snap_file.js
 - spec/js/global.js
@@ -273,3 +285,4 @@ test_files:
 - spec/thumbnails/home/test_image-afrique.png
 - spec/thumbnails/home/test_image-diff.png
 - spec/thumbnails/home/test_image-russian.png
+- spec/validate_spec.rb

data/lib/wraith/javascript/_phantom__common.js

@@ -1,120 +0,0 @@
-module.exports = function (config) {
-
-  // config
-  var systemArgs        = config.systemArgs,
-      javascriptEnabled = config.javascriptEnabled;
-
-  // modules
-  var page   = require('webpage').create(),
-      helper = require('./_helper.js')(systemArgs[2]);
-
-  // command line arguments
-  var url = systemArgs[1],
-      dimensions = helper.dimensions,
-      image_name = systemArgs[3],
-      selector   = systemArgs[4],
-      globalBeforeCaptureJS = systemArgs[5],
-      pathBeforeCaptureJS = systemArgs[6],
-      dimensionsProcessed = 0,
-      currentDimensions;
-
-  globalBeforeCaptureJS = globalBeforeCaptureJS === 'false' ? false : globalBeforeCaptureJS;
-  pathBeforeCaptureJS   = pathBeforeCaptureJS === 'false' ? false : pathBeforeCaptureJS;
-
-  var current_requests = 0;
-  var last_request_timeout;
-  var final_timeout;
-
-  if (helper.takingMultipleScreenshots(dimensions)) {
-    currentDimensions = dimensions[0];
-    image_name = helper.replaceImageNameWithDimensions(image_name, currentDimensions);
-  }
-  else {
-    currentDimensions = dimensions;
-  }
-
-  page.settings = { loadImages: true, javascriptEnabled: javascriptEnabled };
-
-  // If you want to use additional phantomjs commands, place them here
-  page.settings.userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.17';
-
-  page.onResourceRequested = function(req) {
-    current_requests += 1;
-  };
-
-  page.onResourceReceived = function(res) {
-    if (res.stage === 'end') {
-      current_requests -= 1;
-      debounced_render();
-    }
-  };
-
-  page.open(url, function(status) {
-    if (status !== 'success') {
-      console.log('Error with page ' + url);
-      phantom.exit();
-    }
-  });
-
-  function runSetupJavaScriptThenCaptureImage() {
-    resize();
-    if (globalBeforeCaptureJS) {
-      require(globalBeforeCaptureJS)(page);
-    }
-    if (pathBeforeCaptureJS) {
-      require(pathBeforeCaptureJS)(page);
-    }
-    resizeAndCaptureImage();
-  }
-
-  function resize() {
-    page.viewportSize = { width: currentDimensions.viewportWidth, height: currentDimensions.viewportHeight};
-  }
-
-  function resizeAndCaptureImage() {
-    console.log('Snapping ' + url + ' at: ' + currentDimensions.viewportWidth + 'x' + currentDimensions.viewportHeight);
-    resize();
-    setTimeout(captureImage, 1000); // give page time to re-render properly
-  }
-
-  function captureImage() {
-    page.clipRect = {
-      top: 0,
-      left: 0,
-      height: currentDimensions.viewportHeight,
-      width: currentDimensions.viewportWidth
-    };
-    page.render(image_name);
-
-    dimensionsProcessed++;
-    if (helper.takingMultipleScreenshots(dimensions) && dimensionsProcessed < dimensions.length) {
-      currentDimensions = dimensions[dimensionsProcessed];
-      image_name = helper.replaceImageNameWithDimensions(image_name, currentDimensions);
-      setTimeout(resizeAndCaptureImage, 1000);
-    }
-    else {
-      // prevent CI from failing from 'Unsafe JavaScript attempt to access frame with URL about:blank from frame with URL' errors
-      // see https://github.com/n1k0/casperjs/issues/1068
-      setTimeout(function(){
-        phantom.exit();
-      }, 30);
-    }
-  }
-
-  function debounced_render() {
-    clearTimeout(last_request_timeout);
-    clearTimeout(final_timeout);
-
-    // If there's no more ongoing resource requests, wait for 1 second before
-    // rendering, just in case the page kicks off another request
-    if (current_requests < 1) {
-      clearTimeout(final_timeout);
-      last_request_timeout = setTimeout(runSetupJavaScriptThenCaptureImage, 1000);
-    }
-
-    // Sometimes, straggling requests never make it back, in which
-    // case, timeout after 5 seconds and render the page anyway
-    final_timeout = setTimeout(runSetupJavaScriptThenCaptureImage, 5000);
-  }
-
-}

data/lib/wraith/javascript/phantom--nojs.js

@@ -1,6 +0,0 @@
-var system = require('system');
-
-require('./_phantom__common.js')({
-  systemArgs:        system.args,
-  javascriptEnabled: false
-});

data/templates/configs/component.yaml

@@ -1,60 +0,0 @@
-# Add as many domains as necessary. Key will act as a label
-domains:
-  english: "http://www.bbc.co.uk"
-
-# (optional) JavaScript file to execute before taking screenshot of every path.
-# Can be used to reload current page with headers specified, or to dynamically
-# AJAX in content, or all manner of other uses!
-#before_capture: 'javascript/global.js'
-
-# Type page URL paths below, here are a couple of examples
-paths:
-  clickable_guide:
-    path: /news/entertainment-arts-27221191
-    selector: '.idt__news' # selector to take a screenshot of
-  clickable_guide__after_click:
-    path: /news/entertainment-arts-27221191
-    selector: '.idt__news'
-    # (optional) JavaScript file to execute before taking the screenshot of this path.
-    # This is always executed AFTER the 'global' before_capture hook toward the top of this file.
-    before_capture: 'javascript/beforeCapture--casper_example.js'
-
-# amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
-fuzz: '20%'
-
-# the maximum acceptable level of difference (in %) between two images.
-# Wraith considers it a failure if an image diff goes above this threshold.
-threshold: 5
-
-# screen widths (and optional height) to resize the browser to before taking the screenshot
-screen_widths:
-  - 320
-  - 600x768
-  - 768
-  - 1024
-  - 1280
-
-# resize to each screen width, or reload at each screen width. (The former is more efficient).
-resize_or_reload: 'resize'
-
-# the engine to run Wraith with.
-browser: "casperjs"
-
-# the directory that your base screenshots will be stored in
-history_dir: 'shots_base'
-
-# the directory that your latest screenshots will be stored in
-directory: 'shots'
-
-gallery:
-  template: 'slideshow_template' # 'basic_template' (default)
-  thumb_width: 200
-  thumb_height: 200
-
-# choose how results are displayed in the gallery (default is `alphanumeric` if omitted)
-# Different screen widths are always grouped together.
-# Options:
-#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
-#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
-#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
-mode: alphanumeric

data/templates/configs/multiple_domains.yaml

@@ -1,53 +0,0 @@
-# Add as many domains as necessary. Key will act as a label
-domains:
-  arabic:  "http://www.bbc.com/arabic"
-  persian: "http://www.bbc.com/persian"
-  russian: "http://www.bbc.com/russian"
-
-# (optional) JavaScript file to execute before taking screenshot of every path.
-# Can be used to reload current page with headers specified, or to dynamically
-# AJAX in content, or all manner of other uses!
-#before_capture: 'javascript/global.js'
-
-# Type page URL paths below, here are a couple of examples.
-# They should exist for all of the domains you've specified above.
-paths:
-  home: /
-  interactivity: /interactivity
-
-# amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
-fuzz: '20%'
-
-# the maximum acceptable level of difference (in %) between two images.
-# Wraith considers it a failure if an image diff goes above this threshold.
-threshold: 5
-
-# screen widths (and optional height) to resize the browser to before taking the screenshot
-screen_widths:
-  - 320
-  - 600x768
-  - 768
-  - 1024
-  - 1280
-
-# the engine to run Wraith with. Examples: 'phantomjs', 'casperjs', 'slimerjs'
-browser: "phantomjs"
-
-# the directory that your base screenshots will be stored in
-history_dir: 'shots_base'
-
-# the directory that your latest screenshots will be stored in
-directory: 'shots'
-
-gallery:
-  template: 'slideshow_template' # 'basic_template' (default)
-  thumb_width: 200
-  thumb_height: 200
-
-# choose how results are displayed in the gallery (default is `alphanumeric` if omitted)
-# Different screen widths are always grouped together.
-# Options:
-#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
-#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
-#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
-mode: diffs_first

data/templates/javascript/beforeCapture--casper_example.js

@@ -1,12 +0,0 @@
-module.exports = function (casper) {
-
-    /* you may want to test some interaction on the page */
-    casper.wait(2000, function() {
-        casper.click('.ns-panel__hotspot--2');
-    });
-
-    /* or you may want to see how your page looks without JavaScript */
-    // casper.options.pageSettings.javascriptEnabled = false;
-    // casper.thenOpen(casper.page.url);
-
-}

data/templates/javascript/beforeCapture--phantom_example.js

@@ -1,36 +0,0 @@
-module.exports = function (phantom) {
-
-    /* you may want to test some interaction on the page */
-    phantom.evaluate(function(){
-        var a = document.querySelector('.ns-panel__hotspot--2');
-        var e = document.createEvent('MouseEvents');
-        e.initMouseEvent('click', true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
-        a.dispatchEvent(e);
-        waitforload = true;
-    });
-
-    /* or you may want to see how your page looks without JavaScript */
-    // phantom.settings.javascriptEnabled = false;
-    // phantom.open(phantom.page.url);
-
-    // You can place custom headers here, example below.
-    // page.customHeaders = {
-
-    //      'X-Candy-OVERRIDE': 'https://api.live.bbc.co.uk/'
-
-    //  };
-
-    // If you want to set a cookie, just add your details below in the following way.
-
-    // phantom.addCookie({
-    //     'name': 'ckns_policy',
-    //     'value': '111',
-    //     'domain': '.bbc.co.uk'
-    // });
-    // phantom.addCookie({
-    //     'name': 'locserv',
-    //     'value': '1#l1#i=6691484:n=Oxford+Circus:h=e@w1#i=8:p=London@d1#1=l:2=e:3=e:4=2@n1#r=40',
-    //     'domain': '.bbc.co.uk'
-    // });
-
-}