minitest-holdify 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2fecbc870f5205d62da0200a806adc5dc5d47b99a81e53c1af4d50f3f8aaa21
-  data.tar.gz: 06aed82a631a3632c531ef311a53f89e339a00d122fbc75eb31c52f1723e8d24
+  metadata.gz: 4fb43344c6f2a11991bd6ec2b71e7fabcb8a8c5f77bd2048cbac1f9c94b85448
+  data.tar.gz: d8c9580c6701d82c50e11b96bd4bf0bc8fe9efeb98f7287057c6f8220519425d
 SHA512:
-  metadata.gz: ebd7c7cbf15fc450a1a657affe961399ac916c3d57aafc74a89067638ba2d569c59ea134eecd811361d6970989a227dc6814bc1bec07673ee5ea2ca86ea5f877
-  data.tar.gz: c14c8219c1fbaaf1f10a6f28eef93f4696f71d59020090f85d96afe0ae431fa6a52db0a91d6f37f713ea266a6ef61369589bd85544a70c681f73c1902f0055eb
+  metadata.gz: b9420de8747442f0c2853caed136ac08bbd8066af4aa7d429efdec534a7e081b4a12b7bf7f5652de887f73c478a085f0f7032c34c5befd6b558b81128eff6583
+  data.tar.gz: 1c78694729ccf6de3192648f1d0657fcf7cbcb3d471fbb82ffd4e18e6a9378a58eea0ea23a7ee057a6206ecd474bd56455506f765bef2fa1d9a2633644c012f2

data/lib/holdify/feedback.rb

@@ -7,34 +7,30 @@ require 'open3'
 module Holdify
   # Feedback report on failure
   class Feedback
-    attr_reader :xxhi_ref
-
     def initialize(hold, hold_ref, *args)
       test_lno  = hold.test_loc.lineno
       index     = hold.session[test_lno].size - 1   # current index
       xxh       = hold.store.xxh(test_lno)
       yaml_path = hold.store.path
 
-      @xxhi_ref = "<<< @xxh[i] --> #{xxh}[#{index}]"
-
       @yaml_lno = find_yaml_lno(yaml_path, test_lno, xxh, index)
-      @yaml_ref = Holdify.relative("#{yaml_path}:#{@yaml_lno}")
+      @yaml_ref = Holdify.relativize("#{yaml_path}:#{@yaml_lno}")
 
-      @hold_ref = Holdify.relative(hold_ref)
-      test_ref  = Holdify.relative(hold.test_loc.to_s.sub(/:in .*$/, ''))
+      @hold_ref = Holdify.relativize(hold_ref)
+      test_ref  = Holdify.relativize(hold.test_loc.to_s.sub(/:in .*$/, ''))
       @test_ref = test_ref unless @hold_ref == test_ref
 
       @expected, @actual, @message = *args
 
       # Extend with features
       extend(Color) if Holdify.color
-      return unless Holdify.git
+      return unless Holdify.git_diff
 
       extend GitDiff
       extend(Color::GitDiff) if Holdify.color
     end
 
-    def message = [@message, xxhi_ref, *file_refs, *diff, ''].join("\n")
+    def message = [@message, *file_refs, *diff, ''].join("\n")
 
     def file_refs
       ["--- @stored --> #{@yaml_ref}", "+++ @tested --> #{@hold_ref}"].tap do |refs|
@@ -42,7 +38,7 @@ module Holdify
       end
     end
 
-    def diff = ["- #{@expected.inspect}", "+ #{@actual.inspect}"]
+    def diff = ["-#{@expected.inspect}", "+#{@actual.inspect}"]
 
     private
 
@@ -58,7 +54,7 @@ module Holdify
 
           return ln
         else
-          found = line.match(/^L#{test_lno} #{xxh}:$/)
+          found = line.match(/^L#{test_lno}-#{xxh}:$/)
         end
       end
     end
@@ -68,8 +64,8 @@ module Holdify
       def git_command = "git diff --no-index --no-color --unified=1000 #{@exp_path} #{@act_path}"
 
       def diff
-        @exp_path = create_tempfile(@expected).path
-        @act_path = create_tempfile(@actual).path
+        @exp_path = create_tempfile(@expected, 'expected').path
+        @act_path = create_tempfile(@actual, 'actual').path
 
         stdout, = Open3.capture3(git_command)
         regex   = /\A[^@]*\r?\n/m   # cleanup git headers
@@ -83,9 +79,9 @@ module Holdify
         # :nocov:
       end
 
-      def create_tempfile(obj)
+      def create_tempfile(obj, type)
         Tempfile.create.tap do |file|
-          file.write(YAML.dump(obj))
+          file.write(Store.hold_dump(obj).sub(/(?=\n)/, type))
           file.close
         end
       end
@@ -94,17 +90,27 @@ module Holdify
         width  = 0
         lineno = [@yaml_lno - 1]
         lines.map.with_index do |line, i|
-          if i.zero?            # @@ ... @@
-            w = line.scan(/,(\d+)/).flatten.map(&:to_i).max
-            width = (@yaml_lno + w).to_s.length
+          if i.zero? # @@ ... @@
+            width, line = render_hunk(line)
             next line
           end
-          next if i == 1        # ---
+          next if i == 1 || (i == 2 && !Holdify.color)  # ---
 
           render_line(line, lineno, width)
         end.compact
       end
 
+      def render_hunk(line)
+        width = 0
+        hunk  = line.gsub(/([-+]\d+),(\d+)\s+([-+]\d+),(\d+)/) do
+          v1, = $2.to_i - 1          # rubocop:disable Style/PerlBackrefs
+          v2  = $4.to_i - 1          # rubocop:disable Style/PerlBackrefs
+          width = (@yaml_lno + [v1, v2].max).to_s.length
+          "#{$1},#{v1} #{$3},#{v2}"  # rubocop:disable Style/PerlBackrefs
+        end
+        [width, hunk]
+      end
+
       def render_line(line, lineno, width)
         type   = line[0]
         line   = line[1..]
@@ -127,16 +133,14 @@ module Holdify
               yellow:  "\e[33m",
               magenta: "\e[35m" }.freeze
 
-      def wrap(color, string) = "#{SGR[color]}#{string}#{SGR[:clear]}"
+      def dye(color, string) = "#{SGR[color]}#{string}#{SGR[:clear]}"
 
       def file_refs
         refs = super
-        [wrap(:red, refs.shift), *refs.map { wrap(:green, _1) }]
+        [dye(:red, refs.shift), *refs.map { dye(:green, _1) }]
       end
 
-      def diff = [wrap(:red, "- #{@expected.inspect}"), wrap(:green, "+ #{@actual.inspect}")]
-
-      def xxhi_ref = wrap(:magenta, @xxhi_ref)
+      def diff = [dye(:red, "-#{@expected.inspect}"), dye(:green, "+#{@actual.inspect}")]
 
       # Methods enabling the git-diff ANSI feedback
       module GitDiff

data/lib/holdify/hold.rb

@@ -11,7 +11,6 @@ module Holdify
       @store   = Holdify.stores(@path)
       @session = Hash.new { |h, k| h[k] = [] } # { lineno => [values] }
       @forced  = []                            # [ lines ]
-      @added   = []                            # [ lines ]
     end
 
     def call(actual, force: false)
@@ -28,7 +27,7 @@ module Holdify
                elsif values && index < values.size
                  values[index]
                else
-                 @added << lineno
+                 Holdify.push_fresh("#{Holdify.relativize(@test_loc.path)}:#{lineno}")
                  actual
                end
 
@@ -37,7 +36,6 @@ module Holdify
     end
 
     def save
-      @added.each   { |lineno| warn "[holdify] Held new value for #{Holdify.relative(@path)}:#{lineno}" } unless Holdify.quiet
       @session.each { |lineno, values| @store.set_values(lineno, values) }
     end
 
@@ -51,10 +49,6 @@ module Holdify
       end
     end
 
-    def warn_for(actual)
-      warn("[holdify] The value from #{Holdify.relative(@test_loc.path)}:#{@test_loc.lineno} is:\n[holdify] => #{actual.inspect}")
-    end
-
     def feedback(*) = Feedback.new(self, *).message
   end
 end

data/lib/holdify/store.rb

@@ -11,6 +11,11 @@ module Holdify
       def register(target, obj); end
     end
 
+    def self.hold_dump(obj)
+      visitor = NoAliasVisitor.create
+      visitor << obj
+      visitor.tree.to_yaml
+    end
     extend Forwardable
 
     def_delegator :@source, :xxh
@@ -35,24 +40,18 @@ module Holdify
         xxh = @source.xxh(lineno)
         next unless xxh
 
-        output["L#{lineno} #{xxh}"] = @data[lineno]
+        output["L#{lineno}-#{xxh}"] = @data[lineno]
       end
 
-      File.write(@path, hold_dump(output))
+      File.write(@path, self.class.hold_dump(output))
     end
 
     private
 
-    def hold_dump(obj)
-      visitor = NoAliasVisitor.create
-      visitor << obj
-      visitor.tree.to_yaml
-    end
-
     def load_and_align
       {}.tap do |aligned|
         data = YAML.unsafe_load_file(@path) || {}
-        data.group_by { |k, _| k.split.last }.each do |xxh, entries|
+        data.group_by { |k, _| k.split('-').last }.each do |xxh, entries|
           lines = @source.lines(xxh)
           next if lines.empty?
 

data/lib/holdify.rb

@@ -7,27 +7,50 @@ require_relative 'holdify/store'
 
 # The container module
 module Holdify
-  VERSION = '1.3.0'
+  VERSION = '1.3.2'
+
+  @fresh_mutex  = Mutex.new
+  @fresh        = []
+  @stores_mutex = Mutex.new
+  @stores       = {}
 
   class << self
-    attr_accessor :reconcile, :quiet, :git, :pwd, :color, :rel_paths, :store_ext
+    attr_accessor :reconcile, :quiet, :git_diff, :pwd, :color, :rel_paths, :store_ext
 
-    def persist_all! = @stores&.each_value(&:persist)
+    def push_fresh(test_ref)
+      @fresh_mutex.synchronize do
+        @fresh << test_ref
+      end
+    end
 
-    def relative(path)
-      return path unless rel_paths
+    def fresh_report
+      return if quiet
 
-      path.sub(%r{^#{pwd}/}, '')
+      @fresh_mutex.synchronize do
+        return if @fresh.empty?
+
+        warn "[HOLDIFY] Fresh value held for:\n#{@fresh.uniq.sort.map { "  #{_1}" }.join("\n")}"
+      end
     end
 
     def stores(path = nil)
-      return @stores unless path
+      @stores_mutex.synchronize do
+        return @stores unless path
 
-      @mutex.synchronize do
         @stores[path] ||= Store.new(path)
       end
     end
+
+    def persist_stores!
+      @stores_mutex.synchronize do
+        @stores&.each_value(&:persist)
+      end
+    end
+
+    def relativize(path)
+      return path unless rel_paths
+
+      path.sub(%r{^#{pwd}/}, '')
+    end
   end
-  @mutex  = Mutex.new
-  @stores = {}
 end

data/lib/minitest/holdify_plugin.rb

@@ -19,8 +19,8 @@ module Minitest
     opts.on '--holdify-no-color', 'Disable colored output' do
       options[:holdify_no_color] = true
     end
-    opts.on '--holdify-no-rel-paths', 'Disable relative paths in file references' do
-      options[:holdify_no_rel_paths] = true
+    opts.on '--holdify-no-relative-paths', 'Disable relative paths in file references' do
+      options[:holdify_no_relative_paths] = true
     end
     opts.on '--holdify-store-ext EXT', 'The yaml store extension (default .yaml)' do |ext|
       options[:holdify_store_ext] = ext
@@ -29,15 +29,28 @@ module Minitest
 
   # Register the after_run hook to persist all data
   def self.plugin_holdify_init(options)
+    # :nocov:
+    git         = system('git --version', out: File::NULL, err: File::NULL)
+    Holdify.pwd = git ? `git rev-parse --show-toplevel`.strip : Dir.pwd
+    # :nocov:
+
     Holdify.reconcile = options[:holdify_reconcile]
     Holdify.quiet     = options[:holdify_quiet]
-    Holdify.git       = system('git --version', out: File::NULL, err: File::NULL) unless options[:holdify_no_git_diff]
-    Holdify.pwd       = Holdify.git ? `git rev-parse --show-toplevel`.strip : Dir.pwd
+    Holdify.git_diff  = git unless options[:holdify_no_git_diff]
     Holdify.color     = !ENV.key?('NO_COLOR') unless options[:holdify_no_color]
-    Holdify.rel_paths = true unless options[:holdify_no_rel_paths]
+    Holdify.rel_paths = true unless options[:holdify_no_relative_paths]
     Holdify.store_ext = options[:holdify_store_ext] || '.yaml'
 
-    Minitest.after_run { Holdify.persist_all! }
+    Minitest.after_run do
+      Holdify.persist_stores!
+      Holdify.fresh_report
+    end
+  end
+
+  # Patching Minitest::Assertion
+  class Assertion
+    remove_const :RE
+    RE = /in [`'](?:[^']+[#.])?(?:assert|refute|flunk|pass|fail|raise|must|wont|to)/ # :nodoc:
   end
 
   # Reopen the minitest class
@@ -51,10 +64,10 @@ module Minitest
       return unless @hold.forced.any?
 
       path, = method(name).source_location
-      msg   = +%([holdify] the value has been stored: remove the "!" suffix to pass the test\n)
+      msg   = +%([HOLDIFY] Reconciled values (Remove the "!" suffix to pass the test)\n)
       msg  << @hold.forced.uniq.map { |lineno| "  #{path}:#{lineno}" }.join("\n")
 
-      raise Minitest::Assertion, msg
+      flunk msg
     end
   end
 
@@ -68,17 +81,19 @@ module Minitest
       expected = @hold.(actual, **)
 
       begin
-        if actual.nil?
+        if inspect
+          message = ['[HOLDIFY] Inspect actual value (Remove the "?" suffix to pass the test)', message].compact.join(' ')
+          flunk(message)
+        elsif actual.nil?
           assert_nil expected, message
         else
           send(assertion || :assert_equal, expected, actual, message)
         end
       rescue Minitest::Assertion => e
-        raise Minitest::Assertion, @hold.feedback(e.location, expected, actual, message)
+        feedback = @hold.feedback(e.location, expected, actual, message)
+        raise(Minitest::Assertion, feedback)
       end
 
-      @hold.warn_for(actual) if inspect
-
       expected
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-holdify
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Domizio Demichelis