ruby-pg-extras 5.6.15 → 5.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e20ed34b0677aa7e50c14ca2d5a511d4854f0eb34a1ad7e04a4f94fe2349895b
-  data.tar.gz: ef35f2a431195ba26a0271808315b54985254df379412ffb4eef9dc4ff81f7e8
+  metadata.gz: 789f323a6bba1cdf366a6eb53b5102a4a0f3d43ebafb1ea2f3151451bb28bffa
+  data.tar.gz: 4faaa79f35aa2c32c1b7c9d7def43b9319d43bb67a3933458bec3badceb672b6
 SHA512:
-  metadata.gz: 6145da151dc40da7d0f79a3a2c9ff3d059dd9b320e44b751f6d5a9d0b00d395a78aff3c8bd1bf51453aa65ccb7cf12953ec73e54b4a350d7ee34ec61b5f661a0
-  data.tar.gz: 72861cc4517a977e39266f2617094db82be77ba31f932831785540c3bc3ae078e1deccbc32b5b025343bbbe2e2c2d25529e24dad170ea9e8969795dfe3ee64de
+  metadata.gz: 8fe626803b4d7eb880f45571998dac5fd95d0430967c8f111d56ca72891732bc957db2276579bab6063087a8241c13ac2daa28e4059bcb4ac1c6688e6e5af478
+  data.tar.gz: b849cd97547e4b394dc4fb6a6e0af538e8dc8c51d85653af165b944c341d0e9cf98ecb0df7607a807145a5befb67cf097f7275dde9de9303d694cb28e6e59b99

data/README.md

@@ -118,7 +118,7 @@ Keep reading to learn about methods that `diagnose` uses under the hood.
 
 ### `missing_fk_indexes`
 
-This method lists columns likely to be foreign keys (i.e. column name ending in `_id` and related table exists) which don't have an index. It's recommended to always index foreign key columns because they are used for searching relation objects. 
+This method lists **actual foreign key columns** (based on existing foreign key constraints) which don't have a supporting index. It's recommended to always index foreign key columns because they are commonly used for lookups and join conditions.
 
 You can add indexes on the columns returned by this query and later check if they are receiving scans using the [unused_indexes method](#unused_indexes). Please remember that each index decreases write performance and autovacuuming overhead, so be careful when adding multiple indexes to often updated tables.
 
@@ -136,14 +136,34 @@ RubyPgExtras.missing_fk_indexes(args: { table_name: "users" })
 
 ```
 
+You can also exclude known/intentional cases using `ignore_list` (array or comma-separated string), with entries like:
+- `"posts.topic_id"` (ignore a specific table+column)
+- `"topic_id"` (ignore this column name for all tables)
+- `"posts.*"` (ignore all columns on a table)
+- `"*"` (ignore everything)
+
+```ruby
+RubyPgExtras.missing_fk_indexes(args: { ignore_list: ["users.company_id", "posts.*"] })
+```
+
 `table_name` argument is optional, if omitted, the method will display missing fk indexes for all the tables.
 
 ## `missing_fk_constraints`
 
-Similarly to the previous method, this one shows columns likely to be foreign keys that don't have a corresponding foreign key constraint. Foreign key constraints improve data integrity in the database by preventing relations with nonexisting objects. You can read more about the benefits of using foreign keys [in this blog post](https://pawelurbanek.com/rails-postgresql-data-integrity).
+This method shows **columns that look like foreign keys** but don't have a corresponding foreign key constraint yet. Foreign key constraints improve data integrity in the database by preventing relations with nonexisting objects. You can read more about the benefits of using foreign keys [in this blog post](https://pawelurbanek.com/rails-postgresql-data-integrity).
+
+Heuristic notes:
+- A column is considered a candidate if it matches `<table_singular>_id` and the related table exists (underscored prefixes like `account_user_id` are supported).
+- Rails polymorphic associations (`<name>_id` + `<name>_type`) are ignored since they cannot be expressed as real FK constraints.
+
+You can also exclude known/intentional cases using `ignore_list` (array or comma-separated string), with entries like:
+- `"posts.category_id"` (ignore a specific table+column)
+- `"category_id"` (ignore this column name for all tables)
+- `"posts.*"` (ignore all columns on a table)
+- `"*"` (ignore everything)
 
 ```ruby
-RubyPgExtras.missing_fk_constraints(args: { table_name: "users" })
+RubyPgExtras.missing_fk_constraints(args: { table_name: "users", ignore_list: ["users.customer_id", "posts.*"] })
 
 +---------------------------------+
 | Missing foreign key constraints |

data/docker-compose.yml.sample

@@ -36,7 +36,7 @@ services:
     ports:
       - '5436:5432'
   postgres17:
-    image: postgres:17.0-alpine
+    image: postgres:17.7-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -44,4 +44,13 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5437:5432'
+  postgres18:
+    image: postgres:18.1-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: ruby-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5438:5432'
 

data/lib/ruby-pg-extras.rb

@@ -192,7 +192,7 @@ module RubyPgExtras
   end
 
   def self.missing_fk_indexes(args: {}, in_format: :display_table)
-    RubyPgExtras::MissingFkIndexes.call(args[:table_name])
+    RubyPgExtras::MissingFkIndexes.call(args[:table_name], ignore_list: args[:ignore_list])
   end
 
   def self.missing_fk_constraints(args: {}, in_format: :display_table)

data/lib/ruby_pg_extras/missing_fk_indexes.rb

@@ -2,11 +2,18 @@
 
 module RubyPgExtras
   class MissingFkIndexes
-    def self.call(table_name)
-      new.call(table_name)
+    # ignore_list: array (or comma-separated string) of entries like:
+    # - "posts.topic_id" (ignore a specific table+column)
+    # - "topic_id"       (ignore this column name for all tables)
+    # - "posts.*"        (ignore all columns on a table)
+    # - "*"              (ignore everything)
+    def self.call(table_name, ignore_list: nil)
+      new.call(table_name, ignore_list: ignore_list)
     end
 
-    def call(table_name)
+    def call(table_name, ignore_list: nil)
+      ignore_list_matcher = IgnoreList.new(ignore_list)
+
       indexes_info = query_module.indexes(in_format: :hash)
       foreign_keys = query_module.foreign_keys(in_format: :hash)
 
@@ -23,6 +30,9 @@ module RubyPgExtras
         table_fks.each do |fk|
           column_name = fk.fetch("column_name")
 
+          # Skip columns explicitly excluded via ignore list.
+          next if ignore_list_matcher.ignored?(table: table, column_name: column_name)
+
           if index_info.none? { |row| row.fetch("columns").split(",").first == column_name }
             agg.push(
               {

data/lib/ruby_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyPgExtras
-  VERSION = "5.6.15"
+  VERSION = "5.6.16"
 end

data/spec/missing_fk_indexes_spec.rb

@@ -18,4 +18,26 @@ describe "missing_fk_indexes" do
       { table: "posts", column_name: "topic_id" },
     ])
   end
+
+  it "supports ignoring a specific table+column via args" do
+    result = RubyPgExtras.missing_fk_indexes(
+      args: { ignore_list: ["posts.topic_id"] },
+      in_format: :hash
+    )
+
+    expect(result).to eq([
+      { table: "users", column_name: "company_id" },
+    ])
+  end
+
+  it "supports ignoring a column name globally via args" do
+    result = RubyPgExtras.missing_fk_indexes(
+      args: { ignore_list: ["company_id"] },
+      in_format: :hash
+    )
+
+    expect(result).to eq([
+      { table: "posts", column_name: "topic_id" },
+    ])
+  end
 end

data/spec/spec_helper.rb

@@ -12,9 +12,10 @@ PG_PORTS = {
   "15" => "5435",
   "16" => "5436",
   "17" => "5437",
+  "18" => "5438",
 }
 
-port = PG_PORTS.fetch(pg_version, "5432")
+port = PG_PORTS.fetch(pg_version, "5438")
 
 ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/ruby-pg-extras-test"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.6.15
+  version: 5.6.16
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-16 00:00:00.000000000 Z
+date: 2026-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg