schema_reaper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c7a7ccaeefa1c6ddc5597a3b54ebb358fdac16ba72e8413b79cc70ecdf9223e
+  data.tar.gz: e6a801a21a746da04c63416669c0cf35e55975b8af85b631502847bdba769189
+SHA512:
+  metadata.gz: fd33e938eddd3fd6ffb0e50dca359a62ac6974573838605f627a999bed26114d7501f92ae9edb769053ba65b8ee2d5a6f1d5f7b01f84b39f8abb8707ca6113ce
+  data.tar.gz: aceba9a2f2fdcb55d8b780b5d1e85a7431c9a587f3592e019c3434e7e0e7343d60d10ee8f7063f4b888027f4bdf3c59e7caa09f04b82c1803e3d96afcef239a3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - "lib/schema_reaper/runtime.rb" # nested Hook/Tracker helpers
+
+Style/SafeNavigationChainLength:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Naming/MethodParameterName:
+  AllowedNames: [f, n, io, id, at, to, db]
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Metrics/ParameterLists:
+  Exclude:
+    - "spec/**/*"
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 130
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/PerceivedComplexity:
+  Max: 13
+
+Metrics/AbcSize:
+  Max: 28

data/.schema_reaper.yml.example

@@ -0,0 +1,43 @@
+# Copy to .schema_reaper.yml and edit. Every key is optional.
+---
+# database_url: postgres://localhost/myapp_development   # else ENV["DATABASE_URL"]
+
+scan_paths:
+  - app
+  - lib
+  - config
+
+view_globs:
+  - app/**/*.erb
+  - app/**/*.haml
+  - app/**/*.slim
+  - app/**/*.jbuilder
+
+ignore:
+  tables:
+    - schema_migrations
+    - ar_internal_metadata
+  columns:
+    - "/_cache$/"        # wrap in slashes for a regex
+    - legacy_notes
+
+always_keep_columns:
+  - id
+  - created_at
+  - updated_at
+  - type
+
+# Auto-whitelist columns owned by gems in your bundle (devise, paper_trail,
+# activestorage, actiontext, friendly_id, audited, pg_search, ahoy_matey, ...).
+gem_awareness: true
+
+# Runtime usage log written by the tracker (see README > Runtime signal).
+runtime_log: .schema_reaper/runtime.jsonl
+
+# Append-only snapshot log for `schema_reaper trend`.
+history_log: .schema_reaper/history.jsonl
+
+baseline: .schema_reaper/baseline.json
+
+# Extra Ruby files to load before analysis -- register custom analyzers here.
+require: []

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+## [1.0.0] - 2026-09-04
+
+First stable release.
+
+### Analyzers
+- `dead_column` — schema column never referenced in code; fuses in runtime
+  signal when present to break the 0.6 static-only confidence cap.
+- `dead_table` — table with no model/query reference and (when known) zero rows.
+- `unused_index` — non-unique index with `idx_scan = 0` in `pg_stat_user_indexes`.
+- `duplicate_index` — index that is a leading prefix of a wider index.
+- `missing_fk_index` — foreign-key / `*_id` column with no covering index.
+- `always_null_column` — column with `null_frac = 1.0` in `pg_stats`.
+- `single_value_column` — column with one distinct value on a large table.
+
+### Signal
+- Postgres introspection now also reads row counts (`pg_class.reltuples`),
+  per-column `pg_stats` (`null_frac`, `n_distinct`) and index scan counts.
+- Optional runtime tracker: samples ActiveRecord attribute reads into a JSONL
+  log; `Runtime::Report` aggregates it and analyzers fuse it in.
+- Gem-awareness maps auto-whitelist columns owned by devise, paper_trail,
+  audited, friendly_id, activestorage, actiontext, pg_search, ahoy_matey and
+  the paranoia family, scoped to tables that actually carry the anchor column.
+
+### Output & workflow
+- Reporters: `table`, `json`, `markdown` (PR-comment ready), `sarif` 2.1.0
+  (GitHub code scanning).
+- Reclaimable-bytes estimate per finding and per run, from row counts.
+- `schema_reaper trend` + append-only history log for cleanup burndown.
+- `scan --ci` gates only findings absent from `.schema_reaper/baseline.json`;
+  `scan --record`, `scan --min-confidence`.
+- Whole-dead-table findings suppress their own column/index noise.
+- Rails railtie: `rake schema_reaper:scan|baseline|trend`, opt-in runtime
+  tracker via `SCHEMA_REAPER_TRACK=1`.
+- Custom analyzers loadable through the `require:` config key.
+
+### Not in 1.0 (planned)
+- MySQL adapter.
+- Mountable dashboard engine.
+- Orphan-row and schema-drift analyzers.
+
+## [0.1.0]
+- Initial scaffold: `dead_column` static analyzer, table/JSON reporters,
+  baseline, staged migration generator.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at akshatpegwar5@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 aksshatt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# schema_reaper
+
+Find dead columns, dead tables, unused indexes and other schema dead-weight in
+Rails / ActiveRecord apps — then remove them safely.
+
+`schema_reaper` reads your **live PostgreSQL schema and planner statistics** and
+cross-references them against a **static scan of your codebase** (Ruby via the
+Prism AST, plus views and SQL string literals). Optionally it also fuses in a
+**runtime signal** — a sampled log of which columns are actually read in
+production. Every finding is scored by confidence and severity, carries an
+estimate of the disk it reclaims, and comes with a concrete fix.
+
+## Install
+
+```ruby
+# Gemfile
+gem "schema_reaper", group: :development
+```
+
+```
+bundle install
+```
+
+Requires Ruby >= 3.1 and PostgreSQL. The database connection resolves from
+`database_url` in `.schema_reaper.yml`, else `ENV["DATABASE_URL"]`.
+
+## Usage
+
+```
+bundle exec schema_reaper scan                    # human-readable report
+bundle exec schema_reaper scan --format markdown  # PR-comment table
+bundle exec schema_reaper scan --format sarif     # GitHub code scanning
+bundle exec schema_reaper scan --format json
+bundle exec schema_reaper scan --ci               # exit 1 on new findings
+bundle exec schema_reaper scan --min-confidence 0.8
+bundle exec schema_reaper baseline                # accept current findings
+bundle exec schema_reaper trend                   # snapshot + progress delta
+bundle exec schema_reaper generate-migration users legacy_api_token
+```
+
+In a Rails app the railtie also gives you
+`rake schema_reaper:scan|baseline|trend` (with `FORMAT=`).
+
+## Analyzers
+
+| type | what it flags | main signal |
+|---|---|---|
+| `dead_column` | column no code path references | static scan (+ runtime) |
+| `dead_table` | table with no model/query reference | static scan + row count |
+| `unused_index` | non-unique index, `idx_scan = 0` | `pg_stat_user_indexes` |
+| `duplicate_index` | index that is a prefix of a wider one | schema shape |
+| `missing_fk_index` | `*_id` / FK column with no index | schema shape |
+| `always_null_column` | `null_frac = 1.0` — no data at all | `pg_stats` |
+| `single_value_column` | one distinct value on a large table | `pg_stats` |
+
+Columns owned by common gems (devise, paper_trail, activestorage, actiontext,
+friendly_id, audited, pg_search, ahoy_matey, paranoia family) are whitelisted
+automatically when the gem is in your bundle.
+
+## Runtime signal (optional, raises confidence)
+
+Static analysis alone can't see metaprogrammed access, so `dead_column`
+confidence is capped at **0.6** without runtime data. To lift the cap:
+
+```ruby
+# config/initializers or manually
+SchemaReaper::Runtime::Tracker.install!(
+  store: SchemaReaper::Runtime::Store.new(path: ".schema_reaper/runtime.jsonl"),
+  sample_rate: 0.05
+)
+```
+
+or, in Rails, boot with `SCHEMA_REAPER_TRACK=1`. Let it run in staging or
+production for a couple of weeks. A column unseen in **both** code and
+>= 14 observed days of runtime data reaches ~0.9 confidence.
+
+## Safety model
+
+`schema_reaper` never drops anything itself. `generate-migration` emits a pair:
+
+1. **Ignore** — you add `self.ignored_columns += %w[col]` to the model and
+   deploy. Nothing is dropped.
+2. **Drop** — run only after step 1 has soaked in production and nothing broke.
+
+`always_null_column` / `single_value_column` fixes ask you to confirm with a
+`SELECT` first.
+
+## CI
+
+```yaml
+# .github/workflows/schema_reaper.yml
+- run: bundle exec schema_reaper scan --ci --format sarif > reaper.sarif
+- uses: github/codeql-action/upload-sarif@v3
+  with: { sarif_file: reaper.sarif }
+```
+
+Commit `.schema_reaper/baseline.json` so the job fails only when a change adds
+*new* dead weight.
+
+## Custom analyzers
+
+```ruby
+# lib/schema_reaper/analyzers/my_check.rb
+class MyCheck < SchemaReaper::Analyzers::Base
+  SchemaReaper::Analyzers::Registry.register(self)
+
+  def call
+    schema.tables.filter_map { |t| ... finding(type: :my_check, table: t.name, ...) }
+  end
+end
+```
+
+```yaml
+# .schema_reaper.yml
+require:
+  - lib/schema_reaper/analyzers/my_check.rb
+```
+
+## Roadmap
+
+- Runtime verdict fusion for index and table findings
+- Orphan-row and `schema.rb`↔DB drift analyzers
+- Disk/$ reclaim from real `pg_total_relation_size`
+- Mountable dashboard engine, trend charts
+- MySQL adapter
+
+## Development
+
+```
+bin/setup
+bundle exec rake        # rspec + rubocop
+```
+
+## License
+
+MIT.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/schema_reaper

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "schema_reaper/cli"
+
+SchemaReaper::CLI.start(ARGV)

data/lib/schema_reaper/analyzers/always_null_column.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SchemaReaper
+  module Analyzers
+    # A column that is NULL in every row (per pg_stats). The data itself says
+    # it is dead, independent of code references.
+    class AlwaysNullColumn < Base
+      Registry.register(self)
+
+      def call
+        schema.tables.reject { |t| config.ignore_tables.include?(t.name) }
+              .flat_map { |t| null_in(t) }
+      end
+
+      private
+
+      def null_in(table)
+        return [] unless table.row_count&.positive?
+
+        table.columns.filter_map do |col|
+          next unless col.always_null?
+          next if config.always_keep_columns.include?(col.name)
+          next if gem_reserved?(table.name, col.name)
+
+          finding(
+            type: :always_null_column,
+            table: table.name,
+            column: col.name,
+            severity: :high,
+            confidence: 0.85,
+            bytes_per_row: col.bytes,
+            evidence: [
+              "pg_stats.null_frac = 1.0 across ~#{table.row_count} row(s)",
+              "column carries no data"
+            ],
+            suggested_fix: "verify with `SELECT count(#{col.name}) FROM #{table.name}` " \
+                           "then stage a removal"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/schema_reaper/analyzers/base.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SchemaReaper
+  module Analyzers
+    # Context passed to every analyzer's #call.
+    #   schema       - DatabaseSchema
+    #   used_tokens  - Set<String> from the static scan
+    #   runtime      - Runtime::Report (may be empty)
+    #   gem_columns  - Hash{table_name => Set<column_name>} reserved by gems
+    #   config       - Config
+    Context = Struct.new(:schema, :used_tokens, :runtime, :gem_columns, :config, keyword_init: true) do
+      def runtime = self[:runtime] || Runtime::Report.empty
+      def gem_columns = self[:gem_columns] || {}
+    end
+
+    # Shared plumbing for analyzers: schema access and token lookup helpers.
+    class Base
+      def self.type
+        name.split("::").last.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym
+      end
+
+      def initialize(context)
+        @ctx = context
+      end
+
+      # @return [Array<Finding>]
+      def call = raise NotImplementedError
+
+      private
+
+      attr_reader :ctx
+
+      def schema = ctx.schema
+      def config = ctx.config
+      def runtime = ctx.runtime
+      def used?(token) = ctx.used_tokens.include?(token.to_s.downcase)
+
+      def gem_reserved?(table, column)
+        ctx.gem_columns.fetch(table, []).include?(column)
+      end
+
+      # Builds a Finding, filling in reclaimable_bytes from the row count.
+      def finding(table:, bytes_per_row: 0, row_count: nil, **rest)
+        rows = row_count || schema.table(table)&.row_count || 0
+        Finding.new(
+          table: table,
+          bytes_per_row: bytes_per_row,
+          reclaimable_bytes: bytes_per_row * rows,
+          **rest
+        )
+      end
+    end
+  end
+end

data/lib/schema_reaper/analyzers/dead_column.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SchemaReaper
+  module Analyzers
+    # Flags columns present in the schema but never referenced in code. When a
+    # runtime usage log is supplied, its signal is fused in: a column unseen in
+    # BOTH code and >= 14 observed days of runtime reaches high confidence.
+    class DeadColumn < Base
+      Registry.register(self)
+
+      STATIC_ONLY_CAP  = 0.6
+      RUNTIME_MIN_DAYS = 14
+
+      def call
+        schema.tables.reject { |t| config.ignore_tables.include?(t.name) }
+              .flat_map { |t| dead_in(t) }
+      end
+
+      private
+
+      def dead_in(table)
+        table.columns.filter_map do |col|
+          next if keep?(table, col)
+          next if used?(col.name)
+          next if runtime.read?(table.name, col.name)
+
+          finding(
+            type: :dead_column,
+            table: table.name,
+            column: col.name,
+            severity: col.null ? :medium : :high,
+            confidence: confidence_for(col),
+            bytes_per_row: col.bytes,
+            evidence: evidence_for(table, col),
+            suggested_fix: "Stage removal: `self.ignored_columns += %w[#{col.name}]` on the " \
+                           "model, deploy, then `remove_column :#{table.name}, :#{col.name}`."
+          )
+        end
+      end
+
+      def keep?(table, col)
+        config.always_keep_columns.include?(col.name) ||
+          config.ignored_column?(col.name) ||
+          col.name == table.primary_key ||
+          table.foreign_keys.include?(col.name) ||
+          col.name.end_with?("_id", "_type") ||
+          gem_reserved?(table.name, col.name)
+      end
+
+      def confidence_for(col)
+        if runtime.present? && runtime.observed_days >= RUNTIME_MIN_DAYS
+          col.null ? 0.9 : 0.8
+        else
+          base = col.null ? 0.5 : 0.4
+          [base, STATIC_ONLY_CAP].min
+        end
+      end
+
+      def evidence_for(table, col)
+        ev = ["no `#{col.name}` reference found in scanned code"]
+        ev << "column is nullable" if col.null
+        ev << if runtime.present?
+                "not read in #{runtime.observed_days} observed day(s) of runtime data"
+              else
+                "static signal only — confidence capped at #{STATIC_ONLY_CAP}"
+              end
+        ev << "table holds ~#{table.row_count} row(s)" if table.row_count
+        ev
+      end
+    end
+  end
+end

data/lib/schema_reaper/analyzers/dead_table.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module SchemaReaper
+  module Analyzers
+    # A table with no model reference in code, no runtime access, and (if known)
+    # zero rows. Reported as one finding for the whole table.
+    class DeadTable < Base
+      Registry.register(self)
+
+      def call
+        schema.tables.reject { |t| ignored?(t) }.filter_map { |t| dead(t) }
+      end
+
+      private
+
+      def ignored?(table)
+        config.ignore_tables.include?(table.name) ||
+          table.name.start_with?("active_storage_", "action_text_", "action_mailbox_")
+      end
+
+      def dead(table)
+        return if referenced?(table)
+        return if runtime.accessed.any? { |k| k.start_with?("#{table.name}.") }
+
+        finding(
+          type: :dead_table,
+          table: table.name,
+          column: nil,
+          severity: :high,
+          confidence: confidence_for(table),
+          bytes_per_row: table.columns.sum(&:bytes),
+          evidence: evidence_for(table),
+          suggested_fix: "confirm no external consumer, then `drop_table :#{table.name}`"
+        )
+      end
+
+      # Match the table name and its singular/camelized model form.
+      def referenced?(table)
+        singular = table.name.sub(/s\z/, "")
+        [table.name, singular, camelize(table.name), camelize(singular)]
+          .any? { |form| used?(form) }
+      end
+
+      def confidence_for(table)
+        return 0.5 if table.row_count.nil?
+
+        table.row_count.zero? ? 0.85 : 0.4
+      end
+
+      def evidence_for(table)
+        ev = ["no model or query reference to `#{table.name}` in scanned code"]
+        ev << "runtime data shows no access" if runtime.present?
+        ev << "table holds ~#{table.row_count} row(s)" unless table.row_count.nil?
+        ev
+      end
+
+      def camelize(str) = str.split("_").map(&:capitalize).join
+    end
+  end
+end