wraith 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c035d0c684bc421a98646e59c2e61a747416d53
-  data.tar.gz: fc54894be8c45a1969cf764ae5f768a82dfa22be
+  metadata.gz: ea2a5aee7b4cbe3a600243e296db2bd328e38ce1
+  data.tar.gz: 60b739fbc44ed47c90d4643fa90458ffaca5e646
 SHA512:
-  metadata.gz: b24697715589292a50f7283b89d729b28c15cc2eb117aad5e700af9b3921d575d34b3752c3512fb7fd5f445f52609a9d70e79a23f56d035c5e1a756ccb396249
-  data.tar.gz: d3db6b016e776027508c493caa27cba9723b58213340d298995b78e193bdface255a74120cb5aab44d9197002569f2aa74e09d7d662a1ace9e35e880514e39c0
+  metadata.gz: fd22474244454f8d4282603b0219b89cb2efaab49f3744a4e0b10b7321a8d41439bd15aa0d5def2141b7afe03a7b8a17bbf67c1ed4c2053b8149eb88348a4fd0
+  data.tar.gz: 5d00b6a992af94fd40fe0fead13b350b79d0f1962a7bfd9c1b35ccc62618df137545a37e0389875a1d60f33c2670b4d3f794aaa2cdef3330d2dd56845942f201

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - "1.9.2"
   - "2.0.0"
 
-script: "./bin/wraith capture config"
+script: ruby -Ilib bin/wraith capture test_config
 
 notifications:
   email:

data/README.md

@@ -47,13 +47,13 @@ You can type `wraith` into terminal to bring up the list of commands, but the on
 wraith capture config_name
 ```
 
-This assumes that your snap.js and config.yaml are in the folders that were created on setup. There are other commands also available, these all expect a config_name to be passed as an option. Wraith will look for the config file at `configs/[config_name].yaml`.
+This assumes that your snap.js and config.yaml are in the folders that were created on setup. There are other commands also available, these all expect a config_name to be passed as an option. Wraith will look for the config file at `configs/[config_name].yaml`.  If you want to use a config from outside the setup folders, you can pass a path to a config where the config name would usually be set.  This will assume that the config and snap file are in the same directory.
 
 ```sh
   wraith capture config_name             # A full Wraith job
   wraith compare_images config_name      # compares images to generate diffs
   wraith crop_images config_name         # crops images to the same height
-  wraith folders config_name             # create folders for images
+  wraith setup_folders config_name       # create folders for images
   wraith generate_gallery config_name    # create page for viewing images
   wraith generate_thumbnails config_name # create thumbnails for gallery
   wraith reset_shots config_name         # removes all the files in the shots folder
@@ -96,4 +96,3 @@ Take a look at the LICENSE file in the code.
  * [Dave Blooman](http://twitter.com/dblooman)
  * [John Cleveley](http://twitter.com/jcleveley)
  * [Simon Thulbourn](http://twitter.com/sthulbourn)
-

data/bin/wraith

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'bundler/setup'
 
 begin
   require 'wraith/cli'

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: "lib/wraith/javascript/snap.js"
+snap_file: "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: "lib/wraith/javascript/nojs.js"
+snap_file: "javascript/nojs.js"
 
 # Type the name of the directory that shots will be stored in
 directory:
@@ -35,9 +35,9 @@ paths:
 #  - /imghp
 #  - /maps
 
-#Amount of fuzz ImageMagick will use 
-fuzz: '20%' 
+#Amount of fuzz ImageMagick will use
+fuzz: '20%'
 
 #Set the number of days to keep the site spider file
 spider_days:
-  - 10
+  - 10

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: "lib/wraith/javascript/snap.js"
+snap_file: "javascript/snap.js"
 
 # Type the name of the directory that shots will be stored in
 directory:
@@ -12,8 +12,8 @@ directory:
 
 # Add only 2 domains, key will act as a label
 domains:
-  english: "http://www.live.bbc.co.uk/news"
-  russian: "http://www.live.bbc.co.uk/russian"
+  english: "http://pal.live.bbc.com/news"
+  russian: "http://pal.live.bbc.co.uk/russian"
 
 #Type screen widths below, here are a couple of examples
 screen_widths:
@@ -35,6 +35,12 @@ paths:
 #  - /imghp
 #  - /maps
 
-#Amount of fuzz ImageMagick will use 
-fuzz: '20%' 
+#Amount of fuzz ImageMagick will use
+fuzz: '20%'
 
+#Set the filename of the spider file to use, if not specified it will fallback to spider.txt
+# spider_file: bbc_co_uk_spider.txt
+
+#Set the number of days to keep the site spider file
+spider_days:
+  - 10

data/lib/wraith/cli.rb

@@ -30,7 +30,7 @@ class Wraith::CLI < Thor
     reset.clear_shots_folder
   end
 
-  desc "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

data/lib/wraith/compare_images.rb

@@ -1,4 +1,6 @@
 require 'wraith'
+require 'image_size'
+require 'open3'
 
 class Wraith::CompareImages
   attr_reader :wraith
@@ -13,9 +15,22 @@ class Wraith::CompareImages
       base, compare = files.slice!(0, 2)
       diff = base.gsub(/([a-z0-9]+).png$/, 'diff.png')
       info = base.gsub(/([a-z0-9]+).png$/, 'data.txt')
-      wraith.compare_images(base, compare, diff, info)
+      compare_task(base, compare, diff, info)
       Dir.glob("#{wraith.directory}/*/*.txt").map { |f| "\n#{f}\n#{File.read(f)}" }
       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) }
+  end
+
+  def compare_task(base, compare, output, info)
+    cmdline = "compare -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
+    img_size = ImageSize.path(output).size.inject(:*)
+    percentage(img_size, px_value, info)
+  end
 end

data/lib/wraith/gallery_template/gallery_template.erb

@@ -50,7 +50,7 @@
                                         </a>
                                     <% end %>
                                     <p class="text-center">diff</p>
-                                    <p class="text-center text-muted"><%=files[:data]%> bytes</p>
+                                    <p class="text-center text-muted"><%=files[:data]%> percent different</p>
 
                                 </div>
                             </div>
@@ -60,4 +60,4 @@
             </div>
         </div>
     </body>
-</html>
+</html>

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '1.1.4'
+  VERSION = '1.1.5'
 end

data/lib/wraith/wraith.rb

@@ -4,7 +4,13 @@ class Wraith::Wraith
   attr_accessor :config
 
   def initialize(config_name)
-    @config = YAML::load(File.open("configs/#{config_name}.yaml"))
+    if File.exists? config_name
+      @config = YAML::load(File.open(config_name))
+      @snap_path = File.expand_path(File.dirname("#{config_name}"))
+    else
+      @config = YAML::load(File.open("configs/#{config_name}.yaml"))
+      @snap_path = File.dirname(__FILE__)
+    end
   end
 
   def directory
@@ -12,7 +18,8 @@ class Wraith::Wraith
   end
 
   def snap_file
-    @config['snap_file'] ? @config['snap_file'] : File.expand_path('lib/wraith/javascript/snap.js')
+    file = @config['snap_file'] ? @config['snap_file'] : 'javascript/snap.js'
+    File.expand_path(file, @snap_path)
   end
 
   def widths
@@ -38,7 +45,7 @@ class Wraith::Wraith
   def comp_domain_label
     domains.keys[1]
   end
-  
+
   def spider_file
     @config['spider_file'] ? @config['spider_file'] : 'spider.txt'
   end
@@ -63,10 +70,6 @@ class Wraith::Wraith
     puts `"#{browser}" #{@config['phantomjs_options']} "#{snap_file}" "#{url}" "#{width}" "#{file_name}"`
   end
 
-  def compare_images(base, compare, output, info)
-    puts `compare -fuzz #{fuzz} -metric AE -highlight-color blue #{base} #{compare} #{output} 2>#{info}`
-  end
-
   def self.crop_images(crop, height)
     # For compatibility with windows file structures switch commenting on the following 2 lines
     puts `convert #{crop} -background none -extent 0x#{height} #{crop}`

data/wraith.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec-given"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement