snap_diff-capybara 0.0.1 → 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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# 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.
+#
+# 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
+  def self.compare(...)
+    Capybara::Screenshot::Diff.compare(...)
+  end
+
+  # v1-style configuration: yields the two existing mattr_accessor holders
+  # (+Capybara::Screenshot+, +Capybara::Screenshot::Diff+) exactly as
+  # +Capybara::Screenshot::Diff.configure+ always has. Kept byte-for-byte
+  # identical to +Diff.configure+ for existing callers migrating namespaces
+  # without changing call shape.
+  #
+  #   SnapDiff.start do |screenshot, diff|
+  #     screenshot.window_size = [1280, 1024]
+  #     diff.tolerance = 0.0005
+  #   end
+  def self.start(&block)
+    Capybara::Screenshot::Diff.configure(&block)
+  end
+
+  # Forward-looking configuration: yields the single consolidated
+  # {SnapDiff::Config} object instead of the two old holders. Same
+  # underlying storage as +start+ / the old mattr_accessors -- this is a
+  # different *shape* of the same settings, not a second source of truth.
+  #
+  #   SnapDiff.configure do |config|
+  #     config.window_size = [1280, 1024]
+  #     config.tolerance = 0.0005
+  #   end
+  def self.configure
+    yield config
+  end
+
+  # The single consolidated settings object. See {SnapDiff::Config}.
+  def self.config
+    @config ||= Config.new
+  end
+end

metadata

@@ -1,28 +1,178 @@
 --- !ruby/object:Gem::Specification
 name: snap_diff-capybara
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 2.0.0.alpha1
 platform: ruby
 authors:
 - Uwe Kubosch
-- Paul Keen
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: Name reservation matching the GitHub repository snap-diff/snap_diff-capybara.
-  Today this library ships as the capybara-screenshot-diff gem, which already exposes
-  the SnapDiff namespace.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Save screen shots and track changes with graphical diff
+email:
+- uwe@kubosch.no
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- Rakefile
+- capybara-screenshot-diff.gemspec
+- docs/RELEASE_PREP.md
+- docs/UPGRADING.md
+- docs/architecture.md
+- docs/ci-integration.md
+- docs/configuration.md
+- docs/docker-testing.md
+- docs/drivers.md
+- docs/framework-setup.md
+- docs/images/snap_diff_annotated.png
+- docs/images/snap_diff_web_ui.png
+- docs/migration-guide.md
+- docs/organization.md
+- docs/reporters.md
+- docs/thread_safety.md
+- gems.rb
+- lib/capybara-screenshot-diff.rb
+- lib/capybara/screenshot/diff.rb
+- 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
+- lib/capybara/screenshot/diff/drivers/base_driver.rb
+- lib/capybara/screenshot/diff/drivers/chunky_png_driver.rb
+- lib/capybara/screenshot/diff/drivers/vips_driver.rb
+- lib/capybara/screenshot/diff/image_compare.rb
+- lib/capybara/screenshot/diff/image_preprocessor.rb
+- lib/capybara/screenshot/diff/os.rb
+- lib/capybara/screenshot/diff/region.rb
+- lib/capybara/screenshot/diff/reporters/default.rb
+- lib/capybara/screenshot/diff/screenshot_matcher.rb
+- lib/capybara/screenshot/diff/screenshoter.rb
+- lib/capybara/screenshot/diff/stable_screenshoter.rb
+- lib/capybara/screenshot/diff/utils.rb
+- lib/capybara/screenshot/diff/vcs.rb
+- lib/capybara/screenshot/diff/version.rb
+- lib/capybara_screenshot_diff.rb
+- lib/capybara_screenshot_diff/attempts_reporter.rb
+- lib/capybara_screenshot_diff/cucumber.rb
+- lib/capybara_screenshot_diff/dsl.rb
+- 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/rspec.rb
+- lib/capybara_screenshot_diff/screenshot_assertion.rb
+- lib/capybara_screenshot_diff/screenshot_namer.rb
+- lib/capybara_screenshot_diff/snap.rb
+- 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
 metadata:
-  allowed_push_host: https://rubygems.org
+  allowed_push_host: https://rubygems.org/
 rdoc_options: []
 require_paths:
 - lib
@@ -39,5 +189,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.16
 specification_version: 4
-summary: 'Reserved: future home of the SnapDiff Capybara integration'
+summary: Track your GUI changes with diff assertions
 test_files: []

data/README.md

@@ -1,3 +0,0 @@
-# snap_diff-capybara
-
-Name reservation matching [snap-diff/snap_diff-capybara](https://github.com/snap-diff/snap_diff-capybara). Install [capybara-screenshot-diff](https://rubygems.org/gems/capybara-screenshot-diff), which already provides the `SnapDiff` namespace.