active_record_doctor 1.7.1 → 1.9.0

data/test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Minitest::Test
+  def test_presence_true_is_reported_on_boolean_only
+    create_table(:users) do |t|
+      t.string :email, null: false
+      t.boolean :active, null: false
+    end.create_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.
+      validates :email, :active, presence: true
+    end
+
+    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
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, inclusion: { in: [true, false] }
+    end
+
+    refute_problems
+  end
+
+  def test_models_with_non_existent_tables_are_skipped
+    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
+end

data/test/active_record_doctor/detectors/incorrect_dependent_option_test.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Test
+  def test_invoking_no_callbacks_suggests_delete_all
+    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
+
+    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
+    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
+
+      before_destroy :log
+
+      def log
+      end
+    end
+
+    refute_problems
+  end
+
+  def test_skipping_callbacks_suggests_destroy
+    create_table(:companies) do
+    end.create_model do
+      has_many :users, dependent: :delete_all
+    end
+
+    create_table(:users) do |t|
+      t.references :companies
+    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::Company.users - the associated model has callbacks that are currently skipped
+    OUTPUT
+  end
+
+  def test_invoking_callbacks_does_not_suggest_destroy
+    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
+
+      before_destroy :log
+
+      def log
+      end
+    end
+
+    refute_problems
+  end
+
+  def test_works_on_has_one
+    create_table(:companies) do
+    end.create_model do
+      has_one :owner, class_name: "ModelFactory::Models::User", dependent: :destroy
+    end
+
+    create_table(:users) do |t|
+      t.references :companies
+    end.create_model do
+      belongs_to :company
+    end
+
+    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
+    create_table(:companies) do
+    end.create_model do
+      has_many :users
+    end
+
+    create_table(:users) do |t|
+      t.references :companies
+    end.create_model do
+      belongs_to :company
+    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/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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingForeignKeysTest < Minitest::Test
+  def test_missing_foreign_key_is_reported
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: false
+    end
+
+    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
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true
+    end
+
+    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