rspec-snapshot 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e969397a7cd054e4bd77820f0e91574d45556659fcded20178ca52f8bc077d
-  data.tar.gz: ca056e2c01e588a69aa51bb86b88af081acff4abd580cf74b1b624f4e3d55822
+  metadata.gz: b55b1aac3c8f7485efb46cf9ae2d62099d074f8c57c41d8a0b649ee6d7040c7f
+  data.tar.gz: 0e6d00759c134fe74c0b627fcbb40757825e959adffdd9ffa3599e68584bc954
 SHA512:
-  metadata.gz: 5e7415a66e8182852a55ac99d922bb03488114cc0c3cf97f56c49ea11ff419f2a53dfbb67bd6aa3cd5956a9f533d3a4c8933897e651a6dc5578296366be2df43
-  data.tar.gz: 69d2418bbfd2c94096ce3aae0dcb6a3415d8c217d491ddd502aa5324e0dd6a799ce595cfa9b846c9a2c474679301ac2ab3c2bd49d41010f39c5fa14c4d55aa2a
+  metadata.gz: c2ff25eb3ebc46a01852c4f2147a862cb8d9b94c2277aaadc9d331608d27cf4d0348c74521196c0c36d234827a274533dce1445ac91ba6f8c478d81a5605c59f
+  data.tar.gz: 3bf7ba016e5e47aa87bec679e06e48b0e54cf03f68f67e794bb065f351fdd09f314563e2053dc8d97d5a5d406f57df85cb71206087fda4738d5b7581a7b666b0

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,39 @@
+on:
+  push:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0', '2.7']
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        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.2', '3.1', '3.0', '2.7']
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        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/github/docs/actions/workflows/ci.yml/badge.svg?branch=master)
 
 Adds snapshot testing to RSpec, inspired by [Jest](https://jestjs.io/).
 

data/lib/rspec/snapshot/configuration.rb

@@ -3,17 +3,15 @@
 module RSpec
   # rubocop:disable Style/Documentation
   module Snapshot
-    # rubocop:disable Lint/EmptyClass
-    class Configuration; end
-    # rubocop:enable Lint/EmptyClass
+    class Configuration
+      def self.initialize_configuration(config)
+        config.add_setting :snapshot_dir, default: :relative
 
-    def self.initialize_configuration(config)
-      config.add_setting :snapshot_dir, default: :relative
-
-      config.add_setting :snapshot_serializer, default: nil
+        config.add_setting :snapshot_serializer, default: nil
+      end
     end
 
-    initialize_configuration RSpec.configuration
+    Configuration.initialize_configuration RSpec.configuration
   end
   # rubocop:enable Style/Documentation
 end

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,73 @@
+# 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)
+        create_snapshot_dir(snapshot_dir)
+        @snapshot_path = File.join(snapshot_dir, "#{snapshot_name}.snap")
+      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)
+        FileUtils.mkdir_p(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,52 +1,28 @@
 # frozen_string_literal: true
 
-require 'fileutils'
-require 'rspec/snapshot/default_serializer'
-
 module RSpec
   module Snapshot
     module Matchers
       # RSpec matcher for snapshot testing
-      class MatchSnapShot
+      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
 
@@ -55,39 +31,24 @@ module RSpec
 
         # === is the method called when matching an argument
         alias === matches?
+        alias match matches?
 
         private def serialize(value)
-          if value.is_a?(String)
-            value
-          else
-            @serializer.dump(value)
-          end
-        end
+          return value if value.is_a?(String)
 
-        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
+          @serializer.dump(value)
         end
 
-        private def should_write?
-          update_snapshots? || !File.exist?(@snapshot_path)
+        private def write_snapshot(value)
+          @file_operator.write(value)
         end
 
-        private def update_snapshots?
-          ENV['UPDATE_SNAPSHOTS']
+        private def read_snapshot
+          @file_operator.read
         end
 
-        private def read_snapshot
-          file = File.new(@snapshot_path)
-          value = file.read
-          file.close
-          value
+        def description
+          "to match a snapshot containing: \"#{@expected}\""
         end
 
         def diffable?

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.0'
+    VERSION = '2.0.2'
   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.17'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.4'
-  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.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Mike Levin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2023-12-15 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.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !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,7 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.9
-  - 2.6.7
-  - 2.7.3
-before_install: gem install bundler:2.2.20