minitest-snapshots 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ada852a8846eb38fdbb54bba6137d8e98526400a6aeb7c4f69c2738063f84ab3
-  data.tar.gz: e6460d1edd5797c28d3f5646aeeaae97990224882fe8d66570be434bbc220766
+  metadata.gz: df1eab7b656ef41c119840132f47702d15dc99fc14eb88b4a47614046bf1694e
+  data.tar.gz: 57b540192a37e77075dac98a026bc2dcb864e50f7a33752dfac979be6c000a53
 SHA512:
-  metadata.gz: 7be94c6b6a1aafccd033504c727dc7bd3ccc693e09f923f28dcf6604d3ef3e60aeb0e338567f34934bfb305ff1fd3602bf85768207c0c3cfa63a9d6367faaf05
-  data.tar.gz: 42388f113aa86b0e8525a09fc25322a0e632003f1ee00d37a4bb9d4f00f9a57f5d94c183a799f52650f2b2e0d2fabecf568be0ac24a828a1770711505441262d
+  metadata.gz: 5b581de57a56296cce3378f59e9ba6d08a3708378068abd8f3004eff456775b78cf7435778c3505fb67ebc5a0d71c658e2b16d7d35013444ba95606dd161fa7a
+  data.tar.gz: f4458793636fdf47fbba8002250e6128ce90b0f326312ccad9ac23ab3b20f65924c088130cd1884be85dbd80c44ef4f361f3f456445882e4da568251ca3b6710

data/README.md

@@ -1,6 +1,14 @@
 # Minitest::Snapshots
 
-Simple minitest plugin gem implementing Jest style snapshot testing. It's like VCR, but for any string.
+[![Gem Version](https://img.shields.io/gem/v/minitest-snapshots)](https://rubygems.org/gems/minitest-snapshots)
+[![Gem Downloads](https://img.shields.io/gem/dt/minitest-snapshots)](https://www.ruby-toolbox.com/projects/minitest-snapshots)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mattbrictson/minitest-snapshots/ci.yml)](https://github.com/mattbrictson/minitest-snapshots/actions/workflows/ci.yml)
+
+Simple minitest plugin gem implementing Jest-style snapshot testing. It's like VCR, but for any value.
+
+## Requirements
+
+- Ruby 2.7 or later
 
 ## Usage
 
@@ -9,17 +17,22 @@ Instead of copying and pasting large segments of machine generated text into you
 Example:
 
 ```ruby
-class QueryCompilerText extends Minitest::Test
-    def test_it_can_compile_a_query
-        assert_matches_snapshot QueryCompiler.new.compile
-    end
+class QueryCompilerText < Minitest::Test
+  def test_it_can_compile_a_query
+    assert_matches_snapshot QueryCompiler.new.compile
+  end
 end
 ```
 
 ## Command line options
 
-* `-u` or `--update-snapshots`: Update snapshots on disk to the new actual value when re-running the test. Useful when you know the new output of a test case is correct and the snapshot is out of date.
-* `-l` or `--lock-snapshots`: Prevents new snapshots from being written. Useful on CI to ensure all snapshots have been written by the developer.
+- `-u` or `--update-snapshots`: Update snapshots on disk to the new actual value when re-running the test. Useful when you know the new output of a test case is correct and the snapshot is out of date.
+- `-l` or `--lock-snapshots`: Prevents new snapshots from being written. Useful on CI to ensure all snapshots have been written by the developer.
+
+For example, to update snapshots on a Rails project:
+
+    $ bin/rails test -u
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,7 +49,6 @@ Or install it yourself as:
 
     $ gem install minitest-snapshots
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -45,12 +57,16 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/superpro-inc/minitest-snapshots. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mattbrictson/minitest-snapshots.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the Minitest::Snapshots project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/superpro-inc/minitest-snapshots/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## History
+
+`minitest-snapshots` was created by Harry Brundage (@airhorns) and originally published to rubygems in 2019. Significant contributions were [added](https://github.com/mattbrictson/minitest-snapshots/pull/6) by @chocolateboy in 2020. In June 2023, ownership of the project was transferred to Matt Brictson (@mattbrictson).

data/lib/minitest/snapshots/assertion_extensions.rb

@@ -1,22 +1,28 @@
+require_relative "serializer"
 require "fileutils"
 
 module Minitest
   module Assertions
-    def assert_matches_snapshot(string, snapshot_name = nil)
-      snapshot_file = snapshot_path(self.class.name.underscore, snapshot_name || (@snapshot_assertion_counter += 1))
+    def assert_matches_snapshot(value, snapshot_name = nil)
+      snapshot_file = snapshot_path(self.class.name, snapshot_name || (@snapshot_assertion_counter += 1))
+      snapshot = Minitest::Snapshots::Serializer.serialize(value)
 
       if !Minitest::Snapshots.force_updates && File.exist?(snapshot_file)
-        assert_equal File.read(snapshot_file), string, "The string does not match the snapshot (located at #{snapshot_file})"
+        assert_equal(
+          File.read(snapshot_file),
+          snapshot,
+          "The value does not match the snapshot (located at #{snapshot_file})"
+        )
       else
         if Minitest::Snapshots.lock_snapshots
-          assert false, "New snapshot tried to be created when snapshot writing is prevented with the --lock-snapshots option."
+          assert(
+            false,
+            "Attempt to create a snapshot failed because writing is prevented by the --lock-snapshots option"
+          )
         end
 
         FileUtils.mkdir_p(File.dirname(snapshot_file))
-
-        File.open(snapshot_file, "w") do |file|
-          file.write(string)
-        end
+        File.write(snapshot_file, snapshot)
       end
     end
   end

data/lib/minitest/snapshots/serializer.rb

@@ -0,0 +1,66 @@
+require "set"
+require "yaml"
+
+module Minitest
+  module Snapshots
+    # The serializer translates values (objects) into strings. By default,
+    # it uses YAML (Psych). Can be overridden to implement custom
+    # serialization formats, e.g.:
+    #
+    #  module Minitest::Snapshots::Serializer
+    #    def self.serialize(value)
+    #      Marshal.dump(value)
+    #    end
+    #  end
+    module Serializer
+      # The name of the method used to customize the output of +to_yaml+.
+      # Used to provide canonical representations for Hash and Set instances.
+      HOOK = :encode_with
+
+      # Used to ensure the addition/removal of hooks is atomic
+      @lock = Mutex.new
+
+      # Serialize the supplied value to YAML with hooks to canonicalize
+      # (i.e. sort) Hash keys and Set elements.
+      #
+      #   h1 = { foo: "bar", baz: "quux" }
+      #   h2 = { baz: "quux", foo: "bar" }
+      #
+      #   h1.to_yaml == h2.to_yaml                             # => false
+      #   Serializer.serialize(h1) == Serializer.serialize(h2) # => true
+      #
+      # The hooks are only installed for the duration of the method call
+      # and are not installed if custom hooks are already defined.
+      def self.serialize(value)
+        @lock.synchronize do
+          if (hook_hash = hook?(Hash))
+            Hash.define_method(HOOK) do |coder|
+              sorted = sort_by { |pair| pair.first.to_yaml }.to_h
+              coder.map = dup.clear.merge!(sorted)
+            end
+          end
+
+          if (hook_set = hook?(Set))
+            Set.define_method(HOOK) do |coder|
+              sorted = sort_by(&:to_yaml)
+              coder.seq = dup.clear.merge(sorted)
+            end
+          end
+
+          value.to_yaml
+        ensure
+          Hash.remove_method(HOOK) if hook_hash
+          Set.remove_method(HOOK) if hook_set
+        end
+      end
+
+      # Returns true if a class is hookable (doesn't already have a YAML
+      # serialization hook defined), false otherwise
+      def self.hook?(mod)
+        !(mod.method_defined?(HOOK) || mod.private_method_defined?(HOOK))
+      end
+
+      private_class_method :hook?
+    end
+  end
+end

data/lib/minitest/snapshots/test_extensions.rb

@@ -6,17 +6,25 @@ module Minitest
       def before_setup
         super
         @snapshot_assertion_counter = 0
-        @snapshot_dir ||= if defined?(Rails)
-                            Rails.root.join("test", "snapshots").to_s
-                          else
-                            FileUtils.pwd
-                          end
+        @snapshot_dir ||= Minitest::Snapshots.default_snapshots_directory
       end
 
       private
 
+      def sanitize(name)
+        sanitized = name.to_s.downcase.gsub(/(?:\A[\W_]+)|(?:[\W_]+\z)/, "").gsub(/[\W_]+/, "_")
+
+        if sanitized.empty?
+          raise NameError, "Can't sanitize name: #{name.inspect}"
+        end
+
+        sanitized
+      end
+
       def snapshot_path(suite_name, snapshot_name)
-        File.join(@snapshot_dir, suite_name, "#{name}__#{snapshot_name}.snap.txt")
+        filename = format("%s__%s.snap.yaml", sanitize(name), sanitize(snapshot_name))
+        subdir = sanitize(suite_name)
+        File.join(@snapshot_dir, subdir, filename)
       end
     end
   end

data/lib/minitest/snapshots/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Snapshots
-    VERSION = "0.3.0"
+    VERSION = "1.0.1".freeze
   end
 end

data/lib/minitest/snapshots.rb

@@ -2,7 +2,18 @@ require "minitest"
 
 module Minitest::Snapshots
   class << self
-    attr_accessor :force_updates
-    attr_accessor :lock_snapshots
+    attr_accessor :force_updates, :lock_snapshots
+
+    def default_snapshots_directory
+      if defined?(Rails) && Rails.respond_to?(:root)
+        Rails.root.join("test", "snapshots").to_s
+      elsif Dir.exist?("test")
+        File.expand_path("test/snapshots")
+      elsif Dir.exist?("spec")
+        File.expand_path("spec/snapshots")
+      else
+        File.expand_path("snapshots")
+      end
+    end
   end
 end

data/lib/minitest/snapshots_plugin.rb

@@ -1,7 +1,8 @@
-require "minitest/snapshots/version"
+require_relative "snapshots"
+require_relative "snapshots/version"
 
 module Minitest
-  def self.plugin_snapshots_options(opts, options)
+  def self.plugin_snapshots_options(opts, _options)
     opts.on "-u", "--update-snapshots", "Update (overwrite) stored snapshots" do
       Minitest::Snapshots.force_updates = true
     end
@@ -11,10 +12,9 @@ module Minitest
     end
   end
 
-  def self.plugin_snapshots_init(options)
-    require "minitest/snapshots"
-    require "minitest/snapshots/test_extensions"
-    require "minitest/snapshots/assertion_extensions"
-    Minitest::Test.send :include, Minitest::Snapshots::TestExtensions
+  def self.plugin_snapshots_init(_options)
+    require_relative "snapshots/test_extensions"
+    require_relative "snapshots/assertion_extensions"
+    Minitest::Test.include Minitest::Snapshots::TestExtensions
   end
 end

metadata

@@ -1,70 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: minitest-snapshots
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Harry Brundage
-autorequire: 
+- Matt Brictson
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+date: 2023-10-03 00:00:00.000000000 Z
+dependencies: []
+description:
 email:
 - harry.brundage@gmail.com
+- opensource@mattbrictson.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/minitest/snapshots.rb
 - lib/minitest/snapshots/assertion_extensions.rb
+- lib/minitest/snapshots/serializer.rb
 - lib/minitest/snapshots/test_extensions.rb
 - lib/minitest/snapshots/version.rb
 - lib/minitest/snapshots_plugin.rb
-- minitest-snapshots.gemspec
-homepage: https://github.com/superpro-inc/minitest-snapshots
+homepage: https://github.com/mattbrictson/minitest-snapshots
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/mattbrictson/minitest-snapshots/issues
+  changelog_uri: https://github.com/mattbrictson/minitest-snapshots/releases
+  source_code_uri: https://github.com/mattbrictson/minitest-snapshots
+  homepage_uri: https://github.com/mattbrictson/minitest-snapshots
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,16 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
-summary: Adds jest style snapshot testing asserting against long values stored on
-  the filesystem.
+summary: Minitest plugin implementing Jest-style snapshot testing
 test_files: []

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at harry.brundage@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in minitest-snapshots.gemspec
-gemspec

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    minitest-snapshots (0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (10.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  minitest-snapshots!
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.17.2

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "minitest/snapshots"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/minitest-snapshots.gemspec

@@ -1,27 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "minitest/snapshots/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "minitest-snapshots"
-  spec.version = Minitest::Snapshots::VERSION
-  spec.authors = ["Harry Brundage"]
-  spec.email = ["harry.brundage@gmail.com"]
-
-  spec.summary = %q{Adds jest style snapshot testing asserting against long values stored on the filesystem.}
-  spec.homepage = "https://github.com/superpro-inc/minitest-snapshots"
-  spec.license = "MIT"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-end