wraith 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69e2afef8a9bfe10381ce28af28978d563d2beaf
-  data.tar.gz: 0f693b221e9a91d53580280b0fdbd7b67675ebf2
+  metadata.gz: 6737fd591c334bd813dbc07970efe9bea443d762
+  data.tar.gz: c1191e025c5fb12056dd8fa15b45a4be5c8027a9
 SHA512:
-  metadata.gz: c13ba3140a2f16fac7a34e545361b9594c5c00c67486d121ff0774dfb2abd3f878f8f043684188c2a7251a5289c445e8e327ce6089e3155cfe374880c9ec2790
-  data.tar.gz: dbe796b62c075b7455b193026be496fc5d1786ba79fd3a575f2cf0c7a198b550ff32f519510b03ca7ac349b660f1929ab52eeee36b37b1284221996d8c70a747
+  metadata.gz: a633654b6891f6803e074dffdd3ce37be5b55be336dbe33dfc0872dd16ec07d64878f779a1667e7b67eb864f5447d6eb3ca0e29f44f9b492a74bd2091653e8a2
+  data.tar.gz: 80cd0a7d9f9ed8216ab2e9b368f8c44c1e562a7a06dead497096a4f4a8e7d3e2ea27e007c64f02e2585c4262cf4e8e243c799277720637577fcd44f7de967e5f

data/Rakefile

@@ -1,4 +1,4 @@
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
 
 require 'bundler/gem_tasks'
 require 'wraith/save_images'
@@ -12,15 +12,15 @@ require 'wraith/gallery'
 
 @config = ('config')
 
-desc "Execute wraith on two sites with a config you specify"
-task :config, [:yaml] do |t, custom|
-  custom.with_defaults(:yaml => "config")
+desc 'Execute wraith on two sites with a config you specify'
+task :config, [:yaml] do |_t, custom|
+  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, :check_images, :crop_images, :compare_images, :generate_thumbnails, :generate_gallery] do
-  puts 'Done!';
+task default: [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :check_images, :crop_images, :compare_images, :generate_thumbnails, :generate_gallery] do
+  puts 'Done!'
 end
 
 task :reset_shots_folder do
@@ -68,14 +68,14 @@ task :generate_gallery do
   gallery.generate_gallery
 end
 
-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")
+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')
   @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/lib/wraith.rb

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

data/lib/wraith/cli.rb

@@ -18,19 +18,19 @@ class Wraith::CLI < Thor
     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')
   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
@@ -48,38 +48,38 @@ 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)
     save_images = Wraith::SaveImages.new(config_name)
     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)
     gallery = Wraith::GalleryGenerator.new(config_name)
     gallery.generate_gallery
-    puts "Gallery generated"
+    puts 'Gallery generated'
   end
 
-  desc "capture [config_name]", "A full Wraith job"
+  desc 'capture [config_name]', 'A full Wraith job'
   def capture(config)
     reset_shots(config)
     check_for_paths(config)

data/lib/wraith/compare_images.rb

@@ -12,7 +12,7 @@ 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|
+    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)
@@ -29,12 +29,12 @@ class Wraith::CompareImages
 
   def compare_task(base, compare, output, info)
     cmdline = "compare -dissimilarity-threshold 1 -fuzz #{wraith.fuzz} -metric AE -highlight-color blue #{base} #{compare} #{output}"
-    px_value = Open3.popen3(cmdline) { |stdin, stdout, stderr, wait_thr| stderr.read }.to_f
+    px_value = Open3.popen3(cmdline) { |_stdin, _stdout, stderr, _wait_thr| stderr.read }.to_f
     begin
       img_size = ImageSize.path(output).size.inject(:*)
       percentage(img_size, px_value, info)
     rescue
-      File.open(info, 'w') { |file| file.write("invalid") } unless File.exists?(output)
+      File.open(info, 'w') { |file| file.write('invalid') } unless File.exist?(output)
     end
   end
 end

data/lib/wraith/crop.rb

@@ -12,7 +12,7 @@ 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|
+    Parallel.each(files.each_slice(2), in_processes: Parallel.processor_count) do |base, compare|
       puts 'cropping images'
 
       base_height    = image_height(base)
@@ -33,7 +33,7 @@ class Wraith::CropImages
   def image_height(image)
     File.open(image, 'rb') do |fh|
       size = ImageSize.new(fh.read).size
-      height = size[1]
+      size[1]
     end
   end
 end

data/lib/wraith/folder.rb

@@ -31,9 +31,9 @@ class Wraith::FolderManager
 
   def create_folders
     spider_paths.each do |folder_label, path|
-      if !path
-        path = folder_label 
-        folder_label = path.gsub('/', '_') 
+      unless path
+        path = folder_label
+        folder_label = path.gsub('/', '_')
       end
 
       FileUtils.mkdir_p("#{dir}/thumbnails/#{folder_label}")

data/lib/wraith/gallery.rb

@@ -38,13 +38,13 @@ class Wraith::GalleryGenerator
       @dirs[category] = {}
       Dir.foreach("#{dirname}/#{category}") do |filename|
         match = MATCH_FILENAME.match(filename)
-        if !match.nil?
+        unless match.nil?
           size = match[1].to_i
           group = match[2]
-          filepath = category + "/" + filename
+          filepath = category + '/' + filename
           thumbnail = "thumbnails/#{category}/#{filename}"
 
-          unless !@dirs[category][size].nil?
+          if @dirs[category][size].nil?
             @dirs[category][size] = { variants: [] }
           end
           size_dict = @dirs[category][size]
@@ -52,31 +52,31 @@ class Wraith::GalleryGenerator
           case group
           when 'diff'
             size_dict[:diff] = {
-                filename: filepath, thumb: thumbnail
+              filename: filepath, thumb: thumbnail
             }
           when 'data'
             size_dict[:data] = File.read("#{dirname}/#{filepath}")
           else
             size_dict[:variants] << {
-                name: group,
-                filename: filepath,
-                thumb: thumbnail
-              }
+              name: group,
+              filename: filepath,
+              thumb: thumbnail
+            }
 
           end
           size_dict[:variants].sort! { |a, b| a[:name] <=> b[:name] }
         end
       end
     end
-   @dirs
+    @dirs
   end
 
   def generate_html(location, directories, template, destination, path)
     template = File.read(template)
     locals = {
-        location: location,
-        directories: directories,
-        path: path
+      location: location,
+      directories: directories,
+      path: path
     }
     html = ERB.new(template).result(ErbBinding.new(locals).get_binding)
     File.open(destination, 'w') do |outf|
@@ -84,7 +84,7 @@ class Wraith::GalleryGenerator
     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)

data/lib/wraith/gallery_template/gallery_template.erb

@@ -12,7 +12,7 @@
     <body>
         <div class="container">
             <div class="row page-header">
-                <h1>List of screenshots for <%= location %> </h1>
+                <h1>List of screenshots for <%= location %> <small>taken <%= Time.now.strftime('%Y/%m/%d %H:%M:%S') %></small></h1>
             </div>
             <div class="row">
                 <!-- <%= directories.length %> -->

data/lib/wraith/save_images.rb

@@ -22,7 +22,7 @@ class Wraith::SaveImages
   end
 
   def engine
-    wraith.engine.each { |label, browser| return browser }
+    wraith.engine.each { |_label, browser| return browser }
   end
 
   def base_urls(path)
@@ -43,16 +43,16 @@ class Wraith::SaveImages
 
       return if File.exist? filename
 
-      puts "Failed to capture image #{filename} on attempt number #{i+1} of #{max_attempts}"
+      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)"
+    fail "Unable to capture image #{filename} after #{max_attempts} attempt(s)"
   end
 
   def save_images
     jobs = []
     check_paths.each do |label, path|
-      if !path
+      unless path
         path = label
         label = path.gsub('/', '_')
       end
@@ -69,13 +69,13 @@ class Wraith::SaveImages
       end
     end
 
-    Parallel.each(jobs, :in_threads => 8) do |label, path, width, url, filename|
+    Parallel.each(jobs, in_threads: 8) do |_label, _path, width, url, filename|
       begin
         attempt_image_capture(width, url, filename, 5)
-      rescue Exception => e
+      rescue => e
         puts e
 
-        puts "Using fallback image instead"
+        puts 'Using fallback image instead'
         invalid = File.expand_path('../../assets/invalid.jpg', File.dirname(__FILE__))
         FileUtils.cp invalid, filename
 

data/lib/wraith/thumbnails.rb

@@ -13,7 +13,7 @@ class Wraith::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")
       wraith.thumbnail_image(filename, new_name)
     end

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/lib/wraith/wraith.rb

@@ -4,7 +4,7 @@ class Wraith::Wraith
   attr_accessor :config
 
   def initialize(config_name)
-    @config = YAML::load(File.open("configs/#{config_name}.yaml"))
+    @config = YAML.load(File.open("configs/#{config_name}.yaml"))
   end
 
   def directory
@@ -69,7 +69,7 @@ class Wraith::Wraith
     # puts `convert #{crop.gsub('/', '\\')} -background none -extent 0x#{height} #{crop.gsub('/', '\\')}`
   end
 
-  def crop_images(crop, height)
+  def crop_images(_crop, _height)
     self.class.crop_images
   end
 
@@ -82,6 +82,6 @@ class Wraith::Wraith
   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}`
-    #`convert #{png_path.gsub('/', '\\')} -thumbnail 200 -crop 200x200+0+0 #{output_path}`
+    # `convert #{png_path.gsub('/', '\\')} -thumbnail 200 -crop 200x200+0+0 #{output_path}`
   end
 end

data/spec/wraith_spec.rb

@@ -1,58 +1,53 @@
 require 'rspec-given'
-require 'wraith'
-require 'wraith_manager'
+require 'image_size'
+require './lib/wraith/cli'
 
 describe Wraith do
   Given(:config_name) { 'test_config' }
-  Given { WraithManager.new(config_name).reset_shots_folder }
-  Given(:test_url1) { "http://www.live.bbc.co.uk/news" }
-  Given(:test_url2) { "http://www.live.bbc.co.uk/russian" }
+  Given { Wraith::FolderManager.new(config_name).clear_shots_folder }
+  Given(:test_url1) { 'http://www.live.bbc.co.uk/news' }
+  Given(:test_url2) { 'http://www.live.bbc.co.uk/russian' }
   Given { Dir.mkdir('shots/test') }
   Given(:test_image1) { 'shots/test/test1.png' }
   Given(:test_image2) { 'shots/test/test2.png' }
   Given(:diff_image) { 'shots/test/test_diff.png' }
   Given(:data_txt) { 'shots/test/test.txt' }
 
-  When(:wraith) { Wraith.new(config_name) }
-  Then { wraith.is_a? Wraith }
+  When(:wraith) { Wraith::Wraith.new(config_name) }
+  Then { wraith.is_a? Wraith::Wraith }
 
-  context "When creating a wraith worker" do
-    When(:no_config) { Wraith.new }
-    Then { no_config.should have_failed(ArgumentError) }
+  context 'When creating a wraith worker' do
 
     Then { wraith.config.keys.size == 8 }
     Then { wraith.widths == [320, 600, 768, 1024, 1280] }
-    Then { wraith.base_domain == "http://www.live.bbc.co.uk/news" }
-    Then { wraith.comp_domain == "http://www.live.bbc.co.uk/russian" }
-    Then { wraith.base_domain_label == "english" }
-    Then { wraith.comp_domain_label == "russian" }
-    Then { wraith.paths == { "home" => "/", "uk_index" => "/uk" } }
+    Then { wraith.base_domain == 'http://pal.live.bbc.com/news' }
+    Then { wraith.comp_domain == 'http://pal.live.bbc.co.uk/russian' }
+    Then { wraith.base_domain_label == 'english' }
+    Then { wraith.comp_domain_label == 'russian' }
+    Then { wraith.paths == { 'home' => '/', 'uk_index' => '/uk' } }
   end
 
-  context "When capturing an image" do
+  context 'When capturing an image' do
     # capture_page_image
     When do
-      wraith.engine.each do |type, engine|
-        wraith.capture_page_image( engine, test_url1, 320, test_image1 )
+      wraith.engine.each do |_type, engine|
+        wraith.capture_page_image(engine, test_url1, 320, test_image1)
       end
     end
     When(:image_size) { ImageSize.path(test_image1).size }
     Then { image_size[0] == 320 }
   end
 
-  context "When comparing images" do
+  context 'When comparing images' do
     When(:diff_image_size) do
-      wraith.engine.each do |type, engine|
-        wraith.capture_page_image( engine, test_url1, 320, test_image1 )
-        wraith.capture_page_image( engine, test_url2, 320, test_image2 )
+      wraith.engine.each do |_type, engine|
+        wraith.capture_page_image(engine, test_url1, 320, test_image1)
+        wraith.capture_page_image(engine, test_url2, 320, test_image2)
       end
-      WraithManager.new(config_name).crop_images
-      wraith.compare_images( test_image1, test_image2, diff_image, data_txt )
+      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
     end
     Then { diff_image_size[0] == 320 }
   end
-
-  # crop_images
-  # thumbnail_image
 end

data/wraith.gemspec

@@ -4,29 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wraith/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wraith"
+  spec.name          = 'wraith'
   spec.version       = Wraith::VERSION
-  spec.authors       = ["Dave Blooman", "Simon Thulbourn"]
-  spec.email         = ["david.blooman@gmail.com", "simon+github@thulbourn.com"]
+  spec.authors       = ['Dave Blooman', 'Simon Thulbourn']
+  spec.email         = ['david.blooman@gmail.com', 'simon+github@thulbourn.com']
   spec.summary       = 'Wraith is a screenshot comparison tool, created by developers at BBC News.'
   spec.description   = 'Wraith is a screenshot comparison tool, created by developers at BBC News.'
-  spec.homepage      = "https://github.com/BBC-News/wraith"
-  spec.license       = "Apache 2"
+  spec.homepage      = 'https://github.com/BBC-News/wraith'
+  spec.license       = 'Apache 2'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec-given'
 
-  spec.add_runtime_dependency "rake"
-  spec.add_runtime_dependency "image_size"
-  spec.add_runtime_dependency "anemone"
-  spec.add_runtime_dependency "robotex"
-  spec.add_runtime_dependency "nokogiri"
-  spec.add_runtime_dependency "log4r"
-  spec.add_runtime_dependency "thor"
-  spec.add_runtime_dependency "parallel"
+  spec.add_runtime_dependency 'rake'
+  spec.add_runtime_dependency 'image_size'
+  spec.add_runtime_dependency 'anemone'
+  spec.add_runtime_dependency 'robotex'
+  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.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -178,7 +178,6 @@ files:
 - lib/wraith/cli.rb
 - lib/wraith/compare_images.rb
 - lib/wraith/crop.rb
-- lib/wraith/error.rb
 - lib/wraith/folder.rb
 - lib/wraith/gallery.rb
 - lib/wraith/gallery_template/bootstrap.min.css

data/lib/wraith/error.rb

@@ -1,3 +0,0 @@
-module Wraith::Error
-
-end