active_record_doctor 1.9.0 → 1.10.0

data/test/active_record_doctor/detectors/missing_non_null_constraint_test.rb

@@ -164,6 +164,40 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
     refute_problems
   end
 
+  def test_not_null_check_constraint
+    skip unless postgresql?
+
+    create_table(:users) do |t|
+      t.string :email
+    end.create_model do
+      validates :email, presence: true
+    end
+
+    ActiveRecord::Base.connection.execute(<<-SQL)
+      ALTER TABLE users ADD CONSTRAINT email_not_null CHECK (email IS NOT NULL)
+    SQL
+
+    refute_problems
+  end
+
+  def test_not_null_check_constraint_not_valid
+    skip unless postgresql?
+
+    create_table(:users) do |t|
+      t.string :email
+    end.create_model do
+      validates :email, presence: true
+    end
+
+    ActiveRecord::Base.connection.execute(<<-SQL)
+      ALTER TABLE users ADD CONSTRAINT email_not_null CHECK (email IS NOT NULL) NOT VALID
+    SQL
+
+    assert_problems(<<~OUTPUT)
+      add `NOT NULL` to users.email - models validates its presence but it's not non-NULL in the database
+    OUTPUT
+  end
+
   def test_config_ignore_tables
     create_table(:users) do |t|
       t.string :name, null: true

data/test/active_record_doctor/detectors/missing_presence_validation_test.rb

@@ -105,9 +105,15 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
 
   def test_timestamps_are_not_reported
     create_table(:users) do |t|
+      # Create created_at/updated_at timestamps.
       t.timestamps null: false
+
+      # Rails also supports created_on/updated_on. We used datetime, which is
+      # what the timestamps method users under the hood, to avoid default value
+      # errors in some MySQL versions when using t.timestamp.
+      t.datetime :created_on, null: false
+      t.datetime :updated_on, null: false
     end.create_model do
-      validates :name, presence: true
     end
 
     refute_problems
@@ -119,6 +125,36 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
     refute_problems
   end
 
+  def test_not_null_check_constraint
+    skip unless postgresql?
+
+    create_table(:users) do |t|
+      t.string :name
+    end.create_model
+
+    ActiveRecord::Base.connection.execute(<<-SQL)
+      ALTER TABLE users ADD CONSTRAINT name_not_null CHECK (name IS NOT NULL)
+    SQL
+
+    assert_problems(<<~OUTPUT)
+      add a `presence` validator to ModelFactory::Models::User.name - it's NOT NULL but lacks a validator
+    OUTPUT
+  end
+
+  def test_not_null_check_constraint_not_valid
+    skip unless postgresql?
+
+    create_table(:users) do |t|
+      t.string :name
+    end.create_model
+
+    ActiveRecord::Base.connection.execute(<<-SQL)
+      ALTER TABLE users ADD CONSTRAINT name_not_null CHECK (name IS NOT NULL) NOT VALID
+    SQL
+
+    refute_problems
+  end
+
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :name, null: false

data/test/active_record_doctor/detectors/missing_unique_indexes_test.rb

@@ -14,6 +14,36 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     OUTPUT
   end
 
+  def test_missing_unique_index_on_functional_index
+    skip if !(ActiveRecord::VERSION::STRING >= "5.0" && postgresql?)
+
+    create_table(:users) do |t|
+      t.string :email
+      t.index "lower(email)"
+    end.create_model do
+      validates :email, uniqueness: true
+    end
+
+    # Running the detector should NOT raise an error when a functional index
+    # is present. No need to assert anything -- the test is successful if no
+    # exception was raised.
+    run_detector
+  end
+
+  def test_validates_multiple_attributes
+    create_table(:users) do |t|
+      t.string :email
+      t.string :ref_token
+    end.create_model do
+      validates :email, :ref_token, uniqueness: true
+    end
+
+    assert_problems(<<~OUTPUT)
+      add a unique index on users(email) - validating uniqueness in the model without an index can lead to duplicates
+      add a unique index on users(ref_token) - validating uniqueness in the model without an index can lead to duplicates
+    OUTPUT
+  end
+
   def test_present_unique_index
     create_table(:users) do |t|
       t.string :email
@@ -25,7 +55,23 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     refute_problems
   end
 
-  def test_missing_unique_index_with_scope
+  def test_present_partial_unique_index
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :email
+      t.boolean :active
+      t.index :email, unique: true, where: "active"
+    end.create_model do
+      validates :email, uniqueness: true
+    end
+
+    assert_problems(<<~OUTPUT)
+      add a unique index on users(email) - validating uniqueness in the model without an index can lead to duplicates
+    OUTPUT
+  end
+
+  def test_unique_index_with_extra_columns_with_scope
     create_table(:users) do |t|
       t.string :email
       t.integer :company_id
@@ -40,7 +86,7 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     OUTPUT
   end
 
-  def test_present_unique_index_with_scope
+  def test_unique_index_with_exact_columns_with_scope
     create_table(:users) do |t|
       t.string :email
       t.integer :company_id
@@ -53,6 +99,73 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     refute_problems
   end
 
+  def test_unique_index_with_fewer_columns_with_scope
+    create_table(:users) do |t|
+      t.string :email
+      t.integer :company_id
+      t.integer :department_id
+      t.index [:company_id, :department_id], unique: true
+    end.create_model do
+      validates :email, uniqueness: { scope: [:company_id, :department_id] }
+    end
+
+    refute_problems
+  end
+
+  def test_missing_unique_index_with_association_attribute
+    create_table(:users) do |t|
+      t.integer :account_id
+    end.create_model do
+      belongs_to :account
+      validates :account, uniqueness: true
+    end
+
+    assert_problems(<<~OUTPUT)
+      add a unique index on users(account_id) - validating uniqueness in the model without an index can lead to duplicates
+    OUTPUT
+  end
+
+  def test_present_unique_index_with_association_attribute
+    create_table(:users) do |t|
+      t.integer :account_id
+      t.index :account_id, unique: true
+    end.create_model do
+      belongs_to :account
+      validates :account, uniqueness: true
+    end
+
+    refute_problems
+  end
+
+  def test_missing_unique_index_with_association_scope
+    create_table(:comments) do |t|
+      t.string :title
+      t.integer :commentable_id
+      t.string :commentable_type
+    end.create_model do
+      belongs_to :commentable, polymorphic: true
+      validates :title, uniqueness: { scope: :commentable }
+    end
+
+    assert_problems(<<~OUTPUT)
+      add a unique index on comments(commentable_type, commentable_id, title) - validating uniqueness in the model without an index can lead to duplicates
+    OUTPUT
+  end
+
+  def test_present_unique_index_with_association_scope
+    create_table(:comments) do |t|
+      t.string :title
+      t.integer :commentable_id
+      t.string :commentable_type
+      t.index [:commentable_id, :commentable_type, :title], unique: true
+    end.create_model do
+      belongs_to :commentable, polymorphic: true
+      validates :title, uniqueness: { scope: :commentable }
+    end
+
+    refute_problems
+  end
+
   def test_column_order_is_ignored
     create_table(:users) do |t|
       t.string :email
@@ -93,6 +206,57 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     refute_problems
   end
 
+  def test_has_one_without_index
+    create_table(:users)
+      .create_model do
+        has_one :account, class_name: "ModelFactory::Models::Account"
+        has_one :account_history, through: :account, class_name: "ModelFactory::Models::Account"
+      end
+
+    create_table(:accounts) do |t|
+      t.integer :user_id
+    end.create_model do
+      has_one :account_history, class_name: "ModelFactory::Models::AccountHistory"
+    end
+
+    create_table(:account_histories) do |t|
+      t.integer :account_id
+    end.create_model do
+      belongs_to :account,  class_name: "ModelFactory::Models::Account"
+    end
+
+    assert_problems(<<~OUTPUT)
+      add a unique index on accounts(user_id) - using `has_one` in the ModelFactory::Models::User model without an index can lead to duplicates
+      add a unique index on account_histories(account_id) - using `has_one` in the ModelFactory::Models::Account model without an index can lead to duplicates
+    OUTPUT
+  end
+
+  def test_has_one_with_scope_and_without_index
+    create_table(:users)
+      .create_model do
+        has_one :last_comment, -> { order(created_at: :desc) }, class_name: "ModelFactory::Models::Comment"
+      end
+
+    create_table(:comments) do |t|
+      t.integer :user_id
+    end.create_model
+
+    refute_problems
+  end
+
+  def test_has_one_with_index
+    create_table(:users)
+      .create_model do
+        has_one :account, class_name: "ModelFactory::Models::Account"
+      end
+
+    create_table(:accounts) do |t|
+      t.integer :user_id, index: { unique: true }
+    end.create_model
+
+    refute_problems
+  end
+
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :email
@@ -137,7 +301,7 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :missing_unique_indexes,
-          ignore_columns: ["ModelFactory::Models::User(organization_id, email, role)"]
+          ignore_columns: ["ModelFactory::Models::User(organization_id, email)", "ModelFactory::Models::User(organization_id, role)"]
       end
     CONFIG
 

data/test/active_record_doctor/detectors/short_primary_key_type_test.rb

@@ -1,32 +1,40 @@
 # frozen_string_literal: true
 
 class ActiveRecordDoctor::Detectors::ShortPrimaryKeyTypeTest < Minitest::Test
+  def setup
+    @connection = ActiveRecord::Base.connection
+    @connection.enable_extension("uuid-ossp") if postgresql?
+    super
+  end
+
+  def teardown
+    @connection.disable_extension("uuid-ossp") if postgresql?
+    super
+  end
+
   def test_short_integer_primary_key_is_reported
-    if mysql?
-      create_table(:companies, id: :int)
-
-      assert_problems(<<~OUTPUT)
-        change the type of companies.id to bigint
-      OUTPUT
-    elsif postgresql?
-      create_table(:companies, id: :integer)
-
-      assert_problems(<<~OUTPUT)
-        change the type of companies.id to bigint
-      OUTPUT
+    create_table(:companies, id: :int)
+
+    # In Rails 4.2 and MySQL primary key is not created due to a bug
+    if mysql? && ActiveRecord::VERSION::STRING < "5.0"
+      @connection.execute("ALTER TABLE companies ADD PRIMARY KEY(id)")
     end
+
+    assert_problems(<<~OUTPUT)
+      change the type of companies.id to bigint
+    OUTPUT
   end
 
   def test_long_integer_primary_key_is_not_reported
-    if mysql?
-      create_table(:companies, id: :bigint)
+    create_table(:companies, id: :bigint)
+    refute_problems
+  end
 
-      refute_problems
-    elsif postgresql?
-      create_table(:companies, id: :bigserial)
+  def test_uuid_primary_key_is_not_reported
+    skip unless postgresql?
 
-      refute_problems
-    end
+    create_table(:companies, id: :uuid)
+    refute_problems
   end
 
   def test_no_primary_key_is_not_reported

data/test/active_record_doctor/detectors/unindexed_deleted_at_test.rb

@@ -11,6 +11,9 @@ class ActiveRecordDoctor::Detectors::UnindexedDeletedAtTest < Minitest::Test
       t.index [:first_name, :last_name],
         name: "index_profiles_on_first_name_and_last_name",
         where: "deleted_at IS NULL"
+      t.index [:last_name],
+        name: "index_deleted_profiles_on_last_name",
+        where: "deleted_at IS NOT NULL"
     end
 
     refute_problems
@@ -28,7 +31,7 @@ class ActiveRecordDoctor::Detectors::UnindexedDeletedAtTest < Minitest::Test
     end
 
     assert_problems(<<~OUTPUT)
-      consider adding `WHERE deleted_at IS NULL` to index_profiles_on_first_name_and_last_name - a partial index can speed lookups of soft-deletable models
+      consider adding `WHERE deleted_at IS NULL` or `WHERE deleted_at IS NOT NULL` to index_profiles_on_first_name_and_last_name - a partial index can speed lookups of soft-deletable models
     OUTPUT
   end
 
@@ -42,6 +45,9 @@ class ActiveRecordDoctor::Detectors::UnindexedDeletedAtTest < Minitest::Test
       t.index [:first_name, :last_name],
         name: "index_profiles_on_first_name_and_last_name",
         where: "discarded_at IS NULL"
+      t.index [:last_name],
+        name: "index_discarded_profiles_on_last_name",
+        where: "discarded_at IS NOT NULL"
     end
 
     refute_problems
@@ -59,7 +65,7 @@ class ActiveRecordDoctor::Detectors::UnindexedDeletedAtTest < Minitest::Test
     end
 
     assert_problems(<<~OUTPUT)
-      consider adding `WHERE discarded_at IS NULL` to index_profiles_on_first_name_and_last_name - a partial index can speed lookups of soft-deletable models
+      consider adding `WHERE discarded_at IS NULL` or `WHERE discarded_at IS NOT NULL` to index_profiles_on_first_name_and_last_name - a partial index can speed lookups of soft-deletable models
     OUTPUT
   end
 
@@ -165,7 +171,7 @@ class ActiveRecordDoctor::Detectors::UnindexedDeletedAtTest < Minitest::Test
     CONFIG
 
     assert_problems(<<~OUTPUT)
-      consider adding `WHERE obliverated_at IS NULL` to index_profiles_on_first_name_and_last_name - a partial index can speed lookups of soft-deletable models
+      consider adding `WHERE obliverated_at IS NULL` or `WHERE obliverated_at IS NOT NULL` to index_profiles_on_first_name_and_last_name - a partial index can speed lookups of soft-deletable models
     OUTPUT
   end
 end

data/test/setup.rb

@@ -104,13 +104,17 @@ class Minitest::Test
 
   def assert_problems(expected_output)
     success, output = run_detector
-    assert_equal(expected_output, output)
+    assert_equal(sort_lines(expected_output), sort_lines(output))
     refute(success, "Expected the detector to return failure.")
   end
 
   def refute_problems(expected_output = "")
     success, output = run_detector
-    assert_equal(expected_output, output)
+    assert_equal(sort_lines(expected_output), sort_lines(output))
     assert(success, "Expected the detector to return success.")
   end
+
+  def sort_lines(string)
+    string.split("\n").sort.join("\n")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -126,6 +126,7 @@ files:
 - lib/active_record_doctor/detectors/extraneous_indexes.rb
 - lib/active_record_doctor/detectors/incorrect_boolean_presence_validation.rb
 - lib/active_record_doctor/detectors/incorrect_dependent_option.rb
+- lib/active_record_doctor/detectors/incorrect_length_validation.rb
 - lib/active_record_doctor/detectors/mismatched_foreign_key_type.rb
 - lib/active_record_doctor/detectors/missing_foreign_keys.rb
 - lib/active_record_doctor/detectors/missing_non_null_constraint.rb
@@ -147,9 +148,11 @@ files:
 - lib/tasks/active_record_doctor.rake
 - test/active_record_doctor/config/loader_test.rb
 - test/active_record_doctor/config_test.rb
+- test/active_record_doctor/detectors/disable_test.rb
 - test/active_record_doctor/detectors/extraneous_indexes_test.rb
 - test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb
 - test/active_record_doctor/detectors/incorrect_dependent_option_test.rb
+- test/active_record_doctor/detectors/incorrect_length_validation_test.rb
 - test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb
 - test/active_record_doctor/detectors/missing_foreign_keys_test.rb
 - test/active_record_doctor/detectors/missing_non_null_constraint_test.rb
@@ -182,16 +185,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Identify database issues before they hit production.
 test_files:
 - test/active_record_doctor/config/loader_test.rb
 - test/active_record_doctor/config_test.rb
+- test/active_record_doctor/detectors/disable_test.rb
 - test/active_record_doctor/detectors/extraneous_indexes_test.rb
 - test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb
 - test/active_record_doctor/detectors/incorrect_dependent_option_test.rb
+- test/active_record_doctor/detectors/incorrect_length_validation_test.rb
 - test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb
 - test/active_record_doctor/detectors/missing_foreign_keys_test.rb
 - test/active_record_doctor/detectors/missing_non_null_constraint_test.rb