capybara-screenshot-diff 1.15.0 → 2.0.0.alpha1

data/lib/snap_diff/vcs.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "open3"
+require_relative "os"
+
+module SnapDiff
+  module Vcs
+    def self.checkout_vcs(root, screenshot_path, checkout_path)
+      root_path = root.to_s
+      git_root, _, status = Open3.capture3("git", "-C", root_path, "rev-parse", "--show-toplevel")
+      return false unless status.success?
+
+      git_root = git_root.chomp
+      vcs_file_path = Pathname.new(screenshot_path).expand_path.relative_path_from(Pathname.new(git_root)).to_s
+
+      if Capybara::Screenshot.use_lfs
+        tmp_path = "#{checkout_path}.tmp"
+        success = system("git", "-C", root_path, "show", "HEAD:#{vcs_file_path}", out: tmp_path, err: File::NULL)
+        if success
+          system("git", "-C", root_path, "lfs", "smudge", in: tmp_path, out: checkout_path.to_s, err: File::NULL)
+        end
+        File.delete(tmp_path) if File.exist?(tmp_path)
+      else
+        success = system("git", "-C", root_path, "show", "HEAD:#{vcs_file_path}", out: checkout_path.to_s, err: File::NULL)
+      end
+
+      unless success
+        checkout_path.delete if checkout_path.exist?
+        return false
+      end
+
+      true
+    end
+  end
+end

data/lib/snap_diff/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SnapDiff
+  VERSION = "2.0.0.alpha1"
+end

data/lib/snap_diff.rb

@@ -1,16 +1,32 @@
 # frozen_string_literal: true
 
-require "capybara_screenshot_diff"
+# None of these requires ever leads back to this file: config_legacy is a
+# leaf (see its own header comment), the image_compare forwarder pulls in
+# snap_diff/comparison plus the legacy const_missing shims, and
+# "capybara/dsl" is the base gem. That keeps this file's require graph
+# acyclic -- it never requires "capybara_screenshot_diff" back, unlike the
+# old autoload-based wiring this replaced. The forwarder path (not
+# "snap_diff/comparison" directly) is deliberate: it installs
+# snap_diff/legacy_shims, so the old Capybara::Screenshot::Diff constants
+# stay resolvable (now with deprecation warnings) even in processes that
+# only ever require "snap_diff".
+# "capybara/dsl" is needed directly (not just transitively) so
+# `Capybara.default_max_wait_time` in Diff.default_options resolves even
+# when "snap_diff" is required standalone (SnapDiffTest's
+# "standalone-loadable in a fresh process" regression test).
+require "capybara/dsl"
+require "capybara/screenshot/diff/config_legacy"
+require "capybara/screenshot/diff/image_compare"
 require "snap_diff/config"
 
 # Forward-looking namespace for the gem, per ADR-004.
 #
-# These are pure additive aliases onto the existing
-# +Capybara::Screenshot::Diff+ API — no behavior changes, no deprecation
-# warnings. See ADR-004 for the full migration plan.
+# Since v2 step 5 the comparison implementation lives here
+# ({SnapDiff::Comparison}, {SnapDiff::ComparisonResult}); since step 6 the
+# old +Capybara::Screenshot::Diff+ constants are same-object const_missing
+# shims (snap_diff/legacy_shims) that emit a deprecation warning once per
+# constant per process. See ADR-004 for the full migration plan.
 module SnapDiff
-  Comparison = Capybara::Screenshot::Diff::ImageCompare
-
   def self.compare(...)
     Capybara::Screenshot::Diff.compare(...)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 2.0.0.alpha1
 platform: ruby
 authors:
 - Uwe Kubosch
@@ -101,6 +101,7 @@ files:
 - lib/capybara/screenshot/diff/annotation_service.rb
 - lib/capybara/screenshot/diff/area_calculator.rb
 - lib/capybara/screenshot/diff/browser_helpers.rb
+- lib/capybara/screenshot/diff/config_legacy.rb
 - lib/capybara/screenshot/diff/cucumber.rb
 - lib/capybara/screenshot/diff/difference.rb
 - lib/capybara/screenshot/diff/drivers.rb
@@ -125,7 +126,6 @@ files:
 - lib/capybara_screenshot_diff/error_with_filtered_backtrace.rb
 - lib/capybara_screenshot_diff/minitest.rb
 - lib/capybara_screenshot_diff/reporters/html.rb
-- lib/capybara_screenshot_diff/reporters/templates/report.html.erb
 - lib/capybara_screenshot_diff/rspec.rb
 - lib/capybara_screenshot_diff/screenshot_assertion.rb
 - lib/capybara_screenshot_diff/screenshot_namer.rb
@@ -133,7 +133,41 @@ files:
 - lib/capybara_screenshot_diff/snap_manager.rb
 - lib/capybara_screenshot_diff/static.rb
 - lib/snap_diff.rb
+- lib/snap_diff/annotation_service.rb
+- lib/snap_diff/area_calculator.rb
+- lib/snap_diff/attempts_reporter.rb
+- lib/snap_diff/browser_helpers.rb
+- lib/snap_diff/capture/viewport.rb
+- lib/snap_diff/comparison.rb
+- lib/snap_diff/comparison_result.rb
 - lib/snap_diff/config.rb
+- lib/snap_diff/deprecation.rb
+- lib/snap_diff/driver.rb
+- lib/snap_diff/drivers.rb
+- lib/snap_diff/drivers/chunky_png_driver.rb
+- lib/snap_diff/drivers/vips_driver.rb
+- lib/snap_diff/dsl.rb
+- lib/snap_diff/error_with_filtered_backtrace.rb
+- lib/snap_diff/image_preprocessor.rb
+- lib/snap_diff/integrations/cucumber.rb
+- lib/snap_diff/integrations/minitest.rb
+- lib/snap_diff/integrations/rspec.rb
+- lib/snap_diff/legacy_shims.rb
+- lib/snap_diff/os.rb
+- lib/snap_diff/reporters/html.rb
+- lib/snap_diff/reporters/templates/report.html.erb
+- lib/snap_diff/reporting.rb
+- lib/snap_diff/screenshot_assertion.rb
+- lib/snap_diff/screenshot_matcher.rb
+- lib/snap_diff/screenshot_namer.rb
+- lib/snap_diff/screenshoter.rb
+- lib/snap_diff/snap.rb
+- lib/snap_diff/snap_manager.rb
+- lib/snap_diff/stable_screenshoter.rb
+- lib/snap_diff/static.rb
+- lib/snap_diff/utils.rb
+- lib/snap_diff/vcs.rb
+- lib/snap_diff/version.rb
 homepage: https://github.com/snap-diff/snap_diff-capybara
 licenses:
 - MIT