capybara-screenshot-diff 1.10.3.1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b731cca6ca98b0d7a9a6c1cb9db02de35b6898cecbb28aba568b8ae773ae0ff
-  data.tar.gz: d42ae0a773e80fdd6aaf9ae7c6e2b5106131998c650338d24c20f9bc48d90602
+  metadata.gz: 5d2139e98f2c24b265a13882b8faf30282f5ef519dcbb77907f5d69d8f565606
+  data.tar.gz: 9302c796f95734c4ec4383f926c0aad03630caed8505f1d8fc815fe11bdb3c61
 SHA512:
-  metadata.gz: 50bf2196f84506387c16aca897d98e9a5ea4ef9dc1b10216c2473566b001b362afffb1834a843cbdcf83bb35ca33713432dad86bf73cb0cb2a078e3cf2c89e68
-  data.tar.gz: 69abf40070444fb6a3f2d2d250cb529cdcae957d3c6eefb55ff7e740964f5eae12556ab76b43ccdd9c4b0e14d00366997a7fe4032597bcf41b1a95aeb34471c9
+  metadata.gz: b072316d36fe69af44d3f318ba2d24968e9e0b377f85842c9a21d29aeb4ae7375a6b5b02c4842c9f3d9eb3115ed4fbcc33edff6c3b74b8ce788069d2301da95a
+  data.tar.gz: 30389f03f593e74c888a2d9de77717f1c839ad8ce41539ef0e6633b5dcff609ed546d7ed5279b3ab7ac9c86c53ed6608872e5b28a70663c7c2aef7c0974fcdf5

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v1.13.0] - 2026-08-22
+
+### Added
+- **`capture_screenshot` DSL method** — take a screenshot without ever comparing or asserting ([#191](https://github.com/snap-diff/snap_diff-capybara/issues/191))
+- **`compare:` option on `screenshot`** — pass `compare: true` (default) to assert, or `compare: false` to capture only ([#191](https://github.com/snap-diff/snap_diff-capybara/issues/191))
+- **`Capybara::Screenshot::Diff.pending_if_new` config** — mark tests as skipped in teardown when a baseline does not exist, complementing `fail_if_new` ([#191](https://github.com/snap-diff/snap_diff-capybara/issues/191))
+
+### Changed
+- **`assert_matches_screenshot` is now the primary assertion method** — captures a screenshot and compares against baseline ([#191](https://github.com/snap-diff/snap_diff-capybara/issues/191))
+- **`screenshot` is now a convenience wrapper** — safe to override in user test classes; the gem no longer calls it internally ([#191](https://github.com/snap-diff/snap_diff-capybara/issues/191))
+
+---
+
+## [v1.12.0] - 2026-04-12
+
+### Added
+- **HTML reporter** — interactive dashboard with 4 comparison modes (both/base/new/heatmap), per-image zoom, keyboard navigation, and search ([#170](https://github.com/snap-diff/snap_diff-capybara/pull/170))
+- **GitHub Actions integration** — inline HTML preview with base64 embedded images + reusable composite action ([#171](https://github.com/snap-diff/snap_diff-capybara/pull/171))
+- **`disable_animations` helper** — inject CSS to stop all animations/transitions during screenshots ([#174](https://github.com/snap-diff/snap_diff-capybara/pull/174))
+- **`snap_diff:clean` rake task** — remove diff artifacts while keeping baselines ([#177](https://github.com/snap-diff/snap_diff-capybara/pull/177))
+- `Diff.compare` for standalone image comparison without Capybara or browser
+- Perceptual color distance (dE00) for anti-aliasing tolerance in VipsDriver
+- `assert_no_screenshot_changes` DSL assertion
+- `Diff.configure` block helper for simplified configuration
+- Ruby 3.5 and 4.0 support
+
+### Changed
+- `blur_active_element` now defaults to `true` — prevents cursor blinking artifacts
+- `hide_caret` now defaults to `true` — stable screenshots without caret
+- `fail_if_new` now defaults to `true` in CI (when `ENV['CI']` is set)
+- Thread-safe reporter notification with mutex ([#175](https://github.com/snap-diff/snap_diff-capybara/pull/175))
+
+### Removed
+- **SVN support** — Git only
+- **ActiveSupport runtime dependency** — pure Ruby, lighter installations
+
+### Fixed
+- VCS path resolution rewritten for thread safety (Open3 + array-form system)
+- Reporter diff artifacts cleaned up properly on `Snap#delete!` ([#173](https://github.com/snap-diff/snap_diff-capybara/pull/173))
+- RSpec matcher now provides `failure_message` and description
+- Missing baseline error includes recording instructions
+- Ruby 4.0 DSLStub ordering compatibility
+- ChunkyPNG `filter_image_with_median` incorrect behavior
+- Tolerance calculation no longer skips large changes
+
+### Performance
+- ChunkyPNG shift-detection: eliminated array allocations (~30% faster for large images)
+- VIPS: cached computations at construction (~15% faster)
+- Memoized region area size, replaced closures with blocks
+
+### Documentation
+- README restructured from 970 to 149 lines with 7 dedicated `docs/` files ([#171](https://github.com/snap-diff/snap_diff-capybara/pull/171))
+- CI integration guide with artifact upload and PR commenting ([docs/ci-integration.md](docs/ci-integration.md))
+- Upgrade guide ([docs/UPGRADING.md](docs/UPGRADING.md))
+- Color comparison guide — tolerance vs perceptual_threshold vs color_distance_limit ([#176](https://github.com/snap-diff/snap_diff-capybara/pull/176))
+
+### Internal
+- Simplified internals: inlined CaptureStrategy, ComparisonLoader, ScreenshotNamerDSL, VipsUtil
+- Unified Screenshoter constructors, consolidated skip_area accessor
+- Upgraded CI dependencies (actions/checkout v5, upload-artifact v7)
+
+---
+
+## [v1.11.0] - Previous Release
+
+[Unreleased]: https://github.com/snap-diff/snap_diff-capybara/compare/v1.12.0...HEAD
+[v1.12.0]: https://github.com/snap-diff/snap_diff-capybara/releases/tag/v1.12.0
+[v1.11.0]: https://github.com/snap-diff/snap_diff-capybara/releases/tag/v1.11.0
+
+**Upgrade Guide:** See [docs/UPGRADING.md](docs/UPGRADING.md) for detailed migration instructions.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by
+[opening a GitHub Issue](https://github.com/snap-diff/snap_diff-capybara/issues).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact:** Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence:** A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact:** A violation through a single incident or series
+of actions.
+
+**Consequence:** A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact:** A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence:** A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact:** Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence:** A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Rakefile

@@ -11,14 +11,42 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+Rake::TestTask.new("test:unit") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/unit/**/*_test.rb"]
+end
+
 Rake::TestTask.new("test:integration") do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/integration/**/*_test.rb"]
 end
 
+desc "Run all tests with coverage"
+task :coverage do
+  ENV["COVERAGE"] = "true"
+  Rake::Task["test"].invoke
+end
+
+desc "Generate sample HTML report. Use bin/rake 'report:sample[embed]' for base64 images"
+task "report:sample", [:embed] do |_t, args|
+  embed_arg = args[:embed] ? "--embed" : ""
+  ruby "scripts/generate_sample_report.rb #{embed_arg}"
+end
+
+desc "Remove screenshot diff artifacts (keeps baselines)"
+task "snap_diff:clean" do
+  patterns = ["**/*.diff.png", "**/*.base.png", "**/*.base.diff.png", "**/*.heatmap.diff.png",
+    "**/*.diff.webp", "**/*.base.webp", "**/*.base.diff.webp", "**/*.heatmap.diff.webp",
+    "**/snap_diff_report.html"]
+  removed = patterns.flat_map { |p| Dir.glob("tmp/#{p}") + Dir.glob("doc/screenshots/#{p}") }.uniq
+  removed.each { |f| FileUtils.rm_f(f) }
+  puts "Removed #{removed.size} diff artifacts"
+end
+
 task "clobber" do
-  puts "Cleanup tmp/*.png"
+  puts "Cleanup tmp/"
   FileUtils.rm_rf(Dir["./tmp/*"])
 end
 

data/capybara-screenshot-diff.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.email = ["uwe@kubosch.no"]
   spec.summary = "Track your GUI changes with diff assertions"
   spec.description = "Save screen shots and track changes with graphical diff"
-  spec.homepage = "https://github.com/donv/capybara-screenshot-diff"
-  spec.required_ruby_version = ">= 3.1"
+  spec.homepage = "https://github.com/snap-diff/snap_diff-capybara"
+  spec.required_ruby_version = ">= 3.2"
   spec.license = "MIT"
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "actionpack", ">= 7.0", "< 9"
+  spec.add_development_dependency "actionpack", ">= 7.1", "< 9"
+  spec.add_development_dependency "activesupport", ">= 7.1", "< 9"
   spec.add_runtime_dependency "capybara", ">= 2", "< 4"
 end

data/docs/RELEASE_PREP.md

@@ -0,0 +1,42 @@
+# Release Preparation — v1.13.0
+
+## Summary
+
+Issue #191 API decoupling: `assert_matches_screenshot` becomes the primary
+assertion method, plus a capture-only API and opt-in pending-instead-of-pass
+for missing baselines.
+
+## Release Checklist
+
+### Pre-Release
+
+- [x] Update version to `1.13.0`
+- [x] Run tests: `bundle exec rake test:unit` (235 runs, 0 failures)
+- [x] Update CHANGELOG.md
+
+### Release (One Click)
+
+1. Push to GitHub
+2. Go to [Actions → Release](https://github.com/snap-diff/snap_diff-capybara/actions/workflows/release.yml)
+3. Click **Run workflow**, enter `1.13.0`
+4. Workflow will: test → tag → publish to RubyGems → create GitHub Release
+
+### Post-Release
+
+- [ ] Verify on [RubyGems](https://rubygems.org/gems/capybara-screenshot-diff)
+- [ ] Verify GitHub Release created
+
+## What Changed
+
+### New Features
+- `capture_screenshot` DSL method — capture without comparing or asserting
+- `compare:` option on `screenshot` — `compare: false` captures only
+- `Capybara::Screenshot::Diff.pending_if_new` — mark tests skipped in teardown
+  when a screenshot has no committed baseline (Minitest, RSpec, and Cucumber)
+
+### Behavior Changes
+- `assert_matches_screenshot` is now the primary assertion method; `screenshot`
+  remains as a convenience wrapper and is safe to override in user test classes —
+  the gem no longer calls it internally ([#191](https://github.com/snap-diff/snap_diff-capybara/issues/191))
+
+See [CHANGELOG.md](../CHANGELOG.md) for full details.