active_record_doctor 1.8.0 → 1.9.0.rc1

data/test/active_record_doctor/config_test.rb

@@ -0,0 +1,116 @@
+# 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/extraneous_indexes_test.rb

@@ -7,8 +7,7 @@ class ActiveRecordDoctor::Detectors::ExtraneousIndexesTest < Minitest::Test
     end
 
     assert_problems(<<OUTPUT)
-The following indexes are extraneous and can be removed:
-  index_users_on_id (is a primary key of users)
+remove index_users_on_id - coincides with the primary key on the table
 OUTPUT
   end
 
@@ -22,8 +21,7 @@ OUTPUT
     ActiveRecord::Base.connection.add_index :users, :email, name: "index_users_on_email"
 
     assert_problems(<<OUTPUT)
-The following indexes are extraneous and can be removed:
-  index_users_on_email (can be handled by unique_index_on_users_email)
+remove index_users_on_email - can be replaced by unique_index_on_users_email
 OUTPUT
   end
 
@@ -40,8 +38,7 @@ OUTPUT
     end
 
     assert_problems(<<OUTPUT)
-The following indexes are extraneous and can be removed:
-  index_users_on_last_name (can be handled by index_users_on_last_name_and_first_name_and_email, unique_index_on_users_last_name_and_first_name)
+remove index_users_on_last_name - can be replaced by index_users_on_last_name_and_first_name_and_email or unique_index_on_users_last_name_and_first_name
 OUTPUT
   end
 
@@ -60,8 +57,134 @@ OUTPUT
     ActiveRecord::Base.connection.add_index :users, [:last_name, :first_name]
 
     assert_problems(<<OUTPUT)
-The following indexes are extraneous and can be removed:
-  index_users_on_last_name_and_first_name (can be handled by index_users_on_last_name_and_first_name_and_email, unique_index_on_users_last_name_and_first_name)
+remove index_users_on_last_name_and_first_name - can be replaced by index_users_on_last_name_and_first_name_and_email or unique_index_on_users_last_name_and_first_name
 OUTPUT
   end
+
+  def test_not_covered_by_different_index_type
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.index [:last_name, :first_name], using: :btree
+
+      if mysql?
+        t.index :last_name, type: :fulltext
+      else
+        t.index :last_name, using: :hash
+      end
+    end
+
+    refute_problems
+  end
+
+  def test_not_covered_by_partial_index
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.boolean :active
+      t.index [:last_name, :first_name], where: "active"
+      t.index :last_name
+    end
+
+    refute_problems
+  end
+
+  def test_not_covered_with_different_opclasses
+    skip("ActiveRecord < 5.2 doesn't support operator classes") if ActiveRecord::VERSION::STRING < "5.2"
+    skip("MySQL doesn't support operator classes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.index [:last_name, :first_name], opclass: :varchar_pattern_ops
+      t.index :last_name
+    end
+
+    refute_problems
+  end
+
+  def test_config_ignore_tables
+    # The detector recognizes two kinds of errors and both must take
+    # ignore_tables into account. We trigger those errors by indexing the
+    # primary key (the first extraneous index) and then indexing email twice
+    # (index2... is the other extraneous index).
+    create_table(:users) do |t|
+      t.index :id
+      t.string :email
+
+      t.index :email, name: "index1_on_users_email"
+      t.index :email, name: "index2_on_users_email"
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :extraneous_indexes,
+          ignore_tables: ["users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_global_ignore_tables
+    create_table(:users) do |t|
+      t.index :id
+      t.string :email
+
+      t.index :email, name: "index1_on_users_email"
+      t.index :email, name: "index2_on_users_email"
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_tables, ["users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_global_ignore_indexes
+    create_table(:users) do |t|
+      t.index :id
+      t.string :email
+
+      t.index :email, name: "index1_on_users_email"
+      t.index :email, name: "index2_on_users_email"
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_indexes, [
+          "index1_on_users_email",
+          "index2_on_users_email",
+          "index_users_on_id",
+        ]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_detector_ignore_indexes
+    create_table(:users) do |t|
+      t.index :id
+      t.string :email
+      t.string :api_key
+
+      t.index :email, name: "index_on_users_email"
+      t.index [:email, :api_key], name: "index_on_users_email_and_api_key"
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :extraneous_indexes,
+          ignore_indexes: ["index_users_on_id", "index_on_users_email"]
+      end
+    CONFIG
+
+    refute_problems
+  end
 end

data/test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -12,10 +12,9 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
       validates :email, :active, presence: true
     end
 
-    assert_problems(<<OUTPUT)
-The presence of the following boolean columns is validated incorrectly:
-  ModelFactory::Models::User: active
-OUTPUT
+    assert_problems(<<~OUTPUT)
+      replace the `presence` validator on ModelFactory::Models::User.active with `inclusion` - `presence` can't be used on booleans
+    OUTPUT
   end
 
   def test_inclusion_is_not_reported
@@ -29,7 +28,51 @@ OUTPUT
   end
 
   def test_models_with_non_existent_tables_are_skipped
-    create_model(:users)
+    create_model(:User)
+
+    refute_problems
+  end
+
+  def test_config_ignore_models
+    create_table(:users) do |t|
+      t.string :email, null: false
+    end.create_model
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_boolean_presence_validation,
+          ignore_models: ["ModelFactory.User"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_global_ignore_models
+    create_table(:users) do |t|
+      t.string :email, null: false
+    end.create_model
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_models, ["ModelFactory.User"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_attributes
+    create_table(:users) do |t|
+      t.string :email, null: false
+    end.create_model
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_boolean_presence_validation,
+          ignore_attributes: ["ModelFactory.User.email"]
+      end
+    CONFIG
 
     refute_problems
   end

data/test/active_record_doctor/detectors/incorrect_dependent_option_test.rb

@@ -13,10 +13,9 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
       belongs_to :company
     end
 
-    assert_problems(<<OUTPUT)
-The following associations might be using invalid dependent settings:
-  ModelFactory::Models::Company: users loads models one-by-one to invoke callbacks even though the related model defines none - consider using `dependent: :delete_all`
-OUTPUT
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete_all` or similar on ModelFactory::Models::Company.users - associated models have no validations and can be deleted in bulk
+    OUTPUT
   end
 
   def test_invoking_callbacks_does_not_suggest_delete_all
@@ -56,10 +55,9 @@ OUTPUT
       end
     end
 
-    assert_problems(<<OUTPUT)
-The following associations might be using invalid dependent settings:
-  ModelFactory::Models::Company: users skips callbacks that are defined on the associated model - consider changing to `dependent: :destroy` or similar
-OUTPUT
+    assert_problems(<<~OUTPUT)
+      use `dependent: :destroy` or similar on ModelFactory::Models::Company.users - the associated model has callbacks that are currently skipped
+    OUTPUT
   end
 
   def test_invoking_callbacks_does_not_suggest_destroy
@@ -94,10 +92,125 @@ OUTPUT
       belongs_to :company
     end
 
-    assert_problems(<<OUTPUT)
-The following associations might be using invalid dependent settings:
-  ModelFactory::Models::Company: owner loads the associated model before deleting it - consider using `dependent: :delete`
-OUTPUT
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete` or similar on ModelFactory::Models::Company.owner - the associated model has no callbacks and can be deleted without loading
+    OUTPUT
+  end
+
+  def test_works_on_belongs_to
+    create_table(:companies) do
+    end.create_model do
+      has_many :users
+    end
+
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, dependent: :destroy
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete` or similar on ModelFactory::Models::User.company - the associated model has no callbacks and can be deleted without loading
+    OUTPUT
+  end
+
+  def test_no_foreign_key_on_second_level_association
+    create_table(:companies) do
+    end.create_model do
+      has_many :users
+      has_many :projects
+    end
+
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, dependent: :destroy
+    end
+
+    create_table(:projects) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete` or similar on ModelFactory::Models::User.company - the associated model has no callbacks and can be deleted without loading
+    OUTPUT
+  end
+
+  def test_nullify_foreign_key_on_second_level_association
+    create_table(:companies) do
+    end.create_model do
+      has_many :users
+      has_many :projects
+    end
+
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, dependent: :destroy
+    end
+
+    create_table(:projects) do |t|
+      t.references :company, foreign_key: { on_delete: :nullify }
+    end.create_model do
+      belongs_to :company
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete` or similar on ModelFactory::Models::User.company - the associated model has no callbacks and can be deleted without loading
+    OUTPUT
+  end
+
+  def test_cascade_foreign_key_and_callbacks_on_second_level_association
+    create_table(:companies) do
+    end.create_model do
+      has_many :users
+      has_many :projects
+    end
+
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, dependent: :delete
+    end
+
+    create_table(:projects) do |t|
+      t.references :company, foreign_key: { on_delete: :cascade }
+    end.create_model do
+      belongs_to :company
+
+      before_destroy :log
+
+      def log
+      end
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :destroy` or similar on ModelFactory::Models::User.company - the associated model has callbacks that are currently skipped
+    OUTPUT
+  end
+
+  def test_cascade_foreign_key_and_no_callbacks_on_second_level_association
+    create_table(:companies) do
+    end.create_model do
+      has_many :users
+      has_many :projects
+    end
+
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, dependent: :delete
+    end
+
+    create_table(:projects) do |t|
+      t.references :company, foreign_key: { on_delete: :cascade }
+    end.create_model do
+      belongs_to :company
+    end
+
+    refute_problems
   end
 
   def test_no_dependent_suggests_nothing
@@ -114,4 +227,69 @@ OUTPUT
 
     refute_problems
   end
+
+  def test_config_ignore_models
+    create_table(:companies) do
+    end.create_model do
+      has_many :users, dependent: :destroy
+    end
+
+    create_table(:users) do |t|
+      t.references :companies
+    end.create_model do
+      belongs_to :company
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_dependent_option,
+          ignore_models: ["ModelFactory::Models::Company"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_global_ignore_models
+    create_table(:companies) do
+    end.create_model do
+      has_many :users, dependent: :destroy
+    end
+
+    create_table(:users) do |t|
+      t.references :companies
+    end.create_model do
+      belongs_to :company
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_models, ["ModelFactory::Models::Company"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_associations
+    create_table(:companies) do
+    end.create_model do
+      has_many :users, dependent: :destroy
+    end
+
+    create_table(:users) do |t|
+      t.references :companies
+    end.create_model do
+      belongs_to :company
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_dependent_option,
+          ignore_associations: ["ModelFactory::Models::Company.users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
 end

data/test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MismatchedForeignKeyTypeTest < Minitest::Test
+  def test_mismatched_foreign_key_type_is_reported
+    # MySQL does not allow foreign keys to have different type than paired primary keys
+    return if mysql?
+
+    create_table(:companies, id: :bigint)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true, type: :integer
+    end
+
+    assert_problems(<<~OUTPUT)
+      users.company_id references a column of different type - foreign keys should be of the same type as the referenced column
+    OUTPUT
+  end
+
+  def test_matched_foreign_key_type_is_not_reported
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true
+    end
+
+    refute_problems
+  end
+
+  def test_config_ignore_tables
+    # MySQL does not allow foreign keys to have different type than paired primary keys
+    return if mysql?
+
+    create_table(:companies, id: :bigint)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true, type: :integer
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :mismatched_foreign_key_type,
+          ignore_tables: ["users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_global_ignore_tables
+    # MySQL does not allow foreign keys to have different type than paired primary keys
+    return if mysql?
+
+    create_table(:companies, id: :bigint)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true, type: :integer
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_tables, ["users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_columns
+    # MySQL does not allow foreign keys to have different type than paired primary keys
+    return if mysql?
+
+    create_table(:companies, id: :bigint)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true, type: :integer
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :mismatched_foreign_key_type,
+          ignore_columns: ["users.company_id"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+end