wraith 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5da45ef7a6e2d91b95dfd97c78b2a67fbc213aed
-  data.tar.gz: f629294fbf9daf54fda68cd57ab46286161e9f8d
+  metadata.gz: 7cfd12ddc2a452f6dffc57109d8941fee8d6e3f3
+  data.tar.gz: 6ea9037c3abd03977b8602bdbb8e34da62781a17
 SHA512:
-  metadata.gz: f314042b1c3b46a96ed5b352ef41eb40ced18f64b2aef0c7498ba563d0d980399a9c38801ee0ce80dd77f198d3c02e92a21aa70ca819b11430d0dd44c1a39279
-  data.tar.gz: 3bc518f1a5ad518a9230f4c77edc859ba31d2a21ac989017692a4234e01373335560511e28a7ad4fe0aca1bd75be27636b4641d27ab6e8475e3ec4055209c6e6
+  metadata.gz: cbd574be34e7d10ffebb118b1df7cee44f93031166afa35363e63996475ac2220c5ab651ef4c224b308ca3c18f2c49002bb2a8737b36da03324ff92f26986c8b
+  data.tar.gz: e18eda8062445c426268d3715e119f5e5f299b69ed8b220ba94266c6a6f56cbfa500fac358b09de2d7220fbcdbb5fdb7afc600c1f4914627fbb78d08abb73774

data/lib/wraith/cli.rb

@@ -45,7 +45,7 @@ class Wraith::CLI < Thor
   desc "validate", "checks your configuration and validates that all required properties exist"
   def validate(config_name)
     within_acceptable_limits do
-      wraith = Wraith::Validate.new(config_name).validate
+      logger.info Wraith::Validate.new(config_name).validate
     end
   end
 
@@ -93,6 +93,7 @@ class Wraith::CLI < Thor
   desc "crop_images [config_name]", "crops images to the same height"
   def crop_images(config_name)
     within_acceptable_limits do
+      logger.info "CROPPING IMAGES"
       crop = Wraith::CropImages.new(config_name)
       crop.crop_images
     end
@@ -128,7 +129,7 @@ class Wraith::CLI < Thor
   desc "capture [config_name]", "Capture paths against two domains, compare them, generate gallery"
   def capture(config, multi = false)
     within_acceptable_limits do
-      logger.info Wraith::Validate.new(config).validate('capture')
+      logger.info Wraith::Validate.new(config).validate("capture")
       reset_shots(config)
       check_for_paths(config)
       setup_folders(config)
@@ -153,7 +154,7 @@ class Wraith::CLI < Thor
   desc "history [config_name]", "Setup a baseline set of shots"
   def history(config)
     within_acceptable_limits do
-      logger.info Wraith::Validate.new(config).validate('history')
+      logger.info Wraith::Validate.new(config).validate("history")
       reset_shots(config)
       check_for_paths(config)
       setup_folders(config)
@@ -165,7 +166,7 @@ class Wraith::CLI < Thor
   desc "latest [config_name]", "Capture new shots to compare with baseline"
   def latest(config)
     within_acceptable_limits do
-      logger.info Wraith::Validate.new(config).validate('latest')
+      logger.info Wraith::Validate.new(config).validate("latest")
       reset_shots(config)
       save_images(config, true)
       copy_base_images(config)
@@ -175,4 +176,4 @@ class Wraith::CLI < Thor
       generate_gallery(config)
     end
   end
-end
+end

data/lib/wraith/crop.rb

@@ -16,25 +16,31 @@ class Wraith::CropImages
     files = Dir.glob("#{wraith.directory}/*/*.png").sort
 
     Parallel.each(files.each_slice(2), :in_processes => Parallel.processor_count) do |base, compare|
-      logger.info "cropping images"
+      crop_if_necessary base, compare
+    end
+  end
 
-      width          = image_dimensions(base)[0]
+  def crop_if_necessary(base, compare)
+      base_width     = image_dimensions(base)[0]
       base_height    = image_dimensions(base)[1]
+      compare_width  = image_dimensions(compare)[0]
       compare_height = image_dimensions(compare)[1]
 
-      if base_height > compare_height
-        image_to_crop     = compare
-        height_to_crop_to = base_height
-      else
-        image_to_crop     = base
-        height_to_crop_to = compare_height
+      if base_height == compare_height and base_width == compare_width
+        logger.debug "Both images are exactly #{base_width}x#{base_height} - no cropping required. (#{base}, #{compare})"
+        return true
       end
 
-      crop_task(image_to_crop, height_to_crop_to, width)
-    end
+      max_width  = [base_width, compare_width].max
+      max_height = [base_height, compare_height].max
+
+      logger.debug "Cropping both images to #{max_width}x#{max_height}. (#{base}, #{compare})"
+      [base, compare].each do |image_to_crop|
+        run_crop_task(image_to_crop, max_height, max_width)
+      end
   end
 
-  def crop_task(crop, height, width)
+  def run_crop_task(crop, height, width)
     `convert #{crop.shellescape} -background none -extent #{width}x#{height} #{crop.shellescape}`
   end
 

data/lib/wraith/folder.rb

@@ -37,9 +37,15 @@ class Wraith::FolderManager
 
   def copy_old_shots
     if history_dir.nil?
-      logger.error 'no `history_dir` attribute found in config. Cannot copy files.'
+      logger.error "no `history_dir` attribute found in config. Cannot copy files."
     else
       FileUtils.cp_r("#{dir}/.", "#{history_dir}/")
+      FileUtils.rm_rf("#{history_dir}/thumbnails") # thumbnails aren't generated until the gallery stage anyway
+      FileUtils.rm_rf("#{dir}") # get rid of the live folder
+      Dir["#{history_dir}/**/*.png"].each do |filepath|
+        new_name = filepath.gsub("latest.png", "base.png")
+        File.rename(filepath, new_name)
+      end
     end
   end
 

data/lib/wraith/gallery.rb

@@ -52,9 +52,7 @@ class Wraith::GalleryGenerator
     @thumbnail = "thumbnails/#{category}/#{filename}"
     @url = figure_out_url @group, category
 
-    if @dirs[category][@size].nil?
-      @dirs[category][@size] = { :variants => [] }
-    end
+    @dirs[category][@size] = { :variants => [] } if @dirs[category][@size].nil?
 
     size_dict = @dirs[category][@size]
 
@@ -63,20 +61,20 @@ class Wraith::GalleryGenerator
 
   def figure_out_url(group, category)
     root = wraith.domains["#{group}"]
-    return '' if root.nil?
+    return "" if root.nil?
     path = get_path(category)
     url  = root + path
     url
   end
 
   def get_path(category)
-    wraith.paths[category]['path'] || wraith.paths[category]
+    wraith.paths[category]["path"] || wraith.paths[category]
   end
 
   def get_group_from_match(match)
     group = match[2]
-    dash = match[2].rindex('-')
-    group = match[2][dash+1..-1] unless dash.nil?
+    dash = match[2].rindex("-")
+    group = match[2][dash + 1..-1] unless dash.nil?
     group
   end
 
@@ -159,7 +157,7 @@ class Wraith::GalleryGenerator
 
       @dirs.each do |dir, sizes|
         sizes.to_a.sort.each do |size, files|
-          file = dir.gsub('__', '/')
+          file = dir.gsub("__", "/")
           if !files.include?(:diff)
             logger.warn "\t Unable to create a diff image for #{file}"
           elsif files[:data] > wraith.threshold
@@ -176,7 +174,7 @@ class Wraith::GalleryGenerator
 
   def prompt_user_to_open_gallery(dest)
     logger.info "\nView the gallery in your browser:"
-    logger.info "\t file://" + Dir.pwd + '/' + dest
+    logger.info "\t file://" + Dir.pwd + "/" + dest
   end
 
   class ErbBinding < OpenStruct

data/lib/wraith/helpers/capture_options.rb

@@ -10,7 +10,7 @@ class CaptureOptions
   end
 
   def path
-    has_casper(options)
+    casper?(options)
   end
 
   def selector
@@ -19,15 +19,15 @@ class CaptureOptions
 
   def resize
     # path level, or YAML-file level `resize_or_reload` property value
-    if @options["resize_or_reload"]
-      (@options["resize_or_reload"] == 'resize')
+    if options["resize_or_reload"]
+      (options["resize_or_reload"] == "resize")
     else
-      @wraith.resize
+      wraith.resize
     end
   end
 
   def before_capture
-    @options["before_capture"] ? convert_to_absolute(@options["before_capture"]) : false
+    options["before_capture"] ? convert_to_absolute(options["before_capture"]) : false
   end
 
   def base_url
@@ -46,7 +46,7 @@ class CaptureOptions
     wraith.comp_domain + path unless wraith.comp_domain.nil?
   end
 
-  def has_casper(options)
+  def casper?(options)
     options["path"] ? options["path"] : options
   end
 end

data/lib/wraith/helpers/logger.rb

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

data/lib/wraith/helpers/utilities.rb

@@ -2,10 +2,13 @@ require "wraith/helpers/custom_exceptions"
 
 def convert_to_absolute(filepath)
   if !filepath
-    'false'
-  elsif filepath[0] == '/'
+    "false"
+  elsif filepath[0] == "/"
     # filepath is already absolute. return unchanged
     filepath
+  elsif filepath.match(/^[A-Z]:\/(.+)$/)
+    # filepath is an absolute Windows path, e.g. C:/Code/Wraith/javascript/global.js. return unchanged
+    filepath
   else
     # filepath is relative. it must be converted to absolute
     "#{Dir.pwd}/#{filepath}"

data/lib/wraith/save_images.rb

@@ -36,10 +36,10 @@ class Wraith::SaveImages
       settings = CaptureOptions.new(options, wraith)
 
       if settings.resize
-        jobs = jobs + define_individual_job(label, settings, wraith.widths)
+        jobs += define_individual_job(label, settings, wraith.widths)
       else
         wraith.widths.each do |width|
-          jobs = jobs + define_individual_job(label, settings, width)
+          jobs += define_individual_job(label, settings, width)
         end
       end
     end
@@ -59,7 +59,7 @@ class Wraith::SaveImages
 
   def prepare_widths_for_cli(width)
     # prepare for the command line. [30,40,50] => "30,40,50"
-    width = width.join(',') if width.is_a? Array
+    width = width.join(",") if width.is_a? Array
     width
   end
 
@@ -99,17 +99,16 @@ class Wraith::SaveImages
     max_attempts = 5
     max_attempts.times do |i|
       run_command capture_page_image
-
-      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
-
+      return true if image_was_created filename
       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)"
+    fail "Unable to capture image #{filename} after #{max_attempts} attempt(s)" unless image_was_created filename
+  end
+
+  def image_was_created(filename)
+     # @TODO - need to check if the image was generated even if in resize mode
+    wraith.resize or File.exist? filename
   end
 
   def create_invalid_image(filename, width)

data/lib/wraith/spider.rb

@@ -6,19 +6,20 @@ require "uri"
 
 class Wraith::Spidering
   include Logging
+  attr_reader :wraith
 
   def initialize(config)
     @wraith = Wraith::Wraith.new(config)
   end
 
   def check_for_paths
-    if @wraith.paths.nil?
-      unless @wraith.sitemap.nil?
+    if wraith.paths.nil?
+      unless wraith.sitemap.nil?
         logger.info "no paths defined in config, loading paths from sitemap"
-        spider = Wraith::Sitemap.new(@wraith)
+        spider = Wraith::Sitemap.new(wraith)
       else
         logger.info "no paths defined in config, crawling from site root"
-        spider = Wraith::Crawler.new(@wraith)
+        spider = Wraith::Crawler.new(wraith)
       end
       spider.determine_paths
     end
@@ -39,7 +40,7 @@ class Wraith::Spider
   private
 
   def write_file
-    File.open(@wraith.spider_file, "w+") { |file| file.write(@paths) }
+    File.open(wraith.spider_file, "w+") { |file| file.write(@paths) }
   end
 
   def add_path(path)
@@ -60,16 +61,15 @@ class Wraith::Crawler < Wraith::Spider
            m3u f4v pdf doc xls ppt pps bin exe rss xml)
 
   def spider
-    if File.exist?(@wraith.spider_file) && modified_since(@wraith.spider_file, @wraith.spider_days[0])
+    if File.exist?(wraith.spider_file) && modified_since(wraith.spider_file, wraith.spider_days[0])
       logger.info "using existing spider file"
-      @paths = eval(File.read(@wraith.spider_file))
+      @paths = eval(File.read(wraith.spider_file))
     else
       logger.info "creating new spider file"
-      spider_list = []
-      Anemone.crawl(@wraith.base_domain) do |anemone|
+      Anemone.crawl(wraith.base_domain) do |anemone|
         anemone.skip_links_like(/\.(#{EXT.join('|')})$/)
         # Add user specified skips
-        anemone.skip_links_like(@wraith.spider_skips)
+        anemone.skip_links_like(wraith.spider_skips)
         anemone.on_every_page { |page| add_path(page.url.path) }
       end
     end
@@ -84,21 +84,20 @@ class Wraith::Sitemap < Wraith::Spider
   include Logging
 
   def spider
-    unless @wraith.sitemap.nil?
-      logger.info "reading sitemap.xml from #{@wraith.sitemap}"
-      if @wraith.sitemap =~ URI.regexp
-        sitemap = Nokogiri::XML(open(@wraith.sitemap))
+    unless wraith.sitemap.nil?
+      logger.info "reading sitemap.xml from #{wraith.sitemap}"
+      if wraith.sitemap =~ URI.regexp
+        sitemap = Nokogiri::XML(open(wraith.sitemap))
       else
-        sitemap = Nokogiri::XML(File.open(@wraith.sitemap))
+        sitemap = Nokogiri::XML(File.open(wraith.sitemap))
       end
-      urls = {}
       sitemap.css("loc").each do |loc|
         path = loc.content
         # Allow use of either domain in the sitemap.xml
-        @wraith.domains.each do |_k, v|
+        wraith.domains.each do |_k, v|
           path.sub!(v, "")
         end
-        if @wraith.spider_skips.nil? || @wraith.spider_skips.none? { |regex| regex.match(path) }
+        if wraith.spider_skips.nil? || wraith.spider_skips.none? { |regex| regex.match(path) }
           add_path(path)
         end
       end

data/lib/wraith/validate.rb

@@ -4,13 +4,14 @@ require "wraith/helpers/utilities"
 
 class Wraith::Validate
   include Logging
+  attr_reader :wraith
 
   def initialize(config, yaml_passed = false)
     @wraith = Wraith::Wraith.new(config, yaml_passed)
   end
 
   def validate(mode = false)
-    list_debug_information if @wraith.verbose
+    list_debug_information if wraith.verbose
     validate_basic_properties
     validate_mode_properties(mode) if mode
     # if we get this far, we've only had warnings at worst, not errors.
@@ -18,13 +19,13 @@ class Wraith::Validate
   end
 
   def validate_basic_properties
-    if @wraith.engine.nil?
-      raise MissingRequiredPropertyError, "You must specify a browser engine! #{docs_prompt}"
+    if wraith.engine.nil?
+      fail MissingRequiredPropertyError, "You must specify a browser engine! #{docs_prompt}"
     end
-    unless @wraith.domains
-      raise MissingRequiredPropertyError, "You must specify at least one domain for Wraith to do anything! #{docs_prompt}"
+    unless wraith.domains
+      fail MissingRequiredPropertyError, "You must specify at least one domain for Wraith to do anything! #{docs_prompt}"
     end
-    #@TODO validate fuzz is not nil, etc
+    # @TODO validate fuzz is not nil, etc
   end
 
   def validate_mode_properties(mode)
@@ -42,25 +43,21 @@ class Wraith::Validate
   end
 
   def validate_capture_mode
-    if @wraith.domains.length != 2
-      raise InvalidDomainsError, "`wraith capture` requires exactly two domains. #{docs_prompt}"
-    end
-    if @wraith.history_dir
-      logger.warn "You have specified a `history_dir` in your config, but this is used in `history` mode, NOT `capture` mode. #{docs_prompt}"
-    end
+    fail InvalidDomainsError, "`wraith capture` requires exactly two domains. #{docs_prompt}" if wraith.domains.length != 2
+
+    logger.warn "You have specified a `history_dir` in your config, but this is"\
+                " used in `history` mode, NOT `capture` mode. #{docs_prompt}" if wraith.history_dir
   end
 
   def validate_history_mode
-    unless @wraith.history_dir
-      raise MissingRequiredPropertyError, "You must specify a `history_dir` to run Wraith in history mode. #{docs_prompt}"
-    end
-    if @wraith.domains.length != 1
-      raise InvalidDomainsError, "History mode requires exactly one domain. #{docs_prompt}"
-    end
+    fail MissingRequiredPropertyError, "You must specify a `history_dir` to run"\
+                  " Wraith in history mode. #{docs_prompt}" unless wraith.history_dir
+
+    fail InvalidDomainsError, "History mode requires exactly one domain. #{docs_prompt}" if wraith.domains.length != 1
   end
 
   def validate_base_shots_exist
-    unless File.directory?(@wraith.history_dir)
+    unless File.directory?(wraith.history_dir)
       logger.error "You need to run `wraith history` at least once before you can run `wraith latest`!"
     end
   end
@@ -71,10 +68,10 @@ class Wraith::Validate
 
   def list_debug_information
     wraith_version      = Wraith::VERSION
-    ruby_version        = run_command_safely('ruby -v')             || 'Ruby not installed'
-    phantomjs_version   = run_command_safely('phantomjs --version') || 'PhantomJS not installed'
-    casperjs_version    = run_command_safely('casperjs --version')  || 'CasperJS not installed'
-    imagemagick_version = run_command_safely('convert -version')    || 'ImageMagick not installed'
+    ruby_version        = run_command_safely("ruby -v") || "Ruby not installed"
+    phantomjs_version   = run_command_safely("phantomjs --version") || "PhantomJS not installed"
+    casperjs_version    = run_command_safely("casperjs --version") || "CasperJS not installed"
+    imagemagick_version = run_command_safely("convert -version") || "ImageMagick not installed"
 
     logger.debug "#################################################"
     logger.debug "  Wraith version:     #{wraith_version}"
@@ -90,9 +87,9 @@ class Wraith::Validate
   def run_command_safely(command)
     begin
       output = `#{command}`
-    rescue Exception => e
+    rescue StandardError
       return false
     end
     output.lines.first
   end
-end
+end

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

data/lib/wraith/wraith.rb

@@ -7,21 +7,27 @@ class Wraith::Wraith
   attr_accessor :config
 
   def initialize(config, yaml_passed = false)
-    begin
-      @config = yaml_passed ? config : open_config_file(config)
-      logger.level = verbose ? Logger::DEBUG : Logger::INFO
-    rescue
-      logger.error "unable to find config at #{config}"
-    end
+    @config = yaml_passed ? config : open_config_file(config)
+    logger.level = verbose ? Logger::DEBUG : Logger::INFO
   end
 
   def open_config_file(config_name)
-    if File.exist?(config_name) && File.extname(config_name) == ".yaml"
-      config = File.open config_name
-    else
-      config = File.open "configs/#{config_name}.yaml"
+    possible_filenames = [
+      config_name,
+      "#{config_name}.yml",
+      "#{config_name}.yaml",
+      "configs/#{config_name}.yml",
+      "configs/#{config_name}.yaml"
+    ]
+
+    possible_filenames.each do |filepath|
+      if File.exist?(filepath)
+        config = File.open config_name
+        return YAML.load config
+      end
     end
-    YAML.load config
+  rescue
+    logger.error "unable to find config \"#{config}\""
   end
 
   def directory
@@ -45,7 +51,7 @@ class Wraith::Wraith
   end
 
   def snap_file_from_engine(engine)
-    path_to_js_templates = File.dirname(__FILE__) + '/javascript'
+    path_to_js_templates = File.dirname(__FILE__) + "/javascript"
     case engine
     when "phantomjs"
       path_to_js_templates + "/phantom.js"
@@ -131,7 +137,7 @@ class Wraith::Wraith
   end
 
   def gallery_template
-    default = 'basic_template'
+    default = "basic_template"
     if @config["gallery"].nil?
       default
     else
@@ -163,6 +169,6 @@ class Wraith::Wraith
 
   def verbose
     # @TODO - also add a `--verbose` CLI flag which overrides whatever you have set in the config
-    @config['verbose'] || false
+    @config["verbose"] || false
   end
-end
+end

data/spec/before_capture_spec.rb

@@ -2,12 +2,12 @@ require "_helpers"
 
 def run_js_then_capture(config)
   saving     = Wraith::SaveImages.new(config_name)
-  generated_image = 'shots/test/temporary_jsified_image.png'
+  generated_image = "shots/test/temporary_jsified_image.png"
   capture_image   = saving.construct_command(320, "http://www.bbc.com/afrique", generated_image, selector, config[:global_js], config[:path_js])
   `#{capture_image}`
   Wraith::CompareImages.new(config_name).compare_task(generated_image, config[:output_should_look_like], "shots/test/test_diff.png", "shots/test/test.txt")
-  diff = File.open('shots/test/test.txt', "rb").read
-  expect(diff).to eq '0.0'
+  diff = File.open("shots/test/test.txt", "rb").read
+  expect(diff).to eq "0.0"
 end
 
 describe Wraith do
@@ -30,7 +30,7 @@ describe Wraith do
       '
       wraith = Wraith::Wraith.new(config, true)
       # not sure about having code IN the test, but we want to get this right.
-      expect(wraith.before_capture).to eq (Dir.pwd + '/javascript/do_something.js')
+      expect(wraith.before_capture).to eq(Dir.pwd + "/javascript/do_something.js")
     end
 
     it "should allow users to specify the absolute path to the before_capture file" do
@@ -39,7 +39,7 @@ describe Wraith do
         before_capture: /Users/some_user/wraith/javascript/do_something.js
       '
       wraith = Wraith::Wraith.new(config, true)
-      expect(wraith.before_capture).to eq ('/Users/some_user/wraith/javascript/do_something.js')
+      expect(wraith.before_capture).to eq("/Users/some_user/wraith/javascript/do_something.js")
     end
   end
 
@@ -48,33 +48,33 @@ describe Wraith do
   describe "When hooking into beforeCapture (CasperJS)" do
     it "Executes the global JS before capturing" do
       run_js_then_capture(
-        global_js: before_suite_js,
-        path_js:   false,
-        output_should_look_like: 'spec/base/global.png',
-        engine:    'casperjs'
+        :global_js               => before_suite_js,
+        :path_js                 => false,
+        :output_should_look_like => "spec/base/global.png",
+        :engine                  => "casperjs"
       )
     end
 
     it "Executes the path-level JS before capturing" do
       run_js_then_capture(
-        global_js: false,
-        path_js: before_capture_js,
-        output_should_look_like: 'spec/base/path.png',
-        engine:    'casperjs'
+        :global_js               => false,
+        :path_js                 => before_capture_js,
+        :output_should_look_like => "spec/base/path.png",
+        :engine                  => "casperjs"
       )
     end
 
     it "Executes the global JS before the path-level JS" do
       run_js_then_capture(
-        global_js: before_suite_js,
-        path_js: before_capture_js,
-        output_should_look_like: 'spec/base/path.png',
-        engine:    'casperjs'
+        :global_js               => before_suite_js,
+        :path_js                 => before_capture_js,
+        :output_should_look_like => "spec/base/path.png",
+        :engine                  => "casperjs"
       )
     end
   end
 
-  # @TODO - uncomment and figure out why broken
+  #  @TODO - uncomment and figure out why broken
   # describe "When hooking into beforeCapture (PhantomJS)" do
   #   let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
   #   let(:saving) { Wraith::SaveImages.new(config_name) }
@@ -110,4 +110,4 @@ describe Wraith do
   #     )
   #   end
   # end
-end
+end

data/spec/config_spec.rb

@@ -70,10 +70,10 @@ describe "wraith config" do
 
   describe "different ways of initialising browser engine" do
     it "should let us directly specify the engine" do
-      config = YAML.load 'browser: phantomjs'
+      config = YAML.load "browser: phantomjs"
       wraith = Wraith::Wraith.new(config, true)
 
-      expect(wraith.engine).to eq 'phantomjs'
+      expect(wraith.engine).to eq "phantomjs"
     end
 
     it "should be backwards compatible with the old way" do
@@ -82,19 +82,19 @@ describe "wraith config" do
           phantomjs: "casperjs"
       '
       wraith = Wraith::Wraith.new(config, true)
-      expect(wraith.engine).to eq 'casperjs'
+      expect(wraith.engine).to eq "casperjs"
     end
   end
 
   describe "different ways of determining the snap file" do
     it "should calculate the snap file from the engine" do
-      config = YAML.load 'browser: phantomjs'
+      config = YAML.load "browser: phantomjs"
       wraith = Wraith::Wraith.new(config, true)
-      expect(wraith.snap_file).to include 'lib/wraith/javascript/phantom.js'
+      expect(wraith.snap_file).to include "lib/wraith/javascript/phantom.js"
 
-      config = YAML.load 'browser: casperjs'
+      config = YAML.load "browser: casperjs"
       wraith = Wraith::Wraith.new(config, true)
-      expect(wraith.snap_file).to include 'lib/wraith/javascript/casper.js'
+      expect(wraith.snap_file).to include "lib/wraith/javascript/casper.js"
     end
 
     it "should calculate the snap file in a backwards-compatible way" do
@@ -103,7 +103,7 @@ describe "wraith config" do
           phantomjs: "casperjs"
       '
       wraith = Wraith::Wraith.new(config, true)
-      expect(wraith.snap_file).to include 'lib/wraith/javascript/casper.js'
+      expect(wraith.snap_file).to include "lib/wraith/javascript/casper.js"
     end
 
     it "should allow users to specify the relative path to their own snap file" do
@@ -113,7 +113,7 @@ describe "wraith config" do
       '
       wraith = Wraith::Wraith.new(config, true)
       # not sure about having code IN the test, but we want to get this right.
-      expect(wraith.snap_file).to eq (Dir.pwd + '/path/to/snap.js')
+      expect(wraith.snap_file).to eq(Dir.pwd + "/path/to/snap.js")
     end
 
     it "should allow users to specify the absolute path to their own snap file" do
@@ -122,7 +122,7 @@ describe "wraith config" do
         snap_file: /Users/my_username/Sites/bbc/wraith/path/to/snap.js
       '
       wraith = Wraith::Wraith.new(config, true)
-      expect(wraith.snap_file).to eq ('/Users/my_username/Sites/bbc/wraith/path/to/snap.js')
+      expect(wraith.snap_file).to eq("/Users/my_username/Sites/bbc/wraith/path/to/snap.js")
     end
   end
 
@@ -139,4 +139,4 @@ describe "wraith config" do
       expect(wraith.resize).to eq false
     end
   end
-end
+end

data/spec/construct_command_spec.rb

@@ -6,10 +6,10 @@ describe "Wraith config to CLI argument mapping" do
     let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
     let(:saving)      { Wraith::SaveImages.new(config_name) }
     let(:width)       { 320 }
-    let(:url)         { 'http://example.com/my-page' }
-    let(:file_name)   { 'wraith/my-page/320_phantomjs_latest.png' }
-    let(:selector)    { '.my_selector' }
-    let(:global_bc)   { 'javascript/before_capture.js' }
+    let(:url)         { "http://example.com/my-page" }
+    let(:file_name)   { "wraith/my-page/320_phantomjs_latest.png" }
+    let(:selector)    { ".my_selector" }
+    let(:global_bc)   { "javascript/before_capture.js" }
     let(:path_bc)     { false }
 
     it "should take a load of variables and construct a command" do
@@ -40,4 +40,4 @@ describe "Wraith config to CLI argument mapping" do
       expect(actual).to eq expected
     end
   end
-end
+end

data/spec/gallery_spec.rb

@@ -5,33 +5,27 @@ describe Wraith do
   let(:gallery) { Wraith::GalleryGenerator.new(config_name, false) }
 
   describe "When generating gallery" do
-
     it "should not break when there is a `-` in the filename" do
-      dirs = gallery.parse_directories 'spec/thumbnails'
+      dirs = gallery.parse_directories "spec/thumbnails"
 
       images = [
         {
-          :filename => 'home/test_image-afrique.png',
-          :thumb    => 'thumbnails/home/test_image-afrique.png'
+          :filename => "home/test_image-afrique.png",
+          :thumb    => "thumbnails/home/test_image-afrique.png"
         },
         {
-          :filename => 'home/test_image-russian.png',
-          :thumb    => 'thumbnails/home/test_image-russian.png'
+          :filename => "home/test_image-russian.png",
+          :thumb    => "thumbnails/home/test_image-russian.png"
         }
       ]
 
-      dirs['home'][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 => 'home/test_image-diff.png',
-        :thumb    => 'thumbnails/home/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'
+      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
-end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,31 @@
+require "_helpers"
+
+describe "Wraith helpers classes and functions" do
+
+  describe "the convert_to_absolute function" do
+    it "should return false if no filepath provided" do
+      expect(convert_to_absolute(nil)).to eq 'false'
+    end
+
+    it "should convert a relative path to absolute" do
+      relative = 'my/filepath'
+      absolute = convert_to_absolute relative
+      expect(absolute[0]).to eq '/'
+      expect(absolute.length).to be > relative.length
+      expect(absolute).to match(/\/(.+)\/(.+)\/my\/filepath/)
+    end
+
+    it "should leave an absolute path unchanged" do
+      relative = '/my/filepath'
+      absolute = convert_to_absolute relative
+      expect(absolute).to eq relative
+    end
+
+    it "should leave a Windows-flavoured absolute path unchanged" do
+      relative = 'C:/Code/Wraith/javascript/global.js'
+      absolute = convert_to_absolute relative
+      expect(absolute).to eq relative
+    end
+  end
+
+end

data/spec/resize_reload_spec.rb

@@ -48,4 +48,4 @@ describe "wraith config" do
       expect(inefficient_jobs[0][2]).to eq 320
     end
   end
-end
+end

data/spec/save_images_spec.rb

@@ -52,4 +52,4 @@ describe Wraith do
       expect(File).to exist("shots/thumbnails/test/test_diff.png")
     end
   end
-end
+end

data/spec/validate_spec.rb

@@ -12,40 +12,40 @@ describe "Wraith config validator" do
 
   describe "universal, basic validation for all modes" do
     it "should validate a basic config" do
-      validate = Wraith::Validate.new(config, true).validate
+      Wraith::Validate.new(config, true).validate
     end
 
     it "should complain if the `domains` property is missing" do
-      config['domains'] = nil
+      config["domains"] = nil
       expect { Wraith::Validate.new(config, true).validate }.to raise_error MissingRequiredPropertyError
     end
 
     it "should complain if the `browser` property is missing" do
-      config['browser'] = nil
+      config["browser"] = nil
       expect { Wraith::Validate.new(config, true).validate }.to raise_error MissingRequiredPropertyError
     end
   end
 
   describe "validation specific to capture mode" do
     it "should complain if fewer than two domains are specified" do
-      expect { Wraith::Validate.new(config, true).validate('capture') }.to raise_error InvalidDomainsError
+      expect { Wraith::Validate.new(config, true).validate("capture") }.to raise_error InvalidDomainsError
     end
 
     it "should complain if more than two domains are specified" do
-      config['domains'] = YAML.load('
+      config["domains"] = YAML.load('
         test:  http://something.bbc.com
         stage: http://something-else.bbc.com
         live:  http://www.bbc.com
       ')
-      expect { Wraith::Validate.new(config, true).validate('capture') }.to raise_error InvalidDomainsError
+      expect { Wraith::Validate.new(config, true).validate("capture") }.to raise_error InvalidDomainsError
     end
 
     it "should be happy if exactly two domains are specified" do
-      config['domains'] = YAML.load('
+      config["domains"] = YAML.load('
           test:  http://something.bbc.com
           live:  http://www.bbc.com
       ')
-      validate = Wraith::Validate.new(config, true).validate('capture')
+      Wraith::Validate.new(config, true).validate("capture")
     end
   end
 
@@ -57,20 +57,20 @@ describe "Wraith config validator" do
     end
 
     it "should complain if more than one domain is specified" do
-      history_conf['domains'] = YAML.load('
+      history_conf["domains"] = YAML.load('
         test: http://something.bbc.com
         live: http://www.bbc.com
       ')
-      expect { Wraith::Validate.new(history_conf, true).validate('history') }.to raise_error InvalidDomainsError
+      expect { Wraith::Validate.new(history_conf, true).validate("history") }.to raise_error InvalidDomainsError
     end
 
     it "should complain if no history_dir is specified" do
-      history_conf['history_dir'] = nil
-      expect { Wraith::Validate.new(history_conf, true).validate('history') }.to raise_error MissingRequiredPropertyError
+      history_conf["history_dir"] = nil
+      expect { Wraith::Validate.new(history_conf, true).validate("history") }.to raise_error MissingRequiredPropertyError
     end
 
     it "should be happy if a history_dir and one domain is specified" do
-      validate = Wraith::Validate.new(history_conf, true).validate('history')
+      Wraith::Validate.new(history_conf, true).validate("history")
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Dave Blooman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -221,6 +221,7 @@ files:
 - spec/configs/test_config--phantom.yaml
 - spec/construct_command_spec.rb
 - spec/gallery_spec.rb
+- spec/helper_spec.rb
 - spec/js/custom_snap_file.js
 - spec/js/global.js
 - spec/js/path.js
@@ -263,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Wraith is a screenshot comparison tool, created by developers at BBC News.
@@ -277,6 +278,7 @@ test_files:
 - spec/configs/test_config--phantom.yaml
 - spec/construct_command_spec.rb
 - spec/gallery_spec.rb
+- spec/helper_spec.rb
 - spec/js/custom_snap_file.js
 - spec/js/global.js
 - spec/js/path.js