schema_reaper 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b327fade324c6f2e9a871da57ae46814c1b077a1aca3aec64ca6681f270ffe6
-  data.tar.gz: d63156d86d7dc44e92204475c3d23ffa7e6b87730d0a436dc9aefd041ea8b843
+  metadata.gz: df6a3127bc5e379e183a6f525870c5726bbf016223b6c8531b1be8cb97da8ca5
+  data.tar.gz: 2810a69e8b382c10ecf52bc35717efd53fc9b826b8aae580b15773f4ffb8e246
 SHA512:
-  metadata.gz: cb3fe82c18f9f198ec544089305b183f2a413123093edd6f437a04c8d0b32879c123d1e4d1c338a1e03539a8eb16847406bb21f4eab5932ed6b4aba4fcdf461e
-  data.tar.gz: 1c1cf99e43ff66383f5b3bb0c42d5cfec209cbc8dab3bb986e734b6dcf75706c5ed1ecbf09d61f116ce2883957630f0ceeff7a102fb49793fe73cd93cd8283ad
+  metadata.gz: f4dc2789fcdd897e213a4b050ef98a05d94f6c213e145bdc6ac6e8a5168d355b7fc86a2b18aa0799b76ff1183255e64b5d6bbc2789c9d5a063dac91c9fcabdf9
+  data.tar.gz: f8026dcfb27f4a9a828f519bef9a78f8e626522f8cadb5082ee39b393652d5ff0224a669fc8a4b7d109f20f5b6bc910bcea336971de0603a85af4d1c4ad2280a

data/.rubocop.yml

@@ -44,7 +44,7 @@ Metrics/MethodLength:
   Max: 20
 
 Metrics/ClassLength:
-  Max: 130
+  Max: 135
 
 Metrics/CyclomaticComplexity:
   Max: 12

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## [1.0.16] - 2026-09-22
+
+### Fixed
+- **A bare index on a polymorphic `*_id` column alone silently suppressed the
+  `missing_fk_index` finding it should have raised.** The check tested the
+  generic "is this column indexed at all" before checking whether the column
+  was part of a polymorphic pair, so an index on `commentable_id` by itself
+  — never sufficient, since Rails always queries the pair together — read as
+  "covered" and the analyzer's own doc comment went unenforced. Now gates on
+  the composite `(type, id)` check whenever a `*_type` column is present.
+  (#17, mitkush)
+- **`Postgres#indexes_for` was the one introspection query missing the
+  `public`-schema filter** every sibling query (`columns_for`,
+  `foreign_keys_for`, `table_names`) already has. In a database with more
+  than one schema containing a same-named table, it could pull in and union
+  indexes from the wrong table. Verified live against a two-schema database
+  with a colliding table name and a planted bogus index. (#17, mitkush)
+- **The `SCHEMA_REAPER_TRACK=1` runtime-tracker initializer could crash a
+  host app's entire boot**, not just disable the optional feature, on a
+  malformed `.schema_reaper.yml` or an unwritable log directory — nothing
+  in the initializer was rescued. Now rescues and logs a warning instead.
+  (#18, mitkush)
+- **`schema_reaper scan --format json` could not distinguish a genuinely
+  zero-byte reclaim estimate from an unmeasured one.** `Finding#to_h` read
+  the zero-defaulted accessor instead of the raw value, silently flattening
+  "unknown" into `0` for every CI/tooling consumer of the JSON output, even
+  though every other reporter already preserves that distinction. The
+  payload now carries the raw value plus an explicit `reclaim_known` flag.
+  Verified live: an unmeasured finding now serializes `reclaimable_bytes`
+  as `null` with `reclaim_known: false`. (#18, mitkush)
+- **A query-time Postgres error (anything past the initial connection)
+  propagated as a raw `PG::Error`** instead of the wrapped `SchemaReaper::Error`
+  every other failure path produces, leaking a Ruby backtrace instead of a
+  clean CLI error message. `primary_key_for`'s existing fallback-to-nil
+  rescue is updated to match. (#18, mitkush)
+- Cosmetic: `MigrationGenerator#model` mangled irregular plural table names
+  (`addresses` → "Addresse") in the generated migration's comment text;
+  `Reporters::Trend#bytes` printed `-0.0 B` instead of `+0.0 B` for a zero
+  delta. (#17, mitkush)
+
 ## [1.0.15] - 2026-09-18
 
 ### Fixed

data/lib/schema_reaper/analyzers/missing_fk_index.rb

@@ -32,11 +32,15 @@ module SchemaReaper
 
       def missing_in(table)
         fk_columns(table).filter_map do |col|
-          next if indexed?(table, col)
-          next if empty_column?(table, col) # never advise indexing a column with no data
-
           type_col = polymorphic_type_for(table, col)
-          next if type_col && polymorphic_indexed?(table, type_col, col)
+
+          # A bare index on the id alone doesn't cover a polymorphic pair --
+          # only the composite (type, id) index satisfies it. Check that
+          # instead of the generic `indexed?`, or a bare id-only index would
+          # wrongly suppress this finding.
+          covered = type_col ? polymorphic_indexed?(table, type_col, col) : indexed?(table, col)
+          next if covered
+          next if empty_column?(table, col) # never advise indexing a column with no data
 
           finding_for(table, col, type_col, declared: table.foreign_keys.include?(col))
         end

data/lib/schema_reaper/finding.rb

@@ -50,8 +50,12 @@ module SchemaReaper
       parts.empty? ? nil : parts.join(" · ")
     end
 
+    # Keeps the raw (possibly nil) reclaimable_bytes from Struct#to_h rather
+    # than the zero-defaulted accessor above, so JSON/SARIF consumers can tell
+    # "genuinely zero" apart from "unknown" the same way every other reporter
+    # does -- reclaim_known? makes that distinction explicit in the payload.
     def to_h
-      super.merge(id: id, reclaimable_bytes: reclaimable_bytes)
+      super.merge(id: id, reclaim_known: reclaim_known?)
     end
   end
 end

data/lib/schema_reaper/introspect/postgres.rb

@@ -8,13 +8,12 @@ module SchemaReaper
       AVG_TYPE_BYTES = {
         "boolean" => 1, "smallint" => 2, "integer" => 4, "bigint" => 8,
         "real" => 4, "double precision" => 8, "numeric" => 8,
-        "date" => 4, "timestamp without time zone" => 8,
-        "timestamp with time zone" => 8, "uuid" => 16
+        "date" => 4, "timestamp without time zone" => 8, "timestamp with time zone" => 8, "uuid" => 16
       }.freeze
 
       NO_URL = "no database connection found. schema_reaper looks, in order, for: " \
-               "database_url: in .schema_reaper.yml; the DATABASE_URL env var; " \
-               "config/database.yml for RAILS_ENV (default: development, Postgres only)."
+               "database_url: in .schema_reaper.yml; the DATABASE_URL env var; config/database.yml " \
+               "for RAILS_ENV (default: development, Postgres only)."
 
       # A record separator that cannot appear inside a plain identifier and is
       # exceedingly unlikely inside an expression, so splitting the aggregated
@@ -119,7 +118,7 @@ module SchemaReaper
           JOIN pg_class i ON i.oid = ix.indexrelid
           JOIN LATERAL generate_series(1, ix.indnkeyatts) AS k(ord) ON TRUE
           LEFT JOIN pg_stat_user_indexes s ON s.indexrelid = i.oid
-          WHERE t.relname = $1
+          WHERE t.relname = $1 AND t.relnamespace = 'public'::regnamespace
           GROUP BY i.relname, ix.indisunique, ix.indisprimary, ix.indpred, s.idx_scan
         SQL
           Index.new(
@@ -142,7 +141,7 @@ module SchemaReaper
           WHERE i.indrelid = $1::regclass AND i.indisprimary
           ORDER BY k.ord
         SQL
-      rescue PG::Error
+      rescue Error, PG::Error
         nil
       end
 
@@ -172,6 +171,8 @@ module SchemaReaper
 
       def exec(sql, params = nil)
         (params ? @conn.exec_params(sql, params) : @conn.exec(sql)).to_a
+      rescue PG::Error => e
+        raise Error, "query against the database failed: #{e.message.strip}"
       end
     end
   end

data/lib/schema_reaper/migration_generator.rb

@@ -5,6 +5,14 @@ require "fileutils"
 module SchemaReaper
   # Emits a two-step, reversible migration pair for a dead column.
   class MigrationGenerator
+    # Enough of Rails' inflector for table names in this comment text -- a
+    # wrong guess doesn't break anything functional, just reads oddly.
+    SINGULAR_RULES = [
+      [/ies\z/, "y"],               # activities -> activity
+      [/(ss|sh|ch|x|z)es\z/, '\1'], # addresses  -> address, boxes -> box
+      [/s\z/, ""]                   # employees  -> employee
+    ].freeze
+
     def initialize(table:, column:, dir: "db/migrate")
       @table = table
       @column = column
@@ -77,7 +85,12 @@ module SchemaReaper
     end
 
     def model
-      @table.split("_").map(&:capitalize).join.sub(/s$/, "")
+      singular.split("_").map(&:capitalize).join
+    end
+
+    def singular
+      rule = SINGULAR_RULES.find { |pattern, _| @table.match?(pattern) }
+      rule ? @table.sub(rule[0], rule[1]) : @table
     end
   end
 end

data/lib/schema_reaper/railtie.rb

@@ -12,10 +12,17 @@ module SchemaReaper
     initializer "schema_reaper.runtime_tracker" do
       next unless ENV["SCHEMA_REAPER_TRACK"] == "1"
 
-      config = SchemaReaper::Config.load
-      store = SchemaReaper::Runtime::Store.new(path: config.runtime_log)
-      rate = (ENV["SCHEMA_REAPER_SAMPLE"] || "0.05").to_f
-      SchemaReaper::Runtime::Tracker.install!(store: store, sample_rate: rate)
+      begin
+        config = SchemaReaper::Config.load
+        store = SchemaReaper::Runtime::Store.new(path: config.runtime_log)
+        rate = (ENV["SCHEMA_REAPER_SAMPLE"] || "0.05").to_f
+        SchemaReaper::Runtime::Tracker.install!(store: store, sample_rate: rate)
+      rescue StandardError => e
+        # Optional instrumentation must never take the host app down with it --
+        # a bad config file or an unwritable log directory disables tracking,
+        # it does not abort boot.
+        Rails.logger&.warn("[schema_reaper] runtime tracker disabled: #{e.class}: #{e.message}")
+      end
     end
   end
 end

data/lib/schema_reaper/reporters/trend.rb

@@ -47,7 +47,7 @@ module SchemaReaper
 
       def bytes
         delta = @d[:bytes_change_total].to_i
-        sign = delta.positive? ? "+" : "-"
+        sign = delta.negative? ? "-" : "+"
         @c.row("reclaimable", Bytes.human(@d.fetch(:latest_bytes, 0)),
                "#{sign}#{Bytes.human(delta.abs)} since first run")
       end

data/lib/schema_reaper/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_reaper
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.16
 platform: ruby
 authors:
 - aksshatt
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-18 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism