active_record_doctor 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5091f9668515416b73453756daa5f78598f6d35f0f60073a947719e535110f
-  data.tar.gz: 428450c43db5adb8510debfb9e895efba1f21649355255fe3eb7a2ea16c82642
+  metadata.gz: 649707d9a4a22831b3733778ad05614cc71f8edb704a68e9b18bd784a350daf9
+  data.tar.gz: 6e0fc8fe22ba882549152203c3a92f3eeebd3effb3f4eead6245001849b9e5de
 SHA512:
-  metadata.gz: fffc1ffd284a2448ac5c74dae34a3bbe45eda4836b0e22a0af072ab6353f16b1386385254b1cdb2b87e4776372869d8cee67bf0a066f180b85bd45ef7ed3cc33
-  data.tar.gz: 0011f60f1e37542911a72cce23cc8c8430310f8263fe7ba73aba30230ec8ff3f6e7ee9df72f42d8db6ff54e732a86aa49f1e6489a5b44d51bf1bd6c68821ebcd
+  metadata.gz: 437df56684da87b78b3336337cabe138f5375c54673a5d02da29b06fa9d238e1c9fa34a4cf9973b7bf944a0ef8ebbed5ec9dd9d9d12612f87e16597292ff22aa
+  data.tar.gz: 3ee83bab9d6dc5c88c4c47d33d69d30ecf373bb6ab4798accfc681066fd0a1a4580295f29a869c69a9ff582c925f7c2cb328b345429a92623942995a0416e1d6

data/README.md

@@ -3,15 +3,15 @@
 Active Record Doctor helps to keep the database in a good shape. Currently, it
 can:
 
-* index unindexed foreign keys
-* detect extraneous indexes
-* detect unindexed `deleted_at` columns
-* detect missing foreign key constraints
-* detect models referencing undefined tables
-* detect uniqueness validations not backed by an unique index
-* detect missing non-`NULL` constraints
-* detect missing presence validations
-* detect incorrect presence validations on boolean columns
+* index unindexed foreign keys - [`active_record_doctor:unindexed_foreign_keys`](#indexing-unindexed-foreign-keys)
+* detect extraneous indexes - [`active_record_doctor:extraneous_indexes`](#removing-extraneous-indexes)
+* detect unindexed `deleted_at` columns - [`active_record_doctor:unindexed_deleted_at`](#detecting-unindexed-deleted_at-columns)
+* detect missing foreign key constraints - [`active_record_doctor:missing_foreign_keys`](#detecting-missing-foreign-key-constraints)
+* detect models referencing undefined tables - [`active_record_doctor:undefined_table_references`](#detecting-models-referencing-undefined-tables)
+* detect uniqueness validations not backed by an unique index - [`active_record_doctor:missing_unique_indexes`](#detecting-uniqueness-validations-not-backed-by-an-index)
+* detect missing non-`NULL` constraints - [`active_record_doctor:missing_non_null_constraint`](#detecting-missing-non-null-constraints)
+* detect missing presence validations - [`active_record_doctor:missing_presence_validation`](#detecting-missing-presence-validations)
+* detect incorrect presence validations on boolean columns - [`active_record_doctor:incorrect_boolean_presence_validation`](#detecting-incorrect-presence-validations-on-boolean-columns)
 
 More features coming soon!
 
@@ -237,6 +237,8 @@ The following columns should be marked as `null: false`:
 You can mark the columns mentioned in the output as `null: false` by creating a
 migration and calling `change_column_null`.
 
+This validator skips models whose corresponding database tables don't exist.
+
 ### Detecting Missing Presence Validations
 
 If a column is marked as `null: false` then it's likely it should have the
@@ -257,6 +259,8 @@ The following models and columns should have presence validations:
 
 This means `User` should have a presence validator on `email` and `name`.
 
+This validator skips models whose corresponding database tables don't exist.
+
 ### Detecting Incorrect Presence Validations on Boolean Columns
 
 A boolean column's presence should be validated using inclusion or exclusion
@@ -278,6 +282,19 @@ The presence of the following boolean columns is validated incorrectly:
 This means `active` is validated with `presence: true` instead of
 `inclusion: { in: [true, false] }` or `exclusion: { in: [nil] }`.
 
+This validator skips models whose corresponding database tables don't exist.
+
+## Ruby and Rails Compatibility Policy
+
+The goal of the policy is to ensure proper functioning in reasonable
+combinations of Ruby and Rails versions. Specifically:
+
+1. If a Rails version is officially supported by the Rails Core Team then it's
+   supported by `active_record_doctor`.
+2. If a Ruby version is compatible with a supported Rails version then it's
+   also supported by `active_record_doctor`.
+3. Only most recent teeny Ruby versions and patch Rails versions are supported.
+
 ## Author
 
 This gem is developed and maintained by [Greg Navis](http://www.gregnavis.com).

data/lib/active_record_doctor.rb

@@ -1,4 +1,18 @@
-require "active_record_doctor/railtie" if defined?(Rails)
+require "active_record_doctor/printers"
+require "active_record_doctor/printers/io_printer"
+require "active_record_doctor/railtie" if defined?(Rails) && defined?(Rails::Railtie)
+require "active_record_doctor/tasks"
+require "active_record_doctor/tasks/base"
+require "active_record_doctor/tasks/missing_presence_validation"
+require "active_record_doctor/tasks/missing_foreign_keys"
+require "active_record_doctor/tasks/missing_unique_indexes"
+require "active_record_doctor/tasks/incorrect_boolean_presence_validation"
+require "active_record_doctor/tasks/extraneous_indexes"
+require "active_record_doctor/tasks/unindexed_deleted_at"
+require "active_record_doctor/tasks/undefined_table_references"
+require "active_record_doctor/tasks/missing_non_null_constraint"
+require "active_record_doctor/tasks/unindexed_foreign_keys"
+require "active_record_doctor/version"
 
 module ActiveRecordDoctor
 end

data/lib/active_record_doctor/printers/io_printer.rb

@@ -92,11 +92,11 @@ EOS
         end
       end
 
-      def presence_true_on_boolean(presence_true_on_booleans)
-        return if presence_true_on_booleans.empty?
+      def incorrect_boolean_presence_validation(incorrect_boolean_presence_validations)
+        return if incorrect_boolean_presence_validations.empty?
 
         @io.puts('The presence of the following boolean columns is validated incorrectly:')
-        presence_true_on_booleans.each do |table, columns|
+        incorrect_boolean_presence_validations.each do |table, columns|
           @io.puts("  #{table}: #{columns.join(', ')}")
         end
       end

data/lib/active_record_doctor/tasks.rb

@@ -1,3 +1,6 @@
+require "active_support"
+require "active_support/core_ext/class/subclasses"
+
 module ActiveRecordDoctor
   module Tasks
     def self.all

data/lib/active_record_doctor/tasks/base.rb

@@ -7,6 +7,10 @@ module ActiveRecordDoctor
         new.run
       end
 
+      def self.description
+        @description
+      end
+
       def initialize(printer = ActiveRecordDoctor::Printers::IOPrinter.new)
         @printer = printer
       end
@@ -27,16 +31,20 @@ module ActiveRecordDoctor
 
       def tables
         @tables ||=
-          if Rails::VERSION::MAJOR == 5
+          if ActiveRecord::VERSION::MAJOR == 5
             connection.data_sources
           else
             connection.tables
           end
       end
 
+      def table_exists?(table_name)
+        connection.table_exists?(table_name)
+      end
+
       def views
         @views ||=
-          if Rails::VERSION::MAJOR == 5
+          if ActiveRecord::VERSION::MAJOR == 5
             connection.views
           elsif connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
             ActiveRecord::Base.connection.execute(<<-SQL).map { |tuple| tuple.fetch("relname") }

data/lib/active_record_doctor/tasks/extraneous_indexes.rb

@@ -3,6 +3,8 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class ExtraneousIndexes < Base
+      @description = 'Detect extraneous indexes'
+
       def run
         success(subindexes_of_multi_column_indexes + indexed_primary_keys)
       end

data/lib/active_record_doctor/tasks/incorrect_boolean_presence_validation.rb

@@ -3,11 +3,15 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class IncorrectBooleanPresenceValidation < Base
+      @description = 'Detect boolean columns with presence/absence instead of includes/excludes validators'
+
       def run
         eager_load!
 
         success(hash_from_pairs(models.reject do |model|
-          model.table_name.nil? || model.table_name == 'schema_migrations'
+          model.table_name.nil? ||
+            model.table_name == 'schema_migrations' ||
+            !table_exists?(model.table_name)
         end.map do |model|
           [
             model.name,

data/lib/active_record_doctor/tasks/missing_foreign_keys.rb

@@ -3,6 +3,8 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class MissingForeignKeys < Base
+      @description = 'Detect association columns without a foreign key constraint'
+
       def run
         success(hash_from_pairs(tables.select do |table|
           "schema_migrations" != table

data/lib/active_record_doctor/tasks/missing_non_null_constraint.rb

@@ -3,11 +3,15 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class MissingNonNullConstraint < Base
+      @description = 'Detect presence validators not backed by a non-NULL constraint'
+
       def run
         eager_load!
 
         success(hash_from_pairs(models.reject do |model|
-          model.table_name.nil? || model.table_name == 'schema_migrations'
+          model.table_name.nil? ||
+          model.table_name == 'schema_migrations' ||
+          !table_exists?(model.table_name)
         end.map do |model|
           [
             model.table_name,

data/lib/active_record_doctor/tasks/missing_presence_validation.rb

@@ -3,11 +3,15 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class MissingPresenceValidation < Base
+      @description = 'Detect non-NULL columns without a presence validator'
+
       def run
         eager_load!
 
         success(hash_from_pairs(models.reject do |model|
-          model.table_name.nil? || model.table_name == 'schema_migrations'
+          model.table_name.nil? ||
+          model.table_name == 'schema_migrations' ||
+          !table_exists?(model.table_name)
         end.map do |model|
           [
             model.name,

data/lib/active_record_doctor/tasks/missing_unique_indexes.rb

@@ -3,6 +3,8 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class MissingUniqueIndexes < Base
+      @description = 'Detect columns covered by a uniqueness validator without a unique index'
+
       def run
         eager_load!
 
@@ -13,12 +15,11 @@ module ActiveRecordDoctor
             model.table_name,
             model.validators.select do |validator|
               table_name = model.table_name
-              attributes = validator.attributes
               scope = validator.options.fetch(:scope, [])
 
               validator.is_a?(ActiveRecord::Validations::UniquenessValidator) &&
                 supported_validator?(validator) &&
-                !unique_index?(table_name, attributes, scope)
+                !unique_index?(table_name, validator.attributes, scope)
             end.map do |validator|
               scope = Array(validator.options.fetch(:scope, []))
               attributes = validator.attributes
@@ -48,7 +49,7 @@ module ActiveRecordDoctor
         columns = (Array(scope) + columns).map(&:to_s)
 
         indexes(table_name).any? do |index|
-          index.columns == columns && index.unique
+          index.columns.to_set == columns.to_set && index.unique
         end
       end
     end

data/lib/active_record_doctor/tasks/undefined_table_references.rb

@@ -3,6 +3,8 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class UndefinedTableReferences < Base
+      @description = 'Detect models referencing undefined tables or views'
+
       def run
         eager_load!
 

data/lib/active_record_doctor/tasks/unindexed_deleted_at.rb

@@ -3,12 +3,16 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class UnindexedDeletedAt < Base
+      COLUMNS = %w[deleted_at discarded_at].freeze
+      PATTERN = COLUMNS.join('|').freeze
+      @description = 'Detect unindexed deleted_at columns'
+
       def run
         success(connection.tables.select do |table|
-          connection.columns(table).map(&:name).include?('deleted_at')
+          connection.columns(table).any? { |column| column.name =~ /^#{PATTERN}$/ }
         end.flat_map do |table|
           connection.indexes(table).reject do |index|
-            index.where =~ /\bdeleted_at\s+IS\s+NULL\b/i
+            index.where =~ /\b#{PATTERN}\s+IS\s+NULL\b/i
           end.map do |index|
             index.name
           end

data/lib/active_record_doctor/tasks/unindexed_foreign_keys.rb

@@ -3,6 +3,8 @@ require "active_record_doctor/tasks/base"
 module ActiveRecordDoctor
   module Tasks
     class UnindexedForeignKeys < Base
+      @description = 'Detect foreign keys without an index on them'
+
       def run
         success(hash_from_pairs(tables.select do |table|
           "schema_migrations" != table

data/lib/active_record_doctor/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordDoctor
-  VERSION = "1.7.1"
+  VERSION = "1.7.2"
 end

data/lib/tasks/active_record_doctor.rake

@@ -13,6 +13,7 @@ namespace :active_record_doctor do
   def mount(task_class)
     name = task_class.name.demodulize.underscore.to_sym
 
+    desc task_class.description
     task name => :environment do
       result, success = task_class.run
       success = true if success.nil?

data/test/active_record_doctor/printers/io_printer_test.rb

@@ -1,8 +1,16 @@
-require 'test_helper'
+# Load all tasks
+class ActiveRecordDoctor::Printers::IOPrinterTest < Minitest::Test
+  def test_all_tasks_have_printers
+    ActiveRecordDoctor::Tasks::Base.subclasses.each do |task_class|
+      name = task_class.name.demodulize.underscore.to_sym
 
-require 'active_record_doctor/printers/io_printer'
+      assert(
+        ActiveRecordDoctor::Printers::IOPrinter.method_defined?(name),
+        "IOPrinter should define #{name}"
+      )
+    end
+  end
 
-class ActiveRecordDoctor::Printers::IOPrinterTest < ActiveSupport::TestCase
   def test_unindexed_foreign_keys
     assert_equal(<<EOF, unindexed_foreign_keys({ "users" => ["profile_id", "account_id"], "account" => ["group_id"] }))
 account group_id

data/test/active_record_doctor/tasks/extraneous_indexes_test.rb

@@ -1,8 +1,4 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/extraneous_indexes'
-
-class ActiveRecordDoctor::Tasks::ExtraneousIndexesTest < ActiveSupport::TestCase
+class ActiveRecordDoctor::Tasks::ExtraneousIndexesTest < Minitest::Test
   def test_index_on_primary_key_is_duplicate
     Temping.create(:user, temporary: false) do
       with_columns do |t|

data/test/active_record_doctor/tasks/incorrect_boolean_presence_validation_test.rb

@@ -1,8 +1,4 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/incorrect_boolean_presence_validation'
-
-class ActiveRecordDoctor::Tasks::IncorrectBooleanPresenceValidationTest < ActiveSupport::TestCase
+class ActiveRecordDoctor::Tasks::IncorrectBooleanPresenceValidationTest < Minitest::Test
   def test_presence_true_is_reported_on_boolean_only
     Temping.create(:users, temporary: false) do
       # email is a non-boolean column whose presence CAN be validated in the
@@ -30,4 +26,13 @@ class ActiveRecordDoctor::Tasks::IncorrectBooleanPresenceValidationTest < Active
 
     assert_equal({}, run_task)
   end
+
+  def test_models_with_non_existent_tables_are_skipped
+    klass = Class.new(ActiveRecord::Base) do
+      self.table_name = 'action_text_rich_texts'
+    end
+
+    # No need to assert anything as merely not raising an exception is a success.
+    run_task
+  end
 end

data/test/active_record_doctor/tasks/missing_foreign_keys_test.rb

@@ -1,8 +1,4 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/missing_foreign_keys'
-
-class ActiveRecordDoctor::Tasks::MissingForeignKeysTest < ActiveSupport::TestCase
+class ActiveRecordDoctor::Tasks::MissingForeignKeysTest < Minitest::Test
   def test_missing_foreign_key_is_reported
     Temping.create(:companies, temporary: false)
     Temping.create(:users, temporary: false) do

data/test/active_record_doctor/tasks/missing_non_null_constraint_test.rb

@@ -1,8 +1,4 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/missing_non_null_constraint'
-
-class ActiveRecordDoctor::Tasks::MissingNonNullConstraintTest < ActiveSupport::TestCase
+class ActiveRecordDoctor::Tasks::MissingNonNullConstraintTest < Minitest::Test
   def test_presence_true_and_null_true
     Temping.create(:users, temporary: false) do
       validates :name, presence: true
@@ -105,4 +101,13 @@ class ActiveRecordDoctor::Tasks::MissingNonNullConstraintTest < ActiveSupport::T
 
     assert_equal({}, run_task)
   end
+
+  def test_models_with_non_existent_tables_are_skipped
+    klass = Class.new(ActiveRecord::Base) do
+      self.table_name = 'action_text_rich_texts'
+    end
+
+    # No need to assert anything as merely not raising an exception is a success.
+    run_task
+  end
 end

data/test/active_record_doctor/tasks/missing_presence_validation_test.rb

@@ -1,8 +1,4 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/missing_presence_validation'
-
-class ActiveRecordDoctor::Tasks::MissingPresenceValidationTest < ActiveSupport::TestCase
+class ActiveRecordDoctor::Tasks::MissingPresenceValidationTest < Minitest::Test
   def test_null_column_is_not_reported_if_validation_absent
     Temping.create(:users, temporary: false) do
       with_columns do |t|
@@ -107,4 +103,13 @@ class ActiveRecordDoctor::Tasks::MissingPresenceValidationTest < ActiveSupport::
 
     assert_equal({}, run_task)
   end
+
+  def test_models_with_non_existent_tables_are_skipped
+    klass = Class.new(ActiveRecord::Base) do
+      self.table_name = 'action_text_rich_texts'
+    end
+
+    # No need to assert anything as merely not raising an exception is a success.
+    run_task
+  end
 end

data/test/active_record_doctor/tasks/missing_unique_indexes_test.rb

@@ -1,8 +1,4 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/missing_unique_indexes'
-
-class ActiveRecordDoctor::Tasks::MissingUniqueIndexesTest < ActiveSupport::TestCase
+class ActiveRecordDoctor::Tasks::MissingUniqueIndexesTest < Minitest::Test
   def test_missing_unique_index
     Temping.create(:users, temporary: false) do
       with_columns do |t|
@@ -63,6 +59,21 @@ class ActiveRecordDoctor::Tasks::MissingUniqueIndexesTest < ActiveSupport::TestC
     assert_result([])
   end
 
+  def test_column_order_is_ignored
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.integer :organization_id
+
+        t.index [:email, :organization_id], unique: true
+      end
+
+      validates :email, uniqueness: { scope: :organization_id }
+    end
+
+    assert_result([])
+  end
+
   def test_conditions_is_skipped
     assert_skipped(conditions: -> { where.not(email: nil) })
   end
@@ -79,6 +90,26 @@ class ActiveRecordDoctor::Tasks::MissingUniqueIndexesTest < ActiveSupport::TestC
     assert_skipped(unless: ->(model) { true })
   end
 
+  def test_skips_validator_without_attributes
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.index :email
+      end
+
+      validates_with DummyValidator
+    end
+
+    # There's no need for assert/refute as it's enough the line below doesn't
+    # raise an exception.
+    run_task
+  end
+
+  class DummyValidator < ActiveModel::Validator
+    def validate(record)
+    end
+  end
+
   private
 
   def assert_skipped(options)