active_record_doctor 1.9.0 → 1.11.0

data/test/active_record_doctor/detectors/missing_unique_indexes_test.rb

@@ -5,7 +5,7 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     create_table(:users) do |t|
       t.string :email
       t.index :email
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: true
     end
 
@@ -14,24 +14,70 @@ 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.define_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.define_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
       t.index :email, unique: true
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: true
     end
 
     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.define_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
       t.integer :department_id
       t.index [:company_id, :department_id, :email]
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: { scope: [:company_id, :department_id] }
     end
 
@@ -40,26 +86,93 @@ 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
       t.integer :department_id
       t.index [:company_id, :department_id, :email], unique: true
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: { scope: [:company_id, :department_id] }
     end
 
     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.define_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.define_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.define_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.define_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.define_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
       t.integer :organization_id
 
       t.index [:email, :organization_id], unique: true
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: { scope: :organization_id }
     end
 
@@ -86,24 +199,75 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     create_table(:users) do |t|
       t.string :email
       t.index :email
-    end.create_model do
+    end.define_model do
       validates_with DummyValidator
     end
 
     refute_problems
   end
 
+  def test_has_one_without_index
+    create_table(:users)
+      .define_model do
+        has_one :account, class_name: "TransientRecord::Models::Account"
+        has_one :account_history, through: :account, class_name: "TransientRecord::Models::Account"
+      end
+
+    create_table(:accounts) do |t|
+      t.integer :user_id
+    end.define_model do
+      has_one :account_history, class_name: "TransientRecord::Models::AccountHistory"
+    end
+
+    create_table(:account_histories) do |t|
+      t.integer :account_id
+    end.define_model do
+      belongs_to :account,  class_name: "TransientRecord::Models::Account"
+    end
+
+    assert_problems(<<~OUTPUT)
+      add a unique index on accounts(user_id) - using `has_one` in the TransientRecord::Models::User model without an index can lead to duplicates
+      add a unique index on account_histories(account_id) - using `has_one` in the TransientRecord::Models::Account model without an index can lead to duplicates
+    OUTPUT
+  end
+
+  def test_has_one_with_scope_and_without_index
+    create_table(:users)
+      .define_model do
+        has_one :last_comment, -> { order(created_at: :desc) }, class_name: "TransientRecord::Models::Comment"
+      end
+
+    create_table(:comments) do |t|
+      t.integer :user_id
+    end.define_model
+
+    refute_problems
+  end
+
+  def test_has_one_with_index
+    create_table(:users)
+      .define_model do
+        has_one :account, class_name: "TransientRecord::Models::Account"
+      end
+
+    create_table(:accounts) do |t|
+      t.integer :user_id, index: { unique: true }
+    end.define_model
+
+    refute_problems
+  end
+
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :email
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: true
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :missing_unique_indexes,
-          ignore_models: ["ModelFactory::Models::User"]
+          ignore_models: ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -113,13 +277,13 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
   def test_global_ignore_models
     create_table(:users) do |t|
       t.string :email
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: true
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory::Models::User"]
+        config.global :ignore_models, ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -130,14 +294,14 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
     create_table(:users) do |t|
       t.string :email
       t.integer :role
-    end.create_model do
+    end.define_model do
       validates :email, :role, uniqueness: { scope: :organization_id }
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :missing_unique_indexes,
-          ignore_columns: ["ModelFactory::Models::User(organization_id, email, role)"]
+          ignore_columns: ["TransientRecord::Models::User(organization_id, email)", "TransientRecord::Models::User(organization_id, role)"]
       end
     CONFIG
 
@@ -154,7 +318,7 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
   def assert_skipped(options)
     create_table(:users) do |t|
       t.string :email
-    end.create_model do
+    end.define_model do
       validates :email, uniqueness: options
     end
 

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/undefined_table_references_test.rb

@@ -3,17 +3,17 @@
 class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Test
   def test_model_backed_by_table
     create_table(:users) do
-    end.create_model do
+    end.define_model do
     end
 
     refute_problems
   end
 
   def test_model_backed_by_non_existent_table
-    create_model(:User)
+    define_model(:User)
 
     assert_problems(<<~OUTPUT)
-      ModelFactory::Models::User references a non-existent table or view named users
+      TransientRecord::Models::User references a non-existent table or view named users
     OUTPUT
   end
 
@@ -21,22 +21,20 @@ class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Te
     # We replace the underlying table with a view. The view doesn't have to be
     # backed by an actual table - it can simply return a predefined tuple.
     ActiveRecord::Base.connection.execute("CREATE VIEW users AS SELECT 1")
-    create_model(:User)
+    define_model(:User)
 
-    begin
-      refute_problems
-    ensure
-      ActiveRecord::Base.connection.execute("DROP VIEW users")
-    end
+    refute_problems
+  ensure
+    ActiveRecord::Base.connection.execute("DROP VIEW users")
   end
 
   def test_config_ignore_tables
-    create_model(:User)
+    define_model(:User)
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :undefined_table_references,
-          ignore_models: ["ModelFactory::Models::User"]
+          ignore_models: ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -44,11 +42,11 @@ class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Te
   end
 
   def test_global_ignore_tables
-    create_model(:User)
+    define_model(:User)
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory::Models::User"]
+        config.global :ignore_models, ["TransientRecord::Models::User"]
       end
     CONFIG
 

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/active_record_doctor/runner_test.rb

@@ -1,42 +1,41 @@
 # frozen_string_literal: true
 
 class ActiveRecordDoctor::RunnerTest < Minitest::Test
-  def test_run_one_raises_on_unknown_detectors
-    io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+  def setup
+    @io = StringIO.new
+    @runner = ActiveRecordDoctor::Runner.new(
+      config: load_config,
+      logger: ActiveRecordDoctor::Logger::Dummy.new,
+      io: @io
+    )
+  end
 
+  def test_run_one_raises_on_unknown_detectors
     assert_raises(KeyError) do
-      runner.run_one(:performance_issues)
+      @runner.run_one(:performance_issues)
     end
   end
 
   def test_run_all_returns_true_when_no_errors
-    io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
-
-    assert(runner.run_all)
-    assert(io.string.blank?)
+    assert(@runner.run_all)
+    assert(@io.string.blank?)
   end
 
   def test_run_all_returns_false_when_errors
     # Create a model without its underlying table to trigger an error.
-    create_model(:User)
-
-    io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+    define_model(:User)
 
-    refute(runner.run_all)
-    refute(io.string.blank?)
+    refute(@runner.run_all)
+    refute(@io.string.blank?)
   end
 
   def test_help_prints_help
     ActiveRecordDoctor.detectors.each do |name, _|
-      io = StringIO.new
-      runner = ActiveRecordDoctor::Runner.new(load_config, io)
+      @io.truncate(0)
 
-      runner.help(name)
+      @runner.help(name)
 
-      refute(io.string.blank?, "expected help for #{name}")
+      refute(@io.string.blank?, "expected help for #{name}")
     end
   end
 end

data/test/setup.rb

@@ -33,7 +33,7 @@ require "active_record_doctor"
 require "minitest"
 require "minitest/autorun"
 require "minitest/fork_executor"
-require_relative "model_factory"
+require "transient_record"
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.
@@ -44,11 +44,11 @@ Minitest.parallel_executor = Minitest::ForkExecutor.new
 
 # Prepare the test class.
 class Minitest::Test
-  include ModelFactory
+  include TransientRecord
 
   def setup
     # Delete remnants (models and tables) of previous test case runs.
-    cleanup_models
+    TransientRecord.cleanup
   end
 
   def teardown
@@ -61,7 +61,7 @@ class Minitest::Test
 
     # Ensure all remnants of previous test runs, most likely in form of tables,
     # are removed.
-    cleanup_models
+    TransientRecord.cleanup
   end
 
   private
@@ -93,7 +93,11 @@ class Minitest::Test
 
   def run_detector
     io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+    runner = ActiveRecordDoctor::Runner.new(
+      config: load_config,
+      logger: ActiveRecordDoctor::Logger::Dummy.new,
+      io: io
+    )
     success = runner.run_one(detector_name)
     [success, io.string]
   end
@@ -104,13 +108,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
+  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.11.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: transient_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +140,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
@@ -137,6 +152,9 @@ files:
 - lib/active_record_doctor/detectors/unindexed_foreign_keys.rb
 - lib/active_record_doctor/errors.rb
 - lib/active_record_doctor/help.rb
+- lib/active_record_doctor/logger.rb
+- lib/active_record_doctor/logger/dummy.rb
+- lib/active_record_doctor/logger/hierarchical.rb
 - lib/active_record_doctor/printers.rb
 - lib/active_record_doctor/railtie.rb
 - lib/active_record_doctor/rake/task.rb
@@ -147,9 +165,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
@@ -161,7 +181,6 @@ files:
 - test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
 - test/active_record_doctor/runner_test.rb
 - test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
-- test/model_factory.rb
 - test/setup.rb
 homepage: https://github.com/gregnavis/active_record_doctor
 licenses:
@@ -182,16 +201,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
@@ -203,5 +224,4 @@ test_files:
 - test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
 - test/active_record_doctor/runner_test.rb
 - test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
-- test/model_factory.rb
 - test/setup.rb