active_record_doctor 1.8.0 → 1.10.0

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 model ModelFactory::Models::User has 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 ModelFactory::Models::User 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 ModelFactory::Models::User 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 ModelFactory::Models::Company 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 ModelFactory::Models::Company 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 ModelFactory::Models::Company 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 ModelFactory::Models::Company 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,167 @@ OUTPUT
 
     refute_problems
   end
+
+  def test_polymorphic_destroy_reported_when_all_associations_deletable
+    create_table(:images) do |t|
+      t.bigint :imageable_id, null: false
+      t.string :imageable_type, null: true
+    end.create_model do
+      belongs_to :imageable, polymorphic: true, dependent: :destroy
+    end
+
+    create_table(:users) do
+    end.create_model do
+      has_one :image, as: :imageable
+    end
+
+    create_table(:companies) do
+    end.create_model do
+      has_one :image, as: :imageable
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete` or similar on ModelFactory::Models::Image.imageable - the associated models ModelFactory::Models::Company, ModelFactory::Models::User have no callbacks and can be deleted without loading
+    OUTPUT
+  end
+
+  def test_polymorphic_destroy_not_reported_when_some_associations_not_deletable
+    create_table(:images) do |t|
+      t.bigint :imageable_id, null: false
+      t.string :imageable_type, null: true
+    end.create_model do
+      belongs_to :imageable, polymorphic: true, dependent: :destroy
+    end
+
+    create_table(:users) do
+    end.create_model do
+      has_one :image, as: :imageable
+
+      before_destroy :log
+
+      def log
+      end
+    end
+
+    create_table(:companies) do
+    end.create_model do
+      has_one :image, as: :imageable
+    end
+
+    refute_problems
+  end
+
+  def test_polymorphic_delete_reported_when_some_associations_not_deletable
+    create_table(:images) do |t|
+      t.bigint :imageable_id, null: false
+      t.string :imageable_type, null: true
+    end.create_model do
+      belongs_to :imageable, polymorphic: true, dependent: :delete
+    end
+
+    create_table(:users) do
+    end.create_model do
+      has_one :image, as: :imageable
+
+      before_destroy :log
+
+      def log
+      end
+    end
+
+    create_table(:companies) do
+    end.create_model do
+      has_one :image, as: :imageable
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :destroy` or similar on ModelFactory::Models::Image.imageable - the associated model ModelFactory::Models::User has callbacks that are currently skipped
+    OUTPUT
+  end
+
+  def test_polymorphic_delete_not_reported_when_all_associations_deletable
+    create_table(:images) do |t|
+      t.bigint :imageable_id, null: false
+      t.string :imageable_type, null: true
+    end.create_model do
+      belongs_to :imageable, polymorphic: true, dependent: :delete
+    end
+
+    create_table(:users) do
+    end.create_model do
+      has_one :image, as: :imageable
+    end
+
+    create_table(:companies) do
+    end.create_model do
+      has_one :image, as: :imageable
+    end
+
+    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/incorrect_length_validation_test.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::Test
+  def test_validation_and_limit_equal_is_ok
+    create_table(:users) do |t|
+      t.string :email, limit: 64
+    end.create_model do
+      validates :email, length: { maximum: 64 }
+    end
+
+    refute_problems
+  end
+
+  def test_validation_and_limit_different_is_error
+    create_table(:users) do |t|
+      t.string :email, limit: 64
+    end.create_model do
+      validates :email, length: { maximum: 32 }
+    end
+
+    assert_problems(<<~OUTPUT)
+      the schema limits users.email to 64 characters but the length validator on ModelFactory::Models::User.email enforces a maximum of 32 characters - set both limits to the same value or remove both
+    OUTPUT
+  end
+
+  def test_validation_and_no_limit_is_error
+    skip("MySQL always sets a limit on text columns") if mysql?
+
+    create_table(:users) do |t|
+      t.string :email
+    end.create_model do
+      validates :email, length: { maximum: 32 }
+    end
+
+    assert_problems(<<~OUTPUT)
+      the length validator on ModelFactory::Models::User.email enforces a maximum of 32 characters but there's no schema limit on users.email - remove the validator or the schema length limit
+    OUTPUT
+  end
+
+  def test_no_validation_and_limit_is_error
+    create_table(:users) do |t|
+      t.string :email, limit: 64
+    end.create_model do
+    end
+
+    assert_problems(<<~OUTPUT)
+      the schema limits users.email to 64 characters but there's no length validator on ModelFactory::Models::User.email - remove the database limit or add the validator
+    OUTPUT
+  end
+
+  def test_no_validation_and_no_limit_is_ok
+    skip("MySQL always sets a limit on text columns") if mysql?
+
+    create_table(:users) do |t|
+      t.string :email
+    end.create_model do
+    end
+
+    refute_problems
+  end
+
+  def test_config_ignore_models
+    create_table(:users) do |t|
+      t.string :email, limit: 64
+    end.create_model
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_length_validation,
+          ignore_models: ["ModelFactory::Models::User"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_global_ignore_models
+    create_table(:users) do |t|
+      t.string :email, limit: 64
+    end.create_model
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_models, ["ModelFactory::Models::User"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_attributes
+    create_table(:users) do |t|
+      t.string :email, limit: 64
+    end.create_model
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_length_validation,
+          ignore_attributes: ["ModelFactory::Models::User.email"]
+      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

data/test/active_record_doctor/detectors/missing_foreign_keys_test.rb

@@ -7,10 +7,9 @@ class ActiveRecordDoctor::Detectors::MissingForeignKeysTest < Minitest::Test
       t.references :company, foreign_key: false
     end
 
-    assert_problems(<<OUTPUT)
-The following columns lack a foreign key constraint:
-  users company_id
-OUTPUT
+    assert_problems(<<~OUTPUT)
+      create a foreign key on users.company_id - looks like an association without a foreign key constraint
+    OUTPUT
   end
 
   def test_present_foreign_key_is_not_reported
@@ -21,4 +20,51 @@ OUTPUT
 
     refute_problems
   end
+
+  def test_config_ignore_models
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: false
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :missing_foreign_keys,
+          ignore_tables: ["users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_global_ignore_models
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: false
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.global :ignore_tables, ["users"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_columns
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: false
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :missing_foreign_keys,
+          ignore_columns: ["users.company_id"]
+      end
+    CONFIG
+
+    refute_problems
+  end
 end