minitest-holdify 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aff615590c52a4b538a92ae7e90dd24a6d4f5461e70b3cc240f5a30a819a8855
-  data.tar.gz: 6a0977317a054b2e6c89c403715c2815cd3d24d479161f83c622acb55ded2aeb
+  metadata.gz: 16f323fa95fbafe93f7554b26b3bcfd77c64904541374d1bb2355625a0cf3456
+  data.tar.gz: 35af707d16f16b01da03cdc4c57601c62d7c33157604a5a539f3b3b313dcfc21
 SHA512:
-  metadata.gz: 8f0553c5e76cced33e96d49adf7b89929d2d119d3f375ac36ea1aa3fac2a5786cfc65000aaefae5bf5066f94921840549927761a36b2f9832f6ea770a8a71702
-  data.tar.gz: 73ff0933e454a35def50e40b2cf46b82a45a4fa801c6dbb2dcb9a36d4ef11ddd91ee51649260f60e544ef581e7768942076aa1a4120aae4aeabf5a4d4a65cb79
+  metadata.gz: 1becfd3103d6e03e31e25b5cbfc16155792a6454d5052b85e4797d7d1597a25689dfc109597d115cd541c736eedb17c2b708cf6cd28089f13e8819b79cef62ac
+  data.tar.gz: 7a7be717e2bba29f50c16dcc0d4017cd9dc96a41618e65c8eeabec5a457de4da6891b190efe7a04464d2a447e4a81e55baf24b4546c37785022d1c9068f01a49

data/lib/holdify/feedback.rb

@@ -7,34 +7,34 @@ 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
+      # Extend features
+      extend Color if Holdify.color
+      return unless Holdify.git_diff
 
-      extend GitDiff
-      extend(Color::GitDiff) if Holdify.color
+      @diff_yaml_headers = 2    # ----expected and +---actual (no sgr code) on 2 lines
+      extend GitDiff            # rubocop:disable Layout/EmptyLinesAfterModuleInclusion
+      return unless Holdify.color
+
+      @diff_yaml_headers = 1    # ---expected---actual (with sgr codes) on single line
+      extend Color::GitDiff
     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 +42,7 @@ module Holdify
       end
     end
 
-    def diff = ["- #{@expected.inspect}", "+ #{@actual.inspect}"]
+    def diff = ["-#{@expected.inspect}", "+#{@actual.inspect}"]
 
     private
 
@@ -58,7 +58,7 @@ module Holdify
 
           return ln
         else
-          found = line.match(/^L#{test_lno} #{xxh}:$/)
+          found = line.match(/^L#{test_lno}-#{xxh}:$/)
         end
       end
     end
@@ -91,14 +91,15 @@ module Holdify
       end
 
       def process_lines(lines)
-        width  = 0
-        lineno = [@yaml_lno - 1]
+        width   = 0
+        lineno  = [@yaml_lno - 1]
         lines.map.with_index do |line, i|
           if i.zero? # @@ ... @@
             width, line = render_hunk(line)
             next line
+          elsif i <= @diff_yaml_headers # ---
+            next
           end
-          next if i == 1 || (i == 2 && !Holdify.color)  # ---
 
           render_line(line, lineno, width)
         end.compact
@@ -137,16 +138,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
@@ -162,7 +161,7 @@ module Holdify
 
           sgr    = SGR[color].to_s if color
           gutter = if added
-                     "#{sgr}#{type} #{' ' * width}#{SGR[:clear]}"
+                     "#{sgr}#{type}#{' ' * width}#{SGR[:clear]}"
                    else
                      lineno[0] += 1
                      "#{sgr}#{type || ' '}#{lineno[0].to_s.rjust(width)}#{SGR[:clear]}"

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
 

data/lib/holdify/store.rb

@@ -40,7 +40,7 @@ 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, self.class.hold_dump(output))
@@ -51,7 +51,7 @@ module Holdify
     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.1'
+  VERSION = '1.3.3'
+
+  @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
 
@@ -69,7 +82,7 @@ module Minitest
 
       begin
         if inspect
-          message = ['INSPECT[?]', message].compact.join(' ')
+          message = ['[HOLDIFY] Inspect actual value (Remove the "?" suffix to pass the test)', message].compact.join(' ')
           flunk(message)
         elsif actual.nil?
           assert_nil expected, message

metadata

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