ruby-pg-extras 5.6.0 → 5.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1348ba4881f0d65e98e76e5224fc830d5c124f9005a66d5b4157da7eb8f7cfd3
-  data.tar.gz: 83803cc3cbb81a80791b74aa8c768d6033f572d71b8074083c96172bc41f364e
+  metadata.gz: 57c2a84fde86ad8d8f2edba0c3bb0036b525df7471013341338291b1e8c1f8e9
+  data.tar.gz: bc5624774204781bd1e970f118957aea5107e555c6f5698f3d32f7dfe5f3dc8e
 SHA512:
-  metadata.gz: 27e9cc6ffc9dd82e53bc1511a8338123b2d2c60fb820358955d47412026d9b77660975d32005e829085bd780adf448774f9801507edf2a9844594b0318645779
-  data.tar.gz: d27cd85774ca39e9837c136e006359beb3e88ddf10ca5b5c6b88ea59b3734731a0a0dfb1f97a9e905aff034e67a3cc5e8da250a0cdc6bb18fb5a6dfb2b9b7a95
+  metadata.gz: bbe16634243b05f414ca9eee58b30b939a3a7bed2bbadead9782aa39951bb2b4dc13e71cd5b3e38a0698b03fb330b43427a807f1b221e4beb62128e3dc2e6a62
+  data.tar.gz: 6ea5ef05e992a7f8f9dcb986b3ff983a888584bea0468711ce7e40a4c43c4485d205fbd1bb71dd50591f37e5036406829f7ae24f3ec5b5390da2e75bca7eccb7

data/README.md

@@ -118,27 +118,45 @@ 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. name ending in `_id`) but don't have a corresponding index. It's a generally recommended to always index foreign key columns because they are used for searching relation objects. 
+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. 
 
-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 also remember that each index decreases write performance and autovacuuming overhead, so be careful when adding multiple indexes to often updated tables.
+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.
 
 ```ruby
 RubyPgExtras.missing_fk_indexes(args: { table_name: "users" })
 
++---------------------------------+
+| Missing foreign key indexes     |
++-------------------+-------------+
+| table             | column_name |
++-------------------+-------------+
+| feedbacks         | team_id     |
+| votes             | user_id     |
++-------------------+-------------+
+
 ```
 
 `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 (i.e. name ending in `_id`) 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).
+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).
 
 ```ruby
 RubyPgExtras.missing_fk_constraints(args: { table_name: "users" })
 
++---------------------------------+
+| Missing foreign key constraints |
++-------------------+-------------+
+| table             | column_name |
++-------------------+-------------+
+| feedbacks         | team_id     |
+| votes             | user_id     |
++-------------------+-------------+
+
 ```
 
-`table_name` argument is optional, if omitted, method will display missing foreign keys for all the tables.
+`table_name` argument is optional, if omitted, method will display missing fk constraints for all the tables.
 
 ### `table_info`
 
@@ -160,6 +178,14 @@ This method displays structure of a selected table, listing its column names, to
 ```ruby
 RubyPgExtras.table_schema(args: { table_name: "users" })
 
++-----------------------------+-----------------------------+-------------+-----------------------------------+
+| column_name                 | data_type                   | is_nullable | column_default                    |
++-----------------------------+-----------------------------+-------------+-----------------------------------+
+| id                          | bigint                      | NO          | nextval('users_id_seq'::regclass) |
+| team_id                     | integer                     | NO          |                                   |
+| slack_id                    | character varying           | NO          |                                   |
+| pseudonym                   | character varying           | YES         |                                   |
+
 ```
 
 ### `table_foreign_keys`
@@ -169,6 +195,12 @@ This method displays foreign key constraints for a selected table. It lists fore
 ```ruby
 RubyPgExtras.table_foreign_keys(args: { table_name: "users" })
 
++------------+---------------------+-------------+--------------------+---------------------+
+| table_name | constraint_name     | column_name | foreign_table_name | foreign_column_name |
++------------+---------------------+-------------+--------------------+---------------------+
+| users      | fk_rails_b2bbf87303 | team_id     | teams              | id                  |
++------------+---------------------+-------------+--------------------+---------------------+
+
 ```
 
 ### `index_info`

data/lib/ruby-pg-extras.rb

@@ -6,6 +6,7 @@ require "pg"
 require "ruby_pg_extras/size_parser"
 require "ruby_pg_extras/diagnose_data"
 require "ruby_pg_extras/diagnose_print"
+require "ruby_pg_extras/detect_fk_column"
 require "ruby_pg_extras/missing_fk_indexes"
 require "ruby_pg_extras/missing_fk_constraints"
 require "ruby_pg_extras/index_info"
@@ -74,9 +75,9 @@ module RubyPgExtras
     end
   end
 
-  def self.run_query(query_name:, in_format:, args: {})
+  def self.run_query_base(query_name:, conn:, exec_method:, in_format:, args: {})
     if %i(calls outliers).include?(query_name)
-      pg_stat_statements_ver = RubyPgExtras.connection.exec("select installed_version from pg_available_extensions where name='pg_stat_statements'")
+      pg_stat_statements_ver = conn.send(exec_method, "select installed_version from pg_available_extensions where name='pg_stat_statements'")
         .to_a[0].fetch("installed_version", nil)
       if pg_stat_statements_ver != nil
         if Gem::Version.new(pg_stat_statements_ver) < Gem::Version.new(NEW_PG_STAT_STATEMENTS)
@@ -98,7 +99,7 @@ module RubyPgExtras
       else
         sql_for(query_name: query_name)
       end
-    result = connection.exec(sql)
+    result = conn.send(exec_method, sql)
 
     display_result(
       result,
@@ -107,6 +108,16 @@ module RubyPgExtras
     )
   end
 
+  def self.run_query(query_name:, in_format:, args: {})
+    run_query_base(
+      query_name: query_name,
+      conn: connection,
+      exec_method: :exec,
+      in_format: in_format,
+      args: args,
+    )
+  end
+
   def self.diagnose(in_format: :display_table)
     data = RubyPgExtras::DiagnoseData.call
 
@@ -154,7 +165,7 @@ module RubyPgExtras
   end
 
   def self.missing_fk_constraints(args: {}, in_format: :display_table)
-    RubyPgExtras::MissingFkContraints.call(args[:table_name])
+    RubyPgExtras::MissingFkConstraints.call(args[:table_name])
   end
 
   def self.display_result(result, title:, in_format:)
@@ -175,7 +186,7 @@ module RubyPgExtras
       puts Terminal::Table.new(
         title: title,
         headings: headings,
-        rows: result.values,
+        rows: (result.try(:values) || result.map(&:values)),
       )
     else
       raise "Invalid in_format option"

data/lib/ruby_pg_extras/detect_fk_column.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RubyPgExtras
+  class DetectFkColumn
+    PLURAL_RULES = [
+      [/s$/i, "s"],
+      [/^(ax|test)is$/i, '\1es'],
+      [/(octop|vir)us$/i, '\1i'],
+      [/(alias|status)$/i, '\1es'],
+      [/(bu)s$/i, '\1ses'],
+      [/(buffal|tomat)o$/i, '\1oes'],
+      [/([ti])um$/i, '\1a'],
+      [/sis$/i, "ses"],
+      [/(?:([^f])fe|([lr])f)$/i, '\1\2ves'],
+      [/([^aeiouy]|qu)y$/i, '\1ies'],
+      [/(x|ch|ss|sh)$/i, '\1es'],
+      [/(matr|vert|ind)(?:ix|ex)$/i, '\1ices'],
+      [/^(m|l)ouse$/i, '\1ice'],
+      [/^(ox)$/i, '\1en'],
+      [/(quiz)$/i, '\1zes'],
+    ]
+    IRREGULAR = {
+      "person" => "people",
+      "man" => "men",
+      "child" => "children",
+      "sex" => "sexes",
+      "move" => "moves",
+      "zombie" => "zombies",
+    }
+    UNCOUNTABLE = %w(equipment information rice money species series fish sheep jeans police)
+
+    def self.call(column_name, tables)
+      new.call(column_name, tables)
+    end
+
+    def call(column_name, tables)
+      return false unless column_name =~ /_id$/
+      table_name = column_name.split("_").first
+      table_name = pluralize(table_name)
+      tables.include?(table_name)
+    end
+
+    def pluralize(word)
+      return word if UNCOUNTABLE.include?(word.downcase)
+      return IRREGULAR[word] if IRREGULAR.key?(word)
+      return IRREGULAR.invert[word] if IRREGULAR.value?(word)
+
+      PLURAL_RULES.reverse.each do |(rule, replacement)|
+        return word.gsub(rule, replacement) if word.match?(rule)
+      end
+      word + "s"
+    end
+  end
+end

data/lib/ruby_pg_extras/diagnose_data.rb

@@ -23,6 +23,8 @@ module RubyPgExtras
         :null_indexes,
         :bloat,
         :duplicate_indexes,
+        :missing_fk_indexes,
+        :missing_fk_constraints,
       ].yield_self do |checks|
         extensions_data = query_module.extensions(in_format: :hash)
 
@@ -55,6 +57,46 @@ module RubyPgExtras
       RubyPgExtras
     end
 
+    def missing_fk_indexes
+      missing = query_module.missing_fk_indexes(in_format: :hash)
+
+      if missing.count == 0
+        return {
+                 ok: true,
+                 message: "No missing foreign key indexes detected.",
+               }
+      end
+
+      missing_text = missing.map do |el|
+        "#{el.fetch(:table)}.#{el.fetch(:column_name)}"
+      end.join(",\n")
+
+      {
+        ok: false,
+        message: "Missing foreign key indexes detected: #{missing_text}.",
+      }
+    end
+
+    def missing_fk_constraints
+      missing = query_module.missing_fk_constraints(in_format: :hash)
+
+      if missing.count == 0
+        return {
+                 ok: true,
+                 message: "No missing foreign key constraints detected.",
+               }
+      end
+
+      missing_text = missing.map do |el|
+        "#{el.fetch(:table)}.#{el.fetch(:column_name)}"
+      end.join(",\n")
+
+      {
+        ok: false,
+        message: "Missing foreign key constraints detected: #{missing_text}.",
+      }
+    end
+
     def table_cache_hit
       min_expected = ENV.fetch(
         "PG_EXTRAS_TABLE_CACHE_HIT_MIN_EXPECTED",

data/lib/ruby_pg_extras/missing_fk_constraints.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RubyPgExtras
-  class MissingFkContraints
+  class MissingFkConstraints
     def self.call(table_name)
       new.call(table_name)
     end
@@ -10,15 +10,17 @@ module RubyPgExtras
       tables = if table_name
           [table_name]
         else
-          RubyPgExtras.table_size(in_format: :hash).map { |row| row.fetch("name") }
+          all_tables
         end
 
       tables.reduce([]) do |agg, table|
-        foreign_keys_info = RubyPgExtras.table_foreign_keys(args: { table_name: table }, in_format: :hash)
-        schema = RubyPgExtras.table_schema(args: { table_name: table }, in_format: :hash)
+        foreign_keys_info = query_module.table_foreign_keys(args: { table_name: table }, in_format: :hash)
+        schema = query_module.table_schema(args: { table_name: table }, in_format: :hash)
 
         fk_columns = schema.filter_map do |row|
-          row.fetch("column_name") if row.fetch("column_name") =~ /_id$/
+          if DetectFkColumn.call(row.fetch("column_name"), all_tables)
+            row.fetch("column_name")
+          end
         end
 
         fk_columns.each do |column_name|
@@ -35,5 +37,15 @@ module RubyPgExtras
         agg
       end
     end
+
+    private
+
+    def all_tables
+      @_all_tables ||= query_module.table_size(in_format: :hash).map { |row| row.fetch("name") }
+    end
+
+    def query_module
+      RubyPgExtras
+    end
   end
 end

data/lib/ruby_pg_extras/missing_fk_indexes.rb

@@ -10,19 +10,23 @@ module RubyPgExtras
       tables = if table_name
           [table_name]
         else
-          RubyPgExtras.table_size(in_format: :hash).map { |row| row.fetch("name") }
+          all_tables
         end
 
+      indexes_info = query_module.indexes(in_format: :hash)
+
       tables.reduce([]) do |agg, table|
-        index_info = RubyPgExtras.index_info(args: { table_name: table }, in_format: :hash)
-        schema = RubyPgExtras.table_schema(args: { table_name: table }, in_format: :hash)
+        index_info = indexes_info.select { |row| row.fetch("tablename") == table }
+        schema = query_module.table_schema(args: { table_name: table }, in_format: :hash)
 
         fk_columns = schema.filter_map do |row|
-          row.fetch("column_name") if row.fetch("column_name") =~ /_id$/
+          if DetectFkColumn.call(row.fetch("column_name"), all_tables)
+            row.fetch("column_name")
+          end
         end
 
         fk_columns.each do |column_name|
-          if index_info.none? { |row| row.fetch(:columns)[0] == column_name }
+          if index_info.none? { |row| row.fetch("columns").split(",").first == column_name }
             agg.push(
               {
                 table: table,
@@ -35,5 +39,15 @@ module RubyPgExtras
         agg
       end
     end
+
+    private
+
+    def all_tables
+      @_all_tables ||= query_module.table_size(in_format: :hash).map { |row| row.fetch("name") }
+    end
+
+    def query_module
+      RubyPgExtras
+    end
   end
 end

data/lib/ruby_pg_extras/version.rb

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

data/spec/detect_fk_column_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe RubyPgExtras::DetectFkColumn do
+  subject(:result) do
+    RubyPgExtras::DetectFkColumn.call(column_name, tables)
+  end
+
+  describe "call" do
+    context "no matching table" do
+      let(:column_name) { "company_id" }
+      let(:tables) { ["users", "posts"] }
+
+      it "returns false" do
+        expect(result).to eq(false)
+      end
+    end
+
+    context "matching table" do
+      let(:column_name) { "user_id" }
+      let(:tables) { ["users", "posts"] }
+
+      it "returns true" do
+        expect(result).to eq(true)
+      end
+    end
+
+    context "matching table" do
+      let(:column_name) { "octopus_id" }
+      let(:tables) { ["users", "octopi"] }
+
+      it "returns true" do
+        expect(result).to eq(true)
+      end
+    end
+  end
+end

data/spec/diagnose_data_spec.rb

@@ -45,6 +45,20 @@ describe RubyPgExtras::DiagnoseData do
             { "query" => "SELECT * FROM users WHERE users.age > 20 AND users.height > 160", "exec_time" => "154:39:26.431466", "prop_exec_time" => "72.2%", "ncalls" => "34,211,877", "sync_io_time" => "00:34:19.784318" },
           ]
         }
+
+        expect(RubyPgExtras).to receive(:missing_fk_constraints) {
+          [
+            { table: "users", column_name: "company_id" },
+            { table: "posts", column_name: "topic_id" },
+          ]
+        }
+
+        expect(RubyPgExtras).to receive(:missing_fk_indexes) {
+          [
+            { table: "users", column_name: "company_id" },
+            { table: "posts", column_name: "topic_id" },
+          ]
+        }
       end
 
       it "works" do

data/spec/spec_helper.rb

@@ -24,6 +24,8 @@ RSpec.configure do |config|
     DB_SCHEMA = <<-SQL
 DROP TABLE IF EXISTS posts;
 DROP TABLE IF EXISTS users;
+DROP TABLE IF EXISTS topics;
+DROP TABLE IF EXISTS companies;
 
 CREATE TABLE users (
     id SERIAL PRIMARY KEY,
@@ -35,11 +37,22 @@ CREATE TABLE posts (
     id SERIAL PRIMARY KEY,
     user_id INTEGER NOT NULL,
     topic_id INTEGER,
+    external_id INTEGER,
     title VARCHAR(255),
     CONSTRAINT fk_posts_user FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
 );
 
-CREATE INDEX index_posts_on_user_id ON posts(user_id);
+CREATE TABLE topics (
+    id SERIAL PRIMARY KEY,
+    title VARCHAR(255)
+);
+
+CREATE TABLE companies (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(255)
+);
+
+CREATE INDEX index_posts_on_user_id ON posts(user_id, topic_id);
 SQL
 
     RubyPgExtras.connection.exec(DB_SCHEMA)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.2
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-01 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -111,6 +111,7 @@ files:
 - Rakefile
 - docker-compose.yml.sample
 - lib/ruby-pg-extras.rb
+- lib/ruby_pg_extras/detect_fk_column.rb
 - lib/ruby_pg_extras/diagnose_data.rb
 - lib/ruby_pg_extras/diagnose_print.rb
 - lib/ruby_pg_extras/index_info.rb
@@ -166,10 +167,11 @@ files:
 - lib/ruby_pg_extras/version.rb
 - ruby-pg-extras-diagnose.png
 - ruby-pg-extras.gemspec
+- spec/detect_fk_column_spec.rb
 - spec/diagnose_data_spec.rb
 - spec/diagnose_print_spec.rb
 - spec/index_info_spec.rb
-- spec/missing_fk_constraints.rb
+- spec/missing_fk_constraints_spec.rb
 - spec/missing_fk_indexes_spec.rb
 - spec/size_parser_spec.rb
 - spec/smoke_spec.rb
@@ -200,10 +202,11 @@ signing_key:
 specification_version: 4
 summary: Ruby PostgreSQL performance database insights
 test_files:
+- spec/detect_fk_column_spec.rb
 - spec/diagnose_data_spec.rb
 - spec/diagnose_print_spec.rb
 - spec/index_info_spec.rb
-- spec/missing_fk_constraints.rb
+- spec/missing_fk_constraints_spec.rb
 - spec/missing_fk_indexes_spec.rb
 - spec/size_parser_spec.rb
 - spec/smoke_spec.rb