goggles 0.1.1 → 0.1.2

data/README.md

@@ -9,6 +9,7 @@ Install ImageMagick:
 
 * OSX: `$ brew install imagemagick`
 * Linux: `$ sudo apt-get install imagemagick`
+* Windows: [Download](http://www.imagemagick.org/script/binary-releases.php#windows) installer and add to your PATH.
 
 Add this line to your application's Gemfile:
 
@@ -60,6 +61,9 @@ browser_widths:
 
 # Fuzzing percentage. Play around with this to find the right fit. Required.
 image_fuzzing: "20%"
+
+# Color for diffing images. Defaults to blue. Optional.
+diff_color: "blue"
 ```
 
 If you pass scripts to goggles as part of your testing, you **must** specify when screenshots should be taken with the `#grab_screenshot` method. If you do not specify scripts in configuration, goggles will open each of your paths and take a screenshot.

data/lib/goggles.rb

@@ -13,14 +13,15 @@ module Goggles
   def swim(config_path)
     conf = YAML::load(File.open(config_path))
 
-    @goggles_result_dir = conf['results_directory']
-    @goggles_script_dir = conf['scripts_directory']
-    @goggles_domain = conf['domain_under_test']
-    @goggles_paths = conf['paths_to_capture']
-    @goggles_scripts = conf['scripts_to_execute']
-    @goggles_platforms = conf['browsers']
-    @goggles_widths = conf['browser_widths']
-    @goggles_fuzz = conf['image_fuzzing']
+    @gg_result_dir = conf['results_directory']
+    @gg_script_dir = conf['scripts_directory']
+    @gg_domain = conf['domain_under_test']
+    @gg_paths = conf['paths_to_capture']
+    @gg_scripts = conf['scripts_to_execute']
+    @gg_platforms = conf['browsers']
+    @gg_widths = conf['browser_widths']
+    @gg_fuzz = conf['image_fuzzing']
+    @gg_color = conf['diff_color'] || 'blue'
 
     embark!
     diff_images
@@ -29,7 +30,7 @@ module Goggles
   def grab_screenshot(detail)
     make_result_dir
 
-    image_dir = "#{@goggles_result_dir}/#{@gg_label}"
+    image_dir = "#{@gg_result_dir}/#{@gg_label}"
     image_name = "#{detail}_#{@gg_size}_#{@gg_browser}"
 
     @watir.screenshot.save "#{image_dir}/#{image_name}.png"
@@ -40,25 +41,25 @@ module Goggles
   def embark!
     ensure_fresh_start
     
-    @goggles_widths.each do |size|
+    @gg_widths.each do |size|
       @gg_size = size.to_i
 
-      @goggles_platforms.each do |pf|
+      @gg_platforms.each do |pf|
         @gg_browser = pf
         
         @watir = Watir::Browser.new pf.to_sym
         @watir.driver.manage.window.resize_to(@gg_size, 768)
 
-        @goggles_paths.each do |label, path|
+        @gg_paths.each do |label, path|
           @gg_label = label
-          url = "#{@goggles_domain}#{path}"
+          url = "#{@gg_domain}#{path}"
 
-          if @goggles_scripts.nil?
+          if @gg_scripts.nil?
             @watir.goto url
             grab_screenshot("screenshot")
           else
-            @goggles_scripts.each do |script|
-              script = "#{@goggles_script_dir}/#{script}"
+            @gg_scripts.each do |script|
+              script = "#{@gg_script_dir}/#{script}"
               execute_script(url, script)
             end
           end
@@ -70,11 +71,11 @@ module Goggles
   end
 
   def ensure_fresh_start
-    FileUtils.rm_rf("#{@goggles_result_dir}")
+    FileUtils.rm_rf("#{@gg_result_dir}")
   end
 
   def make_result_dir
-    FileUtils.mkdir_p("#{@goggles_result_dir}/#{@gg_label}")
+    FileUtils.mkdir_p("#{@gg_result_dir}/#{@gg_label}")
   end
 
 end

data/lib/goggles/cli.rb

@@ -53,7 +53,8 @@ module Goggles
       'paths_to_capture' => { 'home' => "/", 'gmail' => "/gmail" },
       'browsers' => ["chrome", "firefox"],
       'browser_widths' => [1024, 600],
-      'image_fuzzing' => "20%"
+      'image_fuzzing' => "20%",
+      'diff_color' => "blue"
     }
   end
 end

data/lib/goggles/comparison.rb

@@ -5,9 +5,9 @@ module Goggles
   def diff_images
     size_to_smallest!
 
-    images = Dir.glob("#{@goggles_result_dir}/*/*.png").sort
+    images = Dir.glob("#{@gg_result_dir}/*/*.png").sort
 
-    raise Goggles::EmptyResultError, "No screenshots found in results directory: #{@goggles_result_dir}" if images.empty?
+    raise Goggles::EmptyResultError, "No screenshots found in results directory: #{@gg_result_dir}" if images.empty?
 
     until images.empty?
       one = images.slice!(0)
@@ -19,12 +19,12 @@ module Goggles
       diff_out = "#{out_path}diff.png"
       data_out = "#{out_path}data.txt"
 
-      `compare -fuzz #{@goggles_fuzz} -metric AE -highlight-color blue #{one} #{two} #{diff_out} 2>#{data_out}`
+      `compare -fuzz #{@gg_fuzz} -metric AE -highlight-color #{@gg_color} #{one} #{two} #{diff_out} 2>#{data_out}`
     end
   end
 
   def size_to_smallest!
-    images = Dir.glob("#{@goggles_result_dir}/*/*.png").sort
+    images = Dir.glob("#{@gg_result_dir}/*/*.png").sort
 
     until images.empty?
       one = images.slice!(0)

data/lib/goggles/version.rb

@@ -1,3 +1,3 @@
 module Goggles
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goggles
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors: