active_record_doctor 1.10.0 → 1.12.0

data/test/active_record_doctor/detectors/incorrect_dependent_option_test.rb

@@ -3,30 +3,30 @@
 class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Test
   def test_invoking_no_callbacks_suggests_delete_all
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users, dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
     end
 
     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
+      use `dependent: :delete_all` or similar on TransientRecord::Models::Company.users - associated model TransientRecord::Models::User has no callbacks 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
+    end.define_model do
       has_many :users, dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
 
       before_destroy :log
@@ -40,13 +40,13 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
 
   def test_skipping_callbacks_suggests_destroy
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users, dependent: :delete_all
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
 
       before_destroy :log
@@ -56,19 +56,19 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     end
 
     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
+      use `dependent: :destroy` or similar on TransientRecord::Models::Company.users - associated model TransientRecord::Models::User has callbacks that are currently skipped
     OUTPUT
   end
 
   def test_invoking_callbacks_does_not_suggest_destroy
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users, dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
 
       before_destroy :log
@@ -82,102 +82,102 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
 
   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.define_model do
+      has_one :owner, class_name: "TransientRecord::Models::User", dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
     end
 
     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
+      use `dependent: :delete` or similar on TransientRecord::Models::Company.owner - associated model TransientRecord::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
+    end.define_model do
       has_many :users
     end
 
     create_table(:users) do |t|
       t.references :company
-    end.create_model do
+    end.define_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
+      use `dependent: :delete` or similar on TransientRecord::Models::User.company - associated model TransientRecord::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
+    end.define_model do
       has_many :users
       has_many :projects
     end
 
     create_table(:users) do |t|
       t.references :company
-    end.create_model do
+    end.define_model do
       belongs_to :company, dependent: :destroy
     end
 
     create_table(:projects) do |t|
       t.references :company
-    end.create_model do
+    end.define_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
+      use `dependent: :delete` or similar on TransientRecord::Models::User.company - associated model TransientRecord::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
+    end.define_model do
       has_many :users
       has_many :projects
     end
 
     create_table(:users) do |t|
       t.references :company
-    end.create_model do
+    end.define_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
+    end.define_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
+      use `dependent: :delete` or similar on TransientRecord::Models::User.company - associated model TransientRecord::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
+    end.define_model do
       has_many :users
       has_many :projects
     end
 
     create_table(:users) do |t|
       t.references :company
-    end.create_model do
+    end.define_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
+    end.define_model do
       belongs_to :company
 
       before_destroy :log
@@ -187,26 +187,26 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     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
+      use `dependent: :destroy` or similar on TransientRecord::Models::User.company - associated model TransientRecord::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
+    end.define_model do
       has_many :users
       has_many :projects
     end
 
     create_table(:users) do |t|
       t.references :company
-    end.create_model do
+    end.define_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
+    end.define_model do
       belongs_to :company
     end
 
@@ -215,13 +215,13 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
 
   def test_no_dependent_suggests_nothing
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
     end
 
@@ -232,22 +232,22 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     create_table(:images) do |t|
       t.bigint :imageable_id, null: false
       t.string :imageable_type, null: true
-    end.create_model do
+    end.define_model do
       belongs_to :imageable, polymorphic: true, dependent: :destroy
     end
 
     create_table(:users) do
-    end.create_model do
+    end.define_model do
       has_one :image, as: :imageable
     end
 
     create_table(:companies) do
-    end.create_model do
+    end.define_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
+      use `dependent: :delete` or similar on TransientRecord::Models::Image.imageable - associated models TransientRecord::Models::Company, TransientRecord::Models::User have no callbacks and can be deleted without loading
     OUTPUT
   end
 
@@ -255,12 +255,12 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     create_table(:images) do |t|
       t.bigint :imageable_id, null: false
       t.string :imageable_type, null: true
-    end.create_model do
+    end.define_model do
       belongs_to :imageable, polymorphic: true, dependent: :destroy
     end
 
     create_table(:users) do
-    end.create_model do
+    end.define_model do
       has_one :image, as: :imageable
 
       before_destroy :log
@@ -270,7 +270,7 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     end
 
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_one :image, as: :imageable
     end
 
@@ -281,12 +281,12 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     create_table(:images) do |t|
       t.bigint :imageable_id, null: false
       t.string :imageable_type, null: true
-    end.create_model do
+    end.define_model do
       belongs_to :imageable, polymorphic: true, dependent: :delete
     end
 
     create_table(:users) do
-    end.create_model do
+    end.define_model do
       has_one :image, as: :imageable
 
       before_destroy :log
@@ -296,12 +296,12 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     end
 
     create_table(:companies) do
-    end.create_model do
+    end.define_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
+      use `dependent: :destroy` or similar on TransientRecord::Models::Image.imageable - associated model TransientRecord::Models::User has callbacks that are currently skipped
     OUTPUT
   end
 
@@ -309,39 +309,157 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
     create_table(:images) do |t|
       t.bigint :imageable_id, null: false
       t.string :imageable_type, null: true
-    end.create_model do
+    end.define_model do
       belongs_to :imageable, polymorphic: true, dependent: :delete
     end
 
     create_table(:users) do
-    end.create_model do
+    end.define_model do
       has_one :image, as: :imageable
     end
 
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_one :image, as: :imageable
     end
 
     refute_problems
   end
 
+  def test_works_on_has_through_associations_with_destroy
+    create_table(:users) do
+    end.define_model do
+      has_many :posts
+      has_many :comments, through: :posts, dependent: :destroy
+    end
+
+    create_table(:posts) do |t|
+      t.references :users
+    end.define_model do
+      belongs_to :user
+      has_many :comments
+    end
+
+    create_table(:comments) do |t|
+      t.references :posts
+    end.define_model do
+      belongs_to :post
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :delete_all` or similar on TransientRecord::Models::User.comments - associated join model TransientRecord::Models::Post has no callbacks and can be deleted in bulk
+    OUTPUT
+  end
+
+  def test_works_on_has_through_associations_with_delete_all
+    create_table(:users) do
+    end.define_model do
+      has_many :posts
+      has_many :comments, through: :posts, dependent: :delete_all
+    end
+
+    create_table(:posts) do |t|
+      t.references :users
+    end.define_model do
+      belongs_to :user
+      has_many :comments
+
+      before_destroy :log
+
+      def log
+      end
+    end
+
+    create_table(:comments) do |t|
+      t.references :posts
+    end.define_model do
+      belongs_to :post
+    end
+
+    assert_problems(<<~OUTPUT)
+      use `dependent: :destroy` or similar on TransientRecord::Models::User.comments - associated join model TransientRecord::Models::Post has callbacks that are currently skipped
+    OUTPUT
+  end
+
+  def test_has_through_associations_when_join_model_incomplete
+    create_table(:users) do
+    end.define_model do
+      has_many :posts
+      has_many :comments, through: :posts
+    end
+
+    create_table(:posts) do |t|
+      t.references :users
+    end.define_model do
+      # The join model should define has_many :comments, but intentionally skips
+      # it for this test case's purpose.
+    end
+
+    create_table(:comments) do |t|
+      t.references :posts
+    end.define_model do
+    end
+
+    assert_problems(<<~OUTPUT)
+      ensure TransientRecord::Models::User.comments is configured correctly - TransientRecord::Models::Post.comments may be undefined
+    OUTPUT
+  end
+
+  def test_destroy_async_and_foreign_key_exists
+    skip("ActiveRecord < 6.1 doesn't support :destroy_async") if ActiveRecord::VERSION::STRING < "6.1"
+
+    create_table(:companies) do
+    end.define_model do
+      # We need an ActiveJob job defined to appease the ActiveRecord
+      class_attribute :destroy_association_async_job, default: Class.new
+
+      has_many :users, dependent: :destroy_async
+    end
+
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true
+    end.define_model
+
+    assert_problems(<<~OUTPUT)
+      don't use `dependent: :destroy_async` on TransientRecord::Models::Company.users or remove the foreign key from users.company_id - \
+      associated models will be deleted in the same transaction along with TransientRecord::Models::Company
+    OUTPUT
+  end
+
+  def test_destroy_async_and_no_foreign_key
+    skip("ActiveRecord < 6.1 doesn't support :destroy_async") if ActiveRecord::VERSION::STRING < "6.1"
+
+    create_table(:companies) do
+    end.define_model do
+      # We need an ActiveJob job defined to appease the ActiveRecord
+      class_attribute :destroy_association_async_job, default: Class.new
+
+      has_many :users, dependent: :destroy_async
+    end
+
+    create_table(:users) do |t|
+      t.references :company, foreign_key: false
+    end.define_model
+
+    refute_problems
+  end
+
   def test_config_ignore_models
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users, dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_dependent_option,
-          ignore_models: ["ModelFactory::Models::Company"]
+          ignore_models: ["TransientRecord::Models::Company"]
       end
     CONFIG
 
@@ -350,19 +468,19 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
 
   def test_global_ignore_models
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users, dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory::Models::Company"]
+        config.global :ignore_models, ["TransientRecord::Models::Company"]
       end
     CONFIG
 
@@ -371,20 +489,20 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOptionTest < Minitest::Te
 
   def test_config_ignore_associations
     create_table(:companies) do
-    end.create_model do
+    end.define_model do
       has_many :users, dependent: :destroy
     end
 
     create_table(:users) do |t|
       t.references :companies
-    end.create_model do
+    end.define_model do
       belongs_to :company
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_dependent_option,
-          ignore_associations: ["ModelFactory::Models::Company.users"]
+          ignore_associations: ["TransientRecord::Models::Company.users"]
       end
     CONFIG
 

data/test/active_record_doctor/detectors/incorrect_length_validation_test.rb

@@ -4,8 +4,10 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
   def test_validation_and_limit_equal_is_ok
     create_table(:users) do |t|
       t.string :email, limit: 64
-    end.create_model do
+      t.string :name, limit: 32
+    end.define_model do
       validates :email, length: { maximum: 64 }
+      validates :name, length: { maximum: 32 }
     end
 
     refute_problems
@@ -14,12 +16,12 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
   def test_validation_and_limit_different_is_error
     create_table(:users) do |t|
       t.string :email, limit: 64
-    end.create_model do
+    end.define_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
+      the schema limits users.email to 64 characters but the length validator on TransientRecord::Models::User.email enforces a maximum of 32 characters - set both limits to the same value or remove both
     OUTPUT
   end
 
@@ -28,23 +30,23 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
 
     create_table(:users) do |t|
       t.string :email
-    end.create_model do
+    end.define_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
+      the length validator on TransientRecord::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.define_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
+      the schema limits users.email to 64 characters but there's no length validator on TransientRecord::Models::User.email - remove the database limit or add the validator
     OUTPUT
   end
 
@@ -53,7 +55,7 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
 
     create_table(:users) do |t|
       t.string :email
-    end.create_model do
+    end.define_model do
     end
 
     refute_problems
@@ -62,12 +64,12 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :email, limit: 64
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_length_validation,
-          ignore_models: ["ModelFactory::Models::User"]
+          ignore_models: ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -77,11 +79,11 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
   def test_global_ignore_models
     create_table(:users) do |t|
       t.string :email, limit: 64
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory::Models::User"]
+        config.global :ignore_models, ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -91,12 +93,12 @@ class ActiveRecordDoctor::Detectors::IncorrectLengthValidationTest < Minitest::T
   def test_config_ignore_attributes
     create_table(:users) do |t|
       t.string :email, limit: 64
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_length_validation,
-          ignore_attributes: ["ModelFactory::Models::User.email"]
+          ignore_attributes: ["TransientRecord::Models::User.email"]
       end
     CONFIG
 

data/test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb

@@ -11,7 +11,7 @@ class ActiveRecordDoctor::Detectors::MismatchedForeignKeyTypeTest < Minitest::Te
     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
+      users.company_id is a foreign key of type integer and references companies.id of type bigint - foreign keys should be of the same type as the referenced column
     OUTPUT
   end
 
@@ -24,6 +24,40 @@ class ActiveRecordDoctor::Detectors::MismatchedForeignKeyTypeTest < Minitest::Te
     refute_problems
   end
 
+  def test_mismatched_foreign_key_with_non_primary_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) do |t|
+      t.string :code
+      t.index :code, unique: true
+    end
+    create_table(:users) do |t|
+      t.text :code
+      t.foreign_key :companies, table: :companies, column: :code, primary_key: :code
+    end
+
+    assert_problems(<<~OUTPUT)
+      users.code is a foreign key of type text and references companies.code of type character varying - foreign keys should be of the same type as the referenced column
+    OUTPUT
+  end
+
+  def test_matched_foreign_key_with_non_primary_key_type_is_not_reported
+    # MySQL does not allow foreign keys to have different type than paired primary keys
+    return if mysql?
+
+    create_table(:companies, id: :bigint) do |t|
+      t.string :code
+      t.index :code, unique: true
+    end
+    create_table(:users) do |t|
+      t.string :code
+      t.foreign_key :companies, table: :companies, column: :code, primary_key: :code
+    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?