wraith 3.0.4 → 3.1.0

data/lib/wraith/helpers/capture_options.rb

@@ -0,0 +1,52 @@
+require "wraith"
+require "wraith/helpers/utilities"
+
+class CaptureOptions
+  attr_reader :options, :wraith
+
+  def initialize(options, wraith)
+    @options = options
+    @wraith = wraith
+  end
+
+  def path
+    has_casper(options)
+  end
+
+  def selector
+    options["selector"] || "body"
+  end
+
+  def resize
+    # path level, or YAML-file level `resize_or_reload` property value
+    if @options["resize_or_reload"]
+      (@options["resize_or_reload"] == 'resize')
+    else
+      @wraith.resize
+    end
+  end
+
+  def before_capture
+    @options["before_capture"] ? convert_to_absolute(@options["before_capture"]) : false
+  end
+
+  def base_url
+    base_urls(path)
+  end
+
+  def compare_url
+    compare_urls(path)
+  end
+
+  def base_urls(path)
+    wraith.base_domain + path unless wraith.base_domain.nil?
+  end
+
+  def compare_urls(path)
+    wraith.comp_domain + path unless wraith.comp_domain.nil?
+  end
+
+  def has_casper(options)
+    options["path"] ? options["path"] : options
+  end
+end

data/lib/wraith/helpers/custom_exceptions.rb

@@ -0,0 +1,8 @@
+class CustomError < StandardError
+end
+
+class InvalidDomainsError < CustomError
+end
+
+class MissingRequiredPropertyError < CustomError
+end

data/lib/wraith/helpers/logger.rb

@@ -0,0 +1,20 @@
+# Logging Module, credit: http://stackoverflow.com/a/6768164
+require 'logger'
+
+module Logging
+  # This is the magical bit that gets mixed into your classes
+  def logger
+    Logging.logger
+  end
+
+  # Global, memoized, lazy initialized instance of a logger
+  def self.logger
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        (severity == 'INFO') ? "#{msg}\n" : "#{severity}: #{msg}\n"
+      end
+    end
+    @logger
+  end
+end

data/lib/wraith/helpers/save_metadata.rb

@@ -0,0 +1,31 @@
+require "wraith"
+
+class SaveMetadata
+  attr_reader :wraith, :history
+
+  def initialize(config, history)
+    @wraith = config
+    @history = history
+  end
+
+  def history_label
+    history ? "_latest" : ""
+  end
+
+  def file_names(width, label, domain_label)
+    width = "MULTI" if width.is_a? Array
+    "#{wraith.directory}/#{label}/#{width}_#{engine}_#{domain_label}.png"
+  end
+
+  def base_label
+    "#{wraith.base_domain_label}#{history_label}"
+  end
+
+  def compare_label
+    "#{wraith.comp_domain_label}#{history_label}"
+  end
+
+  def engine
+    wraith.engine
+  end
+end

data/lib/wraith/{utilities.rb → helpers/utilities.rb}

@@ -1,12 +1,13 @@
-# @TODO - extract more shared functions to this file
+require "wraith/helpers/custom_exceptions"
 
 def convert_to_absolute(filepath)
-  if filepath[0] == '/'
+  if !filepath
+    'false'
+  elsif filepath[0] == '/'
     # filepath is already absolute. return unchanged
     filepath
   else
     # filepath is relative. it must be converted to absolute
-    working_dir = `pwd`.chomp
-    "#{working_dir}/#{filepath}"
+    "#{Dir.pwd}/#{filepath}"
   end
 end

data/lib/wraith/javascript/_helper.js

@@ -1,8 +1,6 @@
 module.exports = function (commandLineDimensions) {
 
     commandLineDimensions = '' + commandLineDimensions; // cast to string
-    // remove quotes from dimensions string
-    commandLineDimensions = commandLineDimensions.replace(/'/gi, '');
 
     function getWidthAndHeight(dimensions) {
         dimensions = /(\d*)x?((\d*))?/i.exec(dimensions);

data/lib/wraith/javascript/casper.js

@@ -57,25 +57,35 @@ casper.start();
 casper.open(url);
 casper.viewport(currentDimensions.viewportWidth, currentDimensions.viewportHeight);
 casper.then(function() {
-  if (globalBeforeCaptureJS) {
-    require(globalBeforeCaptureJS)(this);
+  var self = this;
+  if (globalBeforeCaptureJS && pathBeforeCaptureJS) {
+    require(globalBeforeCaptureJS)(self, function thenExecuteOtherBeforeCaptureFile() {
+      require(pathBeforeCaptureJS)(self, captureImage);
+    });
   }
-});
-casper.then(function() {
-  if (pathBeforeCaptureJS) {
-    require(pathBeforeCaptureJS)(this);
+  else if (globalBeforeCaptureJS) {
+    require(globalBeforeCaptureJS)(self, captureImage);
+  }
+  else if (pathBeforeCaptureJS) {
+    require(pathBeforeCaptureJS)(self, captureImage);
+  }
+  else {
+    captureImage();
   }
 });
-// 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 captureImage() {
+  // 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)();
   });
-}, function then () {
-  snap.bind(this)();
-});
+}
 
 casper.run();

data/lib/wraith/javascript/phantom.js

@@ -1,6 +1,149 @@
-var system = require('system');
+// modules
+var system = require('system'),
+    page   = require('webpage').create(),
+    helper = require('./_helper.js')(system.args[2]);
 
-require('./_phantom__common.js')({
-  systemArgs:        system.args,
-  javascriptEnabled: true
-});
+// command line arguments
+var url        = system.args[1],
+    dimensions = helper.dimensions,
+    image_name = system.args[3],
+    selector   = system.args[4],
+    globalBeforeCaptureJS = system.args[5],
+    pathBeforeCaptureJS = system.args[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;
+
+var setupJavaScriptRan = false;
+
+var waitTime = 300,
+    maxWait = 5000,
+    beenLoadingFor = 0;
+
+if (helper.takingMultipleScreenshots(dimensions)) {
+  currentDimensions = dimensions[0];
+  image_name = helper.replaceImageNameWithDimensions(image_name, currentDimensions);
+}
+else {
+  currentDimensions = dimensions;
+}
+
+page.settings = { loadImages: true, javascriptEnabled: true};
+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.onError = function(msg, trace) {
+  // suppress JS errors from Wraith output
+  // http://stackoverflow.com/a/19538646
+};
+
+page.onResourceRequested = function(req) {
+  current_requests += 1;
+};
+
+page.onResourceReceived = function(res) {
+  if (res.stage === 'end') {
+    current_requests -= 1;
+  }
+};
+
+console.log('Loading ' + url + ' at dimensions: ' + currentDimensions.viewportWidth + 'x' + currentDimensions.viewportHeight);
+page.viewportSize = { width: currentDimensions.viewportWidth, height: currentDimensions.viewportHeight};
+
+page.open(url, function(status) {
+  if (status !== 'success') {
+    console.log('Error with page ' + url);
+    phantom.exit();
+  }
+
+  setTimeout(checkStatusOfAssets, waitTime);
+});
+
+
+function checkStatusOfAssets() {
+  if (current_requests >= 1) {
+
+    if (beenLoadingFor > maxWait) {
+      // sometimes not all assets will download in an acceptable time - continue anyway.
+      markPageAsLoaded();
+    }
+    else {
+      beenLoadingFor += waitTime;
+      setTimeout(checkStatusOfAssets, waitTime);
+    }
+  }
+  else {
+    markPageAsLoaded();
+  }
+}
+
+function markPageAsLoaded() {
+  if (!setupJavaScriptRan) {
+    runSetupJavaScriptThen(captureImage);
+  }
+  else {
+    captureImage();
+  }
+}
+
+
+function runSetupJavaScriptThen(callback) {
+  setupJavaScriptRan = true;
+  if (globalBeforeCaptureJS && pathBeforeCaptureJS) {
+    require(globalBeforeCaptureJS)(page, function thenExecuteOtherBeforeCaptureFile() {
+      require(pathBeforeCaptureJS)(page, callback);
+    });
+  }
+  else if (globalBeforeCaptureJS) {
+    require(globalBeforeCaptureJS)(page, callback);
+  }
+  else if (pathBeforeCaptureJS) {
+    require(pathBeforeCaptureJS)(page, callback);
+  }
+  else {
+    callback();
+  }
+}
+
+function captureImage() {
+  takeScreenshot();
+
+  dimensionsProcessed++;
+  if (helper.takingMultipleScreenshots(dimensions) && dimensionsProcessed < dimensions.length) {
+    currentDimensions = dimensions[dimensionsProcessed];
+    image_name = helper.replaceImageNameWithDimensions(image_name, currentDimensions);
+    setTimeout(resizeAndCaptureImage, waitTime);
+  }
+  else {
+    exit_phantom();
+  }
+}
+
+function resizeAndCaptureImage() {
+  console.log('Resizing ' + url + ' to: ' + currentDimensions.viewportWidth + 'x' + currentDimensions.viewportHeight);
+  page.viewportSize = { width: currentDimensions.viewportWidth, height: currentDimensions.viewportHeight};
+  setTimeout(captureImage, 5000); // give page time to re-render properly
+}
+
+function takeScreenshot() {
+  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);
+}
+
+function exit_phantom() {
+  // 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);
+}

data/lib/wraith/save_images.rb

@@ -1,9 +1,13 @@
-require "wraith"
 require "parallel"
 require "shellwords"
-require "wraith/utilities"
+require "wraith"
+require "wraith/helpers/capture_options"
+require "wraith/helpers/logger"
+require "wraith/helpers/save_metadata"
+require "wraith/helpers/utilities"
 
 class Wraith::SaveImages
+  include Logging
   attr_reader :wraith, :history, :meta
 
   def initialize(config, history = false, yaml_passed = false)
@@ -54,26 +58,15 @@ class Wraith::SaveImages
   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
+    # prepare for the command line. [30,40,50] => "30,40,50"
+    width = width.join(',') if width.is_a? Array
     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}'"
-
-    # @TODO - uncomment the following line when we add a verbose mode
-    # puts command
-    run_command command
-  end
-
   def run_command(command)
     output = []
     IO.popen(command).each do |line|
-      puts line
+      logger.info line
       output << line.chomp!
     end.close
     output
@@ -82,17 +75,30 @@ class Wraith::SaveImages
   def parallel_task(jobs)
     Parallel.each(jobs, :in_threads => 8) do |_label, _path, width, url, filename, selector, global_before_capture, path_before_capture|
       begin
-        attempt_image_capture(width, url, filename, selector, global_before_capture, path_before_capture, 5)
+        command = construct_command(width, url, filename, selector, global_before_capture, path_before_capture)
+        attempt_image_capture(command, filename)
       rescue => e
-        puts e
+        logger.error e
         create_invalid_image(filename, width)
       end
     end
   end
 
-  def attempt_image_capture(width, url, filename, selector, global_before_capture, path_before_capture, max_attempts)
+  def construct_command(width, url, file_name, selector, global_before_capture, path_before_capture)
+    width    = prepare_widths_for_cli(width)
+    selector = selector.gsub '#', '\#' # make sure id selectors aren't escaped in the CLI
+    global_before_capture = convert_to_absolute global_before_capture
+    path_before_capture   = convert_to_absolute path_before_capture
+
+    command_to_run = "#{meta.engine} #{wraith.phantomjs_options} '#{wraith.snap_file}' '#{url}' '#{width}' '#{file_name}' '#{selector}' '#{global_before_capture}' '#{path_before_capture}'"
+    logger.debug command_to_run
+    command_to_run
+  end
+
+  def attempt_image_capture(capture_page_image, filename)
+    max_attempts = 5
     max_attempts.times do |i|
-      capture_page_image meta.engine, url, width, filename, selector, global_before_capture, path_before_capture
+      run_command capture_page_image
 
       if wraith.resize
         return # @TODO - need to check if the image was generated, as per the reload example below
@@ -100,14 +106,14 @@ class Wraith::SaveImages
 
       return if File.exist? filename
 
-      puts "Failed to capture image #{filename} on attempt number #{i + 1} of #{max_attempts}"
+      logger.warn "Failed to capture image #{filename} on attempt number #{i + 1} of #{max_attempts}"
     end
 
     fail "Unable to capture image #{filename} after #{max_attempts} attempt(s)"
   end
 
   def create_invalid_image(filename, width)
-    puts "Using fallback image instead"
+    logger.warn "Using fallback image instead"
     invalid = File.expand_path("../../assets/invalid.jpg", File.dirname(__FILE__))
     FileUtils.cp invalid, filename
 
@@ -118,85 +124,3 @@ class Wraith::SaveImages
     `convert #{image.shellescape} -background none -extent #{width}x0 #{image.shellescape}`
   end
 end
-
-class CaptureOptions
-  attr_reader :options, :wraith
-
-  def initialize(options, wraith)
-    @options = options
-    @wraith = wraith
-  end
-
-  def path
-    has_casper(options)
-  end
-
-  def selector
-    options["selector"] || "body"
-  end
-
-  def resize
-    # path level, or YAML-file level `resize_or_reload` property value
-    if @options["resize_or_reload"]
-      (@options["resize_or_reload"] == 'resize')
-    else
-      @wraith.resize
-    end
-  end
-
-  def before_capture
-    @options["before_capture"] ? convert_to_absolute(@options["before_capture"]) : "false"
-  end
-
-  def base_url
-    base_urls(path)
-  end
-
-  def compare_url
-    compare_urls(path)
-  end
-
-  def base_urls(path)
-    wraith.base_domain + path unless wraith.base_domain.nil?
-  end
-
-  def compare_urls(path)
-    wraith.comp_domain + path unless wraith.comp_domain.nil?
-  end
-
-  def has_casper(options)
-    options["path"] ? options["path"] : options
-  end
-end
-
-class SaveMetadata
-  attr_reader :wraith, :history
-
-  def initialize(config, history)
-    @wraith = config
-    @history = history
-  end
-
-  def history_label
-    history ? "_latest" : ""
-  end
-
-  def file_names(width, label, domain_label)
-    if width.kind_of? Array
-      width = 'MULTI'
-    end
-    "#{wraith.directory}/#{label}/#{width}_#{engine}_#{domain_label}.png"
-  end
-
-  def base_label
-    "#{wraith.base_domain_label}#{history_label}"
-  end
-
-  def compare_label
-    "#{wraith.comp_domain_label}#{history_label}"
-  end
-
-  def engine
-    wraith.engine
-  end
-end