lookbook_visual_tester 0.1.6 → 0.5.0

data/lib/tasks/lookbook_visual_tester.rake

@@ -1,92 +1,327 @@
 # lib/tasks/lookbook_visual_tester.rake
-require 'fileutils'
-require 'mini_magick'
-require 'ruby-prof'
-require 'concurrent-ruby'
-
+require 'lookbook_visual_tester/runner'
 require 'lookbook_visual_tester/report_generator'
-require 'lookbook_visual_tester/screenshot_taker'
-require 'lookbook_visual_tester/image_comparator'
-require 'lookbook_visual_tester/scenario_run'
+require 'lookbook_visual_tester/json_output_handler'
 
-namespace :lookbook_visual_tester do
-  desc 'Profile the lookbook_visual_tester:run task'
-  task profile: :environment do
-    RubyProf.start
-    Rake::Task['lookbook_visual_tester:run'].invoke
-    result = RubyProf.stop
+require 'lookbook_visual_tester/preview_checker'
+require 'lookbook_visual_tester/check_reporter'
 
-    printer = RubyProf::FlatPrinter.new(result)
-    printer.print(STDOUT)
+namespace :lookbook do
+  desc 'Check previews for load/syntax errors'
+  task check: :environment do
+    puts 'Checking previews...'
+    checker = LookbookVisualTester::PreviewChecker.new
+    results = checker.check
+    LookbookVisualTester::CheckReporter.start([results])
   end
 
-  desc 'Run and copy to clipboard first scenario matching the given name'
-  task :copy, [:name] => :environment do |t, args|
-    # example on how to run: `rake lookbook_visual_tester:copy["Button"]`
+  desc 'Deep check previews by rendering them'
+  task deep_check: :environment do
+    puts 'Deep checking previews (render)...'
+    checker = LookbookVisualTester::PreviewChecker.new
+    results = checker.deep_check
+    LookbookVisualTester::CheckReporter.start([results])
+  end
 
-    previews = Lookbook.previews
+  desc 'Find components missing previews'
+  task missing: :environment do
+    puts 'Finding missing previews...'
+    checker = LookbookVisualTester::PreviewChecker.new
+    missing = checker.missing
+    LookbookVisualTester::CheckReporter.report_missing(missing)
+  end
+end
 
-    scenario_run = LookbookVisualTester::ScenarioFinder.call(args[:name], previews)
-    unless scenario_run
-      screenshot_taker = LookbookVisualTester::ScreenshotTaker.new(scenario_run:)
-      puts "No Lookbook previews found matching #{args[:name]}"
-      exit
+namespace :lookbook do
+  desc 'List all available previews'
+  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 }
+    end.sort
+
+    if args[:format] == 'json'
+      LookbookVisualTester::JsonOutputHandler.print(previews)
+    else
+      puts previews
     end
-    screenshot_taker.capture(scenario_run.preview_url)
-    exit
   end
 
-  desc 'Run visual regression tests for Lookbook previews'
-  task run: :environment do
-    image_comparator = LookbookVisualTester::ImageComparator.new
-    report = LookbookVisualTester::ReportGenerator.new
+  desc 'Generate screenshots for a specific preview (and run comparison)'
+  task :screenshot, %i[preview_name format] => :environment do |_, args|
+    preview_name = args[:preview_name]
+    format = args[:format]
+
+    unless preview_name
+      if format == 'json'
+        LookbookVisualTester::JsonOutputHandler.print({ error: 'Please provide a preview name' })
+      else
+        puts 'Please provide a preview name: rake lookbook:screenshot[Button]'
+      end
+      exit 1
+    end
+
+    # Run the test (which generates screenshots)
+    runner = LookbookVisualTester::Runner.new(pattern: preview_name)
 
-    previews = Lookbook.previews
+    # Silence stdout if json format, to avoid pollution
+    original_stdout = $stdout
+    $stdout = File.new('/dev/null', 'w') if format == 'json'
 
-    if previews.empty?
-      puts 'No Lookbook previews found.'
-      exit
+    begin
+      results = runner.run
+    ensure
+      $stdout = original_stdout if format == 'json'
     end
 
-    pool = Concurrent::FixedThreadPool.new(LookbookVisualTester.config.threads)
-    previews.each do |preview|
-      preview_name = preview.name.underscore
-      puts "Processing Preview: #{preview_name}"
+    if format == 'json'
+      # Transform results to simple hash
+      json_results = results.map do |r|
+        {
+          scenario_name: r.scenario_name,
+          status: r.status,
+          mismatch: r.mismatch,
+          diff_path: r.diff_path,
+          baseline_path: r.baseline_path,
+          current_path: r.current_path,
+          error: r.error
+        }
+      end
+
+      # If single result, return just object, else array
+      output = json_results.size == 1 ? json_results.first : json_results
+      LookbookVisualTester::JsonOutputHandler.print(output)
+    else
+      print_cli_summary(results)
+    end
+  end
+
+  desc 'Run visual regression tests for all previews'
+  task :test, [:format] => :environment do |_, args|
+    runner = LookbookVisualTester::Runner.new
 
-      preview.scenarios.each do |scenario|
-        Concurrent::Promises.future_on(pool) do
-          scenario_run = LookbookVisualTester::ScenarioRun.new(scenario)
-          screenshot_taker = LookbookVisualTester::ScreenshotTaker.new(scenario_run:)
-          screenshot_taker.capture(scenario_run.preview_url, scenario_run.current_path)
-          puts "    Visiting URL: #{preview_url}"
+    # Check for ENV var or arg
+    json_mode = args[:format] == 'json' || ENV['JSON_OUTPUT'] == 'true'
 
-          image_comparator.compare(scenario_run)
+    original_stdout = $stdout
+    $stdout = File.new('/dev/null', 'w') if json_mode
+
+    begin
+      results = runner.run
+    ensure
+      $stdout = original_stdout if json_mode
+    end
+
+    # 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))
+
+      simplified_results = results.map do |r|
+        {
+          scenario_name: r.scenario_name,
+          status: r.status,
+          mismatch: r.mismatch,
+          diff_path: r.diff_path.to_s,
+          current_path: r.current_path.to_s,
+          baseline_path: r.baseline_path.to_s
+        }
+      end
+      File.write(result_file, JSON.dump(simplified_results))
+    end
+
+    if json_mode
+      summary = {
+        total: results.size,
+        passed: results.count { |r| r.status == :passed },
+        failed: results.count { |r| r.status == :failed },
+        new: results.count { |r| r.status == :new },
+        errors: results.count { |r| r.status == :error },
+        results: results.map do |r|
+          {
+            name: r.scenario_name,
+            status: r.status,
+            mismatch: r.mismatch,
+            diff_path: r.diff_path
+          }
         end
+      }
+      LookbookVisualTester::JsonOutputHandler.print(summary)
+    else
+      print_cli_summary(results)
+
+      # Generate detailed HTML report
+      reporter = LookbookVisualTester::ReportGenerator.new(results)
+      reporter.call
+
+      exit 1 if results.any? { |r| r.status == :failed }
+    end
+  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]'
+      exit 1
+    end
+
+    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('/', '_'))
+    end
+
+    if candidates.empty?
+      puts "No current runs found matching '#{preview_name}'."
+      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)
+      FileUtils.cp(current_file, baseline_file)
+      puts "Approved: #{filename}"
+    end
+  end
+
+  desc 'Re-run only failing tests from the last run'
+  task :retry, [:format] => :environment do |_, args|
+    result_file = LookbookVisualTester.config.diff_dir.join('last_run.json')
+    unless File.exist?(result_file)
+      puts "No previous run data found at #{result_file}. Run 'rake lookbook:test' first."
+      exit 1
+    end
+
+    last_run = JSON.parse(File.read(result_file), symbolize_names: true)
+    failures = last_run.select { |r| r[:status] == 'failed' || r[:status] == 'error' }
+
+    if failures.empty?
+      puts 'No failures found in last run.'
+      exit 0
+    end
+
+    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
+    end
+  end
+
+  def print_cli_summary(results)
+    total = results.size
+    passed = results.count { |r| r.status == :passed }
+    failed = results.count { |r| r.status == :failed }
+    new_scenarios = results.count { |r| r.status == :new }
+    errors = results.count { |r| r.status == :error }
+
+    puts "\n"
+    puts '========================================'
+    puts '           Test Summary                 '
+    puts '========================================'
+    puts "Total Scenarios: #{total}"
+    puts "Passed:          #{passed}"
+    puts "Failed:          #{failed}"
+    puts "New (Baselines): #{new_scenarios}" if new_scenarios > 0
+    puts "Errors:          #{errors}" if errors > 0
+    puts '========================================'
+
+    if failed > 0
+      puts "\nFailed Scenarios:"
+      results.select { |r| r.status == :failed }.each do |r|
+        puts "  [FAIL] #{r.scenario_name}"
+        puts "         Mismatch: #{r.mismatch.round(2)}%"
+        puts "         Diff:     #{r.diff_path}"
       end
     end
 
-    pool.shutdown
-    pool.wait_for_termination
-    report_path = report.generate
-    puts "Visual regression report generated at #{report_path}"
+    if errors > 0
+      puts "\nErrors:"
+      results.select { |r| r.status == :error }.each do |r|
+        puts "  [ERROR] #{r.scenario_name}"
+        puts "          Message: #{r.error}"
+      end
+    end
+    puts "\n"
   end
+end
 
-  desc 'Update baseline screenshots with current_run screenshots'
-  task update_baseline: :environment do
-    base_path = Rails.root.join('spec/visual_screenshots')
-    baseline_dir = base_path.join('baseline')
-    current_dir = base_path.join('current_run')
+# Compatibility aliases and extra tools
+namespace :lookbook_visual_tester do
+  desc 'Run visual regression tests (alias for lookbook:test)'
+  task run: 'lookbook:test'
+
+  desc 'Update baseline screenshots from current_run'
+  task update_baseline: 'lookbook_visual_tester:environment' do
+    baseline_dir = LookbookVisualTester.config.baseline_dir
+    current_dir = LookbookVisualTester.config.current_dir
 
     unless current_dir.exist?
-      puts 'Current run directory does not exist. Run the visual regression tests first.'
-      exit
+      puts 'Current run directory does not exist.'
+      exit 1
     end
 
     Dir.glob(current_dir.join('*.png')).each do |current_file|
       filename = File.basename(current_file)
       baseline_file = baseline_dir.join(filename)
+      FileUtils.mkdir_p(baseline_dir)
       FileUtils.cp(current_file, baseline_file)
-      puts "Baseline updated for #{filename}"
+      puts "Updated baseline: #{filename}"
     end
   end
+
+  desc 'Profile the visual tester'
+  task profile: :environment do
+    require 'ruby-prof'
+    RubyProf.start
+    Rake::Task['lookbook:test'].invoke
+    result = RubyProf.stop
+    printer = RubyProf::FlatPrinter.new(result)
+    printer.print($stdout)
+  end
+
+  desc 'Get list of images for the given component'
+  task :images, %i[name skip_capture] => :environment do |_, args|
+    require 'lookbook_visual_tester/scenario_finder'
+    scenario_run = LookbookVisualTester::ScenarioFinder.call(args[:name])
+
+    unless scenario_run
+      puts "No Lookbook previews found matching #{args[:name]}"
+      exit 1
+    end
+
+    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')
+      runner.run
+      $stdout = STDOUT
+    end
+
+    puts scenario_run.current_path
+  end
+
+  desc 'Run and copy to clipboard first scenario matching the given name'
+  task :copy, [:name] => :environment do |_, args|
+    require 'lookbook_visual_tester/scenario_finder'
+    scenario_run = LookbookVisualTester::ScenarioFinder.call(args[:name])
+    unless scenario_run
+      puts "No Lookbook previews found matching #{args[:name]}"
+      exit 1
+    end
+
+    # Use our runner to capture it (which handles clipboard if enabled)
+    runner = LookbookVisualTester::Runner.new(pattern: args[:name])
+    runner.run
+  end
 end

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lookbook_visual_tester
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Murilo Vasconcelos
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capybara
-  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
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lookbook
+  name: ferrum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: lookbook
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-prof
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -149,6 +135,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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.
@@ -163,26 +163,36 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - README.md
+- RELEASING.md
 - Rakefile
 - assets/logo.jpg
 - lib/lookbook_visual_tester.rb
 - lib/lookbook_visual_tester/baseline_manager.rb
 - lib/lookbook_visual_tester/capybara_setup.rb
+- lib/lookbook_visual_tester/check_reporter.rb
 - 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
 - lib/lookbook_visual_tester/report_generator.rb
+- 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/service.rb
+- lib/lookbook_visual_tester/services/image_comparator.rb
 - lib/lookbook_visual_tester/session_manager.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
 - lib/lookbook_visual_tester/update_previews.rb
+- lib/lookbook_visual_tester/variant_resolver.rb
 - lib/lookbook_visual_tester/version.rb
 - lib/tasks/lookbook_visual_tester.rake
 - sig/lookbook_visual_tester.rbs
-- tasks/lookbook_visual_tester.rake
 homepage: https://github.com/muriloime/lookbook_visual_tester
 licenses:
 - MIT
@@ -203,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Visual regression testing for Lookbook previews in Rails applications.
 test_files: []