capybara-screenshot-diff 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea2eb0302f1b07c925218f42f50e34a92ea53d6a
-  data.tar.gz: bf0641106aec6b525fd13912b7863b616a8d16df
+  metadata.gz: 6ae86364bfe6e5bbcfe03ce6c9b6a0a39c60b2ac
+  data.tar.gz: 803b1d3d309c2a4e93e2de388c5666d03712325a
 SHA512:
-  metadata.gz: 61c6f15802542903bee2236fb7b72b65fae467b45e885515f15bac7da2dd60d4faa6a2b03e9de90450a1f66710c9c853c31c75e284befae8adab177d89cf3ac4
-  data.tar.gz: d1a8ac84a126b5227d00e43e37115a27547ca9877d4e6ec4da0cd1c37980899b8da441e39c50c6de51775359604c99a497a6a0101f589e75e23b123bebcc35f6
+  metadata.gz: 73d1f23776d8afc8315b7d518b78448a2215b526f7f50088fc809df70359ccb27b1f635b6e905d080ca286596e98825f98f77cb2a303c59b3c54eba12de8e3fe
+  data.tar.gz: 8534dcb0cf6b3a72b26d42f010d255f35afe38e9f4b8defc34396227932b93fe6baf19f6ba71f09258d4ba09943266239b9d7f924b226c99596b8d6ca6873919

data/.rubocop_todo.yml

@@ -13,7 +13,7 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 181
+  Max: 182
 
 # Offense count: 3
 Metrics/CyclomaticComplexity:

data/lib/capybara/screenshot/diff.rb

@@ -1,3 +1,4 @@
+require 'capybara/dsl'
 require 'capybara/screenshot/diff/version'
 require 'capybara/screenshot/diff/image_compare'
 require 'capybara/screenshot/diff/test_methods'
@@ -32,9 +33,33 @@ module Capybara
 
     # Module to track screen shot changes
     module Diff
+      include Capybara::DSL
+      include Capybara::Screenshot::Os
+
       mattr_accessor :area_size_limit
       mattr_accessor :color_distance_limit
       mattr_accessor(:enabled) { true }
+
+      def self.included(clas)
+        clas.include TestMethods
+        clas.setup do
+          if Capybara::Screenshot.window_size
+            if selenium?
+              page.driver.browser.manage.window.resize_to(*Capybara::Screenshot.window_size)
+            elsif poltergeist?
+              page.driver.resize(*Capybara::Screenshot.window_size)
+            end
+          end
+        end
+
+        clas.teardown do
+          if Capybara::Screenshot::Diff.enabled && @test_screenshots
+            test_screenshot_errors = @test_screenshots
+                .map { |caller, name, compare| assert_image_not_changed(caller, name, compare) }.compact
+            fail(test_screenshot_errors.join("\n\n")) if test_screenshot_errors.any?
+          end
+        end
+      end
     end
   end
 end

data/lib/capybara/screenshot/diff/image_compare.rb

@@ -3,6 +3,8 @@ require 'chunky_png'
 module Capybara
   module Screenshot
     module Diff
+      # Compare two images and determine if they are equal, different, or within som comparison
+      # range considering color values and difference area size.
       class ImageCompare
         include ChunkyPNG::Color
 
@@ -21,10 +23,11 @@ module Capybara
           reset
         end
 
+        # Resets the calculated data about the comparison with regard to the "new_image".
+        # Data about the original image is kept.
         def reset
           @max_color_distance = @color_distance_limit ? 0 : nil
           @left = @top = @right = @bottom = nil
-          @_old_filesize = nil
         end
 
         # Compare the two image files and return `true` or `false` as quickly as possible.

data/lib/capybara/screenshot/diff/stabilization.rb

@@ -18,7 +18,48 @@ module Capybara
           }()
         EOF
 
-        def reduce_retina_image_size(file_name)
+        def take_stable_screenshot(comparison, color_distance_limit:, area_size_limit:)
+          input = prepare_page_for_screenshot
+          previous_file_name = comparison.old_file_name
+          screenshot_started_at = last_image_change_at = Time.now
+          loop.with_index do |_x, i|
+            take_right_size_screenshot(comparison)
+
+            break unless Capybara::Screenshot.stability_time_limit
+            if comparison.quick_equal?
+              clean_stabilization_images(comparison.new_file_name)
+              break
+            end
+            comparison.reset
+
+            if previous_file_name
+              stabilization_comparison =
+                ImageCompare.new(comparison.new_file_name, previous_file_name,
+                    color_distance_limit: color_distance_limit, area_size_limit: area_size_limit)
+              if stabilization_comparison.quick_equal?
+                if (Time.now - last_image_change_at) > Capybara::Screenshot.stability_time_limit
+                  clean_stabilization_images(comparison.new_file_name)
+                  break
+                end
+                next
+              else
+                last_image_change_at = Time.now
+              end
+
+              check_max_wait_time(comparison, screenshot_started_at)
+            end
+
+            previous_file_name = "#{comparison.new_file_name.chomp('.png')}_x#{format('%02i', i)}.png~"
+
+            FileUtils.mv comparison.new_file_name, previous_file_name
+          end
+        ensure
+          input.click if input
+        end
+
+        private
+
+        private def reduce_retina_image_size(file_name)
           return if !ON_MAC || !selenium? || !Capybara::Screenshot.window_size
           saved_image = ChunkyPNG::Image.from_file(file_name)
           width = Capybara::Screenshot.window_size[0]
@@ -28,15 +69,15 @@ module Capybara
           resized_image.save(file_name)
         end
 
-        def stabilization_images(base_file)
+        private def stabilization_images(base_file)
           Dir["#{base_file.chomp('.png')}_x*.png~"]
         end
 
-        def clean_stabilization_images(base_file)
+        private def clean_stabilization_images(base_file)
           FileUtils.rm stabilization_images(base_file)
         end
 
-        def prepare_page_for_screenshot
+        private def prepare_page_for_screenshot
           assert_images_loaded
           if Capybara::Screenshot.blur_active_element
             active_element = execute_script(<<-JS)
@@ -52,7 +93,7 @@ module Capybara
           input
         end
 
-        def take_right_size_screenshot(comparison)
+        private def take_right_size_screenshot(comparison)
           save_screenshot(comparison.new_file_name)
 
           # TODO(uwe): Remove when chromedriver takes right size screenshots
@@ -60,48 +101,13 @@ module Capybara
           # ODOT
         end
 
-        def take_stable_screenshot(comparison, color_distance_limit: , area_size_limit: )
-          input = prepare_page_for_screenshot
-          previous_file_name = comparison.old_file_name
-          screenshot_started_at = last_image_change_at = Time.now
-          loop.with_index do |_x, i|
-            take_right_size_screenshot(comparison)
-
-            break unless Capybara::Screenshot.stability_time_limit
-            if comparison.quick_equal?
-              clean_stabilization_images(comparison.new_file_name)
-              break
-            end
-            comparison.reset
-
-            if previous_file_name
-              stabilization_comparison =
-                ImageCompare.new(comparison.new_file_name, previous_file_name,
-                    color_distance_limit: color_distance_limit, area_size_limit: area_size_limit)
-              if stabilization_comparison.quick_equal?
-                if (Time.now - last_image_change_at) > Capybara::Screenshot.stability_time_limit
-                  clean_stabilization_images(comparison.new_file_name)
-                  break
-                end
-                next
-              else
-                last_image_change_at = Time.now
-              end
-
-              assert (Time.now - screenshot_started_at) < Capybara.default_max_wait_time,
-                  "Could not get stable screenshot within #{Capybara.default_max_wait_time}s\n" \
+        private def check_max_wait_time(comparison, screenshot_started_at)
+          assert (Time.now - screenshot_started_at) < Capybara.default_max_wait_time,
+              "Could not get stable screenshot within #{Capybara.default_max_wait_time}s\n" \
                       "#{stabilization_images(comparison.new_file_name).join("\n")}"
-            end
-
-            previous_file_name = "#{comparison.new_file_name.chomp('.png')}_x#{format('%02i', i)}.png~"
-
-            FileUtils.mv comparison.new_file_name, previous_file_name
-          end
-        ensure
-          input.click if input
         end
 
-        def assert_images_loaded(timeout: Capybara.default_max_wait_time)
+        private def assert_images_loaded(timeout: Capybara.default_max_wait_time)
           return unless respond_to? :evaluate_script
           start = Time.now
           loop do

data/lib/capybara/screenshot/diff/test_methods.rb

@@ -75,20 +75,20 @@ module Capybara
           file_name = "#{Screenshot.screenshot_area_abs}/#{name}.png"
 
           FileUtils.mkdir_p File.dirname(file_name)
-          comparison = ImageCompare.new(file_name, dimensions: Screenshot.window_size,
-              color_distance_limit: color_distance_limit, area_size_limit: area_size_limit)
+          comparison = ImageCompare.new(file_name,
+              dimensions: Screenshot.window_size, color_distance_limit: color_distance_limit,
+              area_size_limit: area_size_limit)
           checkout_vcs(name, comparison)
           take_stable_screenshot(comparison, color_distance_limit: color_distance_limit,
-              area_size_limit: area_size_limit)
+                                             area_size_limit: area_size_limit)
           return unless comparison.old_file_exists?
           (@test_screenshots ||= []) << [caller(1..1).first, name, comparison]
         end
 
         def window_size_is_wrong?
           selenium? && Screenshot.window_size &&
-            (!page.driver.chrome? || ON_WINDOWS) && # TODO(uwe): Allow for Chrome when it works
             page.driver.browser.manage.window.size !=
-              Selenium::WebDriver::Dimension.new(*Screenshot.window_size)
+              ::Selenium::WebDriver::Dimension.new(*Screenshot.window_size)
         end
 
         def assert_image_not_changed(caller, name, comparison)
@@ -113,30 +113,3 @@ module Capybara
   end
 end
 # rubocop:enable Metrics/ClassLength
-
-module ActionDispatch
-  class IntegrationTest
-    prepend Capybara::Screenshot::Diff::TestMethods
-
-    setup do
-      if Capybara::Screenshot.window_size
-        if selenium?
-          # TODO(uwe): Enable for Chrome and non-windows when it works)
-          if !page.driver.chrome? || ON_WINDOWS
-            page.driver.browser.manage.window.resize_to(*Capybara::Screenshot.window_size)
-          end
-        elsif poltergeist?
-          page.driver.resize(*Capybara::Screenshot.window_size)
-        end
-      end
-    end
-
-    teardown do
-      if Capybara::Screenshot::Diff.enabled && @test_screenshots
-        test_screenshot_errors = @test_screenshots
-          .map { |caller, name, compare| assert_image_not_changed(caller, name, compare) }.compact
-        fail(test_screenshot_errors.join("\n\n")) if test_screenshot_errors.any?
-      end
-    end
-  end
-end

data/lib/capybara/screenshot/diff/version.rb

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '0.9.1'.freeze
+      VERSION = '0.10.0'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack