screenpress 0.1.1 → 0.2.0

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/README.md

@@ -67,10 +67,11 @@ end
 * Maybe be more deliberate like Huxley and set modes (ENV variables?) for recording
 * Enable mode that fails test if image changes
 * Enable tools to easily compare without Github (locally)
-
+* Is there a good way to automatically take screenshots or when example is tagged?
 
 ### Inspiration
 
 * [Huxley](https://github.com/facebook/huxley)
 * [Wraith](https://github.com/BBC-News/wraith)
+* [Green Onion](https://github.com/intridea/green_onion)
 * [Capybara Screenshot](https://github.com/mattheworiordan/capybara-screenshot)

data/lib/screenpress.rb

@@ -3,6 +3,7 @@ require "capybara"
 
 module Screenpress
   autoload :Config,    'screenpress/config'
+  autoload :Compare,   'screenpress/compare'
   autoload :DSL,       'screenpress/dsl'
   autoload :Saver,     'screenpress/saver'
 

data/lib/screenpress/compare.rb

@@ -0,0 +1,115 @@
+# based on: https://github.com/intridea/green_onion/blob/master/lib/green_onion/compare.rb
+
+require "oily_png"
+
+module Screenpress
+  class Compare
+    include ChunkyPNG::Color
+
+    attr_reader :orig_image, :fresh_image, :threshold
+    def initialize(orig_path, fresh_path, threshold)
+      @orig_path  = orig_path
+      @fresh_path = fresh_path
+      @threshold ||= threshold
+    end
+
+    def same?
+      return !File.exists?(@fresh_path) if !File.exists?(@orig_path)
+      setup
+
+      return false unless diff_iterator
+
+      
+      if percentage_diff > 0
+        puts "Image Percentage Different #{@orig_path}: #{percentage_diff}"
+        if percentage_diff > self.threshold
+          puts "   Image different!"
+          return false
+        end
+      end
+
+      true
+    end
+
+    protected
+
+    def setup
+      return if @diff_index
+      @orig_image  = ChunkyPNG::Image.from_file(@orig_path)
+      @fresh_image = ChunkyPNG::Image.from_file(@fresh_path)
+      @diff_index = []
+    end
+
+
+    # Pulled from Jeff Kreeftmeijer's post here: http://jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/
+    # Run through all of the pixels on both org image, and fresh image. Change the pixel color accordingly.
+    def update_diff_index(x, y, pixel)
+      lowest_score = 1
+      return if pixel == fresh_image[x,y]
+
+      # try a bit in each direction to account for differences
+      [-2, -1, 0, 1, 2].each do |yd|
+        [-1, 0, 1].each do |xd|
+          begin
+            # to do based on more nuanced score
+            #score = Math.sqrt(
+            #        (r(fresh_image[x+xd,y+yd]) - r(pixel)) ** 2 +
+            #        (g(fresh_image[x+xd,y+yd]) - g(pixel)) ** 2 +
+            #        (b(fresh_image[x+xd,y+yd]) - b(pixel)) ** 2
+            #      ) / Math.sqrt(MAX ** 2 * 3)
+            
+            return if pixel == fresh_image[x+xd,y+yd]
+
+            score = 1
+
+            lowest_score = score if score < lowest_score
+          rescue ChunkyPNG::OutOfBounds
+            # off the edge!
+          end
+        end
+      end
+      
+      @diff_index << [x,y,lowest_score] if lowest_score > 0
+    end
+
+    def diff_iterator
+      orig_image.height.times do |y|
+        orig_image.row(y).each_with_index do |pixel, x|
+          update_diff_index(x, y, pixel)
+        end
+      end
+
+      return true
+    end
+
+    # Returns the numeric results of the diff of 2 images
+    def percentage_diff
+      return @percentage_changed if @percentage_changed
+      total_px = orig_image.pixels.length
+      changed_px = @diff_index.length
+
+      # to do based on more nuanced score
+      #changed_px = 0.0
+      #@diff_index.each do |x,y,score|
+        # could use the actual score
+      #  changed_px += score
+      #end
+      @percentage_changed = ((changed_px.to_f*100) / total_px)
+    end
+
+    # Saves the visual diff as a separate file
+    def save_visual_diff
+      x, y = @diff_index.map{ |xy| xy[0] }, @diff_index.map{ |xy| xy[1] }
+      diff_path = @orig_path.insert(-5, '_diff')
+
+      begin
+        fresh_image.rect(x.min, y.min, x.max, y.max, ChunkyPNG::Color.rgb(0,255,0))
+      rescue NoMethodError
+        puts "Both images are the same."
+      end
+      
+      fresh_image.save(diff_path)
+    end
+
+  end
+end

data/lib/screenpress/config.rb

@@ -1,5 +1,7 @@
 module Screenpress
   class Config
+    attr_accessor :enabled
+
     def path=val
       self.full_path = root.join(val)
     end
@@ -13,13 +15,31 @@ module Screenpress
       @full_path
     end
 
-    def enabled=val
-      @enabled = val
+    def tmp_path=val
+      self.full_tmp_path=root.join(val)
+    end
+
+    def full_tmp_path=val
+      @full_tmp_path = Pathname.new(val).expand_path
+    end
+
+    def full_tmp_path
+      self.tmp_path = "tmp" unless @full_tmp_path
+      @full_tmp_path
     end
 
     def enabled?
-      return !!@enabled if defined?(@enabled)
-      @enabled = calc_enabled
+      return !!@calc_enabled if defined?(@calc_enabled)
+      @calc_enabled = calc_enabled
+    end
+
+    def threshold=val
+      # number between 0.0 and 100.0 for percentage of image that can change
+      @threshold = val.to_f
+    end
+
+    def threshold
+      @threshold ||= 0.1
     end
 
     protected

data/lib/screenpress/saver.rb

@@ -17,13 +17,28 @@ module Screenpress
     end
 
     def save_screenshot
+      tmp_file = self.tmp_filename
+
       # settings to nil because of issues in some version of capybara
       old_path = Capybara.save_and_open_page_path
       Capybara.save_and_open_page_path = nil
 
       ensure_directory
 
-      Screenpress::Saver::Proxy.save!(capybara.current_driver, page.driver, filename)
+      return false unless Screenpress::Saver::Proxy.save!(capybara.current_driver, page.driver, tmp_file)
+
+      # is it different?
+      compare = Screenpress::Compare.new(filename, tmp_file, Screenpress.config.threshold)
+      if compare.same?
+        File.delete(tmp_file)
+      else
+        FileUtils.mv(tmp_file, filename)
+      end
+      return true
+
+    rescue Exception => e
+      File.delete(tmp_file) if tmp_file && File.exists?(tmp_file)
+      raise e
     end
 
     def ensure_directory
@@ -32,6 +47,12 @@ module Screenpress
       FileUtils.mkdir_p(folder)
     end
 
+    def tmp_filename
+      tmp_dir  = Screenpress.config.full_tmp_path.to_s
+      tmp_file = "#{tmp_dir}/screenpress_#{File.basename(filename)}"
+      tmp_file
+    end
+
     class Proxy
       class << self
         def save!(name, driver, filename)

data/lib/screenpress/version.rb

@@ -1,3 +1,3 @@
 module Screenpress
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/screenpress.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "capybara"
+  spec.add_dependency "oily_png"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,32 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: screenpress
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Brian Leonard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,43 +62,49 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Workflow and Capybara extension that takes screenshots of your tests
@@ -90,11 +117,13 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/screenpress.rb
+- lib/screenpress/compare.rb
 - lib/screenpress/config.rb
 - lib/screenpress/dsl.rb
 - lib/screenpress/saver.rb
@@ -107,29 +136,31 @@ files:
 homepage: https://github.com/taskrabbit/screenpress
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Prevent visual regressions
 test_files:
 - spec/config_spec.rb
 - spec/dsl_spec.rb
 - spec/saver_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 0e788d87ac38505a9a4a0a18c763ed7b90090510
-  data.tar.gz: 700ac9fd342eb0a9f471813840eaf65b6b5c87a0
-SHA512:
-  metadata.gz: cafa83682004a4c115dbaa6417d5628cb7c69396a154f68bb6af49e4e584cba612d54560393bbec33e00f301e4bc769da1c978ab7a1a398a1618e4f9b74bda33
-  data.tar.gz: 1bfeca9e8bcdc5b4b72f3144fc3c98bc59ae6edad94874795ffbca383643783ff8dd4df240255b949cfa0233db33808baf518b337ddaf19151246d53dff67bb3