wraith 2.8.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 322bea139215b0b76a3fbee69b95ca2e715b2229
-  data.tar.gz: d0c66b25dafb3df3fe601dad9a618c2e924c573c
+  metadata.gz: 9eb43d65349986285e6d089a4ed007f7d58247b6
+  data.tar.gz: 8a807791ed5348d4538495c6637ab1e2a6a11efd
 SHA512:
-  metadata.gz: dd04184a6fc39dd9cedb1a8f099abb4567d740b3650b69ef31ef7c53eea2db97e8cb49e96eb29452e82dfb725695155458b4c3bd96924e3e73062d0e3e7933b2
-  data.tar.gz: 22cd83978f44aecb5bbaaf9b72792d9114c6104c9bfd79e41bc884aeb9be49da52d1b9059ea6d723894bfe6983586f420b2df65355a7d23c63b3ba6e68550ab2
+  metadata.gz: 2460efd5b9be376c0fefeb69926d5c8d7cc05728718f8c2703f2cfb3c827825f701c0dea044424a99ba62ec8e9355fb956b71293e71d8ea9a06a500ea383bedd
+  data.tar.gz: 5a0fcdb92530cb4a46f34e57f90374c1ba229a634e5087d64d85386f1fd146b58bf00ce79d38b4fb15cced586f66faa3be1dcfe1f645fc51fbfb399d068a79ab

data/lib/wraith/gallery.rb

@@ -147,7 +147,9 @@ class Wraith::GalleryGenerator
     generate_html(@location, directories, slideshow_template, dest, with_path)
 
     puts "Gallery generated"
-    check_failed_shots
+    failed = check_failed_shots
+    prompt_user_to_open_gallery dest
+    exit 1 if failed
   end
 
   def check_failed_shots
@@ -167,12 +169,17 @@ class Wraith::GalleryGenerator
         end
       end
 
-      exit 1
+      return false
     else
       true
     end
   end
 
+  def prompt_user_to_open_gallery(dest)
+    puts "\nView the gallery in your browser:"
+    puts "\t file://" + `pwd`.chomp + '/' + dest
+  end
+
   class ErbBinding < OpenStruct
     def get_binding
       binding

data/lib/wraith/javascript/_helper.js

@@ -0,0 +1,45 @@
+module.exports = function (commandLineDimensions) {
+    // remove quotes from dimensions string
+    commandLineDimensions = commandLineDimensions.replace(/'/gi, '');
+
+    function getWidthAndHeight(dimensions) {
+        dimensions = /(\d*)x?((\d*))?/i.exec(dimensions);
+        return {
+            'viewportWidth':  parseInt(dimensions[1]),
+            'viewportHeight': parseInt(dimensions[2] || 1500)
+        };
+    }
+
+    var multipleDimensions = commandLineDimensions.split(','),
+        dimensionsToPass;
+
+    if (multipleDimensions.length > 1) {
+        dimensionsToPass = multipleDimensions.map(function (cliDimensions) {
+            return getWidthAndHeight(cliDimensions);
+        });
+    }
+    else {
+        dimensionsToPass = getWidthAndHeight(commandLineDimensions);
+    }
+
+    return {
+        dimensions: dimensionsToPass,
+        takingMultipleScreenshots: function (dimensions) {
+          return dimensions.length && dimensions.length > 1;
+        },
+        replaceImageNameWithDimensions: function (image_name, currentDimensions) {
+            // shots/clickable_guide__after_click/MULTI_casperjs_english.png
+            // ->
+            // shots/clickable_guide__after_click/1024x359_casperjs_english.png
+            var dirs = image_name.split('/'),
+                filename = dirs[dirs.length - 1],
+                filenameParts = filename.split('_'),
+                newFilename;
+
+            filenameParts[0] = currentDimensions.viewportWidth + 'x' + currentDimensions.viewportHeight;
+            dirs.pop(); // remove MULTI_casperjs_english.png
+            newFilename = dirs.join('/') + '/' + filenameParts.join('_');
+            return newFilename;
+        }
+    }
+}

data/lib/wraith/javascript/_phantom__common.js

@@ -0,0 +1,112 @@
+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.viewportSize = { width: currentDimensions.viewportWidth, height: currentDimensions.viewportHeight};
+  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() {
+    if (globalBeforeCaptureJS) {
+      require(globalBeforeCaptureJS)(page);
+    }
+    if (pathBeforeCaptureJS) {
+      require(pathBeforeCaptureJS)(page);
+    }
+    captureImage();
+  }
+
+  function captureImage() {
+
+    console.log('Snapping ' + url + ' at: ' + currentDimensions.viewportWidth + 'x' + currentDimensions.viewportHeight);
+    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(captureImage, 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();
+      }, 10);
+    }
+  }
+
+  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/casper.js

@@ -0,0 +1,81 @@
+// modules
+var system = require('system'),
+    casper = require('casper').create(),
+    helper = requireRelative('_helper.js')(casper.cli.get(1));
+
+// command line arguments
+var url = casper.cli.get(0),
+    dimensions = helper.dimensions,
+    image_name = casper.cli.get(2),
+    selector = casper.cli.get(3),
+    globalBeforeCaptureJS = casper.cli.get(4),
+    pathBeforeCaptureJS = casper.cli.get(5),
+    dimensionsProcessed = 0,
+    currentDimensions;
+
+// functions
+function requireRelative(file) {
+  // PhantomJS will automatically `require` relatively, but CasperJS needs some extra help. Hence this function.
+  // 'templates/javascript/casper.js' -> 'templates/javascript'
+  var currentFilePath = system.args[3].split('/');
+  currentFilePath.pop();
+  var fs = require('fs');
+  currentFilePath = fs.absolute(currentFilePath.join('/'));
+  return require(currentFilePath + '/' + file);
+}
+function snap() {
+  console.log('Snapping ' + url + ' at: ' + currentDimensions.viewportWidth + 'x' + currentDimensions.viewportHeight);
+
+  if (!selector) {
+    this.capture(image_name);
+  }
+  else {
+    this.captureSelector(image_name, selector);
+  }
+
+  dimensionsProcessed++;
+  if (helper.takingMultipleScreenshots(dimensions) && dimensionsProcessed < dimensions.length) {
+    currentDimensions = dimensions[dimensionsProcessed];
+    image_name = helper.replaceImageNameWithDimensions(image_name, currentDimensions);
+    casper.viewport(currentDimensions.viewportWidth, currentDimensions.viewportHeight);
+    casper.wait(300, function then () {
+      snap.bind(this)();
+    });
+  }
+}
+
+if (helper.takingMultipleScreenshots(dimensions)) {
+  currentDimensions = dimensions[0];
+  image_name = helper.replaceImageNameWithDimensions(image_name, currentDimensions);
+}
+else {
+  currentDimensions = dimensions;
+}
+
+// Casper can now do its magic
+casper.start();
+casper.open(url);
+casper.viewport(currentDimensions.viewportWidth, currentDimensions.viewportHeight);
+casper.then(function() {
+  if (globalBeforeCaptureJS) {
+    require('./' + globalBeforeCaptureJS)(this);
+  }
+});
+casper.then(function() {
+  if (pathBeforeCaptureJS) {
+    require('./' + pathBeforeCaptureJS)(this);
+  }
+});
+// waits for all images to download before taking screenshots
+// (broken images are a big cause of Wraith failures!)
+// Credit: http://reff.it/8m3HYP
+casper.waitFor(function() {
+  return this.evaluate(function() {
+    var images = document.getElementsByTagName('img');
+    return Array.prototype.every.call(images, function(i) { return i.complete; });
+  });
+}, function then () {
+  snap.bind(this)();
+});
+
+casper.run();

data/lib/wraith/save_images.rb

@@ -5,8 +5,8 @@ require "shellwords"
 class Wraith::SaveImages
   attr_reader :wraith, :history, :meta
 
-  def initialize(config, history = false)
-    @wraith = Wraith::Wraith.new(config)
+  def initialize(config, history = false, yaml_passed = false)
+    @wraith = Wraith::Wraith.new(config, yaml_passed)
     @history = history
     @meta = SaveMetadata.new(@wraith, history)
   end
@@ -21,26 +21,51 @@ class Wraith::SaveImages
   end
 
   def save_images
+    jobs = define_jobs
+    parallel_task(jobs)
+  end
+
+  def define_jobs
     jobs = []
     check_paths.each do |label, options|
       settings = CaptureOptions.new(options, wraith)
 
-      wraith.widths.each do |width|
-        base_file_name    = meta.file_names(width, label, meta.base_label)
-        compare_file_name = meta.file_names(width, label, meta.compare_label)
-
-        jobs << [label, settings.path, width, settings.base_url,    base_file_name, settings.selector, wraith.before_capture, settings.before_capture]
-        jobs << [label, settings.path, width, settings.compare_url, compare_file_name, settings.selector, wraith.before_capture, settings.before_capture] unless settings.compare_url.nil?
+      if wraith.resize
+        jobs = jobs + define_individual_job(label, settings, wraith.widths)
+      else
+        wraith.widths.each do |width|
+          jobs = jobs + define_individual_job(label, settings, width)
+        end
       end
     end
-    parallel_task(jobs)
+    jobs
+  end
+
+  def define_individual_job(label, settings, width)
+    base_file_name    = meta.file_names(width, label, meta.base_label)
+    compare_file_name = meta.file_names(width, label, meta.compare_label)
+
+    jobs = []
+    jobs << [label, settings.path, prepare_widths_for_cli(width), settings.base_url,    base_file_name,    settings.selector, wraith.before_capture, settings.before_capture]
+    jobs << [label, settings.path, prepare_widths_for_cli(width), settings.compare_url, compare_file_name, settings.selector, wraith.before_capture, settings.before_capture] unless settings.compare_url.nil?
+
+    jobs
+  end
+
+  def prepare_widths_for_cli(width)
+    if width.kind_of? Array
+      # prepare for the command line. [30,40,50] => "'30','40','50'"
+      width = width.map{ |i| "'#{i}'" }.join(',')
+    end
+    width
   end
 
   def capture_page_image(browser, url, width, file_name, selector, global_before_capture, path_before_capture)
-    command = "#{browser} #{wraith.phantomjs_options} '#{wraith.snap_file}' '#{url}' '#{width}' '#{file_name}' '#{selector}' '#{global_before_capture}' '#{path_before_capture}'"
+
+    command = "#{browser} #{wraith.phantomjs_options} '#{wraith.snap_file}' '#{url}' \"#{width}\" '#{file_name}' '#{selector}' '#{global_before_capture}' '#{path_before_capture}'"
 
     # @TODO - uncomment the following line when we add a verbose mode
-    # puts command
+    #puts command
     run_command command
   end
 
@@ -68,6 +93,10 @@ class Wraith::SaveImages
     max_attempts.times do |i|
       capture_page_image meta.engine, url, width, filename, selector, global_before_capture, path_before_capture
 
+      if wraith.resize
+        return # @TODO - need to check if the image was generated, as per the reload example below
+      end
+
       return if File.exist? filename
 
       puts "Failed to capture image #{filename} on attempt number #{i + 1} of #{max_attempts}"
@@ -142,12 +171,11 @@ class SaveMetadata
     history ? "_latest" : ""
   end
 
-  def engine_label
-    wraith.engine.key(engine)
-  end
-
   def file_names(width, label, domain_label)
-    "#{wraith.directory}/#{label}/#{width}_#{engine_label}_#{domain_label}.png"
+    if width.kind_of? Array
+      width = 'MULTI'
+    end
+    "#{wraith.directory}/#{label}/#{width}_#{engine}_#{domain_label}.png"
   end
 
   def base_label
@@ -159,6 +187,6 @@ class SaveMetadata
   end
 
   def engine
-    wraith.engine.each { |_label, browser| return browser }
+    wraith.engine
   end
 end

data/lib/wraith/version.rb

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

data/lib/wraith/wraith.rb

@@ -3,15 +3,20 @@ require "yaml"
 class Wraith::Wraith
   attr_accessor :config
 
-  def initialize(config_name)
+  def initialize(config, yaml_passed = false)
+    @config = yaml_passed ? config : open_config_file(config)
+  rescue
+    puts "unable to find config at #{config}"
+    exit 1
+  end
+
+  def open_config_file(config_name)
     if File.exist?(config_name) && File.extname(config_name) == ".yaml"
-      @config = YAML.load(File.open(config_name))
+      config = File.open config_name
     else
-      @config = YAML.load(File.open("configs/#{config_name}.yaml"))
+      config = File.open "configs/#{config_name}.yaml"
     end
-  rescue
-    puts "unable to find config at #{config_name}"
-    exit 1
+    YAML.load config
   end
 
   def directory
@@ -23,8 +28,30 @@ class Wraith::Wraith
     @config["history_dir"]
   end
 
+  def engine
+    engine = @config["browser"]
+    # Legacy support for those using the old style "browser: \n phantomjs: 'casperjs'" configs
+    if engine.is_a? Hash
+      engine = engine.values.first
+    end
+    engine
+  end
+
   def snap_file
-    @config["snap_file"] ? @config["snap_file"] : File.expand_path("lib/wraith/javascript/snap.js")
+    @config["snap_file"] || snap_file_from_engine(engine)
+  end
+
+  def snap_file_from_engine(engine)
+    path_to_js_templates = File.dirname(__FILE__) + '/javascript'
+    case engine
+    when "phantomjs"
+      path_to_js_templates + "/phantom.js"
+    when "casperjs"
+      path_to_js_templates + "/casper.js"
+    # @TODO - add a SlimerJS option
+    else
+      abort "Wraith does not recognise the browser engine '#{engine}'"
+    end
   end
 
   def before_capture
@@ -35,6 +62,11 @@ class Wraith::Wraith
     @config["screen_widths"]
   end
 
+  def resize
+    # @TODO make this default to true, once it's been tested a bit more thoroughly
+    @config["resize_or_reload"] ? (@config["resize_or_reload"] == "resize") : false
+  end
+
   def domains
     @config["domains"]
   end
@@ -75,10 +107,6 @@ class Wraith::Wraith
     @config["paths"]
   end
 
-  def engine
-    @config["browser"]
-  end
-
   def fuzz
     @config["fuzz"]
   end