active_record_doctor 1.12.0 → 1.13.0

data/test/active_record_doctor/detectors/mismatched_foreign_key_type_test.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::Detectors::MismatchedForeignKeyTypeTest < Minitest::Test
-  def test_mismatched_foreign_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)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: true, type: :integer
-    end
-
-    assert_problems(<<~OUTPUT)
-      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
-
-  def test_matched_foreign_key_type_is_not_reported
-    create_table(:companies)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: true
-    end
-
-    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?
-
-    create_table(:companies, id: :bigint)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: true, type: :integer
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :mismatched_foreign_key_type,
-          ignore_tables: ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_global_ignore_tables
-    # MySQL does not allow foreign keys to have different type than paired primary keys
-    return if mysql?
-
-    create_table(:companies, id: :bigint)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: true, type: :integer
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_tables, ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_ignore_columns
-    # MySQL does not allow foreign keys to have different type than paired primary keys
-    return if mysql?
-
-    create_table(:companies, id: :bigint)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: true, type: :integer
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :mismatched_foreign_key_type,
-          ignore_columns: ["users.company_id"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-end

data/test/active_record_doctor/detectors/missing_foreign_keys_test.rb

@@ -1,70 +0,0 @@
-# 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)
-      create a foreign key on users.company_id - looks like an association without a foreign key constraint
-    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
-
-  def test_config_ignore_models
-    create_table(:companies)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: false
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_foreign_keys,
-          ignore_tables: ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_global_ignore_models
-    create_table(:companies)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: false
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_tables, ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_ignore_columns
-    create_table(:companies)
-    create_table(:users) do |t|
-      t.references :company, foreign_key: false
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_foreign_keys,
-          ignore_columns: ["users.company_id"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-end

data/test/active_record_doctor/detectors/missing_non_null_constraint_test.rb

@@ -1,273 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Test
-  def test_optional_columns_with_presence_validator_are_disallowed
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true
-    end
-
-    assert_problems(<<~OUTPUT)
-      add `NOT NULL` to users.name - models validates its presence but it's not non-NULL in the database
-    OUTPUT
-  end
-
-  def test_optional_foreign_keys_with_required_association_are_disallowed
-    create_table(:companies)
-    create_table(:users) do |t|
-      t.references :company, null: true
-    end.define_model do
-      belongs_to :company, required: true
-    end
-
-    assert_problems(<<~OUTPUT)
-      add `NOT NULL` to users.company_id - models validates its presence but it's not non-NULL in the database
-    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.define_model do
-      validates :name, presence: true
-    end
-
-    refute_problems
-  end
-
-  def test_optional_columns_without_presence_validator_are_allowed
-    create_table(:users) do |t|
-      t.string :name, null: false
-    end.define_model do
-      validates :name, presence: false
-    end
-
-    refute_problems
-  end
-
-  def test_validators_matched_to_correct_columns
-    create_table(:users) do |t|
-      t.string :name, null: true
-    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
-      # 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_validators_with_if_on_optional_columns_are_allowed
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true, if: -> { false }
-    end
-
-    refute_problems
-  end
-
-  def test_validators_with_unless_on_optional_columns_are_allowed
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true, unless: -> { false }
-    end
-
-    refute_problems
-  end
-
-  def test_validators_allowing_nil_on_optional_columns_are_allowed
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true, allow_nil: true
-    end
-
-    refute_problems
-  end
-
-  def test_models_with_non_existent_tables_are_skipped
-    define_model(:User)
-
-    refute_problems
-  end
-
-  def test_optional_columns_validated_by_all_sti_models_are_disallowed
-    create_table(:users) do |t|
-      t.string :type, null: false
-      t.string :email, null: true
-    end.define_model
-
-    define_model(:Client, TransientRecord::Models::User) do
-      validates :email, presence: true
-    end
-
-    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_optional_columns_validated_by_some_sti_models_are_allowed
-    create_table(:users) do |t|
-      t.string :type, null: false
-      t.string :email, null: true
-    end.define_model
-
-    define_model(:Client, TransientRecord::Models::User) do
-      validates :email, presence: true
-    end
-
-    define_model(:Admin, TransientRecord::Models::User) do
-      validates :email, presence: false
-    end
-
-    refute_problems
-  end
-
-  def test_optional_columns_validated_by_all_non_sti_models_are_disallowed
-    create_table(:users) do |t|
-      t.string :email, null: true
-    end.define_model do
-      validates :email, presence: true
-    end
-
-    define_model(:Client) do
-      self.table_name = :users
-
-      validates :email, presence: true
-    end
-
-    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_optional_columns_validated_by_some_non_sti_models_are_allowed
-    create_table(:users) do |t|
-      t.string :email, null: true
-    end.define_model do
-      validates :email, presence: true
-    end
-
-    define_model(:Client) do
-      self.table_name = :users
-
-      validates :email, presence: false
-    end
-
-    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.define_model do
-      validates :name, presence: true
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_non_null_constraint,
-          ignore_tables: ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_global_ignore_tables
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_tables, ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_ignore_columns
-    create_table(:users) do |t|
-      t.string :name, null: true
-    end.define_model do
-      validates :name, presence: true
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_non_null_constraint,
-          ignore_columns: ["users.name"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-end

data/test/active_record_doctor/detectors/missing_presence_validation_test.rb

@@ -1,232 +0,0 @@
-# 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.define_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.define_model do
-    end
-
-    assert_problems(<<~OUTPUT)
-      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.define_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).define_model
-    create_table(:users) do |t|
-      t.references :company, null: false
-    end.define_model do
-      belongs_to :company, required: true
-    end
-
-    refute_problems
-  end
-
-  def test_not_null_column_is_not_reported_if_habtm_association
-    create_table(:users).define_model do
-      has_and_belongs_to_many :projects, class_name: "TransientRecord::Models::Project"
-    end
-
-    create_table(:projects_users) do |t|
-      t.bigint :project_id, null: false
-      t.bigint :user_id, null: false
-    end
-
-    create_table(:projects).define_model do
-      has_and_belongs_to_many :users, class_name: "TransientRecord::Models::User"
-    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.define_model do
-      validates :active, inclusion: { in: [nil, true, false] }
-    end
-
-    assert_problems(<<~OUTPUT)
-      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.define_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.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.define_model do
-      validates :active, exclusion: { in: [false] }
-    end
-
-    assert_problems(<<~OUTPUT)
-      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
-
-      # 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
-    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
-
-  def test_config_ignore_models
-    create_table(:users) do |t|
-      t.string :name, null: false
-    end.define_model do
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_presence_validation,
-          ignore_models: ["TransientRecord::Models::User"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_global_ignore_models
-    create_table(:users) do |t|
-      t.string :name, null: false
-    end.define_model do
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["TransientRecord::Models::User"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_ignore_attributes
-    create_table(:users) do |t|
-      t.string :name, null: false
-    end.define_model do
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :missing_presence_validation,
-          ignore_attributes: ["TransientRecord::Models::User.name"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-end