lookbook_visual_tester 0.6.0 → 0.7.0

data/lib/tasks/lookbook_visual_tester.rake

@@ -38,8 +38,7 @@ namespace :lookbook do
   task :list, [:format] => :environment do |_, args|
     require 'lookbook'
     previews = Lookbook.previews.flat_map do |preview|
-      group = preview.respond_to?(:scenarios) ? preview.scenarios : preview.examples
-      group.map { |scenario| scenario.lookup_path }
+      preview.scenarios.map { |scenario| scenario.lookup_path }
     end.sort
 
     if args[:format] == 'json'
@@ -54,8 +53,10 @@ namespace :lookbook do
     preview_name = args[:preview_name]
     format = args[:format]
 
+    json_mode = format == 'json'
+
     unless preview_name
-      if format == 'json'
+      if json_mode
         LookbookVisualTester::JsonOutputHandler.print({ error: 'Please provide a preview name' })
       else
         puts 'Please provide a preview name: rake lookbook:screenshot[Button]'
@@ -63,21 +64,12 @@ namespace :lookbook do
       exit 1
     end
 
-    # Run the test (which generates screenshots)
-    runner = LookbookVisualTester::Runner.new(pattern: preview_name)
-
-    # Silence stdout if json format, to avoid pollution
-    original_stdout = $stdout
-    $stdout = File.new('/dev/null', 'w') if format == 'json'
-
-    begin
-      results = runner.run
-    ensure
-      $stdout = original_stdout if format == 'json'
-    end
+    output = json_mode ? File.open(File::NULL, 'w') : $stdout
+    runner = LookbookVisualTester::Runner.new(pattern: preview_name, output: output)
+    results = runner.run
+    output.close if json_mode
 
-    if format == 'json'
-      # Transform results to simple hash
+    if json_mode
       json_results = results.map do |r|
         {
           scenario_name: r.scenario_name,
@@ -90,9 +82,8 @@ namespace :lookbook do
         }
       end
 
-      # If single result, return just object, else array
-      output = json_results.size == 1 ? json_results.first : json_results
-      LookbookVisualTester::JsonOutputHandler.print(output)
+      output_payload = json_results.size == 1 ? json_results.first : json_results
+      LookbookVisualTester::JsonOutputHandler.print(output_payload)
     else
       print_cli_summary(results)
     end
@@ -100,21 +91,16 @@ namespace :lookbook do
 
   desc 'Run visual regression tests for all previews'
   task :test, [:format] => :environment do |_, args|
-    runner = LookbookVisualTester::Runner.new(force_update: args[:format] == 'force' || ENV['UPDATE'] == 'true')
-
-    # Check for ENV var or arg
     json_mode = args[:format] == 'json' || ENV['JSON_OUTPUT'] == 'true'
+    output = json_mode ? File.open(File::NULL, 'w') : $stdout
 
-    original_stdout = $stdout
-    $stdout = File.new('/dev/null', 'w') if json_mode
-
-    begin
-      results = runner.run
-    ensure
-      $stdout = original_stdout if json_mode
-    end
+    runner = LookbookVisualTester::Runner.new(
+      force_update: args[:format] == 'force' || ENV['UPDATE'] == 'true',
+      output: output
+    )
+    results = runner.run
+    output.close if json_mode
 
-    # Save results for retry logic
     if defined?(LookbookVisualTester.config.diff_dir)
       result_file = LookbookVisualTester.config.diff_dir.join('last_run.json')
       FileUtils.mkdir_p(File.dirname(result_file))
@@ -160,35 +146,45 @@ namespace :lookbook do
     end
   end
 
+  desc 'Start Rails server, run visual tests, then stop the server'
+  task server_and_test: :environment do
+    LookbookVisualTester::ServerTestRunner.call(
+      timeout: ENV.fetch('LOOKBOOK_SERVER_TIMEOUT', '60').to_i,
+      test_task: 'lookbook:test',
+      log_path: ENV['LOOKBOOK_SERVER_LOG']
+    )
+  end
+
   desc 'Approve a specific preview change (update baseline)'
   task :approve, [:preview_name] => :environment do |_, args|
     preview_name = args[:preview_name]
     unless preview_name
-      puts 'Please provide a preview name: rake lookbook:approve[Button/default]'
+      puts 'Please provide a preview name: rake "lookbook:approve[ui/button/default]"'
       exit 1
     end
 
+    normalized = preview_name.tr('/', '_').tr(' ', '_')
     baseline_dir = LookbookVisualTester.config.baseline_dir
     current_dir = LookbookVisualTester.config.current_dir
 
-    # Find matching files in current_dir
-    candidates = Dir.glob(current_dir.join('*')).select do |f|
-      File.basename(f).include?(preview_name.gsub('/', '_'))
+    candidates = Dir.glob(current_dir.join('**', '*.png')).reject do |f|
+      File.basename(f).end_with?('_diff.png')
+    end.select do |f|
+      base = File.basename(f, '.png')
+      base == normalized || base.end_with?("_#{normalized}")
     end
 
     if candidates.empty?
-      puts "No current runs found matching '#{preview_name}'."
+      puts "No current runs found matching '#{preview_name}' in #{current_dir}."
       exit 1
     end
 
     candidates.each do |current_file|
-      filename = File.basename(current_file)
-      next if filename.include?('_diff.png') # Don't copy diffs
-
-      baseline_file = baseline_dir.join(filename)
-      FileUtils.mkdir_p(baseline_dir)
+      relative = Pathname.new(current_file).relative_path_from(current_dir)
+      baseline_file = baseline_dir.join(relative)
+      FileUtils.mkdir_p(File.dirname(baseline_file))
       FileUtils.cp(current_file, baseline_file)
-      puts "Approved: #{filename}"
+      puts "Approved: #{relative}"
     end
   end
 
@@ -210,10 +206,15 @@ namespace :lookbook do
 
     puts "Retrying #{failures.size} failure(s)..."
 
-    failures.each do |failure|
-      puts "Retrying #{failure[:scenario_name]}..."
-      runner = LookbookVisualTester::Runner.new(pattern: failure[:scenario_name])
-      runner.run
+    json_mode = args[:format] == 'json' || ENV['JSON_OUTPUT'] == 'true'
+    output = json_mode ? File.open(File::NULL, 'w') : $stdout
+    begin
+      failures.each do |failure|
+        puts "Retrying #{failure[:scenario_name]}..."
+        LookbookVisualTester::Runner.new(pattern: failure[:scenario_name], output: output).run
+      end
+    ensure
+      output.close if json_mode
     end
   end
 
@@ -435,11 +436,9 @@ namespace :lookbook_visual_tester do
     if args[:skip_capture].to_s == 'true'
       # Just print existing
     else
-      # Run it first but silenty
-      runner = LookbookVisualTester::Runner.new(pattern: args[:name])
-      $stdout = File.new('/dev/null', 'w')
+      # Run it first, silently
+      runner = LookbookVisualTester::Runner.new(pattern: args[:name], output: File.open(File::NULL, 'w'))
       runner.run
-      $stdout = STDOUT
     end
 
     puts scenario_run.current_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookbook_visual_tester
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Murilo Vasconcelos
@@ -13,114 +13,100 @@ dependencies:
   name: benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: cuprite
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: ferrum
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: lookbook
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,16 +153,16 @@ dependencies:
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 description: A Rails gem that captures screenshots of Lookbook component previews,
   compares them against baseline images, and highlights visual differences to assist
   in safe refactoring.
@@ -187,6 +173,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".agent/rules/style_guide.md"
+- ".env.example"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
@@ -195,9 +182,9 @@ files:
 - RELEASING.md
 - Rakefile
 - assets/logo.jpg
+- docs/superpowers/plans/2026-08-09-lookbook-visual-tester-hardening.md
 - lib/lookbook_visual_tester.rb
-- lib/lookbook_visual_tester/baseline_manager.rb
-- lib/lookbook_visual_tester/capybara_setup.rb
+- lib/lookbook_visual_tester/browser_discovery.rb
 - lib/lookbook_visual_tester/check_reporter.rb
 - lib/lookbook_visual_tester/configuration.rb
 - lib/lookbook_visual_tester/driver.rb
@@ -209,10 +196,10 @@ files:
 - lib/lookbook_visual_tester/runner.rb
 - lib/lookbook_visual_tester/scenario_finder.rb
 - lib/lookbook_visual_tester/scenario_run.rb
-- lib/lookbook_visual_tester/screenshot_taker.rb
+- lib/lookbook_visual_tester/server_test_runner.rb
 - lib/lookbook_visual_tester/service.rb
 - lib/lookbook_visual_tester/services/image_comparator.rb
-- lib/lookbook_visual_tester/session_manager.rb
+- lib/lookbook_visual_tester/services/image_trimmer.rb
 - lib/lookbook_visual_tester/store.rb
 - lib/lookbook_visual_tester/templates/preview_check_report.html.tt
 - lib/lookbook_visual_tester/templates/report.html.erb

data/lib/lookbook_visual_tester/baseline_manager.rb

@@ -1,34 +0,0 @@
-module LookbookVisualTester
-  class BaselineManager < Service
-    attr_reader :preview_name, :scenario_name
-
-    def initialize(preview_name:, scenario_name:)
-      @preview_name = preview_name
-      @scenario_name = scenario_name
-    end
-
-    def self.update_baseline_if_approved(preview_name:, scenario_name:)
-      new(preview_name:, scenario_name:).update_baseline_if_approved
-    end
-
-    def update_baseline_if_approved
-      return false unless last_screenshot_path
-
-      FileUtils.cp(
-        last_screenshot_path,
-        File.join(LookbookVisualTester.config.baseline_dir, scenario_path)
-      )
-      true
-    end
-
-    private
-
-    def last_screenshot_path
-      LookbookVisualTester.data[:last_changed_screenshot]&.[](preview_name)
-    end
-
-    def scenario_path
-      "#{preview_name}/#{scenario_name}.png"
-    end
-  end
-end

data/lib/lookbook_visual_tester/capybara_setup.rb

@@ -1,29 +0,0 @@
-require 'capybara'
-require 'capybara/cuprite'
-
-module LookbookVisualTester
-  module CapybaraSetup
-    @setup_complete = false
-
-    def self.setup
-      return if @setup_complete
-
-      Capybara.register_driver :cuprite do |app|
-        Capybara::Cuprite::Driver.new(
-          app,
-          window_size: [1200, 800],
-          timeout: 20,
-          process_timeout: 20,
-          headless: true,
-          browser_options: { 'ignore-certificate-errors' => true }
-        )
-      end
-
-      Capybara.default_driver = :cuprite
-      Capybara.default_max_wait_time = 15
-      Capybara.server = :puma, { Silent: true }
-
-      @setup_complete = true
-    end
-  end
-end

data/lib/lookbook_visual_tester/screenshot_taker.rb

@@ -1,118 +0,0 @@
-require 'lookbook_visual_tester/session_manager'
-require 'lookbook_visual_tester/service'
-
-require 'fileutils'
-
-module LookbookVisualTester
-  class ScreenshotTaker < Service
-    attr_reader :scenario_run, :path, :crop, :logger
-
-    CLIPBOARD = 'clipboard'
-
-    delegate :preview_url, to: :scenario_run
-
-    def initialize(scenario_run:,
-                   path: nil,
-                   crop: true,
-                   logger: Rails.logger)
-      @scenario_run = scenario_run
-      @path = path || File.join(LookbookVisualTester.config.current_dir, scenario_run.filename)
-      @crop = crop
-      @logger = logger
-    end
-
-    def session
-      @session ||= SessionManager.instance.session
-    end
-
-    def call
-      FileUtils.mkdir_p(File.dirname(path))
-
-      session.visit(preview_url)
-
-      # Wait for network requests to complete
-      # session.driver.network_idle?
-
-      # # Wait for any loading indicators to disappear
-      # begin
-      #   session.has_no_css?(".loading", wait: 10)
-      # rescue StandardError
-      #   nil
-      # end
-      if path == CLIPBOARD
-        print_and_save_to_clipboard
-      else
-        save_printscreen
-      end
-      # Additional wait for any JavaScript animations
-      sleep 1
-    rescue StandardError => e
-      logger.info "Error capturing screenshot for #{preview_url}: #{e.message}"
-      raise e
-    end
-
-    def save_to_clipboard(path = @path)
-      system("xclip -selection clipboard -t image/png -i #{path}")
-    end
-
-    private
-
-    def print_and_save_to_clipboard
-      Tempfile.create(['screenshot', '.png']) do |file|
-        save_printscreen(file.path)
-        # save_to_clipboard(file.path)
-      end
-    end
-
-    def save_printscreen(path = @path)
-      session.save_screenshot(path)
-
-      system("convert #{path} -trim -bordercolor white -border 10x10 #{path}") if crop
-
-      if different_from_baseline?(path)
-        save_to_clipboard(path) if LookbookVisualTester.config.copy_to_clipboard
-
-        save_to_last_modified(path)
-        save_to_history(path)
-        LookbookVisualTester.data[:last_changed_screenshot] ||= {}
-        LookbookVisualTester.data[:last_changed_screenshot][scenario_run.preview_name] =
-          history_path
-      end
-
-      clean_old_history
-      logger.info "Screenshot saved to #{path}"
-    end
-
-    def different_from_baseline?(current_path)
-      baseline_path = File.join(LookbookVisualTester.config.baseline_dir, scenario_run.filename)
-      return true unless File.exist?(baseline_path)
-
-      system("compare -metric AE #{current_path} #{baseline_path} null: 2>&1") != '0'
-    end
-
-    def clean_old_history(keep: LookbookVisualTester.config.history_keep_last_n)
-      history_files = Dir.glob(File.join(LookbookVisualTester.config.history_dir,
-                                         "#{scenario_run.preview_name}_*.png"))
-      history_files.sort_by! { |f| File.mtime(f) }
-      history_files[0...-keep].each { |f| File.delete(f) }
-    end
-
-    def save_to_history(current_path)
-      @history_path = File.join(
-        LookbookVisualTester.config.history_dir,
-        scenario_run.timestamp_filename
-      )
-      FileUtils.cp(current_path, history_path)
-    end
-
-    def save_to_last_modified(current_path)
-      last_path = File.join(
-        LookbookVisualTester.config.current_dir,
-        'last.png'
-      )
-      FileUtils.cp(current_path, last_path)
-    end
-
-    attr_reader :history_path
-  end
-end

data/lib/lookbook_visual_tester/session_manager.rb

@@ -1,17 +0,0 @@
-# Setup Capybara
-require 'singleton'
-require 'capybara'
-require 'capybara/cuprite'
-
-module LookbookVisualTester
-  class SessionManager
-    include Singleton
-
-    def initialize
-      CapybaraSetup.setup
-      @session = Capybara::Session.new(:cuprite)
-    end
-
-    attr_reader :session
-  end
-end