active_record_doctor 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc970595479a84692995f75b3e512f1b1a01dc6fc61eee9a738abbd402ac9e44
-  data.tar.gz: 3bd5807bc126459379478c24d14a5595a2ee207415cb71c86c82ebdfae5f19f3
+  metadata.gz: de87f340b23468b20a336608acbb3adc75a1505845e9f03c03722199896a2582
+  data.tar.gz: b98205be522fc4a97d21d835fcf81d285209cdbb07b5ac8072d7c912cb544eb0
 SHA512:
-  metadata.gz: 4b0ac66a6f9037ce810ff73660735b816bc58d614dd7612b7c7849292741519cbecd6bdb7105c7392e01fc1621ce550e1b8ba0726573beca33ee6e10ec6e35da
-  data.tar.gz: c3d2d7b0448ccff98001c72fa6330b54f45364a43e3eff35ff7407d0e2aeaaf8c3070a3ce308992577fa41adf7cdde3a8ba2aa93db4c8955fd69e5ec7f29d03b
+  metadata.gz: 492104d7e80292d96b91760e453c27aeff140b83eff8f78092a90a34c83dc1e7f1b0defe5d47fa15408c08eeb48c7c0ee61280108dd2f31f3eeba4712f3093d2
+  data.tar.gz: 2be286fd10dbbbf6b54eebe96ea44618e48906d6875fdfce0e2f1ae3ac5420b0ec95e7c1c25c378f26ba3ffb3c2a40267c4fa3daf14643410ea78e90484b5b91

data/README.md

@@ -15,12 +15,15 @@ can detect:
 * incorrect values of `dependent` on associations - [`active_record_doctor:incorrect_dependent_option`](#detecting-incorrect-dependent-option-on-associations)
 * primary keys having short integer types - [`active_record_doctor:short_primary_key_type`](#detecting-primary-keys-having-short-integer-types)
 * mismatched foreign key types - [`active_record_doctor:mismatched_foreign_key_type`](#detecting-mismatched-foreign-key-types)
+* tables without primary keys - [`active_record_doctor:table_without_primary_key`](#detecting-tables-without-primary-keys)
 
 It can also:
 
 * index unindexed foreign keys - [`active_record_doctor:unindexed_foreign_keys`](#indexing-unindexed-foreign-keys)
 
-[![Build Status](https://github.com/gregnavis/active_record_doctor/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/gregnavis/active_record_doctor/actions/workflows/test.yml)
+[![Build Status](https://github.com/gregnavis/active_record_doctor/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/gregnavis/active_record_doctor/actions/workflows/lint.yml)
+[![Build Status](https://github.com/gregnavis/active_record_doctor/actions/workflows/mysql.yml/badge.svg?branch=master)](https://github.com/gregnavis/active_record_doctor/actions/workflows/mysql.yml)
+[![Build Status](https://github.com/gregnavis/active_record_doctor/actions/workflows/postgresql.yml/badge.svg?branch=master)](https://github.com/gregnavis/active_record_doctor/actions/workflows/postgresql.yml)
 
 ## Installation
 
@@ -28,14 +31,14 @@ In order to use the latest production release, please add the following to
 your `Gemfile`:
 
 ```ruby
-gem 'active_record_doctor', group: :development
+gem 'active_record_doctor', group: [:development, :test]
 ```
 
 and run `bundle install`. If you'd like to use the most recent development
 version then use this instead:
 
 ```ruby
-gem 'active_record_doctor', github: 'gregnavis/active_record_doctor'
+gem 'active_record_doctor', github: 'gregnavis/active_record_doctor', group: [:development, :test]
 ```
 
 That's it when it comes to Rails projects. If your project doesn't use Rails
@@ -55,7 +58,7 @@ ActiveRecordDoctor::Rake::Task.new do |task|
   task.deps = []
 
   # A path to your active_record_doctor configuration file.
-  task.config_path = ::Rails.root.join(".active_record_doctor")
+  task.config_path = ::Rails.root.join(".active_record_doctor.rb")
 
   # A Proc called right before running detectors that should ensure your Active
   # Record models are preloaded and a database connection is ready.
@@ -101,6 +104,17 @@ bundle exec rake active_record_doctor:extraneous_indexes:help
 This will show the detector help text in the terminal, along with supported
 configuration options, their meaning, and whether they're global or local.
 
+### Debug Logging
+
+It may be that `active_record_doctor` fails with an exception and it is hard to tell
+what went wrong. For easier debugging, use `ACTIVE_RECORD_DOCTOR_DEBUG` environment variable.
+If `active_record_doctor` fails for some reason for your application, feel free
+to open an issue or a PR with the fix.
+
+```
+ACTIVE_RECORD_DOCTOR_DEBUG=1 bundle exec rake active_record_doctor
+```
+
 ### Configuration
 
 `active_record_doctor` can be configured to better suit your project's needs.
@@ -111,7 +125,7 @@ If you want to use the default configuration then you don't have to do anything.
 Just run `active_record_doctor` in your project directory.
 
 If you want to customize the tool you should create a file named
-`.active_record_doctor` in your project root directory with content like:
+`.active_record_doctor.rb` in your project root directory with content like:
 
 ```ruby
 ActiveRecordDoctor.configure do
@@ -358,9 +372,9 @@ Supported configuration options:
 
 ### Detecting Uniqueness Validations not Backed by an Index
 
-Model-level uniqueness validations and `has_one` associations should be backed
-by a database index in order to be robust. Otherwise you risk inserting
-duplicate values under a heavy load.
+Model-level uniqueness validations, `has_one` and `has_and_belongs_to_many`
+associations should be backed by a database index in order to be robust.
+Otherwise you risk inserting duplicate values under a heavy load.
 
 In order to detect such validations run:
 
@@ -382,6 +396,8 @@ Supported configuration options:
 - `ignore_models` - models whose uniqueness validators should not be checked.
 - `ignore_columns` - specific validators, written as Model(column1, ...), that
   should not be checked.
+- `ignore_join_tables` - join tables that should not be checked for existence
+  of unique indexes.
 
 ### Detecting Missing Non-`NULL` Constraints
 
@@ -442,6 +458,7 @@ Supported configuration options:
 - `ignore_models` - models whose underlying tables' columns should not be checked.
 - `ignore_attributes` - specific attributes, written as Model.attribute, that
   should not be checked.
+- `ignore_columns_with_default` - set to `true` to ignore columns with default values.
 
 ### Detecting Incorrect Presence Validations on Boolean Columns
 
@@ -602,6 +619,29 @@ Supported configuration options:
 - `ignore_columns` - foreign keys, written as table.column, that should not be
   checked.
 
+### Detecting Tables Without Primary Keys
+
+Tables should have primary keys. Otherwise, it becomes problematic to easily find a specific record,
+logical replication in PostgreSQL will be troublesome, because all the rows need to be unique
+in the table then etc.
+
+Running the command below will list all tables without primary keys:
+
+```
+bundle exec rake active_record_doctor:table_without_primary_key
+```
+
+The output of the command looks like this:
+
+```
+add a primary key to companies
+```
+
+Supported configuration options:
+
+- `enabled` - set to `false` to disable the detector altogether
+- `ignore_tables` - tables whose primary key existense should not be checked
+
 ## Ruby and Rails Compatibility Policy
 
 The goal of the policy is to ensure proper functioning in reasonable

data/lib/active_record_doctor/config/default.rb

@@ -47,17 +47,23 @@ ActiveRecordDoctor.configure do
   detector :missing_presence_validation,
     enabled: true,
     ignore_models: [],
-    ignore_attributes: []
+    ignore_attributes: [],
+    ignore_columns_with_default: false
 
   detector :missing_unique_indexes,
     enabled: true,
     ignore_models: [],
-    ignore_columns: []
+    ignore_columns: [],
+    ignore_join_tables: []
 
   detector :short_primary_key_type,
     enabled: true,
     ignore_tables: []
 
+  detector :table_without_primary_key,
+    enabled: true,
+    ignore_tables: []
+
   detector :undefined_table_references,
     enabled: true,
     ignore_models: []

data/lib/active_record_doctor/detectors/base.rb

@@ -157,7 +157,7 @@ module ActiveRecordDoctor
       end
 
       def models
-        ActiveRecord::Base.descendants
+        ActiveRecord::Base.descendants.sort_by(&:name)
       end
 
       def underscored_name
@@ -323,7 +323,7 @@ module ActiveRecordDoctor
       end
 
       def ignored?(name, patterns)
-        patterns.any? { |pattern| pattern === name } # rubocop:disable Style/CaseEquality
+        patterns.any? { |pattern| pattern === name || name == pattern.to_s } # rubocop:disable Style/CaseEquality
       end
     end
   end

data/lib/active_record_doctor/detectors/extraneous_indexes.rb

@@ -81,11 +81,12 @@ module ActiveRecordDoctor
 
         case [index1.unique, index2.unique]
         when [true, true]
-          (index2_columns - index1_columns).empty?
+          contains_all?(index1_columns, index2_columns)
         when [true, false]
           false
         else
-          prefix?(index1_columns, index2_columns)
+          prefix?(index1_columns, index2_columns) &&
+            contains_all?(index2_columns + includes(index2), includes(index1))
         end
       end
 
@@ -96,6 +97,14 @@ module ActiveRecordDoctor
       def prefix?(lhs, rhs)
         lhs.count <= rhs.count && rhs[0...lhs.count] == lhs
       end
+
+      def contains_all?(array1, array2)
+        (array2 - array1).empty?
+      end
+
+      def includes(index)
+        index.respond_to?(:include) ? Array(index.include) : []
+      end
     end
   end
 end

data/lib/active_record_doctor/detectors/missing_non_null_constraint.rb

@@ -36,6 +36,7 @@ module ActiveRecordDoctor
             next if ignored?("#{table}.#{column.name}", config(:ignore_columns))
             next if !column.null
             next if !concrete_models.all? { |model| non_null_needed?(model, column) }
+            next if sti_column?(models, column.name)
             next if not_null_check_constraint_exists?(table, column)
 
             problem!(column: column.name, table: table)
@@ -66,10 +67,28 @@ module ActiveRecordDoctor
         model.validators.select do |validator|
           validator.is_a?(ActiveRecord::Validations::PresenceValidator) &&
             !validator.options[:allow_nil] &&
-            !validator.options[:if] &&
-            !validator.options[:unless]
+            (rails_belongs_to_presence_validator?(validator) || !conditional_validator?(validator))
         end
       end
+
+      def sti_column?(models, column_name)
+        models.any? { |model| model.inheritance_column == column_name }
+      end
+
+      def rails_belongs_to_presence_validator?(validator)
+        ActiveRecord.version >= Gem::Version.new("7.1") &&
+          !ActiveRecord.belongs_to_required_validates_foreign_key &&
+          validator.options[:message] == :required &&
+          proc_from_activerecord?(validator.options[:if])
+      end
+
+      def conditional_validator?(validator)
+        validator.options[:if] || validator.options[:unless]
+      end
+
+      def proc_from_activerecord?(object)
+        object.is_a?(Proc) && object.binding.receiver.name.start_with?("ActiveRecord::")
+      end
     end
   end
 end

data/lib/active_record_doctor/detectors/missing_presence_validation.rb

@@ -13,6 +13,9 @@ module ActiveRecordDoctor
         },
         ignore_attributes: {
           description: "specific attributes, written as Model.attribute, that should not be checked"
+        },
+        ignore_columns_with_default: {
+          description: "ignore columns with default values, should be provided as boolean"
         }
       }
 
@@ -35,7 +38,12 @@ module ActiveRecordDoctor
 
       def validator_needed?(model, column)
         ![model.primary_key, "created_at", "updated_at", "created_on", "updated_on"].include?(column.name) &&
-          (!column.null || not_null_check_constraint_exists?(model.table_name, column))
+          (!column.null || not_null_check_constraint_exists?(model.table_name, column)) &&
+          !default_value_instead_of_validation?(column)
+      end
+
+      def default_value_instead_of_validation?(column)
+        !column.default.nil? && config(:ignore_columns_with_default)
       end
 
       def validator_present?(model, column)

data/lib/active_record_doctor/detectors/missing_unique_indexes.rb

@@ -13,9 +13,17 @@ module ActiveRecordDoctor
         },
         ignore_columns: {
           description: "specific validators, written as Model(column1, column2, ...), that should not be checked"
+        },
+        ignore_join_tables: {
+          description: "join tables that should not be checked for existence of unique indexes"
         }
       }
 
+      def initialize(**)
+        super
+        @reported_join_tables = []
+      end
+
       private
 
       # rubocop:disable Layout/LineLength
@@ -28,6 +36,8 @@ module ActiveRecordDoctor
           "without an expression index can lead to duplicates (a regular unique index is not enough)"
         when :has_ones
           "add a unique index on #{table}(#{columns.join(', ')}) - using `has_one` in #{model.name} without an index can lead to duplicates"
+        when :has_and_belongs_to_many
+          "add a unique index on #{table}(#{columns.join(', ')}) - using `has_and_belongs_to_many` in #{model.name} without an index can lead to duplicates"
         end
       end
       # rubocop:enable Layout/LineLength
@@ -35,6 +45,7 @@ module ActiveRecordDoctor
       def detect
         validations_without_indexes
         has_ones_without_indexes
+        has_and_belongs_to_many_without_indexes
       end
 
       def validations_without_indexes
@@ -63,8 +74,11 @@ module ActiveRecordDoctor
 
               next if ignore_columns.include?("#{model.name}(#{columns.join(',')})")
 
-              columns[-1] = "lower(#{columns[-1]})" unless case_sensitive
-
+              # citext is case-insensitive by default, so it doesn't have to be
+              # lowered.
+              if !case_sensitive && model.columns_hash[columns[-1]].type != :citext
+                columns[-1] = "lower(#{columns[-1]})"
+              end
               next if unique_index?(model.table_name, columns)
 
               if case_sensitive
@@ -108,6 +122,21 @@ module ActiveRecordDoctor
         (validator.options.keys & [:if, :unless, :conditions]).present?
       end
 
+      def has_and_belongs_to_many_without_indexes # rubocop:disable Naming/PredicateName
+        each_model do |model|
+          each_association(model, type: :has_and_belongs_to_many, has_scope: false) do |association|
+            join_table = association.join_table
+            next if @reported_join_tables.include?(join_table) || config(:ignore_join_tables).include?(join_table)
+
+            columns = [association.foreign_key, association.association_foreign_key]
+            next if unique_index?(join_table, columns)
+
+            @reported_join_tables << join_table
+            problem!(model: model, table: join_table, columns: columns, problem: :has_and_belongs_to_many)
+          end
+        end
+      end
+
       def resolve_attributes(model, attributes)
         attributes.flat_map do |attribute|
           reflection = model.reflect_on_association(attribute)

data/lib/active_record_doctor/detectors/table_without_primary_key.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "active_record_doctor/detectors/base"
+
+module ActiveRecordDoctor
+  module Detectors
+    class TableWithoutPrimaryKey < Base # :nodoc:
+      @description = "detect tables without primary keys"
+      @config = {
+        ignore_tables: {
+          description: "tables whose primary key existense should not be checked",
+          global: true
+        }
+      }
+
+      private
+
+      def message(table:)
+        "add a primary key to #{table}"
+      end
+
+      def detect
+        each_table(except: config(:ignore_tables)) do |table|
+          column = primary_key(table)
+          problem!(table: table) unless column
+        end
+      end
+    end
+  end
+end

data/lib/active_record_doctor/rake/task.rb

@@ -68,9 +68,41 @@ module ActiveRecordDoctor
       end
 
       def config
-        @config ||= begin
-          path = config_path && File.exist?(config_path) ? config_path : nil
-          ActiveRecordDoctor.load_config_with_defaults(path)
+        @config ||=
+          ActiveRecordDoctor.load_config_with_defaults(effective_config_path)
+      end
+
+      def effective_config_path
+        if config_path.nil?
+          # No explicit config_path was set, so we're trying to use defaults.
+          legacy_default_path = Rails.root.join(".active_record_doctor")
+          new_default_path = Rails.root.join(".active_record_doctor.rb")
+
+          # First, if the legacy file exists we'll use it but show a warning.
+          if legacy_default_path.exist?
+            warn(<<~WARN.squish)
+              DEPRECATION WARNING: active_record_doctor is using the default
+              configuration file located in #{legacy_default_path.basename}. However,
+              that default will change to #{new_default_path.basename} in the future.
+
+              In order to avoid errors, please rename the file from
+              #{legacy_default_path.basename} to #{new_default_path.basename}.
+            WARN
+
+            return legacy_default_path
+          end
+
+          # Second, if the legacy file does NOT exist, but the new one does then
+          # we'll use that.
+          if new_default_path.exist?
+            return new_default_path
+          end
+
+          # Otherwise, there's no configuration file in use.
+          nil
+        else
+          # If an explicit configuration file was set then we use it as is.
+          config_path
         end
       end
 

data/lib/active_record_doctor/version.rb

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

data/lib/active_record_doctor.rb

@@ -20,6 +20,7 @@ require "active_record_doctor/detectors/unindexed_foreign_keys"
 require "active_record_doctor/detectors/incorrect_dependent_option"
 require "active_record_doctor/detectors/short_primary_key_type"
 require "active_record_doctor/detectors/mismatched_foreign_key_type"
+require "active_record_doctor/detectors/table_without_primary_key"
 require "active_record_doctor/errors"
 require "active_record_doctor/help"
 require "active_record_doctor/runner"

data/lib/tasks/active_record_doctor.rake

@@ -19,6 +19,5 @@ 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! }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.5.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: transient_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc2
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,7 @@ files:
 - lib/active_record_doctor/detectors/missing_presence_validation.rb
 - lib/active_record_doctor/detectors/missing_unique_indexes.rb
 - lib/active_record_doctor/detectors/short_primary_key_type.rb
+- lib/active_record_doctor/detectors/table_without_primary_key.rb
 - lib/active_record_doctor/detectors/undefined_table_references.rb
 - lib/active_record_doctor/detectors/unindexed_deleted_at.rb
 - lib/active_record_doctor/detectors/unindexed_foreign_keys.rb
@@ -184,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Identify database issues before they hit production.