wraith 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c2e2f34b4f57be52b02d9c1812068629fab964
-  data.tar.gz: e0db82084db042e981d2141385e95a9f79d3bdf7
+  metadata.gz: 2f06fef6c1584ea8502744988e405e3717a5a1fb
+  data.tar.gz: 47f3489629f192b949277048a330f29e7e0df729
 SHA512:
-  metadata.gz: fa0e6f3d579ca6e85f8a08a00ad09a059dc54798d82f8e90767585f3e85b718d9aee3a95d910987e9853edb43190ec724c1428f993562f29c167687182559aa5
-  data.tar.gz: 2de08d53d57c00f582d1535383d837be73d4a7c4594481081c8d47147f5ee0b02dc8a006b00f2c60e494b1b8b001c0b7bfd973e9f8310dedfc509dadf58a8059
+  metadata.gz: a9d9dbf50a36715eb9f0f00720c84546624467c3d547ef9800a904661895e87f17c56751dd8cde11dc62139d79e4d90af65c12f267f6e6a9cf0b6712fe7effa8
+  data.tar.gz: 45c9b9c474a35147cd732a948cdd091691378e150961b3ab00d0b065d58ba34a755e7e861e8d81d732291f7075b4e1eab722738f409deed60a85db6aec9e77c2

data/.rubocop.yml

@@ -0,0 +1,120 @@
+AllCops:
+  Exclude:
+    - "**/*.gemspec"
+
+Lint/SpaceBeforeFirstArg:
+  Severity: fatal
+  Enabled: true
+
+Lint/RescueException:
+  Severity: fatal
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Severity: fatal
+  Enabled: true
+
+Metrics/LineLength:
+  Severity: fatal
+  Enabled: true
+
+Metrics/MethodLength:
+  Severity: convention
+  Enabled: true
+  Max: 5
+
+Style/AlignHash:
+  Severity: fatal
+  Enabled: true
+  EnforcedHashRocketStyle: table
+
+Style/AlignParameters:
+  Severity: fatal
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Style/BracesAroundHashParameters:
+  Severity: fatal
+  Enabled: true
+
+ClassAndModuleChildren:
+  Severity: fatal
+  Enabled: true
+
+Style/ConstantName:
+  Severity: fatal
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Severity: fatal
+  Enabled: true
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/HashSyntax:
+  Severity: fatal
+  Enabled: true
+  EnforcedStyle: hash_rockets
+
+Style/IndentationConsistency:
+  Severity: fatal
+  Enabled: true
+
+Style/IndentationWidth:
+  Severity: fatal
+  Enabled: true
+
+Style/IndentHash:
+  Severity: fatal
+  Enabled: true
+
+Style/InlineComment:
+  Severity: fatal
+  Enabled: true
+
+Style/LineEndConcatenation:
+  Severity: fatal
+  Enabled: true
+
+Style/MethodName:
+  Severity: fatal
+  Enabled: true
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/NegatedIf:
+  Severity: fatal
+  Enabled: true
+
+Style/Not:
+  Severity: fatal
+  Enabled: true
+
+Style/SpaceInsideHashLiteralBraces:
+  Severity: fatal
+  Enabled: true
+
+Style/StringLiterals:
+  Severity: fatal
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrailingBlankLines:
+  Severity: fatal
+  Enabled: true
+
+Style/TrailingWhitespace:
+  Severity: fatal
+  Enabled: true
+
+Style/VariableName:
+  Severity: fatal
+  Enabled: true

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ..gemspec
 gemspec

data/README.md

@@ -1,7 +1,9 @@
 # Wraith
 
 [![Build Status](https://secure.travis-ci.org/BBC-News/wraith.png?branch=master)](http://travis-ci.org/BBC-News/wraith)
+[![Gem Version](https://badge.fury.io/rb/wraith.svg)](http://badge.fury.io/rb/wraith)
 [![Code Climate](https://codeclimate.com/github/BBC-News/wraith.png)](https://codeclimate.com/github/BBC-News/wraith)
+[![Join the chat at https://gitter.im/BBC-News/wraith](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/BBC-News/wraith?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
  * Website: http://responsivenews.co.uk
  * Source: http://github.com/bbc-news/wraith
@@ -108,9 +110,9 @@ Take a look at the LICENSE file in the code.
 
 ## Credits
 
- * [Dave Blooman](http://twitter.com/dblooman)
- * [John Cleveley](http://twitter.com/jcleveley)
- * [Simon Thulbourn](http://twitter.com/sthulbourn)
+ * [Dave Blooman](https://twitter.com/dblooman)
+ * [John Cleveley](https://twitter.com/jcleveley)
+ * [Simon Thulbourn](https://twitter.com/sthulb)
 
 ## Selenium-Wraith
 

data/Rakefile

@@ -1,25 +1,25 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "lib")
 
-require 'bundler/gem_tasks'
-require 'wraith/save_images'
-require 'wraith/crop'
-require 'wraith/spider'
-require 'wraith/folder'
-require 'wraith/thumbnails'
-require 'wraith/compare_images'
-require 'wraith/gallery'
+require "bundler/gem_tasks"
+require "wraith/save_images"
+require "wraith/crop"
+require "wraith/spider"
+require "wraith/folder"
+require "wraith/thumbnails"
+require "wraith/compare_images"
+require "wraith/gallery"
 
-@config = ('config')
+@config = ("config")
 
-desc 'Execute wraith on two sites with a config you specify'
+desc "Execute wraith on two sites with a config you specify"
 task :config, [:yaml] do |_t, custom|
-  custom.with_defaults(yaml: 'config')
+  custom.with_defaults(:yaml => "config")
   @config = "#{custom[:yaml]}"
-  Rake::Task['default'].invoke
+  Rake::Task["default"].invoke
 end
 
-task default: [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :crop_images, :compare_images, :generate_thumbnails, :generate_gallery] do
-  puts 'Done!'
+task :default => [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :crop_images, :compare_images, :generate_thumbnails, :generate_gallery] do
+  puts "Done!"
 end
 
 task :reset_shots_folder do
@@ -58,18 +58,18 @@ task :generate_thumbnails do
 end
 
 task :generate_gallery do
-  gallery = Wraith::GalleryGenerator.new(@config)
+  gallery = Wraith::GalleryGenerator.new(@config, false)
   gallery.generate_gallery
 end
 
-desc 'Execute wraith on a single site, no image diffs, with a config you specify'
+desc "Execute wraith on a single site, no image diffs, with a config you specify"
 task :grabber, [:yaml] do |_t, custom|
-  custom.with_defaults(yaml: 'config')
+  custom.with_defaults(:yaml => "config")
   @config = "#{custom[:yaml]}"
-  Rake::Task['grab'].invoke
+  Rake::Task["grab"].invoke
 end
 
-desc 'Execute wraith on a single site, no image diffs'
-task grab: [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :generate_thumbnails, :generate_gallery] do
-  puts 'Done!'
+desc "Execute wraith on a single site, no image diffs"
+task :grab => [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :generate_thumbnails, :generate_gallery] do
+  puts "Done!"
 end

data/bin/wraith

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 begin
-  require 'wraith/cli'
+  require "wraith/cli"
   Wraith::CLI.start
 rescue Interrupt
   puts "\nQuitting..."

data/lib/wraith.rb

@@ -1,5 +1,5 @@
-require 'wraith/version'
+require "wraith/version"
 
 module Wraith
-  autoload :CLI, 'wraith/cli'
+  autoload :CLI, "wraith/cli"
 end

data/lib/wraith/cli.rb

@@ -1,12 +1,12 @@
-require 'thor'
-require 'wraith'
-require 'wraith/save_images'
-require 'wraith/crop'
-require 'wraith/spider'
-require 'wraith/folder'
-require 'wraith/thumbnails'
-require 'wraith/compare_images'
-require 'wraith/gallery'
+require "thor"
+require "wraith"
+require "wraith/save_images"
+require "wraith/crop"
+require "wraith/spider"
+require "wraith/folder"
+require "wraith/thumbnails"
+require "wraith/compare_images"
+require "wraith/gallery"
 
 class Wraith::CLI < Thor
   include Thor::Actions
@@ -14,28 +14,28 @@ class Wraith::CLI < Thor
   attr_accessor :config_name
 
   def self.source_root
-    File.expand_path('../../../templates/', __FILE__)
+    File.expand_path("../../../templates/", __FILE__)
   end
 
-  desc 'setup', 'creates config folder and default config'
+  desc "setup", "creates config folder and default config"
   def setup
-    template('configs/config.yaml', 'configs/config.yaml')
-    template('javascript/snap.js', 'javascript/snap.js')
+    template("configs/config.yaml", "configs/config.yaml")
+    template("javascript/snap.js", "javascript/snap.js")
   end
 
-  desc 'setup_casper', 'creates config folder and default config for casper'
+  desc "setup_casper", "creates config folder and default config for casper"
   def setup_casper
-    template('configs/component.yaml', 'configs/component.yaml')
-    template('javascript/casper.js', 'javascript/casper.js')
+    template("configs/component.yaml", "configs/component.yaml")
+    template("javascript/casper.js", "javascript/casper.js")
   end
 
-  desc 'reset_shots [config_name]', 'removes all the files in the shots folder'
+  desc "reset_shots [config_name]", "removes all the files in the shots folder"
   def reset_shots(config_name)
     reset = Wraith::FolderManager.new(config_name)
     reset.clear_shots_folder
   end
 
-  desc 'setup_folders [config_name]', 'create folders for images'
+  desc "setup_folders [config_name]", "create folders for images"
   def setup_folders(config_name)
     create = Wraith::FolderManager.new(config_name)
     create.create_folders
@@ -58,37 +58,37 @@ class Wraith::CLI < Thor
     end
   end
 
-  desc 'save_images [config_name]', 'captures screenshots'
+  desc "save_images [config_name]", "captures screenshots"
   def save_images(config_name, history = false)
     save_images = Wraith::SaveImages.new(config_name, history)
     save_images.save_images
   end
 
-  desc 'crop_images [config_name]', 'crops images to the same height'
+  desc "crop_images [config_name]", "crops images to the same height"
   def crop_images(config_name)
     crop = Wraith::CropImages.new(config_name)
     crop.crop_images
   end
 
-  desc 'compare_images [config_name]', 'compares images to generate diffs'
+  desc "compare_images [config_name]", "compares images to generate diffs"
   def compare_images(config_name)
     compare = Wraith::CompareImages.new(config_name)
     compare.compare_images
   end
 
-  desc 'generate_thumbnails [config_name]', 'create thumbnails for gallery'
+  desc "generate_thumbnails [config_name]", "create thumbnails for gallery"
   def generate_thumbnails(config_name)
     thumbs = Wraith::Thumbnails.new(config_name)
     thumbs.generate_thumbnails
   end
 
-  desc 'generate_gallery [config_name]', 'create page for viewing images'
+  desc "generate_gallery [config_name]", "create page for viewing images"
   def generate_gallery(config_name, multi = false)
     gallery = Wraith::GalleryGenerator.new(config_name, multi)
     gallery.generate_gallery
   end
 
-  desc 'capture [config_name]', 'A full Wraith job'
+  desc "capture [config_name]", "A full Wraith job"
   def capture(config, multi = false)
     reset_shots(config)
     check_for_paths(config)
@@ -100,7 +100,7 @@ class Wraith::CLI < Thor
     generate_gallery(config, multi)
   end
 
-  desc 'multi_capture [filelist]', 'A Batch of Wraith Jobs'
+  desc "multi_capture [filelist]", "A Batch of Wraith Jobs"
   def multi_capture(filelist)
     config_array = IO.readlines(filelist)
     config_array.each do |config|
@@ -108,15 +108,16 @@ class Wraith::CLI < Thor
     end
   end
 
-  desc 'history [config_name]', 'Setup a baseline set of shots'
+  desc "history [config_name]", "Setup a baseline set of shots"
   def history(config)
     reset_shots(config)
+    check_for_paths(config)
     setup_folders(config)
     save_images(config)
     copy_old_shots(config)
   end
 
-  desc 'latest [config_name]', 'Capture new shots to compare with baseline'
+  desc "latest [config_name]", "Capture new shots to compare with baseline"
   def latest(config)
     reset_shots(config)
     restore_shots(config)

data/lib/wraith/compare_images.rb

@@ -1,7 +1,7 @@
-require 'wraith'
-require 'image_size'
-require 'open3'
-require 'parallel'
+require "wraith"
+require "image_size"
+require "open3"
+require "parallel"
 
 class Wraith::CompareImages
   attr_reader :wraith
@@ -12,18 +12,18 @@ class Wraith::CompareImages
 
   def compare_images
     files = Dir.glob("#{wraith.directory}/*/*.png").sort
-    Parallel.each(files.each_slice(2), in_processes: Parallel.processor_count) do |base, compare|
-      diff = base.gsub(/([a-z0-9]+).png$/, 'diff.png')
-      info = base.gsub(/([a-z0-9]+).png$/, 'data.txt')
+    Parallel.each(files.each_slice(2), :in_processes => Parallel.processor_count) do |base, compare|
+      diff = base.gsub(/([a-z0-9]+).png$/, "diff.png")
+      info = base.gsub(/([a-z0-9]+).png$/, "data.txt")
       compare_task(base, compare, diff, info)
-      puts 'Saved diff'
+      puts "Saved diff"
     end
   end
 
   def percentage(img_size, px_value, info)
     pixel_count = (px_value / img_size) * 100
     rounded = pixel_count.round(2)
-    File.open(info, 'w') { |file| file.write(rounded) }
+    File.open(info, "w") { |file| file.write(rounded) }
   end
 
   def compare_task(base, compare, output, info)
@@ -33,7 +33,7 @@ class Wraith::CompareImages
       img_size = ImageSize.path(output).size.inject(:*)
       percentage(img_size, px_value, info)
     rescue
-      File.open(info, 'w') { |file| file.write('invalid') } unless File.exist?(output)
+      File.open(info, "w") { |file| file.write("invalid") } unless File.exist?(output)
     end
   end
 end

data/lib/wraith/crop.rb

@@ -1,6 +1,6 @@
-require 'wraith'
-require 'image_size'
-require 'parallel'
+require "wraith"
+require "image_size"
+require "parallel"
 
 class Wraith::CropImages
   attr_reader :wraith
@@ -12,8 +12,8 @@ class Wraith::CropImages
   def crop_images
     files = Dir.glob("#{wraith.directory}/*/*.png").sort
 
-    Parallel.each(files.each_slice(2), in_processes: Parallel.processor_count) do |base, compare|
-      puts 'cropping images'
+    Parallel.each(files.each_slice(2), :in_processes => Parallel.processor_count) do |base, compare|
+      puts "cropping images"
 
       width          = image_dimensions(base)[0]
       base_height    = image_dimensions(base)[1]
@@ -36,6 +36,6 @@ class Wraith::CropImages
   end
 
   def image_dimensions(image)
-    ImageSize.new(File.open(image, 'rb').read).size
+    ImageSize.new(File.open(image, "rb").read).size
   end
 end

data/lib/wraith/folder.rb

@@ -1,4 +1,4 @@
-require 'wraith'
+require "wraith"
 
 class Wraith::FolderManager
   attr_reader :wraith
@@ -38,7 +38,7 @@ class Wraith::FolderManager
   end
 
   def restore_shots
-    puts 'restoring'
+    puts "restoring"
     FileUtils.cp_r(Dir.glob("#{history_dir}/*"), dir)
   end
 
@@ -46,17 +46,17 @@ class Wraith::FolderManager
     spider_paths.each do |folder_label, path|
       unless path
         path = folder_label
-        folder_label = path.gsub('/', '__')
+        folder_label = path.gsub("/", "__")
       end
 
       FileUtils.mkdir_p("#{dir}/thumbnails/#{folder_label}")
       FileUtils.mkdir_p("#{dir}/#{folder_label}")
     end
-    puts 'Creating Folders'
+    puts "Creating Folders"
   end
 
   def tidy_shots_folder(dirs)
-    if wraith.mode == 'diffs_only'
+    if wraith.mode == "diffs_only"
       dirs.each do |folder_name, shot_info|
         if shot_info.none? { |_k, v| v[:data] > 0 }
           FileUtils.rm_rf("#{wraith.directory}/#{folder_name}")

data/lib/wraith/gallery.rb

@@ -1,16 +1,16 @@
-require 'erb'
-require 'pp'
-require 'fileutils'
-require 'wraith/wraith'
+require "erb"
+require "pp"
+require "fileutils"
+require "wraith/wraith"
 
 class Wraith::GalleryGenerator
   attr_reader :wraith
 
   MATCH_FILENAME = /(\S+)_(\S+)\.\S+/
 
-  TEMPLATE_LOCATION = File.expand_path('gallery_template/gallery_template.erb', File.dirname(__FILE__))
-  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__))
+  TEMPLATE_LOCATION = File.expand_path("gallery_template/gallery_template.erb", File.dirname(__FILE__))
+  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, multi)
     @wraith = Wraith::Wraith.new(config)
@@ -22,10 +22,10 @@ class Wraith::GalleryGenerator
   def parse_directories(dirname)
     @dirs = {}
     categories = Dir.foreach(dirname).select do |category|
-      if ['.', '..', 'thumbnails'].include? category
+      if [".", "..", "thumbnails"].include? category
         # Ignore special dirs
         false
-      elsif File.directory? "#{dirname}/#{category}" then
+      elsif File.directory? "#{dirname}/#{category}"
         # Ignore stray files
         true
       else
@@ -54,11 +54,11 @@ class Wraith::GalleryGenerator
   def matcher(match, filename, dirname, category)
     @size = match[1].to_i
     @group = match[2]
-    @filepath = category + '/' + filename
+    @filepath = category + "/" + filename
     @thumbnail = "thumbnails/#{category}/#{filename}"
 
     if @dirs[category][@size].nil?
-      @dirs[category][@size] = { variants: [] }
+      @dirs[category][@size] = { :variants => [] }
     end
 
     size_dict = @dirs[category][@size]
@@ -68,9 +68,9 @@ class Wraith::GalleryGenerator
 
   def data_group(group, size_dict, dirname, filepath)
     case group
-    when 'diff'
+    when "diff"
       diff_check(size_dict, filepath)
-    when 'data'
+    when "data"
       data_check(size_dict, dirname, filepath)
     else
       variant_check(size_dict, group)
@@ -79,16 +79,16 @@ class Wraith::GalleryGenerator
 
   def variant_check(size_dict, group)
     size_dict[:variants] << {
-      name: group,
-      filename: @filepath,
-      thumb: @thumbnail
+      :name     => group,
+      :filename => @filepath,
+      :thumb    => @thumbnail
     }
     size_dict[:variants].sort! { |a, b| a[:name] <=> b[:name] }
   end
 
   def diff_check(size_dict, filepath)
     size_dict[:diff] = {
-      filename: filepath, thumb: @thumbnail
+      :filename => filepath, :thumb => @thumbnail
     }
   end
 
@@ -109,23 +109,23 @@ class Wraith::GalleryGenerator
   def generate_html(location, directories, template, destination, path)
     template = File.read(template)
     locals = {
-      location: location,
-      directories: directories,
-      path: path,
-      threshold: wraith.threshold
+      :location    => location,
+      :directories => directories,
+      :path        => path,
+      :threshold   => wraith.threshold
     }
     html = ERB.new(template).result(ErbBinding.new(locals).get_binding)
-    File.open(destination, 'w') do |outf|
+    File.open(destination, "w") do |outf|
       outf.write(html)
     end
   end
 
-  def generate_gallery(withPath = '')
+  def generate_gallery(withPath = "")
     dest = "#{@location}/gallery.html"
     directories = parse_directories(@location)
     generate_html(@location, directories, TEMPLATE_BY_DOMAIN_LOCATION, dest, withPath)
     FileUtils.cp(BOOTSTRAP_LOCATION, "#{@location}/bootstrap.min.css")
-    puts 'Gallery generated'
+    puts "Gallery generated"
     check_failed_shots
   end
 
@@ -133,7 +133,7 @@ class Wraith::GalleryGenerator
     if @mutli
       return true
     elsif @failed_shots == false
-      puts 'Failures detected'
+      puts "Failures detected"
       exit 1
     else
       true

data/lib/wraith/save_images.rb

@@ -1,16 +1,13 @@
-require 'wraith'
-require 'parallel'
+require "wraith"
+require "parallel"
 
 class Wraith::SaveImages
-  attr_reader :wraith, :history
+  attr_reader :wraith, :history, :meta
 
   def initialize(config, history = false)
     @wraith = Wraith::Wraith.new(config)
     @history = history
-  end
-
-  def directory
-    wraith.directory
+    @meta = SaveMetadata.new(@wraith, history)
   end
 
   def check_paths
@@ -22,33 +19,42 @@ class Wraith::SaveImages
     end
   end
 
-  def history_label
-    history ? '_latest' : ''
-  end
+  def save_images
+    jobs = []
+    check_paths.each do |label, options|
+      settings = CaptureOptions.new(options, wraith)
 
-  def engine
-    wraith.engine.each { |_label, browser| return browser }
-  end
+      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)
 
-  def engine_label
-    wraith.engine.key(engine)
+        jobs << [label, settings.path, width, settings.base_url,    base_file_name, settings.selector]
+        jobs << [label, settings.path, width, settings.compare_url, compare_file_name, settings.selector] unless settings.compare_url.nil?
+      end
+    end
+    parallel_task(jobs)
   end
 
-  def base_urls(path)
-    wraith.base_domain + path unless wraith.base_domain.nil?
+  def capture_page_image(browser, url, width, file_name, selector)
+    puts `"#{browser}" "#{wraith.phantomjs_options}" "#{wraith.snap_file}" "#{url}" "#{width}" "#{file_name}" "#{selector}"`
   end
 
-  def compare_urls(path)
-    wraith.comp_domain + path unless wraith.comp_domain.nil?
-  end
+  private
 
-  def file_names(width, label, domain_label)
-    "#{directory}/#{label}/#{width}_#{engine_label}_#{domain_label}.png"
+  def parallel_task(jobs)
+    Parallel.each(jobs, :in_threads => 8) do |_label, _path, width, url, filename, selector|
+      begin
+        attempt_image_capture(width, url, filename, selector, 5)
+      rescue => e
+        puts e
+        create_invalid_image(filename, width)
+      end
+    end
   end
 
   def attempt_image_capture(width, url, filename, selector, max_attempts)
     max_attempts.times do |i|
-      capture_page_image engine, url, width, filename, selector
+      capture_page_image meta.engine, url, width, filename, selector
 
       return if File.exist? filename
 
@@ -58,56 +64,88 @@ class Wraith::SaveImages
     fail "Unable to capture image #{filename} after #{max_attempts} attempt(s)"
   end
 
+  def create_invalid_image(filename, width)
+    puts "Using fallback image instead"
+    invalid = File.expand_path("../../assets/invalid.jpg", File.dirname(__FILE__))
+    FileUtils.cp invalid, filename
+
+    set_image_width(filename, width)
+  end
+
+  def set_image_width(image, width)
+    `convert #{image} -background none -extent #{width}x0 #{image}`
+  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
+    casper_selector(options)
+  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
+    options["path"] ? options["path"] : options
   end
 
   def casper_selector(options)
-    options['selector'] ? options['selector'] : ' '
+    options["selector"] ? options["selector"] : " "
   end
+end
 
-  def save_images
-    jobs = []
-    check_paths.each do |label, options|
-      path = has_casper(options)
-      selector = casper_selector(options)
-
-      base_url = base_urls(path)
-      compare_url = compare_urls(path)
+class SaveMetadata
+  attr_reader :wraith, :history
 
-      wraith.widths.each do |width|
-        base_file_name    = file_names(width, label, "#{wraith.base_domain_label}#{history_label}")
-        compare_file_name = file_names(width, label, "#{wraith.comp_domain_label}#{history_label}")
+  def initialize(config, _history)
+    @wraith = config
+  end
 
-        jobs << [label, path, width, base_url,    base_file_name, selector]
-        jobs << [label, path, width, compare_url, compare_file_name, selector] unless compare_url.nil?
-      end
-    end
-    parallel_task(jobs)
+  def history_label
+    history ? "_latest" : ""
   end
 
-  def parallel_task(jobs)
-    Parallel.each(jobs, in_threads: 8) do |_label, _path, width, url, filename, selector|
-      begin
-        attempt_image_capture(width, url, filename, selector, 5)
-      rescue => e
-        puts e
+  def engine_label
+    wraith.engine.key(wraith.engine)
+  end
 
-        puts 'Using fallback image instead'
-        invalid = File.expand_path('../../assets/invalid.jpg', File.dirname(__FILE__))
-        FileUtils.cp invalid, filename
+  def file_names(width, label, domain_label)
+    "#{wraith.directory}/#{label}/#{width}_#{engine_label}_#{domain_label}.png"
+  end
 
-        # Set width of fallback image
-        set_image_width(filename, width)
-      end
-    end
+  def base_label
+    "#{wraith.base_domain_label}#{history_label}"
   end
 
-  def set_image_width(image, width)
-    `convert #{image} -background none -extent #{width}x0 #{image}`
+  def compare_label
+    "#{wraith.comp_domain_label}#{history_label}"
   end
 
-  def capture_page_image(browser, url, width, file_name, selector)
-    puts `"#{browser}" "#{wraith.phantomjs_options}" "#{wraith.snap_file}" "#{url}" "#{width}" "#{file_name}" "#{selector}"`
+  def engine
+    wraith.engine.each { |_label, browser| return browser }
   end
 end

data/lib/wraith/spider.rb

@@ -1,7 +1,7 @@
-require 'wraith'
-require 'anemone'
-require 'nokogiri'
-require 'uri'
+require "wraith"
+require "anemone"
+require "nokogiri"
+require "uri"
 
 class Wraith::Spidering
   def initialize(config)
@@ -11,10 +11,10 @@ class Wraith::Spidering
   def check_for_paths
     if @wraith.paths.nil?
       unless @wraith.sitemap.nil?
-        puts 'no paths defined in config, loading paths from sitemap'
+        puts "no paths defined in config, loading paths from sitemap"
         spider = Wraith::Sitemap.new(@wraith)
       else
-        puts 'no paths defined in config, crawling from site root'
+        puts "no paths defined in config, crawling from site root"
         spider = Wraith::Crawler.new(@wraith)
       end
       spider.determine_paths
@@ -36,11 +36,11 @@ 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)
-    @paths[path == '/' ? 'home' : path.gsub('/', '__').chomp('__').downcase] = path.downcase
+    @paths[path == "/" ? "home" : path.gsub("/", "__").chomp("__").downcase] = path.downcase
   end
 
   def spider
@@ -56,13 +56,13 @@ class Wraith::Crawler < Wraith::Spider
 
   def spider
     if File.exist?(@wraith.spider_file) && modified_since(@wraith.spider_file, @wraith.spider_days[0])
-      puts 'using existing spider file'
+      puts "using existing spider file"
       @paths = eval(File.read(@wraith.spider_file))
     else
-      puts 'creating new spider file'
+      puts "creating new spider file"
       spider_list = []
       Anemone.crawl(@wraith.base_domain) do |anemone|
-        anemone.skip_links_like(/\.#{EXT.join('|')}$/)
+        anemone.skip_links_like(/\.(#{EXT.join('|')})$/)
         # Add user specified skips
         anemone.skip_links_like(@wraith.spider_skips)
         anemone.on_every_page { |page| add_path(page.url.path) }
@@ -85,11 +85,11 @@ class Wraith::Sitemap < Wraith::Spider
         sitemap = Nokogiri::XML(File.open(@wraith.sitemap))
       end
       urls = {}
-      sitemap.css('loc').each do |loc|
+      sitemap.css("loc").each do |loc|
         path = loc.content
         # Allow use of either domain in the sitemap.xml
         @wraith.domains.each do |_k, v|
-          path.sub!(v, '')
+          path.sub!(v, "")
         end
         if @wraith.spider_skips.nil? || @wraith.spider_skips.none? { |regex| regex.match(path) }
           add_path(path)

data/lib/wraith/thumbnails.rb

@@ -1,6 +1,6 @@
-require 'wraith'
-require 'parallel'
-require 'fileutils'
+require "wraith"
+require "parallel"
+require "fileutils"
 
 class Wraith::Thumbnails
   attr_reader :wraith
@@ -10,11 +10,11 @@ class Wraith::Thumbnails
   end
 
   def generate_thumbnails
-    puts 'Generating thumbnails'
+    puts "Generating thumbnails"
 
     files = Dir.glob("#{wraith.directory}/*/*.png")
 
-    Parallel.each(files, in_processes: Parallel.processor_count) do |filename|
+    Parallel.each(files, :in_processes => Parallel.processor_count) do |filename|
       new_name = filename.gsub(/^#{wraith.directory}/, "#{wraith.directory}/thumbnails")
       thumbnail_image(filename, new_name)
     end

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '2.3.2'
+  VERSION = "2.3.3"
 end

data/lib/wraith/wraith.rb

@@ -1,38 +1,38 @@
-require 'yaml'
+require "yaml"
 
 class Wraith::Wraith
   attr_accessor :config
 
   def initialize(config_name)
-    if File.exist?(config_name) && File.extname(config_name) == '.yaml'
+    if File.exist?(config_name) && File.extname(config_name) == ".yaml"
       @config = YAML.load(File.open(config_name))
     else
       @config = YAML.load(File.open("configs/#{config_name}.yaml"))
     end
   rescue
-    puts 'unable to find config'
+    puts "unable to find config"
     exit 1
   end
 
   def directory
     # Legacy support for those using array configs
-    @config['directory'].is_a?(Array) ? @config['directory'].first : @config['directory']
+    @config["directory"].is_a?(Array) ? @config["directory"].first : @config["directory"]
   end
 
   def history_dir
-    @config['history_dir']
+    @config["history_dir"]
   end
 
   def snap_file
-    @config['snap_file'] ? @config['snap_file'] : File.expand_path('lib/wraith/javascript/snap.js')
+    @config["snap_file"] ? @config["snap_file"] : File.expand_path("lib/wraith/javascript/snap.js")
   end
 
   def widths
-    @config['screen_widths']
+    @config["screen_widths"]
   end
 
   def domains
-    @config['domains']
+    @config["domains"]
   end
 
   def base_domain
@@ -52,46 +52,46 @@ class Wraith::Wraith
   end
 
   def spider_file
-    @config['spider_file'] ? @config['spider_file'] : 'spider.txt'
+    @config["spider_file"] ? @config["spider_file"] : "spider.txt"
   end
 
   def spider_days
-    @config['spider_days']
+    @config["spider_days"]
   end
 
   def sitemap
-    @config['sitemap']
+    @config["sitemap"]
   end
 
   def spider_skips
-    @config['spider_skips']
+    @config["spider_skips"]
   end
 
   def paths
-    @config['paths']
+    @config["paths"]
   end
 
   def engine
-    @config['browser']
+    @config["browser"]
   end
 
   def fuzz
-    @config['fuzz']
+    @config["fuzz"]
   end
 
   def mode
-    if %w(diffs_only diffs_first alphanumeric).include?(@config['mode'])
-      @config['mode']
+    if %w(diffs_only diffs_first alphanumeric).include?(@config["mode"])
+      @config["mode"]
     else
-      'alphanumeric'
+      "alphanumeric"
     end
   end
 
   def threshold
-    @config['threshold'] ? @config['threshold'] : 0
+    @config["threshold"] ? @config["threshold"] : 0
   end
 
   def phantomjs_options
-    @config['phantomjs_options']
+    @config["phantomjs_options"]
   end
 end

data/spec/wraith_spec.rb

@@ -1,68 +1,116 @@
-require 'rspec-given'
-require 'image_size'
-require './lib/wraith/cli'
+require "rspec"
+require "image_size"
+require "./lib/wraith/cli"
 
 describe Wraith do
-  Given { Wraith::FolderManager.new(config_name).clear_shots_folder }
-  Given { Dir.mkdir('shots/test') }
-  let(:config_name) { 'test_config' }
-  let(:test_url1) { 'http://www.bbc.co.uk/russian' }
-  let(:test_url2) { 'http://www.bbc.co.uk/russian' }
-  let(:test_image1) { 'shots/test/test1.png' }
-  let(:test_image2) { 'shots/test/test2.png' }
-  let(:diff_image) { 'shots/test/test_diff.png' }
-  let(:data_txt) { 'shots/test/test.txt' }
-  let(:selector) { '' }
+  let(:config_name) { "test_config" }
+  let(:test_url1) { "http://www.bbc.co.uk/russian" }
+  let(:test_url2) { "http://www.bbc.co.uk/russian" }
+  let(:test_image1) { "shots/test/test1.png" }
+  let(:test_image2) { "shots/test/test2.png" }
+  let(:diff_image) { "shots/test/test_diff.png" }
+  let(:data_txt) { "shots/test/test.txt" }
+  let(:selector) { "" }
   let(:saving) { Wraith::SaveImages.new(config_name) }
+  let(:wraith) { Wraith::Wraith.new(config_name) }
 
-  When(:wraith) { Wraith::Wraith.new(config_name) }
-  Then { wraith.is_a? Wraith::Wraith }
+  before(:each) do
+    Wraith::FolderManager.new(config_name).clear_shots_folder
+    Dir.mkdir("shots/test")
+  end
 
-  context 'When creating a wraith worker' do
+  describe "Config" do
+    it "returns a Wraith class" do
+      expect(wraith).is_a? Wraith::Wraith
+    end
 
-    Then { wraith.config.keys.size == 7 }
-    Then { wraith.widths == [320, 600, 1280] }
-    Then { wraith.base_domain == 'http://www.bbc.co.uk/russian' }
-    Then { wraith.comp_domain == 'http://www.bbc.co.uk/russian' }
-    Then { wraith.base_domain_label == 'english' }
-    Then { wraith.comp_domain_label == 'russian' }
-    Then { wraith.paths == { 'home' => '/', 'uk_index' => '/uk' } }
+    it "when config is loaded" do
+      expect(wraith).to respond_to :config
+    end
+
+    it "contains shot options" do
+      expect(wraith.config).to include "directory" => "shots"
+    end
   end
 
-  context 'When capturing an image' do
-    # capture_page_image
-    When do
-      wraith.engine.each do |_type, engine|
-        saving.capture_page_image(engine, test_url1, 320, test_image1, selector)
-      end
+  context "When creating a wraith worker" do
+    it "should have 7 config keys" do
+      expect(wraith.config.keys.size).to be 7
+    end
+
+    it "should have widths" do
+      expect(wraith.widths).to eq [320, 600, 1280]
+    end
+
+    it "include base domain" do
+      expect(wraith.base_domain).to eq "http://www.bbc.co.uk/russian"
+    end
+
+    it "include compare domain" do
+      expect(wraith.comp_domain).to eq "http://www.bbc.co.uk/russian"
+    end
+
+    it "include base label" do
+      expect(wraith.base_domain_label).to eq "english"
+    end
+
+    it "include compare label" do
+      expect(wraith.comp_domain_label).to eq "russian"
+    end
+
+    it "include compare label" do
+      expect(wraith.paths).to eq("home" => "/", "uk_index" => "/uk")
     end
-    When(:image_size) { ImageSize.path(test_image1).size }
-    Then { image_size[0] == 320 }
   end
 
-  context 'When comparing images' do
-    When(:diff_image_size) do
+  describe "When capturing an image" do
+    let(:image_size) { ImageSize.path(test_image1).size }
+
+    it "saves image" do
       wraith.engine.each do |_type, engine|
         saving.capture_page_image(engine, test_url1, 320, test_image1, selector)
-        saving.capture_page_image(engine, test_url2, 320, test_image2, selector)
       end
-      Wraith::CropImages.new(config_name).crop_images
-      Wraith::CompareImages.new(config_name).compare_task(test_image1, test_image2, diff_image, data_txt)
-      ImageSize.path(diff_image).size
+
+      expect(image_size[0]).to eq 320
     end
-    Then { diff_image_size[0] == 320 }
   end
 
-  context 'When generating tumbnails' do
-    When do
-      wraith.engine.each do |_type, engine|
-        saving.capture_page_image(engine, test_url1, 320, test_image1, selector)
-        saving.capture_page_image(engine, test_url2, 320, test_image2, selector)
-      end
-      Wraith::CropImages.new(config_name).crop_images
+  describe "When comparing images" do
+    it "should compare" do
+      create_diff_image
+      crop_images
+      compare_images
+
+      diff = ImageSize.path(diff_image).size
+
+      expect(diff[0]).to eq 320
+    end
+  end
+
+  describe "When generating tumbnails" do
+    it "produce thumbnails" do
+      create_diff_image
       Wraith::CompareImages.new(config_name).compare_task(test_image1, test_image2, diff_image, data_txt)
       Wraith::Thumbnails.new(config_name).generate_thumbnails
+
+      expect(File).to exist("shots/thumbnails/test/test1.png")
+      expect(File).to exist("shots/thumbnails/test/test2.png")
+      expect(File).to exist("shots/thumbnails/test/test_diff.png")
     end
-    Then { File.exist?('shots/thumbnails/test/test1.png') && File.exist?('shots/thumbnails/test/test2.png') && File.exist?('shots/thumbnails/test/test_diff.png') }
   end
 end
+
+def create_diff_image
+  wraith.engine.each do |_type, engine|
+    saving.capture_page_image(engine, test_url1, 320, test_image1, selector)
+    saving.capture_page_image(engine, test_url2, 320, test_image2, selector)
+  end
+end
+
+def crop_images
+  Wraith::CropImages.new(config_name).crop_images
+end
+
+def compare_images
+  Wraith::CompareImages.new(config_name).compare_task(test_image1, test_image2, diff_image, data_txt)
+end

data/templates/javascript/casper.js

@@ -11,7 +11,12 @@ var selector = casper.cli.get(3);
 casper.start(url, function() {
   this.viewport(view_port_width, 1500).then(function(){
     this.wait(2000, function() {
-      this.captureSelector(image_name, selector);
+      if (selector == undefined) {
+        this.capture(image_name);
+      }
+      else {
+        this.captureSelector(image_name, selector);
+      }
       console.log('Snapping ' + url + ' at width ' + view_port_width);
     });
   });

data/wraith.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rspec-given'
+  spec.add_development_dependency 'rspec'
 
   spec.add_runtime_dependency 'rake'
   spec.add_runtime_dependency 'image_size'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-given
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -177,6 +177,7 @@ extra_rdoc_files: []
 files:
 - .gemset
 - .gitignore
+- .rubocop.yml
 - .ruby-version
 - .travis.yml
 - Dockerfile