minitest-holdify 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7560a67982ab6acf747a90307f0fc5fca6ff30c4675aefaf92c973afaa01fe65
-  data.tar.gz: 928f88bd3d8711d13817c924a5c587117e9e61d1cb3a7301b2a097f7cfafb95a
+  metadata.gz: 056a8cc8b2a69276cf8adc189965b484cb9742b6c4e71efaca3b194b56bc1965
+  data.tar.gz: 1570f826edd18de9ee3dbbe6fa39d759f597ab5f5f4ebf452b015ae9cc26f240
 SHA512:
-  metadata.gz: b2cb240ed6c9d90797003b00508b4640d694617b78661fd8ff59a7533eb771a58e12d1f24024cf09d71224c490446c92f325b3bc4b0217ee2c2774d3f78ab4f9
-  data.tar.gz: aa038a10daa87f5d4700d7778dd86e75049d06036f2435b769c455b2f4f37e08fac5a21a91d7a375f06a53dda9a5c2ac50858f4e26cdde27e4d2a6732976fa7c
+  metadata.gz: c6caaf67f67c9992df20d00ab2fc498365ae09f13225e7469aa370b68f0a42cbb77c97c7e68825c21b42600a606ef4c468bcec011c54e2380945bb8f9394741f
+  data.tar.gz: 30bf7d38f0df80f1a2b581c12ee7fbd1ca6811369fe4a2977e286d1876d37daabb1eb5cd8b8d9b81ceb40103dcf430003ef1ed8240db79ce5c5579680395ca7b

data/lib/holdify/failure.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'tempfile'
+require 'open3'
+
+module Holdify
+  # Diff print failure report
+  class Failure
+    GUTTER_WIDTH = 3
+
+    def initialize(expected, actual, message, location:, metadata:)
+      @expected = expected
+      @actual   = actual
+      @message  = message
+      @location = location
+      @metadata = metadata
+      @config   = Holdify.config
+    end
+
+    def message
+      output = add_headers
+      @config[:git] ? output.push(*add_diff) : output.push(@message)
+      output.join("\n")
+    end
+
+    def add_headers
+      ["#{ansi[:red]}--- @yaml#{ansi[:reset]} >>> #{@metadata[:path]}:#{@metadata[:line]}",
+       "#{ansi[:green]}+++ @test#{ansi[:reset]} >>> #{@location.path}:#{@location.lineno}",
+       "#{ansi[:inverse]}<-- #{@metadata[:key]} #{ansi[:reset]}"]
+    end
+
+    def ansi
+      @config[:color] ? { inverse: "\e[7m", reset: "\e[0m", red: "\e[31m", green: "\e[32m" } : {}
+    end
+
+    def git_command
+      if @config[:color]
+        regex = '[^[:space:]]+|[[:space:]]+'
+        %W[git diff --no-index --color-words=#{regex} --unified=1000 #{@exp_file.path} #{@act_file.path}]
+      else
+        %W[git diff --no-index --no-color --unified=1000 #{@exp_file.path} #{@act_file.path}]
+      end
+    end
+
+    def add_diff
+      @exp_file = create_tempfile(@expected)
+      @act_file = create_tempfile(@actual)
+      @config[:color] ? color_process_lines : process_lines
+    rescue Errno::ENOENT
+      []
+    ensure
+      @exp_file&.close!
+      @act_file&.close!
+    end
+
+    def diff_lines
+      stdout, = Open3.capture3(*git_command)
+      return [] if stdout.to_s.empty?
+
+      # Match everything from the start up to the LAST @@...--- sequence
+      # .* is greedy, so it skips all earlier hunks
+      regex = /\A.*@@.*?\r?\n[[:blank:]]*---(\e\[[0-9;]*m)?\r?\n/m
+      body = stdout.sub(regex, '')
+
+      body.split(/\r?\n/)
+    end
+
+    def color_process_lines
+      line_num = @metadata[:line]
+      diff_lines.map do |line|
+        clean = line.gsub(/\e\[(1|22|0)m/, '').lstrip
+        added = clean.start_with?(ansi[:green]) && !line.include?(ansi[:red])
+
+        if added
+          gutter = ' ' * GUTTER_WIDTH
+        else
+          gutter = line_num.to_s.rjust(GUTTER_WIDTH)
+          line_num += 1
+        end
+
+        "#{ansi[:inverse]}#{gutter}#{ansi[:reset]} #{line}"
+      end
+    end
+
+    def process_lines
+      line_num = @metadata[:line]
+      diff_lines.map do |line|
+        type = line[0]
+        line = line[1..]
+
+        if type == '+'
+          gutter = ' ' * GUTTER_WIDTH
+        else
+          gutter = line_num.to_s.rjust(GUTTER_WIDTH)
+          line_num += 1
+        end
+
+        "#{gutter} #{type} #{line}"
+      end
+    end
+
+    def create_tempfile(obj)
+      Tempfile.new(%w[holdify .yaml]).tap do |file|
+        file.write(YAML.dump(obj))
+        file.flush
+      end
+    end
+  end
+end

data/lib/holdify/hold.rb

@@ -3,15 +3,15 @@
 module Holdify
   # The *_hold statement (Assertion/Expectation)
   class Hold
-    attr_reader :forced
+    attr_reader :forced, :store
 
     def initialize(test)
       @test    = test
       @path,   = test.method(test.name).source_location
       @store   = Holdify.stores(@path)
       @session = Hash.new { |h, k| h[k] = [] } # { line => [values] }
-      @forced  = []                            # [ line ]
-      @added   = []                            # [ line ]
+      @forced  = []                            # [ lines ]
+      @added   = []                            # [ lines ]
     end
 
     def call(actual, force: false)
@@ -41,9 +41,12 @@ module Holdify
       @session.each { |line, values| @store.set(line, values) }
     end
 
+    # The index of the current test/value
+    def current_index(line) = @session[line].size - 1
+
     # Find the location in the test that triggered the hold
     def find_location
-      caller_locations.find do |location|
+      caller_locations(2).find do |location|
         next unless location.path == @path
 
         label = location.base_label

data/lib/holdify/ledger.rb

@@ -28,10 +28,34 @@ module Holdify
         output["L#{line} #{xxh}"] = @data[line]
       end
 
-      content = YAML.dump(output, line_width: 78) # Ensure 80 columns (including pretty gutter)
+      content = YAML.dump(output)
       File.write(@path, content)
     end
 
+    # Used in Failure to get the actual storage metadata
+    def lookup(lineno, index = 0)
+      return unless File.exist?(@path)
+
+      xxh   = @source.xxh(lineno)
+      key   = "L#{lineno} #{xxh}"
+
+      found = false
+      count = -1
+
+      File.foreach(@path).with_index(1) do |content, ln|
+        if found
+          next unless content.start_with?('-')
+
+          count += 1
+          next unless count == index
+
+          return { path: @path, line: ln, key: key }
+        else
+          found = content.match(/\b#{xxh}\b/)
+        end
+      end
+    end
+
     private
 
     def load_and_align
@@ -42,13 +66,13 @@ module Holdify
           next if lines.empty?
 
           # Position of the held lines compared to the source lines
-          stayed, moved = entries.map { |key, values| { line: key[/\d+/].to_i, values: values } }
-                                 .partition { |c| lines.include?(c[:line]) }
-          moved.sort_by! { |c| c[:line] }
+          stayed, moved = entries.map { |key, values| { line: key[/\d+/].to_i, values: } }
+                                 .partition { lines.include?(_1[:line]) }
+          moved.sort_by! { _1[:line] }
 
           # Align lines
           lines.each do |line|
-            match         = stayed.find { |c| c[:line] == line } || moved.shift
+            match         = stayed.find { _1[:line] == line } || moved.shift
             aligned[line] = match[:values] if match
           end
         end

data/lib/holdify/store.rb

@@ -15,6 +15,6 @@ module Holdify
     end
 
     def_delegator  :@source, :xxh
-    def_delegators :@ledger, :get, :set, :persist
+    def_delegators :@ledger, :get, :set, :persist, :lookup
   end
 end

data/lib/holdify.rb

@@ -5,12 +5,16 @@ require_relative 'holdify/hold'
 
 # The container module
 module Holdify
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
   CONFIG  = { ext: '.yaml' }.freeze
 
   class << self
     attr_accessor :reconcile, :quiet
-    attr_writer :pretty
+
+    def config
+      @config ||= { git:   system('git --version', out: File::NULL, err: File::NULL),
+                    color: !ENV.key?('NO_COLOR') }
+    end
 
     def stores(path = nil)
       return @stores unless path
@@ -23,13 +27,6 @@ module Holdify
     def persist_all!
       @stores&.each_value(&:persist)
     end
-
-    def pretty
-      return @pretty unless @pretty.nil?
-
-      @pretty = $stdout.tty? && !ENV.key?('NO_COLOR') && ENV['TERM'] != 'dumb' &&
-                system('git --version', out: File::NULL, err: File::NULL)
-    end
   end
   @mutex  = Mutex.new
   @stores = {}

data/lib/minitest/holdify_plugin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'holdify'
-require 'holdify/pretty'
+require 'holdify/failure'
 
 # Implement the minitest plugin
 module Minitest
@@ -17,10 +17,6 @@ module Minitest
       Holdify.quiet     = true
     end
 
-    opts.on '--holdify-pretty', 'Format the stored values with pretty print' do
-      Holdify.pretty = true
-    end
-
     opts.on '--holdify-quiet', 'Skip the warning on storing a new value' do
       Holdify.quiet = true
     end
@@ -37,10 +33,9 @@ module Minitest
       return unless @hold.forced.any?
 
       path, = method(name).source_location
-      msg = <<~MSG.chomp
-        [holdify] the value has been stored: remove the "!" suffix to pass the test
-        #{@hold.forced.uniq.map { |l| "  #{path}:#{l}" }.join("\n")}
-      MSG
+      msg   = +%([holdify] the value has been stored: remove the "!" suffix to pass the test\n)
+      msg  << @hold.forced.uniq.map { |line| "  #{path}:#{line}" }.join("\n")
+
       raise Minitest::Assertion, msg
     end
   end
@@ -60,13 +55,12 @@ module Minitest
         else
           send(assertion || :assert_equal, expected, actual, message)
         end
-      rescue Minitest::Assertion
-        raise unless Holdify.pretty
-
-        diff = Holdify::Pretty.call(expected, actual)
-        raise unless diff
+      rescue Minitest::Assertion => e
+        location = @hold.find_location
+        metadata = @hold.store.lookup(location.lineno, @hold.current_index(location.lineno))
+        hold_msg = Holdify::Failure.new(expected, actual, e.message, metadata:, location:).message
 
-        msg = message ? "#{message}\n#{diff}" : diff
+        msg = message ? "#{message}\n#{hold_msg}" : hold_msg
         raise Minitest::Assertion, msg
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-holdify
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -47,9 +47,9 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - lib/holdify.rb
+- lib/holdify/failure.rb
 - lib/holdify/hold.rb
 - lib/holdify/ledger.rb
-- lib/holdify/pretty.rb
 - lib/holdify/source.rb
 - lib/holdify/store.rb
 - lib/minitest-holdify.rb

data/lib/holdify/pretty.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'tempfile'
-require 'open3'
-
-module Holdify
-  # Generates a pretty diff using git
-  module Pretty
-    RESET    = "\e[0m"
-    RED_FG   = "\e[31m"
-    GREEN_FG = "\e[32m"
-
-    G_BASE = "\e[100m #{RESET} ".freeze
-    G_EXP  = "\e[41m\e[97m\e[1m-#{RESET} ".freeze
-    G_ACT  = "\e[42m\e[97m\e[1m+#{RESET} ".freeze
-
-    class << self
-      def call(expected, actual)
-        exp_file = create_tempfile(expected)
-        act_file = create_tempfile(actual)
-
-        cmd = %W[git diff --no-index --word-diff=porcelain --unified=1000 #{exp_file.path} #{act_file.path}]
-        stdout, _stderr, _status = Open3.capture3(*cmd)
-
-        return nil if stdout.empty?
-
-        format(stdout)
-      rescue Errno::ENOENT
-        nil
-      ensure
-        exp_file&.close!
-        act_file&.close!
-      end
-
-      private
-
-      def format(diff)
-        lines = diff.lines.map(&:chomp)
-        start = lines.index { |l| l.start_with?('@@') }
-        return nil unless start
-
-        output  = ["#{G_EXP}#{RED_FG}Held (Expected)#{RESET}", "#{G_ACT}#{GREEN_FG}Current (Actual)#{RESET}"]
-        exp_buf = +''
-        act_buf = +''
-
-        lines[(start + 1)..].each do |line|
-          char = line[0]
-          text = line[1..]
-
-          # :nocov:
-          case char
-          # :nocov:
-          when ' '
-            exp_buf << text
-            act_buf << text
-          when '-'
-            exp_buf << "#{RED_FG}#{text}#{RESET}"
-          when '+'
-            act_buf << "#{GREEN_FG}#{text}#{RESET}"
-          when '~'
-            flush_buffers(output, exp_buf, act_buf)
-            exp_buf.clear
-            act_buf.clear
-          end
-        end
-
-        flush_buffers(output, exp_buf, act_buf) unless exp_buf.empty? && act_buf.empty?
-
-        output.join("\n")
-      end
-
-      def flush_buffers(output, exp, act)
-        if exp == act
-          output << "#{G_BASE}#{exp}"
-        else
-          output << "#{G_EXP}#{exp}"
-          output << "#{G_ACT}#{act}"
-        end
-      end
-
-      def create_tempfile(obj)
-        Tempfile.new(%w[holdify .yaml]).tap do |file|
-          file.write(YAML.dump(obj, line_width: 78)) # Ensure 80 columns (including pretty gutter)
-          file.flush
-        end
-      end
-    end
-  end
-end