active_record_doctor 1.9.0 → 1.11.0

data/test/active_record_doctor/detectors/missing_non_null_constraint_test.rb

@@ -4,7 +4,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_optional_columns_with_presence_validator_are_disallowed
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true
     end
 
@@ -17,7 +17,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
     create_table(:companies)
     create_table(:users) do |t|
       t.references :company, null: true
-    end.create_model do
+    end.define_model do
       belongs_to :company, required: true
     end
 
@@ -26,10 +26,33 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
     OUTPUT
   end
 
+  def test_optional_columns_with_required_polymorphic_association_are_disallowed
+    create_table(:comments) do |t|
+      t.references :commentable, polymorphic: true, null: true
+    end.define_model do
+      belongs_to :commentable, polymorphic: true, required: true
+    end
+
+    assert_problems(<<~OUTPUT)
+      add `NOT NULL` to comments.commentable_id - models validates its presence but it's not non-NULL in the database
+      add `NOT NULL` to comments.commentable_type - models validates its presence but it's not non-NULL in the database
+    OUTPUT
+  end
+
+  def test_required_columns_with_required_polymorphic_association_are_allowed
+    create_table(:comments) do |t|
+      t.references :commentable, polymorphic: true, null: false
+    end.define_model do
+      belongs_to :commentable, polymorphic: true, required: true
+    end
+
+    refute_problems
+  end
+
   def test_required_columns_with_presence_validators_are_allowed
     create_table(:users) do |t|
       t.string :name, null: false
-    end.create_model do
+    end.define_model do
       validates :name, presence: true
     end
 
@@ -39,7 +62,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_optional_columns_without_presence_validator_are_allowed
     create_table(:users) do |t|
       t.string :name, null: false
-    end.create_model do
+    end.define_model do
       validates :name, presence: false
     end
 
@@ -49,7 +72,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_validators_matched_to_correct_columns
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_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
@@ -65,7 +88,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_validators_with_if_on_optional_columns_are_allowed
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true, if: -> { false }
     end
 
@@ -75,7 +98,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_validators_with_unless_on_optional_columns_are_allowed
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true, unless: -> { false }
     end
 
@@ -85,7 +108,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_validators_allowing_nil_on_optional_columns_are_allowed
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true, allow_nil: true
     end
 
@@ -93,7 +116,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   end
 
   def test_models_with_non_existent_tables_are_skipped
-    create_model(:User)
+    define_model(:User)
 
     refute_problems
   end
@@ -102,9 +125,9 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
     create_table(:users) do |t|
       t.string :type, null: false
       t.string :email, null: true
-    end.create_model
+    end.define_model
 
-    create_model(:Client, ModelFactory::Models::User) do
+    define_model(:Client, TransientRecord::Models::User) do
       validates :email, presence: true
     end
 
@@ -117,13 +140,13 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
     create_table(:users) do |t|
       t.string :type, null: false
       t.string :email, null: true
-    end.create_model
+    end.define_model
 
-    create_model(:Client, ModelFactory::Models::User) do
+    define_model(:Client, TransientRecord::Models::User) do
       validates :email, presence: true
     end
 
-    create_model(:Admin, ModelFactory::Models::User) do
+    define_model(:Admin, TransientRecord::Models::User) do
       validates :email, presence: false
     end
 
@@ -133,11 +156,11 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_optional_columns_validated_by_all_non_sti_models_are_disallowed
     create_table(:users) do |t|
       t.string :email, null: true
-    end.create_model do
+    end.define_model do
       validates :email, presence: true
     end
 
-    create_model(:Client) do
+    define_model(:Client) do
       self.table_name = :users
 
       validates :email, presence: true
@@ -151,11 +174,11 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_optional_columns_validated_by_some_non_sti_models_are_allowed
     create_table(:users) do |t|
       t.string :email, null: true
-    end.create_model do
+    end.define_model do
       validates :email, presence: true
     end
 
-    create_model(:Client) do
+    define_model(:Client) do
       self.table_name = :users
 
       validates :email, presence: false
@@ -164,10 +187,44 @@ 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.define_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.define_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
-    end.create_model do
+    end.define_model do
       validates :name, presence: true
     end
 
@@ -184,7 +241,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_global_ignore_tables
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true
     end
 
@@ -200,7 +257,7 @@ class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Te
   def test_config_ignore_columns
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true
     end
 

data/test/active_record_doctor/detectors/missing_presence_validation_test.rb

@@ -4,7 +4,7 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   def test_null_column_is_not_reported_if_validation_absent
     create_table(:users) do |t|
       t.string :name
-    end.create_model do
+    end.define_model do
     end
 
     refute_problems
@@ -13,18 +13,18 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   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.define_model do
     end
 
     assert_problems(<<~OUTPUT)
-      add a `presence` validator to ModelFactory::Models::User.name - it's NOT NULL but lacks a validator
+      add a `presence` validator to TransientRecord::Models::User.name - it's NOT NULL but lacks a validator
     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
+    end.define_model do
       validates :name, presence: true
     end
 
@@ -32,10 +32,10 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   end
 
   def test_non_null_column_is_not_reported_if_association_validation_present
-    create_table(:companies).create_model
+    create_table(:companies).define_model
     create_table(:users) do |t|
       t.references :company, null: false
-    end.create_model do
+    end.define_model do
       belongs_to :company, required: true
     end
 
@@ -43,8 +43,8 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   end
 
   def test_not_null_column_is_not_reported_if_habtm_association
-    create_table(:users).create_model do
-      has_and_belongs_to_many :projects, class_name: "ModelFactory::Models::Project"
+    create_table(:users).define_model do
+      has_and_belongs_to_many :projects, class_name: "TransientRecord::Models::Project"
     end
 
     create_table(:projects_users) do |t|
@@ -52,8 +52,8 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
       t.bigint :user_id, null: false
     end
 
-    create_table(:projects).create_model do
-      has_and_belongs_to_many :users, class_name: "ModelFactory::Models::User"
+    create_table(:projects).define_model do
+      has_and_belongs_to_many :users, class_name: "TransientRecord::Models::User"
     end
 
     refute_problems
@@ -62,19 +62,19 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   def test_non_null_boolean_is_reported_if_nil_included
     create_table(:users) do |t|
       t.boolean :active, null: false
-    end.create_model do
+    end.define_model do
       validates :active, inclusion: { in: [nil, true, false] }
     end
 
     assert_problems(<<~OUTPUT)
-      add a `presence` validator to ModelFactory::Models::User.active - it's NOT NULL but lacks a validator
+      add a `presence` validator to TransientRecord::Models::User.active - it's NOT NULL but lacks a validator
     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
+    end.define_model do
       validates :active, inclusion: { in: [true, false] }
     end
 
@@ -84,37 +84,101 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   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
+    end.define_model do
       validates :active, exclusion: { in: [nil] }
     end
 
     refute_problems
   end
 
+  def test_non_null_boolean_is_not_reported_if_exclusion_is_proc
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.define_model do
+      validates :active, exclusion: { in: ->(_user) { [nil] } }
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_boolean_is_not_reported_if_inclusion_is_proc
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.define_model do
+      validates :active, inclusion: { in: ->(_user) { [true, false] } }
+    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
+    end.define_model do
       validates :active, exclusion: { in: [false] }
     end
 
     assert_problems(<<~OUTPUT)
-      add a `presence` validator to ModelFactory::Models::User.active - it's NOT NULL but lacks a validator
+      add a `presence` validator to TransientRecord::Models::User.active - it's NOT NULL but lacks a validator
     OUTPUT
   end
 
   def test_timestamps_are_not_reported
     create_table(:users) do |t|
+      # Create created_at/updated_at timestamps.
       t.timestamps null: false
-    end.create_model do
-      validates :name, presence: true
+
+      # 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.define_model do
     end
 
     refute_problems
   end
 
   def test_models_with_non_existent_tables_are_skipped
-    create_model(:User)
+    define_model(:User)
+
+    refute_problems
+  end
+
+  def test_not_null_check_constraint
+    skip unless postgresql?
+
+    create_table(:users) do |t|
+      t.string :name
+    end.define_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 TransientRecord::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.define_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_abstract_class
+    define_model(:ApplicationRecord) do
+      self.abstract_class = true
+    end
 
     refute_problems
   end
@@ -122,13 +186,13 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :name, null: false
-    end.create_model do
+    end.define_model do
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :missing_presence_validation,
-          ignore_models: ["ModelFactory::Models::User"]
+          ignore_models: ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -138,12 +202,12 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   def test_global_ignore_models
     create_table(:users) do |t|
       t.string :name, null: false
-    end.create_model do
+    end.define_model do
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory::Models::User"]
+        config.global :ignore_models, ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -153,13 +217,13 @@ class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::T
   def test_config_ignore_attributes
     create_table(:users) do |t|
       t.string :name, null: false
-    end.create_model do
+    end.define_model do
     end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :missing_presence_validation,
-          ignore_attributes: ["ModelFactory::Models::User.name"]
+          ignore_attributes: ["TransientRecord::Models::User.name"]
       end
     CONFIG