active_record_doctor 1.12.0 → 1.13.0

data/test/active_record_doctor/config_test.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::ConfigTest < Minitest::Test
-  def test_merge_globals_empty
-    config1 = ActiveRecordDoctor::Config.new({}, {})
-    config2 = ActiveRecordDoctor::Config.new({}, {})
-
-    config = config1.merge(config2)
-
-    assert_equal({}, config.globals)
-  end
-
-  def test_merge_globals_in_config1
-    config1 = ActiveRecordDoctor::Config.new(
-      { config1_global: "config1:config1_global" },
-      {}
-    )
-    config2 = ActiveRecordDoctor::Config.new({}, {})
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      { config1_global: "config1:config1_global" },
-      config.globals
-    )
-  end
-
-  def test_merge_globals_in_config2
-    config1 = ActiveRecordDoctor::Config.new({}, {})
-    config2 = ActiveRecordDoctor::Config.new(
-      { config2_global: "config2:config2_global" },
-      {}
-    )
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      { config2_global: "config2:config2_global" },
-      config.globals
-    )
-  end
-
-  def test_merge_globals_in_config1_and_config2
-    config1 = ActiveRecordDoctor::Config.new(
-      {
-        config1_global: "config1:config1_global",
-        shared_global: "config1:shared_global"
-      },
-      {}
-    )
-    config2 = ActiveRecordDoctor::Config.new(
-      {
-        config2_global: "config2:config2_global",
-        shared_global: "config2:shared_global"
-      },
-      {}
-    )
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      {
-        config1_global: "config1:config1_global",
-        shared_global: "config2:shared_global",
-        config2_global: "config2:config2_global"
-      },
-      config.globals
-    )
-  end
-
-  def test_merge_detectors
-    config1 = ActiveRecordDoctor::Config.new(
-      {},
-      {
-        config1_detector: {
-          config1_setting: "config1:config1_detector.config1_setting"
-        },
-        shared_detector: {
-          config1_setting: "config1:shared_detector.config1_setting",
-          shared_setting: "config1:shared_detector.shared_setting"
-        }
-      }
-    )
-    config2 = ActiveRecordDoctor::Config.new(
-      {},
-      {
-        config2_detector: {
-          config2_setting: "config2:config2_detector.config2_setting"
-        },
-        shared_detector: {
-          config2_setting: "config2:shared_detector.config2_setting",
-          shared_setting: "config2:shared_detector.shared_setting"
-        }
-      }
-    )
-
-    config = config1.merge(config2)
-
-    assert_equal(
-      {
-        config1_detector: {
-          config1_setting: "config1:config1_detector.config1_setting"
-        },
-        config2_detector: {
-          config2_setting: "config2:config2_detector.config2_setting"
-        },
-        shared_detector: {
-          config1_setting: "config1:shared_detector.config1_setting",
-          config2_setting: "config2:shared_detector.config2_setting",
-          shared_setting: "config2:shared_detector.shared_setting"
-        }
-      },
-      config.detectors
-    )
-  end
-end

data/test/active_record_doctor/detectors/disable_test.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::Detectors::DisableTest < Minitest::Test
-  # Disabling detectors is implemented in the base class. It's enought to test
-  # it on a single detector to be reasonably certain it works on all of them.
-  def test_disabling
-    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,
-          enabled: false
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  private
-
-  # We need to override that method in order to skip the mechanism that
-  # infers detector name from the test class name.
-  def detector_name
-    :missing_non_null_constraint
-  end
-end

data/test/active_record_doctor/detectors/extraneous_indexes_test.rb

@@ -1,277 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::Detectors::ExtraneousIndexesTest < Minitest::Test
-  def test_index_on_primary_key_is_duplicate
-    create_table(:users) do |t|
-      t.index :id
-    end
-
-    assert_problems(<<OUTPUT)
-remove index_users_on_id from users - coincides with the primary key on the table
-OUTPUT
-  end
-
-  def test_partial_index_on_primary_key
-    skip("MySQL doesn't support partial indexes") if mysql?
-
-    create_table(:users) do |t|
-      t.boolean :admin
-      t.index :id, where: "admin"
-    end
-
-    refute_problems
-  end
-
-  def test_index_on_non_standard_primary_key
-    create_table(:profiles, primary_key: :user_id) do |t|
-      t.index :user_id
-    end
-
-    assert_problems(<<OUTPUT)
-remove index_profiles_on_user_id from profiles - coincides with the primary key on the table
-OUTPUT
-  end
-
-  def test_non_unique_version_of_index_is_duplicate
-    create_table(:users) do |t|
-      t.string :email
-      t.index :email, unique: true, name: "unique_index_on_users_email"
-    end
-
-    # Rails 4.2 compatibility - can't be pulled into the block above.
-    ActiveRecord::Base.connection.add_index :users, :email, name: "index_users_on_email"
-
-    assert_problems(<<OUTPUT)
-remove the index index_users_on_email from the table users - queries should be able to use the following index instead: unique_index_on_users_email
-OUTPUT
-  end
-
-  def test_single_column_covered_by_unique_and_non_unique_multi_column_is_duplicate
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :last_name
-      t.string :email
-      t.index [:last_name, :first_name, :email]
-      t.index [:last_name, :first_name],
-        unique: true,
-        name: "unique_index_on_users_last_name_and_first_name"
-      t.index :last_name
-    end
-
-    assert_problems(<<OUTPUT)
-remove the index index_users_on_last_name from the table users - queries should be able to use the following indices instead: index_users_on_last_name_and_first_name_and_email or unique_index_on_users_last_name_and_first_name
-OUTPUT
-  end
-
-  def test_multi_column_covered_by_unique_and_non_unique_multi_column_is_duplicate
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :last_name
-      t.string :email
-      t.index [:last_name, :first_name, :email]
-      t.index [:last_name, :first_name],
-        unique: true,
-        name: "unique_index_on_users_last_name_and_first_name"
-    end
-
-    # Rails 4.2 compatibility - can't be pulled into the block above.
-    ActiveRecord::Base.connection.add_index :users, [:last_name, :first_name]
-
-    assert_problems(<<OUTPUT)
-remove the index index_users_on_last_name_and_first_name from the table users - queries should be able to use the following indices instead: index_users_on_last_name_and_first_name_and_email or unique_index_on_users_last_name_and_first_name
-OUTPUT
-  end
-
-  def test_unique_index_with_fewer_columns
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :last_name
-      t.index :first_name, unique: true
-      t.index [:last_name, :first_name], unique: true
-    end
-
-    assert_problems(<<OUTPUT)
-remove the index index_users_on_last_name_and_first_name from the table users - queries should be able to use the following index instead: index_users_on_first_name
-OUTPUT
-  end
-
-  def test_expression_index_not_covered_by_multicolumn_index
-    skip("Expression indexes are not supported") if ActiveRecordDoctor::Utils.expression_indexes_unsupported?
-
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :email
-      t.index "(lower(email))"
-      t.index [:first_name, :email]
-    end
-
-    refute_problems
-  end
-
-  def test_unique_expression_index_not_covered_by_unique_multicolumn_index
-    skip("Expression indexes are not supported") if ActiveRecordDoctor::Utils.expression_indexes_unsupported?
-
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :email
-      t.index "(lower(email))", unique: true
-      t.index [:first_name, :email], unique: true
-    end
-
-    refute_problems
-  end
-
-  def test_not_covered_by_different_index_type
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :last_name
-      t.index [:last_name, :first_name], using: :btree
-
-      if mysql?
-        t.index :last_name, type: :fulltext
-      else
-        t.index :last_name, using: :hash
-      end
-    end
-
-    refute_problems
-  end
-
-  def test_not_covered_by_partial_index
-    skip("MySQL doesn't support partial indexes") if mysql?
-
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :last_name
-      t.boolean :active
-      t.index [:last_name, :first_name], where: "active"
-      t.index :last_name
-    end
-
-    refute_problems
-  end
-
-  def test_not_covered_with_different_opclasses
-    skip("ActiveRecord < 5.2 doesn't support operator classes") if ActiveRecord::VERSION::STRING < "5.2"
-    skip("MySQL doesn't support operator classes") if mysql?
-
-    create_table(:users) do |t|
-      t.string :first_name
-      t.string :last_name
-      t.index [:last_name, :first_name], opclass: :varchar_pattern_ops
-      t.index :last_name
-    end
-
-    refute_problems
-  end
-
-  def test_single_column_covered_by_multi_column_on_materialized_view_is_duplicate
-    skip("Only PostgreSQL supports materialized views") unless postgresql?
-
-    begin
-      create_table(:users) do |t|
-        t.string :first_name
-        t.string :last_name
-        t.integer :age
-      end
-
-      connection = ActiveRecord::Base.connection
-      connection.execute(<<-SQL)
-        CREATE MATERIALIZED VIEW user_initials AS
-          SELECT first_name, last_name FROM users
-      SQL
-
-      connection.add_index(:user_initials, [:last_name, :first_name])
-      connection.add_index(:user_initials, :last_name)
-
-      assert_problems(<<OUTPUT)
-remove the index index_user_initials_on_last_name from the table user_initials - queries should be able to use the following index instead: index_user_initials_on_last_name_and_first_name
-OUTPUT
-    ensure
-      connection.execute("DROP MATERIALIZED VIEW user_initials")
-    end
-  end
-
-  def test_config_ignore_tables
-    # The detector recognizes two kinds of errors and both must take
-    # ignore_tables into account. We trigger those errors by indexing the
-    # primary key (the first extraneous index) and then indexing email twice
-    # (index2... is the other extraneous index).
-    create_table(:users) do |t|
-      t.index :id
-      t.string :email
-
-      t.index :email, name: "index1_on_users_email"
-      t.index :email, name: "index2_on_users_email"
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :extraneous_indexes,
-          ignore_tables: ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_global_ignore_tables
-    create_table(:users) do |t|
-      t.index :id
-      t.string :email
-
-      t.index :email, name: "index1_on_users_email"
-      t.index :email, name: "index2_on_users_email"
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_tables, ["users"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_global_ignore_indexes
-    create_table(:users) do |t|
-      t.index :id
-      t.string :email
-
-      t.index :email, name: "index1_on_users_email"
-      t.index :email, name: "index2_on_users_email"
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_indexes, [
-          "index1_on_users_email",
-          "index2_on_users_email",
-          "index_users_on_id",
-        ]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_detector_ignore_indexes
-    create_table(:users) do |t|
-      t.index :id
-      t.string :email
-      t.string :api_key
-
-      t.index :email, name: "index_on_users_email"
-      t.index [:email, :api_key], name: "index_on_users_email_and_api_key"
-    end
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :extraneous_indexes,
-          ignore_indexes: ["index_users_on_id", "index_on_users_email"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-end

data/test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Minitest::Test
-  def test_presence_true_is_reported_on_boolean_only
-    create_table(:users) do |t|
-      t.string :email, null: false
-      t.boolean :active, null: false
-    end.define_model do
-      # email is a non-boolean column whose presence CAN be validated in the
-      # usual way. We include it in the test model to ensure the detector reports
-      # only boolean columns.
-      validates :email, :active, presence: true
-    end
-
-    assert_problems(<<~OUTPUT)
-      replace the `presence` validator on TransientRecord::Models::User.active with `inclusion` - `presence` can't be used on booleans
-    OUTPUT
-  end
-
-  def test_inclusion_is_not_reported
-    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_models_with_non_existent_tables_are_skipped
-    define_model(:User)
-
-    refute_problems
-  end
-
-  def test_config_ignore_models
-    create_table(:users) do |t|
-      t.string :email, null: false
-    end.define_model
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :incorrect_boolean_presence_validation,
-          ignore_models: ["ModelFactory.User"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_global_ignore_models
-    create_table(:users) do |t|
-      t.string :email, null: false
-    end.define_model
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory.User"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-
-  def test_config_ignore_attributes
-    create_table(:users) do |t|
-      t.string :email, null: false
-    end.define_model
-
-    config_file(<<-CONFIG)
-      ActiveRecordDoctor.configure do |config|
-        config.detector :incorrect_boolean_presence_validation,
-          ignore_attributes: ["ModelFactory.User.email"]
-      end
-    CONFIG
-
-    refute_problems
-  end
-end