rspec-snapshot 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b55b1aac3c8f7485efb46cf9ae2d62099d074f8c57c41d8a0b649ee6d7040c7f
-  data.tar.gz: 0e6d00759c134fe74c0b627fcbb40757825e959adffdd9ffa3599e68584bc954
+  metadata.gz: c7f958916acb3c3b0baca23b0787d2eba8b8fcc0ec66d48a279c374f50f1a759
+  data.tar.gz: 0d176ce77bb5ec147e1225711844d980fb3827e4dc4424b14e8fe2cfcad90f19
 SHA512:
-  metadata.gz: c2ff25eb3ebc46a01852c4f2147a862cb8d9b94c2277aaadc9d331608d27cf4d0348c74521196c0c36d234827a274533dce1445ac91ba6f8c478d81a5605c59f
-  data.tar.gz: 3bf7ba016e5e47aa87bec679e06e48b0e54cf03f68f67e794bb065f351fdd09f314563e2053dc8d97d5a5d406f57df85cb71206087fda4738d5b7581a7b666b0
+  metadata.gz: 9a6428ba725307cf97400503f5a0dbce9d6678a40ee31781c0435d843e3b915993f965673f6a2aec1a3a32c9a6214a44e8fbd471e93311af0584f749bea46af2
+  data.tar.gz: 0f0410cc159a5c3e394572d52c75335822ed2eec184f50e11ab5d4c314510e89c3c99990cbebf794cbdb78e1c8ecafa7afaf6a811848830ccc1187cfc0ecac99

data/.github/workflows/ci.yml

@@ -1,21 +1,22 @@
 on:
   push:
+  pull_request:
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['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@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+      - 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
     
@@ -24,16 +25,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['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@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+      - 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
+      - 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 'bundler', '~> 4.0'
 gem 'byebug'
+gem 'logger' # Required for Ruby 4.0+ (no longer in stdlib)
 gem 'pry-byebug'
 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

@@ -1,7 +1,9 @@
-# RSpec::Snapshot [![Build Status]!](https://github.com/github/docs/actions/workflows/ci.yml/badge.svg?branch=master)
+# RSpec::Snapshot ![Build Status](https://github.com/levinmr/rspec-snapshot/actions/workflows/ci.yml/badge.svg?branch=master)
 
 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:
@@ -154,12 +156,19 @@ Install a current version of ruby (> 2.5) and bundler. Then install gems
 
     $ bin/console
 
-### Rake commands
+### Installing the gem locally
+
+    $ bundle exec rake install
+
+### Publishing a new gem version
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* Update the version number in `version.rb`
+* Ensure the changes to be published are merged to the master branch
+* Checkout the master branch locally
+* Run `bundle exec rake release`, which will:
+  * create a git tag for the version
+  * push git commits and tags
+  * push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

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

@@ -13,8 +13,8 @@ module RSpec
       # @param [Hash] metadata The RSpec metadata for the current test.
       def initialize(snapshot_name, metadata)
         snapshot_dir = snapshot_dir(metadata)
-        create_snapshot_dir(snapshot_dir)
         @snapshot_path = File.join(snapshot_dir, "#{snapshot_name}.snap")
+        create_snapshot_dir(@snapshot_path)
       end
 
       private def snapshot_dir(metadata)
@@ -26,7 +26,9 @@ module RSpec
       end
 
       private def create_snapshot_dir(snapshot_dir)
-        FileUtils.mkdir_p(snapshot_dir)
+        return if Dir.exist?(File.dirname(snapshot_dir))
+
+        FileUtils.mkdir_p(File.dirname(snapshot_dir))
       end
 
       # @return [String] The snapshot file contents.

data/lib/rspec/snapshot/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Snapshot
-    VERSION = '2.0.2'
+    VERSION = '2.1.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', '~> 1.6'
   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.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Mike Levin
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-15 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: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.6'
 - !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: []