wraith 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96a69a9ea5f1151ef5586ea053b194e03e16f2e5
-  data.tar.gz: 33b6fc490fb6c02f5f199d9844dd65950bc39650
+  metadata.gz: ad34e154a31f1f604bd6254c51272dc90f99b54e
+  data.tar.gz: d981692a40143a35cf38a5dfb688ff2302085661
 SHA512:
-  metadata.gz: ed5ef37f8fc1c062f0b17d9bddadb36481ffa0aa1827919879d7d606049b8f79035b21284dbd6da26ad879e5ba46a52ac1893b6a48eeb3212a81d1195039cba9
-  data.tar.gz: daa50056dcbefbecf8b19308978fa3af87bd6984edb74e09c8b97dfe56a2204bd2b5f15f07ead48c941f250b1d8625fad075c7f23f8a8f886d56687891ff9805
+  metadata.gz: a9e219db7678d8e51d2c3190d48a9105b88e0326ebc6a90a208a046b6f7ebc5da76164ed72b53f8b9eefcfc61e6548875052f17d060b280268f60998962ad0f5
+  data.tar.gz: ca393aff8ab9c00a5887b1b786c4a5a1a95fab4d1fe17dad89305dedcd50c50efc8e98edb77fc11cf8946a9c344b76f25fbd4737ce828296413b815766d47da6

data/README.md

@@ -22,7 +22,7 @@ diff](http://bbc-news.github.io/wraith/img/320_diff.png)
 
 ## Requirements
 
-To read our detailed instructions for setup and install, as well as example configs, visit [wraith docs](http://bbc-news.github.io/wraith/index.html)
+Imagemagick and PhantomJS are required to use Wraith, install via your favourite package manager.  To read our detailed instructions for setup and install, as well as example configs, visit [wraith docs](http://bbc-news.github.io/wraith/index.html)
 
 ## Installation
 
@@ -83,8 +83,8 @@ If you want to add functionality to this project, pull requests are welcome.
 
 **Please raise any issues with this project as a GitHub issue.**
 
-## Changelog - updated 2014-02-09
-We have released Wraith as a Ruby Gem!!  There is a new CLI to better interact with Wraith and it's commands.
+## Changelog - updated 2014-05-14
+We have updated Wraith some bug fixes and more importantly, parallel support.  This will now enable use of all your CPU cores for faster Wraith runs.  There is error handling in place to ensure if an image fails to capture, it will try again 5 times, if that fails, it will put an holding image in place.  This should solve all the issues with images not capturing and failing to crop/compare.  Big thanks to [Matt Senior](https://github.com/mattsenior) for doing the work.
 
 ## License
 

data/configs/config.yaml

@@ -4,7 +4,7 @@ browser:
   # gecko: "slimerjs"
 
 #If you want to have multiple snapping files, set the file name here
-snap_file: "javascript/snap.js"
+snap_file: "lib/wraith/javascript/snap.js"
 
 # Type the name of the directory that shots will be stored in
 directory:

data/configs/config_nojs.yaml

@@ -4,7 +4,7 @@ browser:
   # gecko: "slimerjs"
 
 #If you want to have multiple snapping files, set the file name here
-snap_file: "javascript/nojs.js"
+snap_file: "lib/wraith/javascript/nojs.js"
 
 # Type the name of the directory that shots will be stored in
 directory:

data/configs/test_config.yaml

@@ -4,7 +4,7 @@ browser:
   # gecko: "./slimerjs"
 
 #If you want to have multiple snapping files, set the file name here
-snap_file: "javascript/snap.js"
+snap_file: "lib/wraith/javascript/snap.js"
 
 # Type the name of the directory that shots will be stored in
 directory:

data/lib/wraith/compare_images.rb

@@ -1,6 +1,7 @@
 require 'wraith'
 require 'image_size'
 require 'open3'
+require 'parallel'
 
 class Wraith::CompareImages
   attr_reader :wraith
@@ -11,8 +12,7 @@ class Wraith::CompareImages
 
   def compare_images
     files = Dir.glob("#{wraith.directory}/*/*.png").sort
-    until files.empty?
-      base, compare = files.slice!(0, 2)
+    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)

data/lib/wraith/crop.rb

@@ -1,5 +1,6 @@
 require 'wraith'
 require 'image_size'
+require 'parallel'
 
 class Wraith::CropImages
   attr_reader :wraith
@@ -8,41 +9,29 @@ class Wraith::CropImages
     @wraith = Wraith::Wraith.new(config)
   end
 
-  def crop
-    crop_value(base_height, compare_height, @compare, @base)
-  end
-
-  def height
-    crop_value(base_height, compare_height, base_height, compare_height)
-  end
-
-  def base_height
-    find_heights(@base)
-  end
-
-  def compare_height
-    find_heights(@compare)
-  end
-
   def crop_images
     files = Dir.glob("#{wraith.directory}/*/*.png").sort
-    until files.empty?
-      @base, @compare = files.slice!(0, 2)
+
+    Parallel.each(files.each_slice(2), :in_processes => Parallel.processor_count) do |base, compare|
       puts 'cropping images'
-      Wraith::Wraith.crop_images(crop, height)
-    end
-  end
 
-  def crop_value(base_height, compare_height, arg3, arg4)
-    if base_height > compare_height
-      arg3
-    else
-      arg4
+      base_height    = image_height(base)
+      compare_height = image_height(compare)
+
+      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
+      end
+
+      Wraith::Wraith.crop_images(image_to_crop, height_to_crop_to)
     end
   end
 
-  def find_heights(height)
-    File.open(height, 'rb') do |fh|
+  def image_height(image)
+    File.open(image, 'rb') do |fh|
       size = ImageSize.new(fh.read).size
       height = size[1]
     end

data/lib/wraith/save_images.rb

@@ -1,4 +1,5 @@
 require 'wraith'
+require 'parallel'
 
 class Wraith::SaveImages
   attr_reader :wraith
@@ -36,22 +37,50 @@ class Wraith::SaveImages
     "#{directory}/#{label}/#{width}_#{engine}_#{domain_label}.png"
   end
 
+  def attempt_image_capture(width, url, filename, max_attempts)
+    max_attempts.times do |i|
+      wraith.capture_page_image engine, url, width, filename
+
+      return if File.exist? filename
+
+      puts "Failed to capture image #{filename} on attempt number #{i+1} of #{max_attempts}"
+    end
+
+    raise "Unable to capture image #{filename} after #{max_attempts} attempt(s)"
+  end
+
   def save_images
+    jobs = []
     check_paths.each do |label, path|
       if !path
-        path = label 
-        label = path.gsub('/', '_') 
+        path = label
+        label = path.gsub('/', '_')
       end
 
       base_url = base_urls(path)
       compare_url = compare_urls(path)
 
       wraith.widths.each do |width|
-        base_file_name = file_names(width, label, wraith.base_domain_label)
+        base_file_name    = file_names(width, label, wraith.base_domain_label)
         compare_file_name = file_names(width, label, wraith.comp_domain_label)
-    
-        wraith.capture_page_image engine, base_url, width, base_file_name unless base_url.nil?
-        wraith.capture_page_image engine, compare_url, width, compare_file_name unless compare_url.nil?
+
+        jobs << [label, path, width, base_url,    base_file_name]
+        jobs << [label, path, width, compare_url, compare_file_name]
+      end
+    end
+
+    Parallel.each(jobs, :in_threads => 8) do |label, path, width, url, filename|
+      begin
+        attempt_image_capture(width, url, filename, 5)
+      rescue Exception => e
+        puts e
+
+        puts "Using fallback image instead"
+        invalid = File.expand_path('../../assets/invalid.jpg', File.dirname(__FILE__))
+        FileUtils.cp invalid, filename
+
+        # Set width of fallback image
+        wraith.set_image_width(filename, width)
       end
     end
   end

data/lib/wraith/thumbnails.rb

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

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '1.1.6'
+  VERSION = '1.2.0'
 end

data/lib/wraith/wraith.rb

@@ -73,6 +73,12 @@ class Wraith::Wraith
     self.class.crop_images
   end
 
+  def set_image_width(image, width)
+    # For compatibility with windows file structures switch commenting on the following 2 lines
+    puts `convert #{image} -background none -extent #{width}x0 #{image}`
+    # puts `convert #{image.gsub('/', '\\')} -background none -extent #{width}x0 #{image.gsub('/', '\\')}`
+  end
+
   def thumbnail_image(png_path, output_path)
     # For compatibility with windows file structures switch commenting on the following 2 lines
     `convert #{png_path} -thumbnail 200 -crop 200x200+0+0 #{output_path}`

data/wraith.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "nokogiri"
   spec.add_runtime_dependency "log4r"
   spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "parallel"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -137,6 +137,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wraith is a screenshot comparison tool, created by developers at BBC
   News.
 email: