active_record_doctor 1.9.0 → 1.11.0

data/lib/active_record_doctor/detectors/unindexed_deleted_at.rb

@@ -26,26 +26,17 @@ module ActiveRecordDoctor
 
       def message(index:, column_name:)
         # rubocop:disable Layout/LineLength
-        "consider adding `WHERE #{column_name} IS NULL` to #{index} - a partial index can speed lookups of soft-deletable models"
+        "consider adding `WHERE #{column_name} IS NULL` or `WHERE #{column_name} IS NOT NULL` to #{index} - a partial index can speed lookups of soft-deletable models"
         # rubocop:enable Layout/LineLength
       end
 
       def detect
-        tables(except: config(:ignore_tables)).each do |table|
-          timestamp_columns = connection.columns(table).reject do |column|
-            config(:ignore_columns).include?("#{table}.#{column.name}")
-          end.select do |column|
-            config(:column_names).include?(column.name)
-          end
-
-          next if timestamp_columns.empty?
-
-          timestamp_columns.each do |timestamp_column|
-            indexes(table, except: config(:ignore_indexes)).each do |index|
-              # TODO: whole word
-              next if index.where =~ /\b#{timestamp_column.name}\s+IS\s+NULL\b/i
+        each_table(except: config(:ignore_tables)) do |table|
+          each_column(table, only: config(:column_names), except: config(:ignore_columns)) do |column|
+            each_index(table, except: config(:ignore_indexes)) do |index|
+              next if index.where =~ /\b#{column.name}\s+IS\s+(NOT\s+)?NULL\b/i
 
-              problem!(index: index.name, column_name: timestamp_column.name)
+              problem!(index: index.name, column_name: column.name)
             end
           end
         end

data/lib/active_record_doctor/detectors/unindexed_foreign_keys.rb

@@ -25,10 +25,8 @@ module ActiveRecordDoctor
       end
 
       def detect
-        tables(except: config(:ignore_tables)).each do |table|
-          connection.columns(table).each do |column|
-            next if config(:ignore_columns).include?("#{table}.#{column.name}")
-
+        each_table(except: config(:ignore_tables)) do |table|
+          each_column(table, except: config(:ignore_columns)) do |column|
             next unless foreign_key?(column)
             next if indexed?(table, column)
             next if indexed_as_polymorphic?(table, column)

data/lib/active_record_doctor/logger/dummy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Logger
+    class Dummy # :nodoc:
+      def log(_message)
+        yield if block_given?
+      end
+    end
+  end
+end

data/lib/active_record_doctor/logger/hierarchical.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Logger
+    class Hierarchical # :nodoc:
+      def initialize(io)
+        @io = io
+        @nesting = 0
+      end
+
+      def log(message)
+        @io.puts("  " * @nesting + message.to_s)
+        return if !block_given?
+
+        @nesting += 1
+        result = yield
+        @nesting -= 1
+        result
+      end
+    end
+  end
+end

data/lib/active_record_doctor/logger.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Logger # :nodoc:
+  end
+end

data/lib/active_record_doctor/rake/task.rb

@@ -64,7 +64,7 @@ module ActiveRecordDoctor
       private
 
       def runner
-        @runner ||= ActiveRecordDoctor::Runner.new(config)
+        @runner ||= ActiveRecordDoctor::Runner.new(config: config, logger: logger)
       end
 
       def config
@@ -73,6 +73,15 @@ module ActiveRecordDoctor
           ActiveRecordDoctor.load_config_with_defaults(path)
         end
       end
+
+      def logger
+        @logger ||=
+          if ENV.include?("ACTIVE_RECORD_DOCTOR_DEBUG")
+            ActiveRecordDoctor::Logger::Hierarchical.new($stderr)
+          else
+            ActiveRecordDoctor::Logger::Dummy.new
+          end
+      end
     end
   end
 end

data/lib/active_record_doctor/runner.rb

@@ -5,14 +5,19 @@ module ActiveRecordDoctor # :nodoc:
   # and an output device for use by detectors.
   class Runner
     # io is injected via constructor parameters to facilitate testing.
-    def initialize(config, io = $stdout)
+    def initialize(config:, logger:, io: $stdout)
       @config = config
+      @logger = logger
       @io = io
     end
 
     def run_one(name)
       ActiveRecordDoctor.handle_exception do
-        ActiveRecordDoctor.detectors.fetch(name).run(config, io)
+        ActiveRecordDoctor.detectors.fetch(name).run(
+          config: config,
+          logger: logger,
+          io: io
+        )
       end
     end
 
@@ -36,6 +41,6 @@ module ActiveRecordDoctor # :nodoc:
 
     private
 
-    attr_reader :config, :io
+    attr_reader :config, :logger, :io
   end
 end

data/lib/active_record_doctor/version.rb

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

data/lib/active_record_doctor.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 require "active_record_doctor/railtie" if defined?(Rails) && defined?(Rails::Railtie)
+require "active_record_doctor/logger"
+require "active_record_doctor/logger/dummy"
+require "active_record_doctor/logger/hierarchical"
 require "active_record_doctor/detectors"
 require "active_record_doctor/detectors/base"
 require "active_record_doctor/detectors/missing_presence_validation"
 require "active_record_doctor/detectors/missing_foreign_keys"
 require "active_record_doctor/detectors/missing_unique_indexes"
 require "active_record_doctor/detectors/incorrect_boolean_presence_validation"
+require "active_record_doctor/detectors/incorrect_length_validation"
 require "active_record_doctor/detectors/extraneous_indexes"
 require "active_record_doctor/detectors/unindexed_deleted_at"
 require "active_record_doctor/detectors/undefined_table_references"

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

@@ -62,14 +62,14 @@ MIGRATION
     end
 
     def add_index(table, column)
-      index_name = Class.new.extend(ActiveRecord::ConnectionAdapters::SchemaStatements).index_name table, column
-      # rubocop:disable Layout/LineLength
-      if index_name.size > ActiveRecord::Base.connection.allowed_index_name_length
-        "    add_index :#{table}, :#{column}, name: '#{index_name.first ActiveRecord::Base.connection.allowed_index_name_length}'"
+      connection = ActiveRecord::Base.connection
+
+      index_name = connection.index_name(table, column)
+      if index_name.size > connection.index_name_length
+        "    add_index :#{table}, :#{column}, name: '#{index_name.first(connection.index_name_length)}'"
       else
         "    add_index :#{table}, :#{column}"
       end
-      # rubocop:enable Layout/LineLength
     end
 
     def migration_version

data/test/active_record_doctor/detectors/disable_test.rb

@@ -0,0 +1,30 @@
+# 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

data/test/active_record_doctor/detectors/extraneous_indexes_test.rb

@@ -11,6 +11,27 @@ remove index_users_on_id - coincides with the primary key on the table
 OUTPUT
   end
 
+  def test_partial_index_on_primary_key
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.boolean :admin
+      t.index :id, where: "admin"
+    end
+
+    refute_problems
+  end
+
+  def test_index_on_non_standard_primary_key
+    create_table(:profiles, primary_key: :user_id) do |t|
+      t.index :user_id
+    end
+
+    assert_problems(<<OUTPUT)
+remove index_profiles_on_user_id - coincides with the primary key on the table
+OUTPUT
+  end
+
   def test_non_unique_version_of_index_is_duplicate
     create_table(:users) do |t|
       t.string :email
@@ -61,6 +82,19 @@ remove index_users_on_last_name_and_first_name - can be replaced by index_users_
 OUTPUT
   end
 
+  def test_unique_index_with_fewer_columns
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.index :first_name, unique: true
+      t.index [:last_name, :first_name], unique: true
+    end
+
+    assert_problems(<<OUTPUT)
+remove index_users_on_last_name_and_first_name - can be replaced by index_users_on_first_name
+OUTPUT
+  end
+
   def test_not_covered_by_different_index_type
     create_table(:users) do |t|
       t.string :first_name

data/test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -5,7 +5,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
     create_table(:users) do |t|
       t.string :email, null: false
       t.boolean :active, null: false
-    end.create_model do
+    end.define_model do
       # email is a non-boolean column whose presence CAN be validated in the
       # usual way. We include it in the test model to ensure the detector reports
       # only boolean columns.
@@ -13,14 +13,14 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
     end
 
     assert_problems(<<~OUTPUT)
-      replace the `presence` validator on ModelFactory::Models::User.active with `inclusion` - `presence` can't be used on booleans
+      replace the `presence` validator on TransientRecord::Models::User.active with `inclusion` - `presence` can't be used on booleans
     OUTPUT
   end
 
   def test_inclusion_is_not_reported
     create_table(:users) do |t|
       t.boolean :active, null: false
-    end.create_model do
+    end.define_model do
       validates :active, inclusion: { in: [true, false] }
     end
 
@@ -28,7 +28,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   end
 
   def test_models_with_non_existent_tables_are_skipped
-    create_model(:User)
+    define_model(:User)
 
     refute_problems
   end
@@ -36,7 +36,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :email, null: false
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
@@ -51,7 +51,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   def test_global_ignore_models
     create_table(:users) do |t|
       t.string :email, null: false
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
@@ -65,7 +65,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   def test_config_ignore_attributes
     create_table(:users) do |t|
       t.string :email, null: false
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|