capybara-screenshot-diff 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd19e8c2bc84aa9f1339d82fc20b16767337d3518364e1a658f73fd832488a6b
-  data.tar.gz: 584607e9e33873c9b5411320f721ad350d125b7d8acc3ae03d98371c8ffe86a2
+  metadata.gz: 6e4f48d95925d0da6d7b8afcb53b0179c0477fb034ea88e9e2dde8db02d4fb61
+  data.tar.gz: 9c6c456601df79a02b4b647f3c0cca0c0439194534c73522054c87d39926b89c
 SHA512:
-  metadata.gz: e71fcea0778aff709d4857706d6b880fd8ea5336886025c12fb8cc9573a350010df137a1bf44f797e49b9e6aa8bd53e05153e90f729d648fce62e3f51a103160
-  data.tar.gz: febeb583ce4dbd4a2f125103cd86b48a2d9dcace05a7158dc5f1cabf6f807031ca0e4619fffaf41a18e8277354c0567fa31abd8e220a9fbc4a6bf1d85170f53b
+  metadata.gz: 54f1f31ec364031eed15cadd22a3e2305874802480efb9ca0b0b2c35a6954293b31552971751f143fc2a6056a96d6d49df31f0c16c3d2785491ed7664f3b1f7c
+  data.tar.gz: 872732c38c6f1822b68d56b94b27c5aeba37ffd1f39379a4e15f76b8ed248d62c787514daa724ed10f22cda1f56b4442dd0753889fc28b99d2fb8299be16c821

data/README.md

@@ -307,6 +307,17 @@ test 'stability_time_limit' do
 end
 ```
 
+### Maximum wait limit
+
+When the `stability_time_limit` is set, but no stable screenshot can be taken, a timeout occurs.
+The timeout occurs after `Capybara.default_max_wait_time`, but can be overridden by an option.
+
+```ruby
+test 'max wait time' do
+  visit '/'
+  screenshot 'index', wait: 20.seconds
+end
+```
 
 ### Removing focus from the active element
 

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

@@ -21,8 +21,8 @@ module Capybara
         JS
 
         def take_stable_screenshot(comparison, color_distance_limit:, shift_distance_limit:,
-            area_size_limit:, skip_area:, stability_time_limit:)
-          blurred_input = prepare_page_for_screenshot
+            area_size_limit:, skip_area:, stability_time_limit:, wait:)
+          blurred_input = prepare_page_for_screenshot(timeout: wait)
           previous_file_name = comparison.old_file_name
           screenshot_started_at = last_image_change_at = Time.now
           1.step do |i|
@@ -56,7 +56,7 @@ module Capybara
             FileUtils.mv comparison.new_file_name, previous_file_name
 
             check_max_wait_time(comparison, screenshot_started_at,
-                shift_distance_limit: shift_distance_limit)
+                wait: wait, shift_distance_limit: shift_distance_limit)
           end
         ensure
           blurred_input&.click
@@ -89,8 +89,8 @@ module Capybara
           FileUtils.rm stabilization_images(base_file)
         end
 
-        def prepare_page_for_screenshot
-          assert_images_loaded
+        def prepare_page_for_screenshot(timeout:)
+          assert_images_loaded(timeout: timeout)
           if Capybara::Screenshot.blur_active_element
             active_element = execute_script(<<-JS)
               ae = document.activeElement;
@@ -114,15 +114,15 @@ module Capybara
           # ODOT
         end
 
-        def check_max_wait_time(comparison, screenshot_started_at, shift_distance_limit:)
+        def check_max_wait_time(comparison, screenshot_started_at, wait:, shift_distance_limit:)
           shift_factor = shift_distance_limit ? (shift_distance_limit * 2 + 1) ^ 2 : 1
-          max_wait_time = Capybara.default_max_wait_time * shift_factor
+          max_wait_time = wait * shift_factor
           assert((Time.now - screenshot_started_at) < max_wait_time,
               "Could not get stable screenshot within #{max_wait_time}s\n" \
                       "#{stabilization_images(comparison.new_file_name).join("\n")}")
         end
 
-        def assert_images_loaded(timeout: Capybara.default_max_wait_time)
+        def assert_images_loaded(timeout:)
           return unless respond_to? :evaluate_script
 
           start = Time.now

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

@@ -71,7 +71,8 @@ module Capybara
         def screenshot(name, area_size_limit: Diff.area_size_limit,
             color_distance_limit: Diff.color_distance_limit,
             shift_distance_limit: Diff.shift_distance_limit, skip_area: Diff.skip_area,
-            stability_time_limit: Screenshot.stability_time_limit)
+            stability_time_limit: Screenshot.stability_time_limit,
+            wait: Capybara.default_max_wait_time)
           return unless Screenshot.active?
           return if window_size_is_wrong?
 
@@ -94,7 +95,8 @@ module Capybara
                                              shift_distance_limit: shift_distance_limit,
                                              area_size_limit: area_size_limit,
                                              skip_area: skip_area,
-                                             stability_time_limit: stability_time_limit)
+                                             stability_time_limit: stability_time_limit,
+                                             wait: wait)
           return unless comparison.old_file_exists?
 
           (@test_screenshots ||= []) << [caller(1..1).first, name, comparison]

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '1.2.1'
+      VERSION = '1.3.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack