lookbook_visual_tester 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4dcc1d8c929065528b1f5ad9ee02dac8a2b0520e72d110ec105f954fcdfcf65
-  data.tar.gz: ce57354faceb6b0035fd89ef6bfbe6c394c0cc616bd8093929d68a26cd323b88
+  metadata.gz: 5198b58b3f8bffad2cb68f1bce804b1bce9d2ccc3e32513699f68a83e04fb054
+  data.tar.gz: bca7f0aa36413c702b5c65e3ed330ac18c4c05edeeeb36e5cb94b0ec1aaa4831
 SHA512:
-  metadata.gz: cc7e7d15b48f2d4aef69244851d1bba41dd8b40dc0709562bcdf764485dee2846ec69848891671701fc89ea1f001555627aed0fe631fd823cc527a1e3ead108a
-  data.tar.gz: 593a40641363733cffbc4c578b3e9ef94c25491ccb6f48a2230ddb12e91290baaea9738387225adfe7b45a36fb95c8002ea63d098e37be8d12a2815f82990939
+  metadata.gz: 7908ba3fb95002233392bc7b570bdf21f7bfd38f25c0206b0521f5fc89a8773173ea2689fbc1ddaca41b1e838d904118d47d4d3a2760dd829265e7e46d8148c9
+  data.tar.gz: ee266274b9ee9bfd9dd24c146bf6537618da8c10490cee78c8a667d072a8c1bb06e5a43d0ac402ca98131de425fe7e5df9ace5c9b015ca8830db35788940f8b6

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## [0.5.7] - 2026-01-06
+
+### Fixed
+- **Flaky Screenshots**: Added `wait_time` configuration to `LookbookVisualTester.config` to allow explicit waiting before screenshot capture. This resolves blank or layout-only screenshots in slower environments.
+- **Robust Driver**: Updated `FerrumDriver` to include consistent network idle checks and support the new `wait_time` option.
+
 ## [0.5.6] - 2026-01-06
 
 ### Fixed

data/README.md

@@ -4,6 +4,8 @@
 
 A powerful visual regression testing tool for [ViewComponent](https://viewcomponent.org/) via [Lookbook](https://lookbook.build/). It automates the process of capturing screenshots of your components, comparing them against baselines, and highlighting differences with human-friendly aesthetics.
 
+*This tool has been tested "at home". If it doesn't work for you, feel free to open an issue. **It works on my machine!***
+
 ### Key Features
 
 - **Automated Visual Regression**: Captures and compares screenshots of all Lookbook previews.
@@ -48,6 +50,7 @@ LookbookVisualTester.configure do |config|
   config.base_path = "coverage/screenshots"    # Root for screenshots
   config.copy_to_clipboard = true                # Enable xclip support
   config.threads = 4                             # Number of parallel threads (default: 4)
+  config.wait_time = 0.5                         # Optional: Wait time (seconds) before screenshot (fixes blank screens)
 end
 ```
 

data/lib/lookbook_visual_tester/configuration.rb

@@ -1,14 +1,10 @@
 module LookbookVisualTester
   class Configuration
     attr_reader :base_path
-    attr_accessor :lookbook_host,
-                  :baseline_dir, :current_dir, :diff_dir, :history_dir,
-                  :history_keep_last_n, :threads, :copy_to_clipboard,
-                  :components_folder,
-                  :automatic_run,
-                  :mask_selectors, :driver_adapter,
-                  :preview_checker_setup,
-                  :logger
+    attr_accessor :lookbook_host, :ui_comparison, :diff_dir, :baseline_dir, :current_dir,
+                  :history_dir, :history_keep_last_n, :threads, :copy_to_clipboard,
+                  :components_folder, :automatic_run, :mask_selectors, :driver_adapter,
+                  :preview_checker_setup, :logger, :wait_time
 
     DEFAULT_THREADS = 4
 
@@ -31,6 +27,7 @@ module LookbookVisualTester
       @mask_selectors = []
       @driver_adapter = :ferrum
       @preview_checker_setup = nil
+      @wait_time = 0.5
       @logger = if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
                   Rails.logger
                 else

data/lib/lookbook_visual_tester/drivers/ferrum_driver.rb

@@ -53,22 +53,26 @@ module LookbookVisualTester
         wait_for_network_idle
         wait_for_fonts
         wait_for_custom_selectors
+        # Explicit wait if configured, for robustness against "blank screenshot" issues
+        sleep(config.wait_time) if config.wait_time.positive?
       end
 
       def wait_for_fonts
-        @browser.execute("return document.fonts.ready")
+        @browser.execute('return document.fonts.ready')
       end
 
-      def wait_for_network_idle(timeout: 2, duration: 0.5)
-        # Ferrum has built-in network idle waiting
+      def wait_for_network_idle
+        # Ferrum has built-in network idle waiting.
+        # We rely on default settings or explicit sleep for extra safety.
         @browser.network.wait_for_idle
       rescue Ferrum::TimeoutError
-        # Log warning but proceed?
+        # Log warning but proceed - sometimes long polling or other scripts keep net active
+        config.logger.warn 'LookbookVisualTester: Network idle timeout. Proceeding with screenshot.'
       end
 
       def save_screenshot(path)
         @browser.screenshot(path: path, full: true)
-        # Note: full: true captures the whole page.
+        # NOTE: full: true captures the whole page.
         # If we capture viewport only, we should remove full: true.
         # Usually for visual testing full page is better unless specifically testing viewport.
       end
@@ -86,7 +90,7 @@ module LookbookVisualTester
       end
 
       def disable_animations
-        css = "* { transition: none !important; animation: none !important; caret-color: transparent !important; }"
+        css = '* { transition: none !important; animation: none !important; caret-color: transparent !important; }'
         inject_style(css)
       end
 
@@ -95,15 +99,17 @@ module LookbookVisualTester
         start = Time.now
         until @browser.execute("return document.fonts.status === 'loaded'")
           break if Time.now - start > 5
+
           sleep 0.1
         end
 
         # Also check for images loading attributes if needed
         # "check that no images have loading attributes active"
         # Often checking complete property is enough
-        until @browser.execute("return Array.from(document.images).every(i => i.complete)")
-           break if Time.now - start > 5
-           sleep 0.1
+        until @browser.execute('return Array.from(document.images).every(i => i.complete)')
+          break if Time.now - start > 5
+
+          sleep 0.1
         end
       end
     end

data/lib/lookbook_visual_tester/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LookbookVisualTester
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookbook_visual_tester
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Murilo Vasconcelos