schema_reaper 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5039780ddae77f5851cbc16afb53bea80df2eb7328253e18b89c2495feb66218
-  data.tar.gz: e88e86f0cb4d723256505d9a4d7e89010c7cc532df86b57a1190713d71339a90
+  metadata.gz: b7e70e2066753282ad6757f3d73175a57b73b7026aa8879314f693dafc8547e7
+  data.tar.gz: d4b2ac7a4e6934e068d79ac32f694a5bffcd329bed689c23d0a080266b8bdb6b
 SHA512:
-  metadata.gz: c4b095e2cc73c98f8415136810c3c00218b741cce186d3ff1d2d4e0063cd1658963aa60d296595bc4a2adc8dffaee982be49b750a8f7280993cc4e68a85fa4e0
-  data.tar.gz: d7437c7dbeb2e0c96f4671c89b0e07e89e0e327bdd741cf6b6ee9c128eedf8c2bf96f58c3d925efe742b94de4632c6204ff363e5a23ddc1d6130aa38eeace44c
+  metadata.gz: '04943ff8915c5a809a9f81741f14e98712a6453dcf046441b7ae10d726031a994045e9490b5a8a62f948210c0e030825429bde387f35ffc15176a6b419e5f57a'
+  data.tar.gz: da080808761005f66096458968fc7c68d3c6f3251d2c97aa50a56020a37abb0d673129782244e880473ffb6287df191418f1142e1bc7632e4da05f49def17cc2

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [1.0.12] - 2026-09-15
+
+### Fixed
+- **`--format markdown` claimed `0 B reclaimable` when the row count was
+  unknown.** `Table` learned in 1.0.11 that `reclaimable_bytes` is `nil`
+  both when the true value is zero and when the row count has never been
+  measured, and that a report should say which. `Markdown` summed the raw
+  bytes directly and always printed a total, so on an unanalysed database
+  it stated there was nothing to reclaim — the exact claim the 1.0.11 fix
+  was written to stop, just in the one format meant for an unattended PR
+  comment or CI job summary. The per-row `Reclaims` column had the same
+  bug: an unmeasured finding showed `0.0 B`, indistinguishable from one
+  that genuinely frees nothing. The summary/unmeasured logic now lives in
+  one shared `Reporters::Reclaim` module used by both reporters, so the
+  two formats cannot answer the same question differently again. (#7,
+  mitkush)
+
 ## [1.0.11] - 2026-09-15
 
 Everything below landed after 1.0.10 was cut, so 1.0.10 on RubyGems contains

data/lib/schema_reaper/reporters/markdown.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "bytes"
+require_relative "reclaim"
 
 module SchemaReaper
   module Reporters
@@ -18,8 +18,7 @@ module SchemaReaper
           return
         end
 
-        @io.puts "\n#{@findings.size} finding(s), " \
-                 "~**#{Bytes.human(total)}** reclaimable.\n\n"
+        @io.puts "\n#{summary_line}\n\n"
         @io.puts "| Severity | Confidence | Type | Target | Reclaims | Fix |"
         @io.puts "|---|---|---|---|---|---|"
         rows.each { |r| @io.puts r }
@@ -27,17 +26,23 @@ module SchemaReaper
 
       private
 
+      # "54 finding(s). **~93.8 KB reclaimable.**" -- or, when the row count is
+      # unknown or the estimate is genuinely zero, no reclaim clause at all,
+      # matching the terminal report rather than claiming a number it does not
+      # have.
+      def summary_line
+        text = Reclaim.summary(@findings)
+        line = "#{@findings.size} finding(s)."
+        line + (text ? " **#{text}.**" : "")
+      end
+
       def rows
         @findings.sort_by { |f| -f.confidence }.map do |f|
           target = [f.table, f.column, f.index].compact.join("`.`")
           "| #{f.severity} | #{(f.confidence * 100).round}% | `#{f.type}` | " \
-            "`#{target}` | #{Bytes.human(f.reclaimable_bytes)} | #{f.suggested_fix} |"
+            "`#{target}` | #{Reclaim.cell(f)} | #{f.suggested_fix} |"
         end
       end
-
-      def total
-        @findings.sum(&:reclaimable_bytes)
-      end
     end
   end
 end

data/lib/schema_reaper/reporters/reclaim.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "bytes"
+
+module SchemaReaper
+  module Reporters
+    # Turns a set of findings' reclaimable-bytes into a human sentence, and a
+    # single finding's into a table cell. Shared by every reporter that states
+    # a reclaim total in prose, so the answer cannot drift between formats --
+    # which is how the terminal report learned to distinguish "no bytes" from
+    # "no idea" while the Markdown report kept treating them as the same 0.
+    module Reclaim
+      module_function
+
+      # A row count is required for a byte estimate, and pg reports
+      # reltuples = -1 for a table that has never been analysed. Printing 0.0 B
+      # for an unknown reads as "nothing to gain here", a different claim.
+      def summary(findings)
+        total = findings.sum(&:reclaimable_bytes)
+        return "~#{Bytes.human(total)} reclaimable" if total.positive?
+        return nil unless unmeasured?(findings)
+
+        "reclaim estimate unavailable — run ANALYZE to populate table statistics"
+      end
+
+      # True when some finding's byte estimate is unknown rather than zero.
+      # bytes_per_row.zero? findings (missing_fk_index, duplicate_index -- they
+      # add or drop an index, not data) always reclaim 0 regardless of row
+      # count, so an unknown row count does not make their answer unmeasured.
+      def unmeasured?(findings)
+        findings.any? { |f| f.bytes_per_row.to_i.positive? && !f.reclaim_known? }
+      end
+
+      # Per-finding cell for a table row: the human size, or a note that it is
+      # not known, using the same bytes_per_row-zero exception as summary.
+      def cell(finding)
+        return Bytes.human(finding.reclaimable_bytes) if measured?(finding)
+
+        "unknown"
+      end
+
+      def measured?(finding)
+        finding.bytes_per_row.to_i.zero? || finding.reclaim_known?
+      end
+    end
+  end
+end

data/lib/schema_reaper/reporters/table.rb

@@ -3,6 +3,7 @@
 require_relative "bytes"
 require_relative "ansi"
 require_relative "rollup"
+require_relative "reclaim"
 
 module SchemaReaper
   module Reporters
@@ -57,18 +58,8 @@ module SchemaReaper
                  .map { |t, n| "#{t} #{n}" }.join(" · ")
       end
 
-      # A reclaim estimate needs a row count, and pg reports reltuples = -1 for
-      # a table it has never analysed. Printing 0.0 B for an unknown reads as
-      # "nothing to gain here", which is a different claim entirely.
       def reclaim_text
-        return "~#{Bytes.human(total_reclaimable)} reclaimable" if total_reclaimable.positive?
-        return nil unless unmeasured?
-
-        "reclaim estimate unavailable — run ANALYZE to populate table statistics"
-      end
-
-      def unmeasured?
-        @findings.any? { |f| f.bytes_per_row.to_i.positive? && !f.reclaim_known? }
+        Reclaim.summary(@findings)
       end
 
       def rolled_up

data/lib/schema_reaper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchemaReaper
-  VERSION = "1.0.11"
+  VERSION = "1.0.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_reaper
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - aksshatt
@@ -130,6 +130,7 @@ files:
 - lib/schema_reaper/reporters/console.rb
 - lib/schema_reaper/reporters/json.rb
 - lib/schema_reaper/reporters/markdown.rb
+- lib/schema_reaper/reporters/reclaim.rb
 - lib/schema_reaper/reporters/rollup.rb
 - lib/schema_reaper/reporters/sarif.rb
 - lib/schema_reaper/reporters/table.rb