rematch 3.2.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517a212dcc929a169a02fb05526206e64ee3aa4f9a9dced33a76d0c0bca20698
-  data.tar.gz: e1764805c826d287daf49ec747551e86a8736ba2cc572e5a3d7b7eea9fe3d923
+  metadata.gz: 75263525e5c9f837c2308c800c6ddd0fa8efa1472dc32aaca3eab36d4ba20990
+  data.tar.gz: 734123f5f1ea481c6d1d8c31cddfa074483e5dbd7289e6f8965f33a724b0eb46
 SHA512:
-  metadata.gz: b6ab2b85043428cd063a52ceaf93bd5e5a05a73d8d795946bdfdffecffdb19e7c4b545ea076cc633e87038947074d657574ebe0914fd254eff633c770a8444a6
-  data.tar.gz: 38a7dd07e06f54900417e7a8344a34777a018380c157342f741f3b956bbb3bbcc24b900692dd9f096437fa7d75df55de0de8fe904c44bc7cd0249a96f56a36db
+  metadata.gz: 3c54c23fd47f85a99f53c3d7deead137ce5b5fcfaa2559ce957c440f2f142246091fde3aa1b6a0407029377519f28751c45ce0f42a8abd02c035843121a857d3
+  data.tar.gz: d3f5337a74934922e9d889564dc67f18be1a7371a2c24df4699cedb764df30c5278cca25b7872192235c4b4a93b4f044cfbe6393ef4e12bcfa769d7f06dda3bd

data/lib/minitest/rematch_plugin.rb

@@ -22,28 +22,34 @@ module Minitest
     # Create the rematch object for each test
     def after_setup
       super
-      @rematch = Rematch.new(path: method(name).source_location.first,
-                             id: "#{self.class.name}##{name}")
+      @rematch = Rematch.new(self)
     end
   end
 
   # Reopen the minitest module
   module Assertions
     # Main assertion
-    def assert_rematch(key, actual, *args)
+    def assert_rematch(actual, *args)
+      # Extract options (id) if present
+      opts      = args.last.is_a?(Hash) && args.last.key?(:id) ? args.pop : {}
+      id        = opts[:id]
       assertion = :assert_equal
       message   = nil
       args.each { |arg| arg.is_a?(Symbol) ? assertion = arg : message = arg }
       if actual.nil?   # use specific assert_nil after deprecation of assert_equal nil
-        assert_nil @rematch.rematch(key, actual), message
+        assert_nil @rematch.rematch(actual, id: id), message
       else
-        send assertion, @rematch.rematch(key, actual), actual, message  # assert that the stored value is the same actual value
+        # assert that the stored value is the same actual value
+        send assertion, @rematch.rematch(actual, id: id), actual, message
       end
     end
 
     # Temporarily used to store the actual value, useful for reconciliation of expected changed values
-    def store_assert_rematch(key, actual, *_args)
-      @rematch.rematch(key, actual, overwrite: true)
+    def store_assert_rematch(actual, *args)
+      opts = args.last.is_a?(Hash) && args.last.key?(:id) ? args.pop : {}
+      id   = opts[:id]
+
+      @rematch.rematch(actual, overwrite: true, id: id)
       # Always fail after storing, forcing the restore of the original assertion/expectation
       raise Minitest::Assertion, '[rematch] the value has been stored: remove the "store_" prefix to pass the test'
     end
@@ -51,7 +57,9 @@ module Minitest
 
   # Register expectations only if minitest/spec is loaded; ensure the right class in 6.0 and < 6.0
   if (expectation_class = defined?(Spec) && (defined?(Expectation) ? Expectation : Expectations))
-    expectation_class.infect_an_assertion :assert_rematch, :must_rematch
-    expectation_class.infect_an_assertion :store_assert_rematch, :store_must_rematch
+    expectation_class.infect_an_assertion :assert_rematch, :must_rematch, :reverse
+    expectation_class.alias_method :to_rematch, :must_rematch # to use with expect().to_rematch
+    expectation_class.infect_an_assertion :store_assert_rematch, :store_must_rematch, :reverse
+    expectation_class.alias_method :store_to_rematch, :store_must_rematch
   end
 end

data/lib/rematch.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'digest/sha1'
 require_relative 'rematch/store'
 
 # Handles the key/value store for each test
 class Rematch
-  VERSION = '3.2.2'
+  VERSION = '4.1.0'
   CONFIG  = { ext: '.yaml' }  # rubocop:disable Style/MutableConstant
 
   @rebuild      = false  # rebuild the store?
@@ -26,35 +27,69 @@ class Rematch
   end
 
   # Instantiated at each test, stores the path and the unique id of the test being run
-  def initialize(path:, id:)
-    store_path = "#{path}#{CONFIG[:ext]}"
+  def initialize(test)
+    @path      = test.method(test.name).source_location.first
+    store_path = "#{@path}#{CONFIG[:ext]}"
     self.class.check_rebuild(store_path)
-    @store = Store.new(store_path, true)
-    @id    = id.tr('#: ', '_')       # easier key string for clumsy yaml parsers/highlighters
+    @store     = Store.new(store_path, true)
+    @id        = test_uid(test.class.name, test.name)
   end
 
   # Retrieve the stored value for the current assertion if its key is known; store the value otherwise
-  def rematch(key, value, overwrite: nil)
-    # key = assertion_key(key)
+  def rematch(value, overwrite: nil, id: nil)
+    key = assertion_key(id)
     @store.transaction do |s|
-      if s.root?(@id)                     # there is the root id
-        if s[@id].key?(key) && !overwrite # there is the key and not overwrite
-          s[@id][key]                     # return it
-        else                              # not such a key
-          s[@id][key] = value             # set it
-          store_warning(key) unless overwrite
-          value
-        end
-      else                                # there is no root yet
-        s[@id] = { key => value }         # the key is the first one
-        store_warning(key)
-        value                             # always return the value
+      if s.root?(key) && !overwrite       # there is the key and not overwrite
+        s[key]                            # return it
+      else                                # no such key or overwrite
+        s[key] = value                    # set it
+        tidy_store(s)                     # sort keys and cleanup orphans
+        store_warning(key) unless overwrite
+        value
       end
     end
   end
 
   def store_warning(key)
-    warn "Rematch stored new value for: #{key.inspect}\n#{@id}\n#{@store.path}\n\n" \
-          unless Rematch.skip_warning
+    warn "Rematch stored new value for: #{key.inspect}\n#{@store.path}\n\n" unless Rematch.skip_warning
+  end
+
+  protected
+
+  # Generate the unique id for the test (SHA1)
+  def test_uid(class_name, method_name)
+    Digest::SHA1.hexdigest("#{class_name}#{method_name}")
+  end
+
+  private
+
+  # Generate the key based on the line number, optional id, and test ID
+  def assertion_key(id)
+    line = caller_locations.find { |l| l.path == @path }&.lineno
+    %(L#{line}#{" [#{id}]" if id} #{@id})
+  end
+
+  # Ensure the keys are sorted by the order of the tests in the file
+  # and remove keys that do not match any existing test (orphans)
+  def tidy_store(store)
+    # Optimization: only if Minitest is loaded
+    return unless defined?(Minitest::Runnable)
+
+    # Get all valid SHA1s from all runnables in this file
+    valid_ids = []
+    Minitest::Runnable.runnables.each do |runnable|
+      runnable.runnable_methods.each do |method_name|
+        file, = runnable.instance_method(method_name).source_location
+        next unless file == @path # @path is the test file path
+
+        valid_ids << test_uid(runnable.name, method_name)
+      end
+    end
+    # Extract all data
+    data = store.roots.to_h { |key| [key, store.delete(key)] }
+    # Re-add data in the correct order, filter orphans, and sort
+    data.select { |key, _| valid_ids.include?(key.split.last) }
+        .sort_by { |key, _| key[/L(\d+)/, 1].to_i }
+        .each { |key, value| store[key] = value }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rematch
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Instead of copying and pasting large outputs or big ruby structures into
-  all the affected test files every time your code change, you can do it the easy
-  way, possibly saving many hours of boring maintenance work!
+description: Rematch declutters your tests by storing large outputs or structures
+  in separate files. It verifies them automatically and enables easy updates when
+  your code changes, eliminating tedious copy-paste maintenance.
 email:
 - dd.nexus@gmail.com
 executables: []
@@ -74,6 +74,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Declutter your test files from large hardcoded data and update them automatically
-  when your code changes
+summary: Declutter your test files and automatically update expected values.
 test_files: []