active_record_doctor 1.11.0 → 1.13.0

data/lib/active_record_doctor/detectors/unindexed_foreign_keys.rb

@@ -18,28 +18,44 @@ module ActiveRecordDoctor
 
       private
 
-      def message(table:, column:)
+      def message(table:, columns:)
         # rubocop:disable Layout/LineLength
-        "add an index on #{table}.#{column} - foreign keys are often used in database lookups and should be indexed for performance reasons"
+        "add an index on #{table}(#{columns.join(', ')}) - foreign keys are often used in database lookups and should be indexed for performance reasons"
         # rubocop:enable Layout/LineLength
       end
 
       def detect
         each_table(except: config(:ignore_tables)) do |table|
           each_column(table, except: config(:ignore_columns)) do |column|
-            next unless foreign_key?(column)
+            next unless named_like_foreign_key?(column) || foreign_key?(table, column)
             next if indexed?(table, column)
             next if indexed_as_polymorphic?(table, column)
+            next if connection.primary_key(table) == column.name
 
-            problem!(table: table, column: column.name)
+            type_column_name = type_column_name(column)
+
+            columns =
+              if column_exists?(table, type_column_name)
+                [type_column_name, column.name]
+              else
+                [column.name]
+              end
+
+            problem!(table: table, columns: columns)
           end
         end
       end
 
-      def foreign_key?(column)
+      def named_like_foreign_key?(column)
         column.name.end_with?("_id")
       end
 
+      def foreign_key?(table, column)
+        connection.foreign_keys(table).any? do |foreign_key|
+          foreign_key.column == column.name
+        end
+      end
+
       def indexed?(table, column)
         connection.indexes(table).any? do |index|
           index.columns.first == column.name
@@ -47,9 +63,20 @@ module ActiveRecordDoctor
       end
 
       def indexed_as_polymorphic?(table, column)
-        type_column_name = column.name.sub(/_id\Z/, "_type")
         connection.indexes(table).any? do |index|
-          index.columns == [type_column_name, column.name]
+          index.columns[0, 2] == [type_column_name(column), column.name]
+        end
+      end
+
+      def column_exists?(table, column_name)
+        connection.columns(table).any? { |column| column.name == column_name }
+      end
+
+      def type_column_name(column)
+        if column.name.end_with?("_id")
+          column.name.sub(/_id\Z/, "_type")
+        else
+          "#{column.name}_type"
         end
       end
     end

data/lib/active_record_doctor/logger/hierarchical.rb

@@ -9,7 +9,7 @@ module ActiveRecordDoctor
       end
 
       def log(message)
-        @io.puts("  " * @nesting + message.to_s)
+        @io.puts(("  " * @nesting) + message.to_s)
         return if !block_given?
 
         @nesting += 1

data/lib/active_record_doctor/railtie.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecordDoctor
-  class Railtie < Rails::Railtie
+  class Railtie < Rails::Railtie # :nodoc:
     rake_tasks do
       load "tasks/active_record_doctor.rake"
     end

data/lib/active_record_doctor/runner.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecordDoctor # :nodoc:
-  # An excecution environment for active_record_doctor that provides a config
+  # An execution environment for active_record_doctor that provides a config
   # and an output device for use by detectors.
   class Runner
     # io is injected via constructor parameters to facilitate testing.

data/lib/active_record_doctor/utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Utils # :nodoc:
+    class << self
+      def postgresql?(connection = ActiveRecord::Base.connection)
+        ["PostgreSQL", "PostGIS"].include?(connection.adapter_name)
+      end
+
+      def mysql?(connection = ActiveRecord::Base.connection)
+        connection.adapter_name == "Mysql2"
+      end
+
+      def expression_indexes_unsupported?(connection = ActiveRecord::Base.connection)
+        (ActiveRecord::VERSION::STRING < "5.0") ||
+          # Active Record is unable to correctly parse expression indexes for MySQL.
+          (mysql?(connection) && ActiveRecord::VERSION::STRING < "7.1")
+      end
+    end
+  end
+end

data/lib/active_record_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordDoctor
-  VERSION = "1.11.0"
+  VERSION = "1.13.0"
 end

data/lib/active_record_doctor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_record_doctor/railtie" if defined?(Rails) && defined?(Rails::Railtie)
+require "active_record_doctor/utils"
 require "active_record_doctor/logger"
 require "active_record_doctor/logger/dummy"
 require "active_record_doctor/logger/hierarchical"
@@ -25,6 +26,7 @@ require "active_record_doctor/runner"
 require "active_record_doctor/version"
 require "active_record_doctor/config"
 require "active_record_doctor/config/loader"
+require "active_record_doctor/rake/task"
 
 module ActiveRecordDoctor # :nodoc:
 end

data/lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb

@@ -10,16 +10,16 @@ module ActiveRecordDoctor
       migration_descriptions = read_migration_descriptions(path)
       now = Time.now
 
-      migration_descriptions.each_with_index do |(table, columns), index|
+      migration_descriptions.each_with_index do |(table, indexes), index|
         timestamp = (now + index).strftime("%Y%m%d%H%M%S")
         file_name = "db/migrate/#{timestamp}_index_foreign_keys_in_#{table}.rb"
-        create_file(file_name, content(table, columns).tap { |x| puts x })
+        create_file(file_name, content(table, indexes).tap { |x| puts x })
       end
     end
 
     private
 
-    INPUT_LINE = /^add an index on (\w+)\.(\w+) - .*$/.freeze
+    INPUT_LINE = /^add an index on (\w+)\((.+)\) - .*$/.freeze
     private_constant :INPUT_LINE
 
     def read_migration_descriptions(path)
@@ -34,41 +34,41 @@ module ActiveRecordDoctor
         end
 
         table = match[1]
-        column = match[2]
+        columns = match[2].split(",").map(&:strip)
 
-        tables_to_columns[table] << column
+        tables_to_columns[table] << columns
       end
 
       tables_to_columns
     end
 
-    def content(table, columns)
+    def content(table, indexes)
       # In order to properly indent the resulting code, we must disable the
       # rubocop rule below.
 
       <<MIGRATION
 class IndexForeignKeysIn#{table.camelize} < ActiveRecord::Migration#{migration_version}
   def change
-#{add_indexes(table, columns)}
+#{add_indexes(table, indexes)}
   end
 end
 MIGRATION
     end
 
-    def add_indexes(table, columns)
-      columns.map do |column|
-        add_index(table, column)
+    def add_indexes(table, indexes)
+      indexes.map do |columns|
+        add_index(table, columns)
       end.join("\n")
     end
 
-    def add_index(table, column)
+    def add_index(table, columns)
       connection = ActiveRecord::Base.connection
 
-      index_name = connection.index_name(table, column)
+      index_name = connection.index_name(table, columns)
       if index_name.size > connection.index_name_length
-        "    add_index :#{table}, :#{column}, name: '#{index_name.first(connection.index_name_length)}'"
+        "    add_index :#{table}, #{columns.inspect}, name: '#{index_name.first(connection.index_name_length)}'"
       else
-        "    add_index :#{table}, :#{column}"
+        "    add_index :#{table}, #{columns.inspect}"
       end
     end
 

data/lib/tasks/active_record_doctor.rake

@@ -19,6 +19,6 @@ ActiveRecordDoctor::Rake::Task.new do |task|
   # This file is imported when active_record_doctor is being used as part of a
   # Rails app so it's the right place for all Rails-specific settings.
   task.deps = [:environment]
-  task.config_path = ::Rails.root.join(".active_record_doctor")
-  task.setup = -> { ::Rails.application.eager_load! }
+  task.config_path = Rails.root.join(".active_record_doctor")
+  task.setup = -> { Rails.application.eager_load! }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 2.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 2.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.57.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.57.1
 description:
 email:
 - contact@gregnavis.com
@@ -159,33 +159,16 @@ files:
 - lib/active_record_doctor/railtie.rb
 - lib/active_record_doctor/rake/task.rb
 - lib/active_record_doctor/runner.rb
+- lib/active_record_doctor/utils.rb
 - lib/active_record_doctor/version.rb
 - lib/generators/active_record_doctor/add_indexes/USAGE
 - lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb
 - lib/tasks/active_record_doctor.rake
-- test/active_record_doctor/config/loader_test.rb
-- test/active_record_doctor/config_test.rb
-- test/active_record_doctor/detectors/disable_test.rb
-- test/active_record_doctor/detectors/extraneous_indexes_test.rb
-- test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb
-- test/active_record_doctor/detectors/incorrect_dependent_option_test.rb
-- test/active_record_doctor/detectors/incorrect_length_validation_test.rb
-- test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb
-- test/active_record_doctor/detectors/missing_foreign_keys_test.rb
-- test/active_record_doctor/detectors/missing_non_null_constraint_test.rb
-- test/active_record_doctor/detectors/missing_presence_validation_test.rb
-- test/active_record_doctor/detectors/missing_unique_indexes_test.rb
-- test/active_record_doctor/detectors/short_primary_key_type_test.rb
-- test/active_record_doctor/detectors/undefined_table_references_test.rb
-- test/active_record_doctor/detectors/unindexed_deleted_at_test.rb
-- test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
-- test/active_record_doctor/runner_test.rb
-- test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
-- test/setup.rb
 homepage: https://github.com/gregnavis/active_record_doctor
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -201,27 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Identify database issues before they hit production.
-test_files:
-- test/active_record_doctor/config/loader_test.rb
-- test/active_record_doctor/config_test.rb
-- test/active_record_doctor/detectors/disable_test.rb
-- test/active_record_doctor/detectors/extraneous_indexes_test.rb
-- test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb
-- test/active_record_doctor/detectors/incorrect_dependent_option_test.rb
-- test/active_record_doctor/detectors/incorrect_length_validation_test.rb
-- test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb
-- test/active_record_doctor/detectors/missing_foreign_keys_test.rb
-- test/active_record_doctor/detectors/missing_non_null_constraint_test.rb
-- test/active_record_doctor/detectors/missing_presence_validation_test.rb
-- test/active_record_doctor/detectors/missing_unique_indexes_test.rb
-- test/active_record_doctor/detectors/short_primary_key_type_test.rb
-- test/active_record_doctor/detectors/undefined_table_references_test.rb
-- test/active_record_doctor/detectors/unindexed_deleted_at_test.rb
-- test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
-- test/active_record_doctor/runner_test.rb
-- test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
-- test/setup.rb
+test_files: []

data/test/active_record_doctor/config/loader_test.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::LoaderTest < Minitest::Test
-  def test_load_config
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_tables, ["schema_migrations"]
-
-        config.detector :extraneous_indexes, ignore_tables: ["users"]
-      end
-    CONFIG
-
-    config = ActiveRecordDoctor.load_config(config_path)
-
-    assert_equal(
-      { ignore_tables: ["schema_migrations"] },
-      config.globals
-    )
-    assert_equal(
-      { extraneous_indexes: { ignore_tables: ["users"] } },
-      config.detectors
-    )
-  end
-
-  def test_load_config_raises_when_configuration_file_missing
-    exc = assert_raises(ActiveRecordDoctor::Error::ConfigurationFileMissing) do
-      ActiveRecordDoctor.load_config("/tmp/config.rb")
-    end
-    assert_equal("/tmp/config.rb", exc.config_path)
-  end
-
-  def test_load_config_raises_when_configuration_file_raises
-    config_path = config_file("1/0")
-
-    assert_raises(ActiveRecordDoctor::Error::ConfigurationError) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_configure_not_called
-    config_path = config_file("# configure is not called")
-
-    assert_raises(ActiveRecordDoctor::Error::ConfigureNotCalled) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_configure_called_twice
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure { |config| }
-      ActiveRecordDoctor.configure { |config| }
-    CONFIG
-
-    assert_raises(ActiveRecordDoctor::Error::ConfigureCalledTwice) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_unrecognized_global_set
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :user, "acme"
-      end
-    CONFIG
-
-    assert_raises(ActiveRecordDoctor::Error::UnrecognizedGlobalSetting) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_global_set_twice
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_tables, ["schema_migrations"]
-        config.global :ignore_tables, ["schema_migrations"]
-      end
-    CONFIG
-
-    assert_raises(ActiveRecordDoctor::Error::DuplicateGlobalSetting) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_configured_unrecognized_detector
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :other_performance_issues, {}
-      end
-    CONFIG
-
-    assert_raises(ActiveRecordDoctor::Error::UnrecognizedDetectorName) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_detector_configured_twice
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :extraneous_indexes, ignore_tables: ["users"]
-        config.detector :extraneous_indexes, ignore_tables: ["users"]
-      end
-    CONFIG
-
-    assert_raises(ActiveRecordDoctor::Error::DetectorConfiguredTwice) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-
-  def test_load_config_raises_when_provided_unrecognized_detector_setting
-    config_path = config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :extraneous_indexes, { delay: 1 }
-      end
-    CONFIG
-
-    assert_raises(ActiveRecordDoctor::Error::UnrecognizedDetectorSettings) do
-      ActiveRecordDoctor.load_config(config_path)
-    end
-  end
-end

data/test/active_record_doctor/config_test.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::ConfigTest < Minitest::Test
-  def test_merge_globals_empty
-    config1 = ActiveRecordDoctor::Config.new({}, {})
-    config2 = ActiveRecordDoctor::Config.new({}, {})
-
-    config = config1.merge(config2)
-
-    assert_equal({}, config.globals)
-  end
-
-  def test_merge_globals_in_config1
-    config1 = ActiveRecordDoctor::Config.new(
-      { config1_global: "config1:config1_global" },
-      {}
-    )
-    config2 = ActiveRecordDoctor::Config.new({}, {})
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      { config1_global: "config1:config1_global" },
-      config.globals
-    )
-  end
-
-  def test_merge_globals_in_config2
-    config1 = ActiveRecordDoctor::Config.new({}, {})
-    config2 = ActiveRecordDoctor::Config.new(
-      { config2_global: "config2:config2_global" },
-      {}
-    )
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      { config2_global: "config2:config2_global" },
-      config.globals
-    )
-  end
-
-  def test_merge_globals_in_config1_and_config2
-    config1 = ActiveRecordDoctor::Config.new(
-      {
-        config1_global: "config1:config1_global",
-        shared_global: "config1:shared_global"
-      },
-      {}
-    )
-    config2 = ActiveRecordDoctor::Config.new(
-      {
-        config2_global: "config2:config2_global",
-        shared_global: "config2:shared_global"
-      },
-      {}
-    )
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      {
-        config1_global: "config1:config1_global",
-        shared_global: "config2:shared_global",
-        config2_global: "config2:config2_global"
-      },
-      config.globals
-    )
-  end
-
-  def test_merge_detectors
-    config1 = ActiveRecordDoctor::Config.new(
-      {},
-      {
-        config1_detector: {
-          config1_setting: "config1:config1_detector.config1_setting"
-        },
-        shared_detector: {
-          config1_setting: "config1:shared_detector.config1_setting",
-          shared_setting: "config1:shared_detector.shared_setting"
-        }
-      }
-    )
-    config2 = ActiveRecordDoctor::Config.new(
-      {},
-      {
-        config2_detector: {
-          config2_setting: "config2:config2_detector.config2_setting"
-        },
-        shared_detector: {
-          config2_setting: "config2:shared_detector.config2_setting",
-          shared_setting: "config2:shared_detector.shared_setting"
-        }
-      }
-    )
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      {
-        config1_detector: {
-          config1_setting: "config1:config1_detector.config1_setting"
-        },
-        config2_detector: {
-          config2_setting: "config2:config2_detector.config2_setting"
-        },
-        shared_detector: {
-          config1_setting: "config1:shared_detector.config1_setting",
-          config2_setting: "config2:shared_detector.config2_setting",
-          shared_setting: "config2:shared_detector.shared_setting"
-        }
-      },
-      config.detectors
-    )
-  end
-end

data/test/active_record_doctor/detectors/disable_test.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::Detectors::DisableTest < Minitest::Test
-  # Disabling detectors is implemented in the base class. It's enought to test
-  # it on a single detector to be reasonably certain it works on all of them.
-  def test_disabling
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_non_null_constraint,
-          enabled: false
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  private
-
-  # We need to override that method in order to skip the mechanism that
-  # infers detector name from the test class name.
-  def detector_name
-    :missing_non_null_constraint
-  end
-end