rspec-snapshot 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '099c9c3b45ca0936bb35a90dc10263dc0634cfbf307e32eab60eb6154cd0d94c'
-  data.tar.gz: 862c34e9f5693afe80ca9384048d03d67e78a6e09300b1906a1e8c929315b263
+  metadata.gz: 4668f539ce7c95d76e77eab406e9b7dd1a8a5cf50265b60309b8da6d3c2564a1
+  data.tar.gz: ecf7a28db05aa850e7fec2b413e9b13dfe9c917eee5747c68fb22eab3bf10471
 SHA512:
-  metadata.gz: a25332c1f83a33d982f16fdf31284d68800db12c1f49a08320e3eca1515a614bd7ba1cb0a5028953d8d32c0cade632c8970a86d1c9fdf941c9b41c9d71476c55
-  data.tar.gz: 3c952f9f7da76ac1c464a9e35c69e8b280e09aa6066c9e763eba97e4ad7b4ded481516b68bdbecf35d235010a51e832a15955538e56d02d355c84299c4e42409
+  metadata.gz: 5fa621abf5030844e59efe1e5b3c2846debaaf9905bc4506c5d4be6481e9f549b3b4df84365867e2ba7c021fcc56d3262f374c9d0fcd5cc2f0d53d7e4ed925d9
+  data.tar.gz: 2b8425fad9b2f564d05b1d9ffbce831368d279321ccfb8747e25fce6f4c4e45a2e7ce44c79ab9b4ca803a4a20c8438f6e2c3d44555b458cb65789cda0fd1570d

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7']
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@360dc864d5da99d54fcb8e9148c14a84b90d3e88
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - run: gem install bundler:2.4.22
+      - run: bundle install
+      - run: bundle exec rubocop
+    
+  test:
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7']
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@360dc864d5da99d54fcb8e9148c14a84b90d3e88
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - run: gem install bundler:2.4.22
+      - run: bundle install
+      - run: cat Gemfile.lock
+      - run: bundle exec rspec

data/.rubocop.yml

@@ -1,4 +1,5 @@
 require:
+  - rubocop-rake
   - rubocop-rspec
 
 AllCops:
@@ -47,7 +48,7 @@ RSpec/ExpectInHook:
 RSpec/FilePath:
   Enabled: true
 RSpec/InstanceVariable:
-  Enabled: false
+  Enabled: true
 RSpec/LeakyConstantDeclaration:
   Enabled: true
 RSpec/LetSetup:

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+3.2.2

data/Gemfile

@@ -2,3 +2,13 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-snapshot.gemspec
 gemspec
+
+# Development dependencies
+gem 'bundler', '~> 2.3'
+gem 'byebug'
+gem 'pry-byebug'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.59'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.16'
+gem 'simplecov'

data/README.md

@@ -1,4 +1,4 @@
-# RSpec::Snapshot [![Build Status](https://travis-ci.com/levinmr/rspec-snapshot.svg?branch=master)](https://travis-ci.com/levinmr/rspec-snapshot)
+# 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/).
 
@@ -154,12 +154,19 @@ Install a current version of ruby (> 2.5) and bundler. Then install gems
 
     $ bin/console
 
-### Rake commands
+### Installing the gem locally
 
-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).
+    $ bundle exec rake install
+
+### Publishing a new gem version
+
+* 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/default_serializer.rb

@@ -7,6 +7,8 @@ module RSpec
     # Serializes values in a human readable way for snapshots using the
     # awesome_print gem
     class DefaultSerializer
+      # @param [*] value The value to serialize.
+      # @return [String] The serialized value.
       def dump(value)
         value.ai(plain: true, indent: 2)
       end

data/lib/rspec/snapshot/file_operator.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module RSpec
+  module Snapshot
+    # Handles File IO for snapshots
+    class FileOperator
+      # Initializes the class instance, and creates the snapshot directory for
+      # the current test if needed.
+      #
+      # @param [String] snapshot_name The name of the snapshot to read/write.
+      # @param [Hash] metadata The RSpec metadata for the current test.
+      def initialize(snapshot_name, metadata)
+        snapshot_dir = snapshot_dir(metadata)
+        @snapshot_path = File.join(snapshot_dir, "#{snapshot_name}.snap")
+        create_snapshot_dir(@snapshot_path)
+      end
+
+      private def snapshot_dir(metadata)
+        if RSpec.configuration.snapshot_dir == :relative
+          File.dirname(metadata[:file_path]) << '/__snapshots__'
+        else
+          RSpec.configuration.snapshot_dir
+        end
+      end
+
+      private def create_snapshot_dir(snapshot_dir)
+        return if Dir.exist?(File.dirname(snapshot_dir))
+
+        FileUtils.mkdir_p(File.dirname(snapshot_dir))
+      end
+
+      # @return [String] The snapshot file contents.
+      def read
+        file = File.new(@snapshot_path)
+        value = file.read
+        file.close
+        value
+      end
+
+      # Writes the value to file, overwriting the file contents if either of the
+      # following is true:
+      # * The snapshot file does not already exist.
+      # * The UPDATE_SNAPSHOTS environment variable is set.
+      #
+      # TODO: Do not write to file if running in CI mode.
+      #
+      # @param [String] snapshot_name The snapshot name.
+      # @param [String] value The value to write to file.
+      def write(value)
+        return unless should_write?
+
+        file = File.new(@snapshot_path, 'w+')
+        file.write(value)
+        RSpec.configuration.reporter.message(
+          "Snapshot written: #{@snapshot_path}"
+        )
+        file.close
+      end
+
+      private def should_write?
+        file_does_not_exist? || update_snapshots?
+      end
+
+      private def update_snapshots?
+        !!ENV.fetch('UPDATE_SNAPSHOTS', nil)
+      end
+
+      private def file_does_not_exist?
+        !File.exist?(@snapshot_path)
+      end
+    end
+  end
+end

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'fileutils'
-require 'rspec/snapshot/default_serializer'
-
 module RSpec
   module Snapshot
     module Matchers
@@ -10,43 +7,22 @@ module RSpec
       class MatchSnapshot
         attr_reader :actual, :expected
 
-        def initialize(metadata, snapshot_name, config)
-          @metadata = metadata
-          @snapshot_name = snapshot_name
-          @config = config
-          @serializer = serializer_class.new
-          @snapshot_path = File.join(snapshot_dir, "#{@snapshot_name}.snap")
-          create_snapshot_dir
-        end
-
-        private def serializer_class
-          if @config[:snapshot_serializer]
-            @config[:snapshot_serializer]
-          elsif RSpec.configuration.snapshot_serializer
-            RSpec.configuration.snapshot_serializer
-          else
-            DefaultSerializer
-          end
-        end
-
-        private def snapshot_dir
-          if RSpec.configuration.snapshot_dir.to_s == 'relative'
-            File.dirname(@metadata[:file_path]) << '/__snapshots__'
-          else
-            RSpec.configuration.snapshot_dir
-          end
-        end
-
-        private def create_snapshot_dir
-          return if Dir.exist?(File.dirname(@snapshot_path))
-
-          FileUtils.mkdir_p(File.dirname(@snapshot_path))
+        # @param [#dump] serializer A class instance which responds to #dump to
+        # convert test values to string for writing to snapshot files.
+        # @param [FileOperator] file_operator Handles reading and writing the
+        # snapshot file contents.
+        def initialize(serializer, file_operator)
+          @serializer = serializer
+          @file_operator = file_operator
         end
 
+        # @param [*] actual The received test value to compare to a snapshot.
+        # @return [Boolean] True if the serialized actual value matches the
+        # snapshot contents, false otherwise.
         def matches?(actual)
           @actual = serialize(actual)
 
-          write_snapshot
+          write_snapshot(@actual)
 
           @expected = read_snapshot
 
@@ -63,30 +39,12 @@ module RSpec
           @serializer.dump(value)
         end
 
-        private def write_snapshot
-          return unless should_write?
-
-          RSpec.configuration.reporter.message(
-            "Snapshot written: #{@snapshot_path}"
-          )
-          file = File.new(@snapshot_path, 'w+')
-          file.write(@actual)
-          file.close
-        end
-
-        private def should_write?
-          update_snapshots? || !File.exist?(@snapshot_path)
-        end
-
-        private def update_snapshots?
-          ENV['UPDATE_SNAPSHOTS']
+        private def write_snapshot(value)
+          @file_operator.write(value)
         end
 
         private def read_snapshot
-          file = File.new(@snapshot_path)
-          value = file.read
-          file.close
-          value
+          @file_operator.read
         end
 
         def description

data/lib/rspec/snapshot/matchers.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 require 'rspec/snapshot/matchers/match_snapshot'
+require 'rspec/snapshot/file_operator'
+require 'rspec/snapshot/serializer_factory'
 
 module RSpec
   module Snapshot
     # rubocop:disable Style/Documentation
     module Matchers
       def match_snapshot(snapshot_name, config = {})
-        MatchSnapshot.new(RSpec.current_example.metadata,
-                          snapshot_name,
-                          config)
+        MatchSnapshot.new(SerializerFactory.new(config).create,
+                          FileOperator.new(snapshot_name,
+                                           RSpec.current_example.metadata))
       end
 
       alias snapshot match_snapshot

data/lib/rspec/snapshot/serializer_factory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rspec/snapshot/default_serializer'
+
+module RSpec
+  module Snapshot
+    # Uses the factory pattern to initialize a snapshot serializer.
+    class SerializerFactory
+      def initialize(config = {})
+        @config = config
+      end
+
+      # @returns [#dump] A serializer object which implements #dump to convert
+      # any value to string.
+      def create
+        serializer_class.new
+      end
+
+      private def serializer_class
+        if @config[:snapshot_serializer]
+          @config[:snapshot_serializer]
+        elsif RSpec.configuration.snapshot_serializer
+          RSpec.configuration.snapshot_serializer
+        else
+          DefaultSerializer
+        end
+      end
+    end
+  end
+end

data/lib/rspec/snapshot/version.rb

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

data/rspec-snapshot.gemspec

@@ -26,12 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'awesome_print', '> 1.0.0'
   spec.add_dependency 'rspec', '> 3.0.0'
-
-  spec.add_development_dependency 'bundler', '~> 2.2'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.22'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
-  spec.add_development_dependency 'simplecov'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-snapshot
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Mike Levin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -38,104 +38,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Adding snapshot testing to RSpec
 email:
 - michael_r_levin@yahoo.com
@@ -143,11 +45,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -156,14 +59,17 @@ files:
 - lib/rspec/snapshot.rb
 - lib/rspec/snapshot/configuration.rb
 - lib/rspec/snapshot/default_serializer.rb
+- lib/rspec/snapshot/file_operator.rb
 - lib/rspec/snapshot/matchers.rb
 - lib/rspec/snapshot/matchers/match_snapshot.rb
+- lib/rspec/snapshot/serializer_factory.rb
 - lib/rspec/snapshot/version.rb
 - rspec-snapshot.gemspec
 homepage: https://github.com/levinmr/rspec-snapshot
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -179,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: RSpec Snapshot Matcher

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-dist: focal
-rvm:
-  - 2.5.9
-  - 2.6.8
-  - 2.7.4
-  - 3.0.2
-before_install: gem install bundler:2.2.22