minitest-holdify 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e52a7f895ae3023c767178f3b678fbb7daa0da3f0253ee83a4428cccfa23cce0
-  data.tar.gz: 56f7bf3e4903f8506053b7fecb3be01c3ac642f6b2d9f490cdcdbb0fc303dfa3
+  metadata.gz: 06f80be32b494ec786f8d873556a8046d6e051854ce38051c1f9a41ecce91fe7
+  data.tar.gz: 95efd3e040696f2eacdbcf61b378db9c51bb33889f73b54c418d8bb0417e6244
 SHA512:
-  metadata.gz: 26522a5a41ee3ff122d748a0536f830d9d7c7d1b376ae3d3f42fe8df46ad2852f4aad48239df5bd0a70ba29af127a51da5efdf565fbeea5700f65833f455cd88
-  data.tar.gz: add1f22c79883b79477340aa077921b981916fbeb36807944b2d6d85d00720baefa76241bdfcd59fa120c0e1b403b0fee381a7db04adf2e09a9a51dca65e764a
+  metadata.gz: 3174aad64ba870444147f629ca38dddbbafce4b57d94d72d32febc1c32afdc56c6f2415337e43fab7be44a45a7d7edae7197aabc06f5ea82504bc868ca3ab123
+  data.tar.gz: a336655be1c76832e50c00b919bbb7ecc8a735b1b49e8067a8df3506fa7a6ef2f7b1553b10356bca2fd54025a0fb22a936bdc70f390eaaa124e244f978407df9

data/lib/holdify/hold.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Holdify
+  # The *_hold statement (Assertion/Expectation)
+  class Hold
+    attr_reader :forced
+
+    def initialize(test)
+      @test    = test
+      @path,   = test.method(test.name).source_location
+      @store   = Holdify.stores[@path] ||= Store.new(@path)
+      @session = Hash.new { |h, k| h[k] = [] }
+      @forced  = []
+      @added   = []
+    end
+
+    def call(actual, force: false)
+      location = find_location
+      id       = @store.id_at(location.lineno)
+      raise "Could not find holdify statement at line #{location.lineno}" unless id
+
+      @session[id] << actual
+      @forced << "#{location.path}:#{location.lineno}" if force
+
+      return actual if force || Holdify.reconcile
+
+      stored = @store.stored(id)
+      index  = @session[id].size - 1
+      return stored[index] if stored && index < stored.size
+
+      @added << "#{location.path}:#{location.lineno}"
+      actual
+    end
+
+    def save
+      return unless @test.failures.empty?
+
+      @added.each { |loc| warn "[holdify] Held new value for #{loc}" } unless Holdify.quiet
+      @session.each { |id, values| @store.update(id, values) }
+      @store.save
+    end
+
+    def find_location
+      caller_locations.find do |location|
+        next unless location.path == @path
+
+        label = location.base_label
+        label == @test.name || label == '<top (required)>' || label == '<main>' || label.start_with?('<class:', '<module:')
+      end
+    end
+  end
+end

data/lib/holdify/store.rb

@@ -2,13 +2,14 @@
 
 require 'yaml'
 require 'fileutils'
+require 'digest/sha1'
 
-class Holdify
+module Holdify
   # A simple Hash-based store that syncs with a static source map
   class Store
     def initialize(source_path)
       @path = "#{source_path}#{CONFIG[:ext]}"
-      File.delete(@path) if Holdify.rebuild && File.exist?(@path)
+      File.delete(@path) if Holdify.reconcile && File.exist?(@path)
 
       @source = {} # { lineno => id }
       File.foreach(source_path).with_index(1) do |line, lineno|

data/lib/holdify.rb

@@ -1,69 +1,16 @@
 # frozen_string_literal: true
 
-require 'digest/sha1'
 require_relative 'holdify/store'
+require_relative 'holdify/hold'
 
 # Add description
-class Holdify
-  VERSION = '1.0.1'
+module Holdify
+  VERSION = '1.0.3'
   CONFIG  = { ext: '.yaml' }.freeze
 
   class << self
-    attr_accessor :rebuild, :quiet
+    attr_accessor :reconcile, :quiet
 
     def stores = @stores ||= {}
   end
-
-  attr_reader :forced
-
-  def initialize(test)
-    @test    = test
-    @path,   = test.method(test.name).source_location
-    @store   = self.class.stores[@path] ||= Store.new(@path)
-    @session = Hash.new { |h, k| h[k] = [] }
-    @forced  = []
-  end
-
-  def hold(actual, force: false)
-    location = find_location
-    id       = @store.id_at(location.lineno)
-    raise "Could not find holdify statement at line #{location.lineno}" unless id
-
-    @session[id] << actual
-    @forced << "#{location.path}:#{location.lineno}" if force
-
-    return actual if force || self.class.rebuild
-
-    stored = @store.stored(id)
-    index  = @session[id].size - 1
-    return stored[index] if stored && index < stored.size
-
-    # :nocov:
-    warn "[holdify] Held new value for #{location.path}:#{location.lineno}" unless self.class.quiet
-    # :nocov:
-    actual
-  end
-
-  def save
-    return unless @test.failures.empty?
-
-    @session.each { |id, values| @store.update(id, values) }
-    @store.save
-  end
-
-  def find_location
-    caller_locations.find do |location|
-      next unless location.path == @path
-
-      label = location.base_label
-      # :nocov:
-      label = ::Regexp.last_match(1) if label.start_with?('block ') && label =~ / in (.+)$/
-      # :nocov:
-
-      label == @test.name ||
-        label == '<top (required)>' ||
-        label == '<main>' ||
-        label.start_with?('<class:', '<module:')
-    end
-  end
 end

data/lib/minitest/holdify_plugin.rb

@@ -6,34 +6,26 @@ require 'holdify'
 module Minitest
   # Set the Holdify options
   def self.plugin_holdify_options(opts, _options)
-    opts.on '--holdify-rebuild', 'Rebuild the stores with the current entries/values' do
-      Holdify.rebuild = true
-      Holdify.quiet   = true
+    opts.on '--holdify-reconcile', 'Reconcile the held values with the new ones' do
+      Holdify.reconcile = true
+      Holdify.quiet     = true
     end
-    # :nocov:
     opts.on '--holdify-quiet', 'Skip the warning on storing a new value' do
       Holdify.quiet = true
     end
-    # :nocov:
   end
 
   # Reopen the minitest class
   class Test
-    # Create the @holdify instance for each test
-    def after_setup
-      super
-      @holdify ||= Holdify.new(self)   # rubocop:disable Naming/MemoizedInstanceVariableName
-    end
-
     # Ensure store is tidied and saved after the test runs
     def before_teardown
       super
-      @holdify&.save
-      return unless @holdify&.forced&.any? && failures.empty?
+      @hold&.save
+      return unless @hold&.forced&.any? && failures.empty?
 
       msg = <<~MSG.chomp
         [holdify] the value has been stored: remove the "!" suffix to pass the test
-        #{@holdify.forced.uniq.map { |l| "  #{l}" }.join("\n")}
+        #{@hold.forced.uniq.map { |l| "  #{l}" }.join("\n")}
       MSG
       raise Minitest::Assertion, msg
     end
@@ -42,38 +34,37 @@ module Minitest
   # Reopen the minitest module
   module Assertions
     # Main assertion
-    def assert_hold(actual, *args)
-      @holdify ||= Holdify.new(self)
+    def assert_hold(actual, *args, inspect: false, **)
+      @hold ||= Holdify::Hold.new(self)
       assertion, message = args
       assertion, message = message, assertion unless assertion.nil? || assertion.is_a?(Symbol)
+      expected = @hold.(actual, **)
 
-      expected = @holdify.hold(actual)
       if actual.nil?
         assert_nil expected, message
       else
         send(assertion || :assert_equal, expected, actual, message)
       end
+
+      if inspect
+        location = @hold.find_location
+        warn "[holdify] The value from #{location.path}:#{location.lineno} is:\n[holdify] => #{actual.inspect}"
+      end
+
+      expected
     end
 
     # Temporarily used to store the actual value, useful for reconciliation of expected changed values
-    def assert_hold!(actual, *)
-      @holdify ||= Holdify.new(self)
-      @holdify.hold(actual, force: true)
-    end
+    def assert_hold!(*, **) = assert_hold(*, **, force: true)
 
     # Temporarily used for development feedback to print to STDERR the actual value
-    def assert_hold_?(actual, *)
-      @holdify ||= Holdify.new(self)
-      location = @holdify.find_location
-      warn "[holdify] Actual value dumped from: #{location.path}:#{location.lineno}\n=> #{actual.inspect}"
-      @holdify.hold(actual)
-    end
+    def assert_hold?(*, **) = assert_hold(*, **, inspect: true)
   end
 
   # Register expectations only if minitest/spec is loaded; ensure the right class in 6.0 and < 6.0
   # :nocov:
   if (expectation_class = defined?(Spec) && (defined?(Expectation) ? Expectation : Expectations))
-    %w[hold hold! hold_?].each do |suffix|
+    %w[hold hold! hold?].each do |suffix|
       expectation_class.infect_an_assertion :"assert_#{suffix}", :"must_#{suffix}", :reverse
       expectation_class.alias_method :"to_#{suffix}", :"must_#{suffix}"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-holdify
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - lib/holdify.rb
+- lib/holdify/hold.rb
 - lib/holdify/store.rb
 - lib/minitest-holdify.rb
 - lib/minitest/holdify_plugin.rb