minitest-holdify 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c91100bb90de5695419fdb279520529462f67f37d2e580ce6d61c496cf43cbcb
-  data.tar.gz: 48b9d63b74bdea68de55c7a2790e8fb1fef59dc1eb956bce96b02d7ef0b141b3
+  metadata.gz: 633215ac6e960bb4fe8e63dbf22d1247b9b684da3a2300611882b5a1251ca0ad
+  data.tar.gz: a80e8995767b2b3438dc809f494a473e4376da664924ba6ee117aa26ccc2d274
 SHA512:
-  metadata.gz: c17c6cfea957cbad41b2f272da130226a1c878546b46559ec80ccb1f939cb8c395c3b91a91e98ada8a1760bf3b661568364f6ca22f2e34ac957961c6011b4a40
-  data.tar.gz: 89f7c53a3ae05ef7e302efff24398e1579067d246a913c2ca91029185e08af9d8b4dae35da3a6686def351ce6fa89b0b9da1a34d388526dfa1455f5a5950e170
+  metadata.gz: '0129f206eddc8ba5683d64e6ac5c4273dd83818a43ef636a5493706816143b6b35c567bcb407aed623c3c761f0a1d954ac23b2c691c6e81b6f1affcdad0d4ac5'
+  data.tar.gz: e1980a9bfd4f392c40c13194bb35c6d375f26bcef76a93ac4d1173305da5d3c557e8ecf69e659194ce1515b89b8ae2f423f204db883ff0c092c13db467c9e395

data/lib/holdify/hold.rb

@@ -9,50 +9,39 @@ module Holdify
       @test    = test
       @path,   = test.method(test.name).source_location
       @store   = Holdify.stores[@path] ||= Store.new(@path)
-      @session = Hash.new { |h, k| h[k] = [] } # { lineno => [values] }
-      @forced  = []                            # [ "file:lineno" ]
-      @added   = []                            # [ "file:lineno" ]
-      @index   = {}                            # { lineno => index }
-      @counts  = Hash.new(0)                   # { id => count }
+      @session = Hash.new { |h, k| h[k] = [] } # { line => [values] }
+      @forced  = []                            # [ "file:line" ]
+      @added   = []                            # [ "file:line" ]
     end
 
     def call(actual, force: false)
       location = find_location
-      lineno   = location.lineno
-      id       = @store.id_at(lineno)
-      raise "Could not find holdify statement at line #{lineno}" unless id
+      line     = location.lineno
+      raise "Could not find holdify statement at line #{line}" unless @store.xxh_at(line)
 
-      unless @index.key?(lineno)
-        @index[lineno] = @counts[id]
-        @counts[id] += 1
-      end
-      index = @index[lineno]
-
-      @session[lineno] << actual
-      @forced << "#{location.path}:#{lineno}" if force
+      @session[line] << actual
+      @forced << "#{@path}:#{line}" if force
 
       return actual if force || Holdify.reconcile
 
-      stored = @store.stored(id, index)
-      index  = @session[lineno].size - 1
-      return stored[index] if stored && index < stored.size
+      # Expected value
+      values = @store.get(line)
+      index  = @session[line].size - 1
+      return values[index] if values && index < values.size
 
-      @added << "#{location.path}:#{lineno}"
+      @added << "#{@path}:#{line}"
       actual
     end
 
     def save
       return unless @test.failures.empty?
 
-      @added.each { |loc| warn "[holdify] Held new value for #{loc}" } unless Holdify.quiet
-      @session.each do |lineno, values|
-        id    = @store.id_at(lineno)
-        index = @index[lineno]
-        @store.update(lineno, id, values, index)
-      end
+      @added.each   { |loc| warn "[holdify] Held new value for #{loc}" } unless Holdify.quiet
+      @session.each { |line, values| @store.set(line, values) }
       @store.save
     end
 
+    # Find the location in the test that triggered the hold
     def find_location
       caller_locations.find do |location|
         next unless location.path == @path

data/lib/holdify/ledger.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+
+module Holdify
+  # Manages the persistence and alignment of stored values
+  class Ledger
+    def initialize(path, source)
+      @path   = "#{path}#{CONFIG[:ext]}"
+      @source = source
+      File.delete(@path) if Holdify.reconcile && File.exist?(@path)
+      @data = load_and_align
+    end
+
+    def get(line) = @data[line]
+
+    def set(line, values) = (@data[line] = values)
+
+    def save
+      return FileUtils.rm_f(@path) if @data.empty?
+
+      output = {}
+      @data.keys.sort.each do |line|
+        sha = @source.xxh_at(line)
+        next unless sha
+
+        output["L#{line} #{sha}"] = @data[line]
+      end
+
+      content = YAML.dump(output, line_width: 78) # Ensure 80 columns (including pretty gutter)
+      return if File.exist?(@path) && File.read(@path) == content
+
+      File.write(@path, content)
+    end
+
+    private
+
+    def load_and_align
+      {}.tap do |aligned|
+        raw_data = (File.exist?(@path) && YAML.unsafe_load_file(@path)) || {}
+        raw_data.group_by { |k, _| k.split.last }.each do |sha, entries|
+          target_lines = @source.lines_with(sha)
+          next if target_lines.empty?
+
+          # Old data
+          candidates   = entries.map { |key, values| { line: key[/\d+/].to_i, values: values } }
+          exact, moved = candidates.partition { |c| target_lines.include?(c[:line]) }
+          moved.sort_by! { |c| c[:line] }
+
+          # New aligned data
+          target_lines.each do |line|
+            match = exact.find { |c| c[:line] == line } || moved.shift
+            aligned[line] = match[:values] if match
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holdify/pretty.rb

@@ -55,9 +55,9 @@ module Holdify
             exp_buf << text
             act_buf << text
           when '-'
-            exp_buf << RED_FG << text << RESET
+            exp_buf << "#{RED_FG}#{text}#{RESET}"
           when '+'
-            act_buf << GREEN_FG << text << RESET
+            act_buf << "#{GREEN_FG}#{text}#{RESET}"
           when '~'
             flush_buffers(output, exp_buf, act_buf)
             exp_buf.clear
@@ -81,7 +81,7 @@ module Holdify
 
       def create_tempfile(obj)
         Tempfile.new(%w[holdify .yaml]).tap do |file|
-          file.write(YAML.dump(obj, line_width: 78)) # Ensure 80 columns (including gutter)
+          file.write(YAML.dump(obj, line_width: 78)) # Ensure 80 columns (including pretty gutter)
           file.flush
         end
       end

data/lib/holdify/source.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'xxhash'
+
+module Holdify
+  # Represents the current state of the source file
+  class Source
+    def initialize(path) = (@line_sha, @sha_lines = parse(path))
+
+    def xxh_at(line) = @line_sha[line]
+
+    def lines_with(sha) = @sha_lines[sha]
+
+    private
+
+    def parse(path)
+      line_sha  = {}
+      sha_lines = Hash.new { |h, k| h[k] = [] }
+
+      File.foreach(path).with_index(1) do |text, line|
+        content = text.strip
+        next if content.empty?
+
+        sha = XXhash.xxh32(content).to_s
+        line_sha[line] = sha
+        sha_lines[sha] << line
+      end
+
+      [line_sha, sha_lines]
+    end
+  end
+end

data/lib/holdify/store.rb

@@ -1,68 +1,20 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require 'fileutils'
-require 'digest/sha1'
+require 'forwardable'
+require_relative 'source'
+require_relative 'ledger'
 
 module Holdify
-  # A simple Hash-based store that syncs with a static source map
+  # Interface to the Source (code) and the Ledger (data)
   class Store
-    def initialize(source_path)
-      @path = "#{source_path}#{CONFIG[:ext]}"
-      File.delete(@path) if Holdify.reconcile && File.exist?(@path)
+    extend Forwardable
 
-      @source = {} # { lineno => id }
-      File.foreach(source_path).with_index(1) do |line, lineno|
-        content = line.strip
-        @source[lineno] = Digest::SHA1.hexdigest(content) unless content.empty?
-      end
-
-      @index = Hash.new { |h, k| h[k] = [] }                              # { id => ["L123 id", "L124 id"] }
-      @data  = (File.exist?(@path) && YAML.unsafe_load_file(@path)) || {} # { key => [values] }
-
-      organize_data
-    end
-
-    def id_at(lineno)     = @source[lineno]
-    def stored(id, index) = @data[@index[id][index]]
-
-    # Overwrite the entry for a given ID with a new list of values
-    def update(lineno, id, values, index)
-      new_key = "L#{lineno} #{id}"
-      old_key = @index[id][index]
-      @data.delete(old_key) if old_key && old_key != new_key
-      @data[new_key] = values
-      @index[id][index] = new_key
-    end
-
-    def save
-      return FileUtils.rm_f(@path) if @data.empty?
-
-      sorted  = @data.sort_by { |k, _| k[/\d+/].to_i }.to_h
-      content = YAML.dump(sorted, line_width: 78)
-      return if File.exist?(@path) && File.read(@path) == content
-
-      File.write(@path, content)
+    def initialize(path)
+      @source = Source.new(path)
+      @ledger = Ledger.new(path, @source)
     end
 
-    private
-
-    def organize_data
-      source_counts = @source.values.tally
-      sorted_keys   = @data.keys.sort_by { |k| k[/\d+/].to_i }
-
-      sorted_keys.each do |key|
-        id = key.split.last
-        next unless source_counts[id]
-
-        if @index[id].size < source_counts[id]
-          @index[id] << key
-        else
-          @data.delete(key)
-        end
-      end
-
-      @data.keep_if { |key, _| source_counts[key.split.last] }
-    end
+    def_delegator  :@source, :xxh_at
+    def_delegators :@ledger, :get, :set, :save
   end
 end

data/lib/holdify.rb

@@ -3,9 +3,9 @@
 require_relative 'holdify/store'
 require_relative 'holdify/hold'
 
-# Add description
+# The container module
 module Holdify
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
   CONFIG  = { ext: '.yaml' }.freeze
 
   class << self

data/lib/minitest/holdify_plugin.rb

@@ -11,12 +11,14 @@ module Minitest
       Holdify.reconcile = true
       Holdify.quiet     = true
     end
-    opts.on '--holdify-quiet', 'Skip the warning on storing a new value' do
-      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
   end
 
   # Reopen the minitest class
@@ -68,10 +70,10 @@ module Minitest
       expected
     end
 
-    # Temporarily used to store the actual value, useful for reconciliation of expected changed values
+    # Force store the current value
     def assert_hold!(*, **) = assert_hold(*, **, force: true)
 
-    # Temporarily used for development feedback to print to STDERR the actual value
+    # Print to STDERR the actual value
     def assert_hold?(*, **) = assert_hold(*, **, inspect: true)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-holdify
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Stop maintaining large expected values in your test/fixture files! Hold
   them automatically. Update them effortlessly.
 email:
@@ -34,7 +48,9 @@ files:
 - LICENSE.txt
 - lib/holdify.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
 - lib/minitest/holdify_plugin.rb