rematch 1.3.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8000531b99edc355b0d29b844278d0cdd07c4fc4381533bc46da67ffe0cc1d68
-  data.tar.gz: 217d652a6fd6f2906320c55dfd3c965e46567d96b57fc52072795af76507d876
+  metadata.gz: f699e5e0c1d64349c09caa39f25bbacb14611337ab42a96f648869bebdb76a0c
+  data.tar.gz: ecfb4cca03ca59e1d7e48678cc5a275638b8274afa3ea86e46cb2489fc1baeed
 SHA512:
-  metadata.gz: fc259ae4bdc84553b60cefe0590721c7762595d8890e0dda85884e96393e97f8f85ef89f10046a10b11ea1d62c2303078fe391cc50204fcb5605155c53407afb
-  data.tar.gz: 60f9c9c325bb6b4937f2513329002891e1f244b475e8d7172c044da64a148e88c90b40e3410b9c288328277d4ac5ced09d25ac37f389b45bc0fcaaa2d9804636
+  metadata.gz: be3f22dcd4354450f4e540eb1102813b681e0b06a4b241db47be3d4bb56cbb94e26ed0610921e3143ea56e23fff5638bad7c0f0a73f89735bd300bb0eece75d2
+  data.tar.gz: ba28a07503d7ab0f3c8c362a5b7117cddeb8efde244041c5b9e82ba8f5137b5aabbad4166d79870d1c9a336e860da4fad62ad74e856105e84bad6ad0d32f4d63

data/lib/minitest/rematch_plugin.rb

@@ -4,32 +4,44 @@ require 'rematch'
 
 # Implement the minitest plugin
 module Minitest
+  # Set Rematch.rebuild with the --rematch-rebuild
   def self.plugin_rematch_options(opts, _options)
     opts.on '--rematch-rebuild', 'Rebuild the stores with the current entries/values' do
       Rematch.rebuild = true
     end
   end
 
-  # reopen the minitest class
+  # Reopen the minitest class
   class Test
+    # Create the rematch object for each test
     def before_setup
       super
       @rematch = Rematch.new(path: method(name).source_location.first, id: location)
     end
   end
 
-  # reopen the minitest module
+  # Reopen the minitest module
   module Assertions
+    # Main assertion
     def assert_rematch(actual, *args)
       assertion = :assert_equal
       message   = nil
       args.each { |arg| arg.is_a?(Symbol) ? assertion = arg : message = arg }
-      send assertion, @rematch.rematch(actual), actual, message
+      send assertion, @rematch.rematch(actual), actual, message  # assert that the stored value is the same actual value
+    end
+
+    # Temporarily used to store the actual value, useful for reconciliation of expected changed values
+    def store_assert_rematch(actual, *_args)
+      @rematch.store(actual)
+      # 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
   end
 
-  # reopen the minitest module
+  # Reopen the minitest module
   module Expectations
+    # Add the expectations pointing to the assertions
     infect_an_assertion :assert_rematch, :must_rematch, true # dont_flip
+    infect_an_assertion :store_assert_rematch, :store_must_rematch, true # dont_flip
   end
 end

data/lib/rematch.rb

@@ -3,15 +3,17 @@
 require 'yaml/store'
 require 'fileutils'
 
-# Implement the key/value store
+# Handles the key/value store for each test
 class Rematch
-  VERSION = '1.3.0'
+  VERSION = '1.4.2'
   EXT     = '.rematch'
 
-  @rebuilt = []
+  @rebuild = false  # rebuild the store?
+  @rebuilt = []     # paths already rebuilt
   class << self
     attr_accessor :rebuild
 
+    # Check whether path requires rebuild and do it if required
     def check_rebuild(path)
       return unless @rebuild && !@rebuilt.include?(path)
 
@@ -21,7 +23,7 @@ class Rematch
     end
   end
 
-  # path and unique id of the test being run
+  # Instantiated at each test, stores the path and the unique id of the test being run
   def initialize(path:, id:)
     path = "#{path}#{EXT}"
     self.class.check_rebuild(path)
@@ -30,9 +32,21 @@ class Rematch
     @count = 0
   end
 
-  # store if unknown; retrieve otherwise
+  # Retrieve the stored value for the current assertion if its key is known; store the value otherwise
   def rematch(value)
-    key = "[#{@count += 1}] #{@id}"
+    key = assertion_key
     @store.transaction { |s| s.root?(key) ? s[key] : s[key] = value }
   end
+
+  # Store the value
+  def store(value)
+    @store.transaction { |s| s[assertion_key] = value }
+  end
+
+  private
+
+  # Return the key for the current assertion
+  def assertion_key
+    "[#{@count += 1}] #{@id}"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rematch
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies: []
 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
@@ -25,7 +25,11 @@ files:
 homepage: https://github.com/ddnexus/rematch
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/ddnexus/rematch
+  bug_tracker_uri: https://github.com/ddnexus/rematch/issues
+  changelog_uri: https://github.com/ddnexus/rematch/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -34,14 +38,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Declutter your test files from large hardcoded data and update them automatically