lookbook_visual_tester 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370dde9f9792988dbeec5a4a3c2302bc5d4740eba45d905254a1ed62d14e3896
-  data.tar.gz: 549e86c2d1b74ac7cc3d0e691a6597b1083735172b8c5fea73555fd6b93240f5
+  metadata.gz: 52de57eac4b35b3aba43c82000005b796b7bfb405fed5914ffda3ff3d6039b2f
+  data.tar.gz: a6c8e5faf0af703732a0438766299bb1300879997c64d6cc96188e1a2a3ab47b
 SHA512:
-  metadata.gz: 595fc1d9c53885253d9de535c3a3569c4e817df1f3c8e958dfbf303d86e7ce49549784e910887640c58c613b5d4ffe070ca87528f0b6b3bcc91ba2940698cbe4
-  data.tar.gz: b765d1b2b103eaa17e4204d674fd5cfae35fc75d4f725221769644f4518918cc33788b9fe7b94e08b64070b72360909845068e44ce21cbcbea618c4be5e475a7
+  metadata.gz: 78ee1ea32f42cbf2fe58f4178f03e7db493ab1598d1d80a65918c497bff2cb51778f6413b321ae8cda01248bd1714fd72ec0b44d6a968d33273234de21836d5c
+  data.tar.gz: 945d4767c88ec3121c11c6ea83e87ca286a5f5d8a1feb07b1fb10275b0c9139066047a348f9b6ce2f3d06d25f1ae09645a75aeba5dfdd99497cf2def48dddddf

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 # Changelog
+## [0.5.4] - 2026-01-06
+
+### Fixed
+- **Variants URL Generation**: Fixed a bug where setting `VARIANTS` caused a `JSON::ParserError` in Lookbook. Variant parameters are now correctly serialized to JSON in the preview URL.
+
+### Fixed
+- **Deep Check**: `rake lookbook:deep_check` now correctly detects and fails when a preview returns `nil` (implicit rendering) but the corresponding template is missing (`ViewComponent::MissingPreviewTemplateError`).
+- **Deep Check**: `rake lookbook:deep_check` now exits with status 1 if any errors or failures are detected.
+
 ## [0.5.2] - 2026-01-04
 
 ### Fixed

data/README.md

@@ -28,8 +28,8 @@ sudo apt-get install imagemagick xclip
 
 Add to your application's Gemfile:
 ```ruby
-group :test do
-  gem 'lookbook_visual_tester'
+group :test, :development do
+  gem 'lookbook_visual_tester', '~> 0.5.4'
 end
 ```
 
@@ -153,7 +153,7 @@ bundle exec rake lookbook:check
 ```
 
 #### Deep Check (Render)
-effectively renders all previews to catch runtime and template errors.
+effectively renders all previews to catch runtime errors, missing templates, and other failures. Exits with status 1 if any errors are found.
 ```bash
 bundle exec rake lookbook:deep_check
 ```
@@ -166,7 +166,13 @@ bundle exec rake lookbook:missing
 
 ## Next Steps
 
-- **CI/CD Integration**: Provide recipes for GitHub Actions to run visual regression on PRs.
+- **Enhanced Approval Workflow**: Implement a `rake lookbook:approve` task (and potentially an interactive mode) to verify and promote changes to baselines without manual file operations.
+- **Tolerance Configuration**: Add support for configuring pixel mismatch tolerance levels to reduce flakiness in rendering (anti-aliasing, shadow rendering differences).
+- **Ignore Regions**: Allow defining specific areas of a component to exclude from visual comparison (useful for unavoidable dynamic content).
+- **Markdown Reports**: Generate markdown summaries of test runs suitable for posting automatically as Pull Request comments.
+- **Cloud Storage**: Integration with cloud storage (S3, GCS) for managing baseline images to keep the git repository light.
+- **CI/CD Blueprints**: Detailed guides and reusable actions/steps for integrating with GitHub Actions, GitLab CI, etc.
+- **Multiple Browsers**: Expand driver support beyond Chrome/Ferrum (e.g. Firefox, Safari/Webkit) for cross-browser visual testing.
 
 ## Contributing
 

data/lib/lookbook_visual_tester/preview_checker.rb

@@ -131,14 +131,22 @@ module LookbookVisualTester
       example_name = example.name
 
       begin
-        preview_instance = preview_class.new
-        unless preview_instance.respond_to?(example_name)
-          return CheckResult.new(preview_name: preview.name, example_name: example_name,
-                                 status: :passed)
+        # Use ViewComponent::Preview logic to get the component to render
+        # This handles the case where the method returns nil (implicit template)
+        # and returns a component that renders the template.
+        if preview_class.respond_to?(:preview_example)
+          result = preview_class.preview_example(example_name)
+          puts "DEBUG: preview_example('#{example_name}') returned: #{result.inspect} (class: #{result.class})"
+        else
+          # Fallback for older VC or non-standard setups
+          preview_instance = preview_class.new
+          unless preview_instance.respond_to?(example_name)
+            return CheckResult.new(preview_name: preview.name, example_name: example_name,
+                                   status: :passed)
+          end
+          result = preview_instance.public_send(example_name)
         end
 
-        result = preview_instance.public_send(example_name)
-
         if result.respond_to?(:render_in)
           # Mock current_user/pundit if needed on the component itself if possible
           # But mainly we render it with a view context
@@ -157,6 +165,36 @@ module LookbookVisualTester
           result.render_in(view_context)
         elsif result.is_a?(String)
           # Rendered string, good.
+        elsif result.nil?
+          # If result is nil, it implies an implicit template rendering.
+          # We need to verify that the template exists.
+
+          # Try to find the template file based on conventions
+          # Convention: preview_file_dir/preview_file_name/example_name.html.erb
+
+          # We need the preview file path. Lookbook::Preview might not expose it easily
+          # but the class might have source_location.
+
+          method = preview_class.instance_method(example_name)
+          source_file = method.source_location&.first
+
+          found_template = false
+          if source_file
+            dir = File.dirname(source_file)
+            filename = File.basename(source_file, '.rb')
+            template_dir = File.join(dir, filename)
+
+            extensions = ['.html.erb', '.html.haml', '.html.slim']
+            path = File.join(template_dir, "#{example_name}")
+
+            found_template = extensions.any? { |ext| File.exist?("#{path}#{ext}") }
+          end
+
+          unless found_template
+            raise ViewComponent::MissingPreviewTemplateError.new("Preview #{example_name} returned nil and no template found at #{path}.* (checked erb, haml, slim)") if defined?(ViewComponent::MissingPreviewTemplateError)
+
+            raise "Preview returned nil and no template found at #{path}.*"
+          end
         end
 
         CheckResult.new(preview_name: preview.name, example_name: example_name, status: :passed)

data/lib/lookbook_visual_tester/runner.rb

@@ -179,6 +179,8 @@ module LookbookVisualTester
           if result[:error] == 'Baseline not found'
             # First run, maybe auto-approve or just report
             puts '  [NEW] Baseline not found. Saved current as potential baseline.'
+            FileUtils.mkdir_p(File.dirname(baseline_path))
+            FileUtils.cp(current_path, baseline_path)
             status = :new
           else
             puts "  [ERROR] #{result[:error]}"

data/lib/lookbook_visual_tester/scenario_run.rb

@@ -57,7 +57,7 @@ module LookbookVisualTester
 
       if display_params.any?
         # Transform display_params { theme: 'dark' } -> { _display: { theme: 'dark' } }
-        params[:_display] = display_params
+        params[:_display] = display_params.to_json
       end
 
       Lookbook::Engine.routes.url_helpers.lookbook_preview_url(

data/lib/lookbook_visual_tester/version.rb

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

data/lib/tasks/lookbook_visual_tester.rake

@@ -21,6 +21,7 @@ namespace :lookbook do
     checker = LookbookVisualTester::PreviewChecker.new
     results = checker.deep_check
     LookbookVisualTester::CheckReporter.start([results])
+    exit 1 if results.any? { |r| r.status == :failed }
   end
 
   desc 'Find components missing previews'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookbook_visual_tester
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Murilo Vasconcelos
@@ -187,7 +187,6 @@ files:
 - lib/lookbook_visual_tester/configuration.rb
 - lib/lookbook_visual_tester/driver.rb
 - lib/lookbook_visual_tester/drivers/ferrum_driver.rb
-- lib/lookbook_visual_tester/image_comparator.rb
 - lib/lookbook_visual_tester/json_output_handler.rb
 - lib/lookbook_visual_tester/preview_checker.rb
 - lib/lookbook_visual_tester/railtie.rb

data/lib/lookbook_visual_tester/image_comparator.rb

@@ -1,49 +0,0 @@
-require 'lookbook_visual_tester/configuration'
-
-module LookbookVisualTester
-  class ImageComparator
-    attr_reader :baseline_dir, :current_dir, :diff_dir
-
-    def initialize
-      @baseline_dir = LookbookVisualTester.config.baseline_dir
-      @current_dir = LookbookVisualTester.config.current_dir
-      @diff_dir = LookbookVisualTester.config.diff_dir
-    end
-
-    def compare(scenario_run)
-      filename = scenario_run.filename
-
-      current_path = current_dir.join(filename)
-      baseline_path = baseline_dir.join(filename)
-      diff_path = diff_dir.join(scenario_run.diff_filename)
-
-      if baseline_path.exist?
-        baseline_image = MiniMagick::Image.open(baseline_path)
-        current_image  = MiniMagick::Image.open(current_path)
-
-        unless baseline_image.dimensions == current_image.dimensions
-          puts '    Image dimensions do not match. Skipping comparison.'
-          return
-        end
-
-        begin
-          compare_command = "compare -metric AE \"#{baseline_path}\" \"#{current_path}\" \"#{diff_path}\" 2>&1"
-          result = `#{compare_command}`
-          distortion = result.strip.to_i
-
-          if distortion > 0
-            puts "    Differences found! Diff image saved to #{diff_path}"
-          else
-            puts '    No differences detected.'
-            File.delete(diff_path) if diff_path.exist?
-          end
-        rescue StandardError => e
-          puts "    Error comparing images: #{e.message}"
-        end
-      else
-        FileUtils.cp(current_path, baseline_path)
-        puts "    Baseline image created at #{baseline_path}"
-      end
-    end
-  end
-end