rematch 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a78aaba52539be2d6d48d6c9ab22cb42619fb2caaae180b910c0479d80a7f2
-  data.tar.gz: c297708164e69b9af694ad7ed82e88a77566ab9dc84061cd0fef82507e2d942a
+  metadata.gz: 2b3e156f501309072c0c57f782f4954d878d6fca881df21be60294d048e8499d
+  data.tar.gz: '09b2e677934c63c345dcd5df0aaa1d045136b2089f93abbc9e88c19109bfaddc'
 SHA512:
-  metadata.gz: 5026206bb987112ecd2cb028d72bb3e128163d44f3e44537f1e745163325196656c5bf03bebac6ae74998c52f2be4b0e7dd3c7e4af575565c2bd6f9ebceff4dd
-  data.tar.gz: ff729f5a2aa8bb2e405ec8f4608cbfd07cc53f32440d1041be0fed6ff437cf37f1a5441cff2d8626d477e7be274942bd73f2db5044c846dcfa6fa07a5560a2ea
+  metadata.gz: ae7b319799b53c0c459217113ca1bb2e4811cadcacf26f2bb5be127414d8e1064fe70a3dfd15ce691a3013016fb8b772168568e450913f6b09045fe5d4e469e4
+  data.tar.gz: 8124b42a3eaa69c37c10b8991f1d3a3eb13c4c70fc2ecde3908580eae388da11e18848a89848c9a2f4682c8f2903afd77f336e70753c33c0ae665c02213c3105

data/lib/minitest/rematch_plugin.rb

@@ -4,6 +4,7 @@ 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
@@ -12,6 +13,7 @@ module Minitest
 
   # 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)
@@ -20,21 +22,25 @@ module Minitest
 
   # 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  # assert that the stored value is the same
+      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
   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

data/lib/rematch.rb

@@ -3,13 +3,13 @@
 require 'yaml/store'
 require 'fileutils'
 
-# Implement the key/value store
+# Handles the key/value store for each test
 class Rematch
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
   EXT     = '.rematch'
 
-  @rebuild = false
-  @rebuilt = []
+  @rebuild = false  # rebuild the store?
+  @rebuilt = []     # paths already rebuilt
   class << self
     attr_accessor :rebuild
 
@@ -23,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)
@@ -32,19 +32,21 @@ class Rematch
     @count = 0
   end
 
-  # Retrieve the stored value if the key is known; store the value otherwise
+  # Retrieve the stored value for the current assertion if its key is known; store the value otherwise
   def rematch(value)
-    key = count_key
+    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[count_key] = value }
+    @store.transaction { |s| s[assertion_key] = value }
   end
 
   private
 
-  def count_key
+  # 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.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2021-12-10 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
@@ -27,6 +27,9 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/ddneus/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: