rspec-snapshot 2.0.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4668f539ce7c95d76e77eab406e9b7dd1a8a5cf50265b60309b8da6d3c2564a1
-  data.tar.gz: ecf7a28db05aa850e7fec2b413e9b13dfe9c917eee5747c68fb22eab3bf10471
+  metadata.gz: 300d9d55d1e789613b7f7948165e3b0b831b8b9e3489a2d28920d47a3b7d8e59
+  data.tar.gz: 6faa6c0db5d1f18faaa557fe86416219f976566e7b8d0060216db147bba9ebcd
 SHA512:
-  metadata.gz: 5fa621abf5030844e59efe1e5b3c2846debaaf9905bc4506c5d4be6481e9f549b3b4df84365867e2ba7c021fcc56d3262f374c9d0fcd5cc2f0d53d7e4ed925d9
-  data.tar.gz: 2b8425fad9b2f564d05b1d9ffbce831368d279321ccfb8747e25fce6f4c4e45a2e7ce44c79ab9b4ca803a4a20c8438f6e2c3d44555b458cb65789cda0fd1570d
+  metadata.gz: 14103a7f7c20ca7d42802ed7e29abb4981056aa0f97a7d0e4c5bc295d485c62bbef807acb0f3519b39e0fcab87fd8046c7382f35dedfc127b94802c5f79a0060
+  data.tar.gz: ecc8dcdbea6e13263ef9641ca0b0c269f649d8c56776711d5a09acee0f30e09529c9e4c0a45caf52bb2fc57e5b5cb69d1636a931627581b11302294baeeacad8

data/.github/workflows/ci.yml

@@ -7,16 +7,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7']
+        ruby-version: ['4.0', '3.4', '3.3']
     defaults:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@360dc864d5da99d54fcb8e9148c14a84b90d3e88
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: ruby/setup-ruby@ba696adf55506673e48342a66e30f1f53cadeae0
         with:
           ruby-version: ${{ matrix.ruby-version }}
-      - run: gem install bundler:2.4.22
+      - run: gem install bundler:4.0.9
       - run: bundle install
       - run: bundle exec rubocop
     
@@ -25,16 +25,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7']
+        ruby-version: ['4.0', '3.4', '3.3']
     defaults:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@360dc864d5da99d54fcb8e9148c14a84b90d3e88
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: ruby/setup-ruby@ba696adf55506673e48342a66e30f1f53cadeae0
         with:
           ruby-version: ${{ matrix.ruby-version }}
-      - run: gem install bundler:2.4.22
+      - run: gem install bundler:4.0.9
       - run: bundle install
       - run: cat Gemfile.lock
       - run: bundle exec rspec

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 
@@ -9,7 +9,7 @@ AllCops:
     - "Rakefile"
     - "bin/**/*"
     - "spec/fixtures/**/*"
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.3
 
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
@@ -42,10 +42,14 @@ RSpec/ContextWording:
     - and
 RSpec/ExampleLength:
   Enabled: true
-  Max: 10
+  Max: 15 # Increased for integration tests
 RSpec/ExpectInHook:
+  Enabled: false # Disabled to allow expect in setup for integration tests
+RSpec/ExpectInLet:
+  Enabled: false # Disabled to balance style guidelines with testing ease
+RSpec/SpecFilePathFormat:
   Enabled: true
-RSpec/FilePath:
+RSpec/SpecFilePathSuffix:
   Enabled: true
 RSpec/InstanceVariable:
   Enabled: true
@@ -56,7 +60,7 @@ RSpec/LetSetup:
 RSpec/MessageSpies:
   Enabled: true
 RSpec/MultipleExpectations:
-  Enabled: true
+  Max: 5 # Increased for integration tests that verify multiple aspects
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
 RSpec/NamedSubject:

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.4.2

data/Gemfile

@@ -4,11 +4,12 @@ source 'https://rubygems.org'
 gemspec
 
 # Development dependencies
-gem 'bundler', '~> 2.3'
-gem 'byebug'
-gem 'pry-byebug'
+gem 'bundler', '~> 4.0'
+gem 'byebug', '~> 13.0'
+gem 'logger' # Required for Ruby 4.0+ (no longer in stdlib)
+gem 'pry-byebug', '~> 3.12'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.59'
-gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec', '~> 2.16'
-gem 'simplecov'
+gem 'rubocop', '~> 1.86'
+gem 'rubocop-rake', '~> 0.6'
+gem 'rubocop-rspec', '~> 3.0'
+gem 'simplecov'

data/MIGRATION_GUIDE.md

@@ -0,0 +1,77 @@
+# Migration Guide: awesome_print to amazing_print
+
+## Overview
+
+Starting with version 2.1.0, rspec-snapshot has migrated from `awesome_print` to `amazing_print`. The `amazing_print` gem is an actively maintained fork of `awesome_print`, which is no longer maintained.
+
+## Backward Compatibility
+
+**Good news!** You do **NOT** need to update your existing snapshots. The gem defaults to the classic hash syntax (`:foo => value`) for backward compatibility with existing snapshots created using `awesome_print`.
+
+## Configuration Options
+
+### Classic Syntax (Default)
+
+By default, the gem uses classic hash rocket syntax to maintain compatibility with existing snapshots:
+
+```ruby
+{
+  :foo => {
+    :bar => [
+      [0] 1,
+      [1] 2,
+      [2] 3
+    ]
+  },
+  :baz => true
+}
+```
+
+This is the default behavior - no configuration needed.
+
+### Modern Syntax (Optional)
+
+If you want to use the modern Ruby 2.0+ hash syntax in your snapshots, you can opt-in by configuring RSpec:
+
+```ruby
+RSpec.configure do |config|
+  config.snapshot_hash_syntax = :modern
+end
+```
+
+This will produce:
+
+```ruby
+{
+  foo: {
+    bar: [
+      [0] 1,
+      [1] 2,
+      [2] 3
+    ]
+  },
+  baz: true
+}
+```
+
+**Note:** If you switch to modern syntax, you'll need to regenerate all your snapshots:
+
+```bash
+UPDATE_SNAPSHOTS=true bundle exec rspec
+```
+
+## For New Projects
+
+New projects can choose either syntax style. We recommend using `:modern` syntax for new projects as it's more consistent with modern Ruby code style.
+
+## Gem Compatibility
+
+The gem will work with either `amazing_print` or `awesome_print`:
+
+- If `amazing_print` is available, it will be used
+- If only `awesome_print` is available, it will fall back to that
+- The gem automatically handles the syntax conversion based on your configuration
+
+## Questions?
+
+If you have any issues with the migration, please open an issue on GitHub.

data/README.md

@@ -2,6 +2,8 @@
 
 Adds snapshot testing to RSpec, inspired by [Jest](https://jestjs.io/).
 
+**This project is looking for a new maintainer, create an issue in the repo if you are interested.**
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/rspec/snapshot/configuration.rb

@@ -8,6 +8,11 @@ module RSpec
         config.add_setting :snapshot_dir, default: :relative
 
         config.add_setting :snapshot_serializer, default: nil
+
+        # Hash syntax style for serialized output
+        # :classic uses hash rockets (:foo => value) for backward compatibility
+        # :modern uses Ruby 2.0+ syntax (foo: value)
+        config.add_setting :snapshot_hash_syntax, default: :classic
       end
     end
 

data/lib/rspec/snapshot/default_serializer.rb

@@ -1,16 +1,43 @@
 # frozen_string_literal: true
 
-require 'awesome_print'
+begin
+  require 'amazing_print'
+  PRINT_GEM = :amazing_print
+rescue LoadError
+  require 'awesome_print'
+  PRINT_GEM = :awesome_print
+end
 
 module RSpec
   module Snapshot
     # Serializes values in a human readable way for snapshots using the
-    # awesome_print gem
+    # amazing_print gem (or awesome_print for backward compatibility)
     class DefaultSerializer
       # @param [*] value The value to serialize.
       # @return [String] The serialized value.
       def dump(value)
-        value.ai(plain: true, indent: 2)
+        output = value.ai(plain: true, indent: 2)
+
+        # Convert modern syntax to classic syntax for backward compatibility
+        if use_classic_syntax? && PRINT_GEM == :amazing_print
+          output = convert_to_classic_syntax(output)
+        end
+
+        output
+      end
+
+      private
+
+      def use_classic_syntax?
+        RSpec.configuration.snapshot_hash_syntax == :classic
+      end
+
+      # Converts modern Ruby hash syntax (foo:) to classic syntax (:foo =>)
+      # for backward compatibility with existing snapshots
+      def convert_to_classic_syntax(output)
+        # Match lines with symbol keys in modern syntax
+        # e.g., "  foo: {" becomes "  :foo => {"
+        output.gsub(/^(\s+)(\w+):(\s)/, '\1:\2 =>\3')
       end
     end
   end

data/lib/rspec/snapshot/file_operator.rb

@@ -6,6 +6,8 @@ module RSpec
   module Snapshot
     # Handles File IO for snapshots
     class FileOperator
+      attr_reader :snapshot_path
+
       # Initializes the class instance, and creates the snapshot directory for
       # the current test if needed.
       #

data/lib/rspec/snapshot/matchers/match_snapshot.rb

@@ -48,7 +48,7 @@ module RSpec
         end
 
         def description
-          "to match a snapshot containing: \"#{@expected}\""
+          "to match a snapshot: '#{@file_operator.snapshot_path}'"
         end
 
         def diffable?

data/lib/rspec/snapshot/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Snapshot
-    VERSION = '2.0.3'
+    VERSION = '2.2.0'
   end
 end

data/rspec-snapshot.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 3.3.0'
 
-  spec.add_dependency 'awesome_print', '> 1.0.0'
+  spec.add_dependency 'amazing_print', '~> 2.0'
   spec.add_dependency 'rspec', '> 3.0.0'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rspec-snapshot
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Mike Levin
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2026-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +52,7 @@ files:
 - ".ruby-version"
 - Gemfile
 - LICENSE.md
+- MIGRATION_GUIDE.md
 - README.md
 - Rakefile
 - bin/console
@@ -70,7 +70,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,15 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RSpec Snapshot Matcher
 test_files: []