lookbook_visual_tester 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6d36810c9ef2a567bcf6fd89685b3d2cc6cf70ef73151d0fc7cf2a284f0d65
-  data.tar.gz: e16804e522edb44ac1751317b21e9fcf8ed92665bf88f02318f3f816b32aa46f
+  metadata.gz: a29c54b1403f4faeaea71ef267faf9aba07d033c3c0bfc79617c0bf0cf77a490
+  data.tar.gz: 2d8cb90e20f1ad2dd92ca6c677bb4e8185c62a16b0b070721551e789575de219
 SHA512:
-  metadata.gz: 41d15e7bff1c2d1634a0adddb580b5aa97bb0b869ee8ce91e1b71d6b751addfd00d5349a458a41c7c023487ea6a4a5ffde4129c57a284a3f4af35b30e2cf9cb2
-  data.tar.gz: c8f00b84c80303323689404c89cea2b2f6dabf94ac501eae16278ef51484206bf5007b9b18c55394a3d52b6fef4fb7c9047a8c562430f836887da9787eddd325
+  metadata.gz: 8328f592622c337d11dca1c10811834e85f0a00cecc92eeb6f6a62c04cf2e1df50e9eed9700ac1b11041e39373710c371454c19d71db0b17c95b2790a67ebaeb
+  data.tar.gz: 3dba60c0c0d2867b185e45c53d68569b29e87c4ac57bf649767aa6c17ada5405d1cf0f493c6b96d75a1755405c70d050b165a72fe58a9f39648609ea703adecb

data/.rubocop.yml

@@ -1,8 +1,209 @@
 AllCops:
-  TargetRubyVersion: 3.0
+  Exclude:
+    - "bin/**/*"
+    - "db/**/*"
+    - "config/**/*"
+    - "node_modules/**/*"
+    - "vendor/**/*"
+    - "app/assets/**/*"
+    - "db/schema.rb"
+  TargetRubyVersion: 3.2.1
+  DisplayCopNames: true
+  NewCops: enable
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "lib/tasks/**/*"
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/FormatString:
+  Exclude:
+    - "app/components/**/*"
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 100
+  AllowedPatterns: ['(\A|\s)#']
+  Exclude:
+    - "spec/**/*"
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 21
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Bundler/OrderedGems:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Layout/BeginEndAlignment:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/ConstantDefinitionInBlock: # (new in 0.91)
+  Enabled: true
+
+Lint/DuplicateRequire: # (new in 0.90)
+  Enabled: true
+
+Lint/DuplicateRescueException: # (new in 0.89)
+  Enabled: true
+
+Lint/EmptyConditionalBody: # (new in 0.89)
+  Enabled: true
+
+Lint/EmptyFile: # (new in 0.90)
+  Enabled: true
+
+Lint/FloatComparison: # (new in 0.89)
+  Enabled: true
+
+Lint/IdentityComparison:
+  Enabled: true
+
+Lint/MissingSuper: # (new in 0.89)
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef: # (new in 0.89)
+  Enabled: true
+
+Lint/SelfAssignment: # (new in 0.89)
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument: # (new in 0.89)
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
+  Enabled: true
+
+Lint/UnreachableLoop: # (new in 0.89)
+  Enabled: true
+
+Lint/UselessMethodDefinition: # (new in 0.90)
+  Enabled: true
+
+Lint/UselessTimes: # (new in 0.91)
+  Enabled: true
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/ExplicitBlockArgument: # (new in 0.89)
+  Enabled: true
+
+Style/GlobalStdStream: # (new in 0.89)
+  Enabled: true
+
+Style/KeywordParametersOrder: # (new in 0.90)
+  Enabled: true
+
+Style/OptionalBooleanParameter: # (new in 0.89)
+  Enabled: true
+
+Style/RedundantSelfAssignment: # (new in 0.90)
+  Enabled: true
+
+Style/SingleArgumentDig: # (new in 0.89)
+  Enabled: true
+
+Style/SoleNestedConditional: # (new in 0.89)
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+Here is the changelog for version **0.1.5** of *LookbookVisualTester*:
+
+---
+
+# Changelog
+
+## [0.1.5] - 2025-02-26
+
+### ✨ New Features & Improvements
+
+- **State Management & History Tracking**  
+  - Introduced a **state store** with the new `Store` class for better history management.  
+  - Implemented file history tracking, enabling more efficient change monitoring.  
+
+- **Component Refactoring**  
+  - Improved **state and history handling** in `LookbookVisualTester`.  
+  - Updated `ScreenshotTaker` signature for better integration with other system components.  
+  - Refactored `CapybaraSetup` to enhance test environment flexibility.  
+  - `UpdatePreviews` now inherits from `Service`, standardizing code structure.  
+  - Improved **clipboard functionality**, allowing better manipulation and copying of screenshots.  
+
+- **Testing & Code Quality Enhancements**  
+  - Added new unit tests for `ScreenshotTaker` and `UpdatePreviews`.  
+  - Refactored logging and scenario handling to improve maintainability.  
+
+
 ## [0.1.4] - 2025-02-20
 ### Added
 - Extracted `n_threads` configuration for improved concurrency.

data/README.md

@@ -1,9 +1,30 @@
-# LookbookVisualTester
+<img src="./assets/logo.jpg" alt="Logo" width="300" />
+
+# Lookbook Visual Tester
 
 This gem was built to serve as a lookbook regression tester, getting prints from previews, comparing them and generating a report of differences.
 
+
+### Features
+
+- Perform visual regression testing on changes.
+- Integrate seamlessly with your Lookbook previews.
+- Automatically generate image differences.
+- Simplify debugging and quality checks.
+- Very useful for AI coding (e.g. aider, etc.)
+
 ## Installation
 
+Tested on linux. A couple of changes to work on mac, etc. You will need tools like xclip, imagemagick
+
+For Ubuntu-based systems, install the necessary dependencies by running:
+
+```bash
+sudo apt-get install xclip imagemagick
+```
+
+
+
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
@@ -18,8 +39,13 @@ gem install lookbook_visual_tester
 
 ## Usage
 
+To run everything 
 bundle exec rake lookbook_visual_tester:run LOOKBOOK_HOST=https://localhost:5000
 
+### Features 
+
+When installed this gem gets your changes and generates 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -33,6 +59,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/murilo
 
 ## Deployment 
 
+Generate artifacts for changelog : 
+
 `git log --pretty=format:"%h %ad | %s [%an]" --date=short --no-merges --name-only | xclip -selection clipboard`
 
 Update changelog 

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "minitest/test_task"
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
 
 Minitest::TestTask.create
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/lookbook_visual_tester/baseline_manager.rb

@@ -0,0 +1,34 @@
+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,15 +1,29 @@
-require "capybara"
-require "capybara/cuprite"
+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, headless: true, browser_options: { "ignore-certificate-errors" => true })
+        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/configuration.rb

@@ -1,20 +1,38 @@
 module LookbookVisualTester
   class Configuration
-    attr_accessor :base_path, :baseline_dir, :current_dir, :diff_dir, :threads ,:host
+    attr_accessor :base_path, :lookbook_host,
+                  :baseline_dir, :current_dir, :diff_dir, :history_dir,
+                  :history_keep_last_n, :threads, :copy_to_clipboard
 
     DEFAULT_THREADS = 4
 
     def initialize
-      @base_path = Rails.root.join("spec/visual_screenshots")
-      @baseline_dir = @base_path.join("baseline")
-      @current_dir = @base_path.join("current_run")
-      @diff_dir = @base_path.join("diff")
+      @base_path = if defined?(Rails) && Rails.respond_to?(:env) && Rails.env.test?
+                     Pathname.new(Dir.pwd).join('spec/visual_screenshots')
+                   elsif defined?(Rails) && Rails.respond_to?(:root) && Rails.root
+                     Rails.root.join('spec/visual_screenshots')
+                   else
+                     # Fallback for non-Rails environments
+                     Pathname.new(Dir.pwd).join('spec/visual_screenshots')
+                   end
+      @baseline_dir = @base_path.join('baseline')
+      @current_dir = @base_path.join('current_run')
+      @diff_dir = @base_path.join('diff')
+      @history_dir = @base_path.join('history')
       @threads = DEFAULT_THREADS
+      @history_keep_last_n = 5
+      @copy_to_clipboard = true
 
-      @host = ENV["LOOKBOOK_HOST"] || "https://localhost:5000"
+      @lookbook_host = ENV.fetch('LOOKBOOK_HOST', 'https://localhost:5000')
+    end
+
+    class << self
+      def config
+        @config ||= new
+      end
 
-      [baseline_dir, current_dir, diff_dir].each do |dir|
-        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+      def configure
+        yield(config)
       end
     end
   end

data/lib/lookbook_visual_tester/image_comparator.rb

@@ -1,4 +1,4 @@
-require "lookbook_visual_tester/configuration"
+require 'lookbook_visual_tester/configuration'
 
 module LookbookVisualTester
   class ImageComparator
@@ -22,7 +22,7 @@ module LookbookVisualTester
         current_image  = MiniMagick::Image.open(current_path)
 
         unless baseline_image.dimensions == current_image.dimensions
-          puts "    Image dimensions do not match. Skipping comparison."
+          puts '    Image dimensions do not match. Skipping comparison.'
           return
         end
 
@@ -34,7 +34,7 @@ module LookbookVisualTester
           if distortion > 0
             puts "    Differences found! Diff image saved to #{diff_path}"
           else
-            puts "    No differences detected."
+            puts '    No differences detected.'
             File.delete(diff_path) if diff_path.exist?
           end
         rescue StandardError => e

data/lib/lookbook_visual_tester/railtie.rb

@@ -1,18 +1,41 @@
 # lib/lookbook_visual_tester/railtie.rb
 
-require "lookbook_visual_tester/capybara_setup"
-require "lookbook_visual_tester/update_previews"
+require 'lookbook_visual_tester/capybara_setup'
+require 'lookbook_visual_tester/update_previews'
 
 module LookbookVisualTester
   class Railtie < ::Rails::Railtie
     rake_tasks do
-      load "tasks/lookbook_visual_tester.rake"
+      load 'tasks/lookbook_visual_tester.rake'
     end
 
-    initializer "LookbookVisualTester.lookbook_after_change" do |app1|
-      puts " >>>>> lookbook_after_change initialized: #{app1.inspect}"
+    initializer 'LookbookVisualTester.lookbook_after_change' do |_app|
+      Rails.logger.info "LookbookVisualTester initialized with host: #{LookbookVisualTester.config.lookbook_host}"
       Lookbook.after_change do |app, changes|
-        LookbookVisualTester::UpdatePreviews.call(app, changes)
+        # get hash of content of modified files to see if has changed
+        modified = changes[:modified]
+        my_hash = modified.sort.map { |f| File.read(f) }.hash
+
+        lock_file = Rails.root.join('tmp', 'lookbook_visual_tester.lock')
+        Rails.logger.info ">>> LookbookVisualTester: No changes detected in #{LookbookVisualTester.data}"
+
+        # Rails.logger.info ">>> LookbookVisualTester: Stack trace: #{caller.join("\n")}"
+        Rails.logger.info ">>> LookbookVisualTester: Changes in #{Rails.cache.instance_variable_get(:@data).keys.inspect}"
+        File.open(lock_file, 'w') do |file|
+          if file.flock(File::LOCK_EX | File::LOCK_NB)
+            if LookbookVisualTester.data[:last_hash] == my_hash
+              Rails.logger.info 'LookbookVisualTester: No changes detected in Lookbook'
+            else
+              LookbookVisualTester.data[:last_hash] = my_hash
+              Rails.logger.info "LookbookVisualTester: Running UpdatePreviews, updattin to #{LookbookVisualTester.data.inspect}"
+              LookbookVisualTester::UpdatePreviews.call(changes)
+            end
+            file.flock(File::LOCK_UN)
+            Rails.logger.info 'LookbookVisualTester: UpdatePreviews File unlocked.'
+          else
+            Rails.logger.info 'LookbookVisualTester: UpdatePreviews already running, skipping this call.'
+          end
+        end
       end
     end
   end

data/lib/lookbook_visual_tester/report_generator.rb

@@ -7,29 +7,29 @@ module LookbookVisualTester
         [config.baseline_dir, config.current_dir, config.diff_dir, config.base_path]
       end
 
-      @report_path = base_path.join("report.html")
+      @report_path = base_path.join('report.html')
     end
 
     def generate
-      File.open(report_path, "w") do |file|
-        file.puts "<!DOCTYPE html>"
+      File.open(report_path, 'w') do |file|
+        file.puts '<!DOCTYPE html>'
         file.puts "<html lang='en'>"
         file.puts "<head><meta charset='UTF-8'><title>Visual Regression Report</title></head>"
-        file.puts "<body>"
-        file.puts "<h1>Visual Regression Report</h1>"
-        file.puts "<ul>"
+        file.puts '<body>'
+        file.puts '<h1>Visual Regression Report</h1>'
+        file.puts '<ul>'
 
-        diff_files = Dir.glob(diff_dir.join("*_diff.png"))
+        diff_files = Dir.glob(diff_dir.join('*_diff.png'))
         diff_files.each do |diff_file|
           filename = File.basename(diff_file)
           # Extract preview and scenario names
-          preview_scenario = filename.sub("_diff.png", "")
-          preview, scenario = preview_scenario.split("_", 2)
+          preview_scenario = filename.sub('_diff.png', '')
+          preview, scenario = preview_scenario.split('_', 2)
 
           baseline_image = baseline_dir.join("#{preview}_#{scenario}.png")
           current_image = current_dir.join("#{preview}_#{scenario}.png")
 
-          file.puts "<li>"
+          file.puts '<li>'
           file.puts "<h2>#{preview.titleize} - #{scenario.titleize}</h2>"
           file.puts "<div style='display: flex; gap: 10px;'>"
 
@@ -40,15 +40,15 @@ module LookbookVisualTester
           file.puts "<div><h3>Baseline</h3><img src='#{baseline_image_path.relative_path_from(base_path)}' alt='Baseline'></div>"
           file.puts "<div><h3>Current</h3><img src='#{current_image_path.relative_path_from(base_path)}' alt='Current'></div>"
           file.puts "<div><h3>Diff</h3><img src='#{diff_file_path.relative_path_from(base_path)}' alt='Diff'></div>"
-          file.puts "</div>"
-          file.puts "</li>"
+          file.puts '</div>'
+          file.puts '</li>'
         end
 
-        file.puts "<li>No differences found!</li>" if diff_files.empty?
+        file.puts '<li>No differences found!</li>' if diff_files.empty?
 
-        file.puts "</ul>"
-        file.puts "</body>"
-        file.puts "</html>"
+        file.puts '</ul>'
+        file.puts '</body>'
+        file.puts '</html>'
       end
 
       @report_path

data/lib/lookbook_visual_tester/scenario_finder.rb

@@ -0,0 +1,34 @@
+require 'lookbook_visual_tester/service'
+require 'lookbook_visual_tester/scenario_run'
+
+module LookbookVisualTester
+  class ScenarioFinder < Service
+    attr_reader :fuzze, :search, :previews
+
+    def initialize(search, fuzzy: true, previews: Lookbook.previews)
+      @search = search
+      @fuzzy = fuzzy
+      @previews = previews
+    end
+
+    def regex
+      @regex = Regexp.new(search.chars.join('.*'), Regexp::IGNORECASE)
+    end
+
+    def matched_previews
+      @matched_previews ||= previews.select { |preview| regex.match?(preview.name.downcase) }
+    end
+
+    def call
+      return nil if search.nil? || search == '' || previews.empty?
+
+      previews.each do |preview|
+        preview.scenarios.each do |scenario|
+          return ScenarioRun.new(scenario) if scenario.name.downcase.include?(search.downcase)
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/lookbook_visual_tester/scenario_run.rb

@@ -1,4 +1,4 @@
-require "lookbook_visual_tester/configuration"
+require 'lookbook_visual_tester/configuration'
 
 module LookbookVisualTester
   class ScenarioRun
@@ -19,8 +19,19 @@ module LookbookVisualTester
       scenario.name.underscore
     end
 
+    def name
+      "#{preview_name}_#{scenario_name}"
+    end
+
     def filename
-      "#{preview_name}_#{scenario_name}.png"
+      "#{name}.png"
+    end
+
+    def timestamp_filename
+      @timestamp_filename ||= begin
+        timestamp = Time.now.strftime('%Y%m%d-%H%M%S')
+        "#{name}_#{timestamp}.png"
+      end
     end
 
     def diff_filename
@@ -37,8 +48,8 @@ module LookbookVisualTester
 
     def preview_url
       Lookbook::Engine.routes.url_helpers.lookbook_preview_url(
-        path: preview.lookup_path + "/" + scenario.name,
-        host: LookbookVisualTester.config.host
+        path: preview.lookup_path + '/' + scenario.name,
+        host: LookbookVisualTester.config.lookbook_host
       )
     end
   end

data/lib/lookbook_visual_tester/screenshot_taker.rb

@@ -1,31 +1,31 @@
-require "lookbook_visual_tester/session_manager"
-require "capybara/cuprite"
-require "fileutils"
+require 'lookbook_visual_tester/session_manager'
+require 'lookbook_visual_tester/service'
+
+require 'fileutils'
 
 module LookbookVisualTester
-  class ScreenshotTaker
-    attr_reader :session, :logger
-
-    CLIPBOARD = "clipboard"
-
-    def initialize(logger: Kernel)
-      Capybara.register_driver :cuprite do |app|
-        Capybara::Cuprite::Driver.new(
-          app,
-          window_size: [1400, 1400],
-          browser_options: { "ignore-certificate-errors" => nil },
-          timeout: 20,
-          process_timeout: 20
-        )
-      end
+  class ScreenshotTaker < Service
+    attr_reader :scenario_run, :path, :crop, :logger
+
+    CLIPBOARD = 'clipboard'
 
-      Capybara.default_driver = :cuprite
-      Capybara.default_max_wait_time = 15
-      @session = Capybara::Session.new(:cuprite)
+    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 capture(preview_url, path = CLIPBOARD, crop: true)
+    def session
+      @session ||= SessionManager.instance.session
+    end
+
+    def call
       FileUtils.mkdir_p(File.dirname(path))
 
       session.visit(preview_url)
@@ -40,35 +40,79 @@ module LookbookVisualTester
       #   nil
       # end
       if path == CLIPBOARD
-        save_to_clipboard(crop: crop)
+        print_and_save_to_clipboard
       else
-        save_printscreen(path: path, crop: crop)
+        save_printscreen
       end
       # Additional wait for any JavaScript animations
       sleep 1
     rescue StandardError => e
-      logger.puts "Error capturing screenshot for #{preview_url}: #{e.message}"
+      logger.info "Error capturing screenshot for #{preview_url}: #{e.message}"
       raise e
     end
 
-    private
+    def save_to_clipboard(path = @path)
+      system("xclip -selection clipboard -t image/png -i #{path}")
+    end
 
-    def save_to_clipboard(crop: false)
-      Tempfile.create(["screenshot", ".png"]) do |file|
-        session.save_screenshot(file.path, crop: crop)
+    private
 
-        # Example: Copy to clipboard (Linux xclip)
-        system("xclip -selection clipboard -t image/png -i #{file.path}")
+    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: nil, crop: false)
+    def save_printscreen(path = @path)
       session.save_screenshot(path)
 
-      # remove white space
       system("convert #{path} -trim -bordercolor white -border 10x10 #{path}") if crop
 
-      logger.puts "    Screenshot saved to #{path}"
+      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/service.rb

@@ -0,0 +1,11 @@
+module LookbookVisualTester
+  class Service
+    def self.call(...)
+      new(...).call
+    end
+
+    def call
+      raise NotImplementedError, 'You must implement the call method'
+    end
+  end
+end

data/lib/lookbook_visual_tester/session_manager.rb

@@ -1,7 +1,7 @@
 # Setup Capybara
-require "singleton"
-require "capybara"
-require "capybara/cuprite"
+require 'singleton'
+require 'capybara'
+require 'capybara/cuprite'
 
 module LookbookVisualTester
   class SessionManager

data/lib/lookbook_visual_tester/store.rb

@@ -0,0 +1,45 @@
+module LookbookVisualTester
+  class Store
+    attr_accessor :stored_hash
+
+    HASH_KEY = 'lookbook_visual_tester:stored_hash'
+
+    def initialize
+      @stored_hash = Rails.cache.read(HASH_KEY) || {}
+    end
+
+    def [](key)
+      @stored_hash[key.to_s]
+    end
+
+    def []=(key, value)
+      save(key.to_s, value)
+    end
+
+    def save(key, value)
+      @stored_hash[key.to_s] = value
+      Rails.cache.write(HASH_KEY, @stored_hash)
+    end
+
+    # pretty inspect of the object
+    def inspect
+      "#<#{self.class.name}
+      stored_hash: #{stored_hash}>"
+    end
+
+    class << self
+      def data
+        @data ||= new
+        # @data ||= new
+      end
+
+      def dataset
+        yield(data)
+      end
+    end
+  end
+
+  def self.data
+    @data ||= Store.new
+  end
+end

data/lib/lookbook_visual_tester/update_previews.rb

@@ -1,20 +1,18 @@
-module LookbookVisualTester
-  class UpdatePreviews
-    def self.call(...)
-      new(...).call
-    end
+require_relative 'service'
+require_relative 'screenshot_taker'
 
-    attr_reader :app, :changes
+module LookbookVisualTester
+  class UpdatePreviews < Service
+    attr_reader :changes
 
-    def initialize(app, changes)
-      @app = app
+    def initialize(changes)
       @changes = changes[:modified]
       @changes_hash = changes
     end
 
     def update_app_data
-      app.data.last_changed_files = changes.presence || []
-      app.data.last_changed_previews = previews
+      LookbookVisualTester.data[:last_changed_files] = changes.presence || []
+      LookbookVisualTester.data[:last_changed_previews] = previews
     end
 
     def call
@@ -34,7 +32,7 @@ module LookbookVisualTester
     end
 
     def process_change?(change)
-      change.to_s.downcase.include?("preview.rb") || change.to_s.downcase.match?(/component\.(html|haml|rb|erb)/)
+      change.to_s.downcase.include?('preview.rb') || change.to_s.downcase.match?(/component\.(html|haml|rb|erb)/)
     end
 
     def should_process?
@@ -44,24 +42,24 @@ module LookbookVisualTester
     end
 
     def clean_file_name(file)
-      file.split("/")[-1].split(".")[0]
+      '/' + file.split('/')[-1].split('.')[0]
     end
 
-    def previews
-      @previews ||= Lookbook.previews.select do |preview|
+    def selected_previews
+      @selected_previews ||= Lookbook.previews.select do |preview|
         selected_changes.any? { |file| preview.file_path.to_s.include?(clean_file_name(file)) }
       end
     end
 
     def process_changes
-      Rails.logger.info "LookbookVisualTester: previws #{previews.count}"
-      previews.each do |preview|
+      Rails.logger.info "LookbookVisualTester: previews #{selected_previews.count}"
+      selected_previews.each do |preview|
         Rails.logger.info "LookbookVisualTester: entering #{preview.inspect}"
 
         preview.scenarios.each do |scenario|
           scenario_run = LookbookVisualTester::ScenarioRun.new(scenario)
           Rails.logger.info "LookbookVisualTester: Processing scenario #{scenario_run.inspect}"
-          LookbookVisualTester::ScreenshotTaker.new.capture(scenario_run.preview_url, scenario_run.current_path)
+          LookbookVisualTester::ScreenshotTaker.call(scenario_run:)
         end
       end
     end

data/lib/lookbook_visual_tester/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LookbookVisualTester
-  VERSION = "0.1.4"
+  VERSION = '0.1.5'
 end

data/lib/lookbook_visual_tester.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
+
 # lib/lookbook_visual_tester.rb
 
-require_relative "lookbook_visual_tester/version"
-require_relative "lookbook_visual_tester/railtie" if defined?(Rails)
+require_relative 'lookbook_visual_tester/version'
+require_relative 'lookbook_visual_tester/railtie' if defined?(Rails)
+require 'lookbook_visual_tester/scenario_finder'
+require 'lookbook_visual_tester/store'
 
 module LookbookVisualTester
   class Error < StandardError; end

data/lib/tasks/lookbook_visual_tester.rake

@@ -1,57 +1,50 @@
 # lib/tasks/lookbook_visual_tester.rake
-require "fileutils"
-require "mini_magick"
-require "ruby-prof"
-require "concurrent-ruby"
+require 'fileutils'
+require 'mini_magick'
+require 'ruby-prof'
+require 'concurrent-ruby'
 
-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/report_generator'
+require 'lookbook_visual_tester/screenshot_taker'
+require 'lookbook_visual_tester/image_comparator'
+require 'lookbook_visual_tester/scenario_run'
 
 namespace :lookbook_visual_tester do
-  desc "Profile the lookbook_visual_tester:run task"
+  desc 'Profile the lookbook_visual_tester:run task'
   task profile: :environment do
     RubyProf.start
-    Rake::Task["lookbook_visual_tester:run"].invoke
+    Rake::Task['lookbook_visual_tester:run'].invoke
     result = RubyProf.stop
 
     printer = RubyProf::FlatPrinter.new(result)
     printer.print(STDOUT)
   end
 
-  desc "Run and copy to clipboard first scenario matching the given name"
+  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"]`
 
-    screenshot_taker = LookbookVisualTester::ScreenshotTaker.new
     previews = Lookbook.previews
 
-    regex = Regexp.new(args[:name].chars.join(".*"), Regexp::IGNORECASE)
-    matched_previews = previews.select { |preview| regex.match?(preview.name.underscore) }
-    if matched_previews.empty?
+    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
     end
-    matched_previews.each do |preview|
-      preview.scenarios.each do |scenario|
-        scenario_run = LookbookVisualTester::ScenarioRun.new(scenario)
-        screenshot_taker.capture(scenario_run.preview_url)
-        exit
-      end
-    end
+    screenshot_taker.capture(scenario_run.preview_url)
+    exit
   end
 
-  desc "Run visual regression tests for Lookbook previews"
+  desc 'Run visual regression tests for Lookbook previews'
   task run: :environment do
-    screenshot_taker = LookbookVisualTester::ScreenshotTaker.new
     image_comparator = LookbookVisualTester::ImageComparator.new
     report = LookbookVisualTester::ReportGenerator.new
 
     previews = Lookbook.previews
 
     if previews.empty?
-      puts "No Lookbook previews found."
+      puts 'No Lookbook previews found.'
       exit
     end
 
@@ -63,7 +56,7 @@ namespace :lookbook_visual_tester do
       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}"
 
@@ -78,18 +71,18 @@ namespace :lookbook_visual_tester do
     puts "Visual regression report generated at #{report_path}"
   end
 
-  desc "Update baseline screenshots with current_run screenshots"
+  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")
+    base_path = Rails.root.join('spec/visual_screenshots')
+    baseline_dir = base_path.join('baseline')
+    current_dir = base_path.join('current_run')
 
     unless current_dir.exist?
-      puts "Current run directory does not exist. Run the visual regression tests first."
+      puts 'Current run directory does not exist. Run the visual regression tests first.'
       exit
     end
 
-    Dir.glob(current_dir.join("*.png")).each do |current_file|
+    Dir.glob(current_dir.join('*.png')).each do |current_file|
       filename = File.basename(current_file)
       baseline_file = baseline_dir.join(filename)
       FileUtils.cp(current_file, baseline_file)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lookbook_visual_tester
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Murilo Vasconcelos
 bindir: exe
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -164,15 +164,20 @@ files:
 - CODE_OF_CONDUCT.md
 - README.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/configuration.rb
 - lib/lookbook_visual_tester/image_comparator.rb
 - lib/lookbook_visual_tester/railtie.rb
 - lib/lookbook_visual_tester/report_generator.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/session_manager.rb
+- lib/lookbook_visual_tester/store.rb
 - lib/lookbook_visual_tester/update_previews.rb
 - lib/lookbook_visual_tester/version.rb
 - lib/tasks/lookbook_visual_tester.rake
@@ -183,6 +188,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/muriloime/lookbook_visual_tester
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib