active_record_doctor 1.7.2 → 1.8.0

data/test/active_record_doctor/detectors/extraneous_indexes_test.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::ExtraneousIndexesTest < Minitest::Test
+  def test_index_on_primary_key_is_duplicate
+    create_table(:users) do |t|
+      t.index :id
+    end
+
+    assert_problems(<<OUTPUT)
+The following indexes are extraneous and can be removed:
+  index_users_on_id (is a primary key of users)
+OUTPUT
+  end
+
+  def test_non_unique_version_of_index_is_duplicate
+    create_table(:users) do |t|
+      t.string :email
+      t.index :email, unique: true, name: "unique_index_on_users_email"
+    end
+
+    # Rails 4.2 compatibility - can't be pulled into the block above.
+    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)
+OUTPUT
+  end
+
+  def test_single_column_covered_by_unique_and_non_unique_multi_column_is_duplicate
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :email
+      t.index [:last_name, :first_name, :email]
+      t.index [:last_name, :first_name],
+        unique: true,
+        name: "unique_index_on_users_last_name_and_first_name"
+      t.index :last_name
+    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)
+OUTPUT
+  end
+
+  def test_multi_column_covered_by_unique_and_non_unique_multi_column_is_duplicate
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :email
+      t.index [:last_name, :first_name, :email]
+      t.index [:last_name, :first_name],
+        unique: true,
+        name: "unique_index_on_users_last_name_and_first_name"
+    end
+
+    # Rails 4.2 compatibility - can't be pulled into the block above.
+    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)
+OUTPUT
+  end
+end

data/test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -0,0 +1,36 @@
+# 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)
+The presence of the following boolean columns is validated incorrectly:
+  ModelFactory::Models::User: active
+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(:users)
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/detectors/incorrect_dependent_option_test.rb

@@ -0,0 +1,117 @@
+# 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)
+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
+  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)
+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
+  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)
+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
+  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
+end

data/test/active_record_doctor/detectors/missing_foreign_keys_test.rb

@@ -0,0 +1,24 @@
+# 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)
+The following columns lack a foreign key constraint:
+  users company_id
+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
+end

data/test/active_record_doctor/detectors/missing_non_null_constraint_test.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Test
+  def test_presence_true_and_null_true
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    assert_problems(<<OUTPUT)
+The following columns should be marked as `null: false`:
+  users: name
+OUTPUT
+  end
+
+  def test_association_presence_true_and_null_true
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, required: true
+    end
+
+    assert_problems(<<OUTPUT)
+The following columns should be marked as `null: false`:
+  users: company_id
+OUTPUT
+  end
+
+  def test_presence_true_and_null_false
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    refute_problems
+  end
+
+  def test_presence_false_and_null_true
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      # The age validator is a form of regression test against a bug that
+      # caused false positives. In this test case, name is NOT validated
+      # for presence so it does NOT need be marked non-NULL. However, the
+      # bug would match the age presence validator with the NULL-able name
+      # column which would result in a false positive error report.
+      validates :age, presence: true
+      validates :name, presence: false
+    end
+
+    refute_problems
+  end
+
+  def test_presence_false_and_null_false
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+      validates :name, presence: false
+    end
+
+    refute_problems
+  end
+
+  def test_presence_true_with_if
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true, if: -> { false }
+    end
+
+    refute_problems
+  end
+
+  def test_presence_true_with_unless
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true, unless: -> { false }
+    end
+
+    refute_problems
+  end
+
+  def test_presence_true_with_allow_nil
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true, allow_nil: true
+    end
+
+    refute_problems
+  end
+
+  def test_models_with_non_existent_tables_are_skipped
+    create_model(:users)
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/detectors/missing_presence_validation_test.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::Test
+  def test_null_column_is_not_reported_if_validation_absent
+    create_table(:users) do |t|
+      t.string :name
+    end.create_model do
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_column_is_reported_if_validation_absent
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+    end
+
+    assert_problems(<<OUTPUT)
+The following models and columns should have presence validations:
+  ModelFactory::Models::User: name
+OUTPUT
+  end
+
+  def test_non_null_column_is_not_reported_if_validation_present
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_column_is_not_reported_if_association_validation_present
+    create_table(:companies).create_model
+    create_table(:users) do |t|
+      t.references :company, null: false
+    end.create_model do
+      belongs_to :company, required: true
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_boolean_is_reported_if_nil_included
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, inclusion: { in: [nil, true, false] }
+    end
+
+    assert_problems(<<OUTPUT)
+The following models and columns should have presence validations:
+  ModelFactory::Models::User: active
+OUTPUT
+  end
+
+  def test_non_null_boolean_is_not_reported_if_nil_not_included
+    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_non_null_boolean_is_not_reported_if_nil_excluded
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, exclusion: { in: [nil] }
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_boolean_is_reported_if_nil_not_excluded
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, exclusion: { in: [false] }
+    end
+
+    assert_problems(<<OUTPUT)
+The following models and columns should have presence validations:
+  ModelFactory::Models::User: active
+OUTPUT
+  end
+
+  def test_timestamps_are_not_reported
+    create_table(:users) do |t|
+      t.timestamps null: false
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    refute_problems
+  end
+
+  def test_models_with_non_existent_tables_are_skipped
+    create_model(:users)
+
+    refute_problems
+  end
+end