rematch 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c8f28666e75297ba7dfa84ba0432715976075f2a2e1699b145eea7f41789fc
-  data.tar.gz: 39c024389c8ccdfd97627952719c2cd0004a69f906b50621e1a9ab9b230e2947
+  metadata.gz: d53eeaada3490407b3977d044320c853c8ebe446099a365c53457a83a34c2ecd
+  data.tar.gz: 289b892aad3fc9edb098751583d7c99882b21311b72bf9be173508266882d45d
 SHA512:
-  metadata.gz: 20cce9b1ae1ee171648d98f8838370bf913100c6dd0d9ccb92af0bbfcd6c0d41a49471e18e78b4235c06151ab8500a23c5a15293b583cc2e141ea035ba8af11b
-  data.tar.gz: dc681036308b31d4d08efe48813c3ffa0a5d8d71d326b6a2495df2ac4f3c00c295a1a45b288046b10d2d8b2069756e150d57f1ab904b247cbc606faae27d216b
+  metadata.gz: 2417bb23ed9c231c6e26fca90596171d004fa2010e75b886aed56b844a82fd4883f4d37244fd1edbd47ecdb415966fafa589501b1c992c7de4271274ef7bfd7a
+  data.tar.gz: a9f1a10ab07482c461ae189d7d89ab0a16dbac2dce1f7dd388bce6a40e2722215574158fe0298dd8426aec336d077d79a59390f1de441b1470de892e0a941834

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Domizio Demichelis
+Copyright (c) 2025 Domizio Demichelis
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/minitest/rematch_plugin.rb

@@ -7,16 +7,23 @@ 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
+      Rematch.rebuild      = true
+      Rematch.skip_warning = true
     end
+    # :nocov:
+    opts.on '--rematch-skip-warning', 'Skip the warning on storing a new value' do
+      Rematch.skip_warning = true
+    end
+    # :nocov:
   end
 
   # Reopen the minitest class
   class Test
     # Create the rematch object for each test
-    def before_setup
+    def after_setup
       super
-      @rematch = Rematch.new(path: method(name).source_location.first, id: location)
+      @rematch = Rematch.new(path: method(name).source_location.first,
+                             id: location)
     end
   end
 
@@ -36,7 +43,7 @@ module Minitest
 
     # Temporarily used to store the actual value, useful for reconciliation of expected changed values
     def store_assert_rematch(key, actual, *_args)
-      @rematch.store(key, actual)
+      @rematch.rematch(key, actual, overwrite: true)
       # 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

data/lib/rematch/store.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'yaml/store'
+
+class Rematch
+  # Subclass of YAML::Store
+  class Store < YAML::Store
+    # Use unsafe load, because tests are trusted content
+    def load(content)
+      YAML.unsafe_load(content) || {}
+    end
+  end
+end

data/lib/rematch.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-require 'yaml/store'
 require 'fileutils'
+require_relative 'rematch/store'
 
 # Handles the key/value store for each test
 class Rematch
-  VERSION = '3.0.0'
-  DEFAULT = { ext: '.yaml' }  # rubocop:disable Style/MutableConstant
+  VERSION = '3.2.0'
+  CONFIG  = { ext: '.yaml' }  # rubocop:disable Style/MutableConstant
+
+  @rebuild      = false  # rebuild the store?
+  @rebuilt      = []     # paths already rebuilt
+  @skip_warning = false
 
-  @rebuild = false  # rebuild the store?
-  @rebuilt = []     # paths already rebuilt
   class << self
-    attr_accessor :rebuild
+    attr_accessor :rebuild, :skip_warning
 
     # Check whether path requires rebuild and do it if required
     def check_rebuild(path)
@@ -25,38 +27,34 @@ class Rematch
 
   # Instantiated at each test, stores the path and the unique id of the test being run
   def initialize(path:, id:)
-    path = "#{path}#{DEFAULT[:ext]}"
-    self.class.check_rebuild(path)
-    @store = YAML::Store.new(path, true)
+    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
   end
 
   # Retrieve the stored value for the current assertion if its key is known; store the value otherwise
-  def rematch(key, value)
+  def rematch(key, value, overwrite: nil)
     # key = assertion_key(key)
     @store.transaction do |s|
-      if s.root?(@id)                # there is the root id
-        if s[@id].key?(key)          # there is the key
-          s[@id][key]                # return it
-        else                         # not such a key
-          s[@id][key] = value        # set
+      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
-        value                        # always return the value
+      else                                # there is no root yet
+        s[@id] = { key => value }         # the key is the first one
+        store_warning(key)
+        value                             # always return the value
       end
     end
   end
 
-  # Store the value
-  def store(key, value)
-    @store.transaction do |s|
-      if s.root?(@id)                # there is the root id
-        s[@id][key] = value          # set
-      else                           # there is no root yet
-        s[@id] = { key => value }    # the key is the first one
-        value                        # always return the value
-      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
   end
 end

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: rematch
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Domizio Demichelis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-20 00:00:00.000000000 Z
-dependencies: []
+date: 2025-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pstore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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!
@@ -22,6 +49,7 @@ files:
 - LICENSE.txt
 - lib/minitest/rematch_plugin.rb
 - lib/rematch.rb
+- lib/rematch/store.rb
 homepage: https://github.com/ddnexus/rematch
 licenses:
 - MIT
@@ -30,7 +58,6 @@ metadata:
   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:
 - lib
@@ -38,15 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Declutter your test files from large hardcoded data and update them automatically
   when your code changes