active_record_doctor 1.4.1 → 1.7.2

data/test/active_record_doctor/tasks/missing_unique_indexes_test.rb

@@ -0,0 +1,126 @@
+class ActiveRecordDoctor::Tasks::MissingUniqueIndexesTest < Minitest::Test
+  def test_missing_unique_index
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.index :email
+      end
+
+      validates :email, uniqueness: true
+    end
+
+    assert_result([
+      ['users', [['email']]]
+    ])
+  end
+
+  def test_present_unique_index
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.index :email, unique: true
+      end
+
+      validates :email, uniqueness: true
+    end
+
+    assert_result([])
+  end
+
+  def test_missing_unique_index_with_scope
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.integer :company_id
+        t.integer :department_id
+        t.index [:company_id, :department_id, :email]
+      end
+
+      validates :email, uniqueness: { scope: [:company_id, :department_id] }
+    end
+
+    assert_result([
+      ['users', [['company_id', 'department_id', 'email']]]
+    ])
+  end
+
+  def test_present_unique_index_with_scope
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.integer :company_id
+        t.integer :department_id
+        t.index [:company_id, :department_id, :email], unique: true
+      end
+
+      validates :email, uniqueness: { scope: [:company_id, :department_id] }
+    end
+
+    assert_result([])
+  end
+
+  def test_column_order_is_ignored
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.integer :organization_id
+
+        t.index [:email, :organization_id], unique: true
+      end
+
+      validates :email, uniqueness: { scope: :organization_id }
+    end
+
+    assert_result([])
+  end
+
+  def test_conditions_is_skipped
+    assert_skipped(conditions: -> { where.not(email: nil) })
+  end
+
+  def test_case_insensitive_is_skipped
+    assert_skipped(case_sensitive: false)
+  end
+
+  def test_if_is_skipped
+    assert_skipped(if: ->(model) { true })
+  end
+
+  def test_unless_is_skipped
+    assert_skipped(unless: ->(model) { true })
+  end
+
+  def test_skips_validator_without_attributes
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+        t.index :email
+      end
+
+      validates_with DummyValidator
+    end
+
+    # There's no need for assert/refute as it's enough the line below doesn't
+    # raise an exception.
+    run_task
+  end
+
+  class DummyValidator < ActiveModel::Validator
+    def validate(record)
+    end
+  end
+
+  private
+
+  def assert_skipped(options)
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :email
+      end
+
+      validates :email, uniqueness: options
+    end
+
+    assert_result([])
+  end
+end

data/test/active_record_doctor/tasks/undefined_table_references_test.rb

@@ -1,19 +1,47 @@
-require 'test_helper'
+class ActiveRecordDoctor::Tasks::UndefinedTableReferencesTest < Minitest::Test
+  def test_table_exists
+    # No columns needed, just the table.
+    Temping.create(:users, temporary: false)
 
-require 'active_record_doctor/tasks/undefined_table_references'
+    assert_equal([[], true], run_task)
+  end
+
+  def test_table_does_not_exist
+    # No columns needed, just the table.
+    Temping.create(:users, temporary: false)
 
-class ActiveRecordDoctor::Tasks::UndefinedTableReferencesTest < ActiveSupport::TestCase
-  def test_undefined_table_references_are_reported
-    result = run_task
+    # We drop the underlying table to make the model invalid.
+    ActiveRecord::Base.connection.drop_table(User.table_name)
 
-    assert_equal([Contract], result)
+    # We wrap the assertion in begin/ensure because we must recreate the
+    # table as otherwise Temping will raise an error. Assertion errors are
+    # signalled via exceptions which we shouldn't swallow if we don't want to
+    # break the test suite hence the choice of begin/ensure.
+    begin
+      assert_equal([[[User.name, User.table_name]], true], run_task)
+    ensure
+      ActiveRecord::Base.connection.create_table(User.table_name)
+    end
   end
 
-  private
+  def test_view_instead_of_table
+    # No columns needed, just the table.
+    Temping.create(:users, temporary: false)
+
+    # 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.drop_table(User.table_name)
+    ActiveRecord::Base.connection.execute("CREATE VIEW users AS SELECT 1")
 
-  def run_task
-    printer = SpyPrinter.new
-    ActiveRecordDoctor::Tasks::UndefinedTableReferences.new(printer: printer).run
-    printer.undefined_table_references
+    # We wrap the assertion in begin/ensure because we must recreate the
+    # table as otherwise Temping will raise an error. Assertion errors are
+    # signalled via exceptions which we shouldn't swallow if we don't want to
+    # break the test suite hence the choice of begin/ensure.
+    begin
+      assert_equal([[], true], run_task)
+    ensure
+      ActiveRecord::Base.connection.execute("DROP VIEW users")
+      ActiveRecord::Base.connection.create_table(User.table_name)
+    end
   end
 end

data/test/active_record_doctor/tasks/unindexed_deleted_at_test.rb

@@ -0,0 +1,59 @@
+class ActiveRecordDoctor::Tasks::UnindexedDeletedAtTest < Minitest::Test
+  def test_indexed_deleted_at_is_not_reported
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :first_name
+        t.string :last_name
+        t.datetime :deleted_at
+        t.index [:first_name, :last_name],
+          name: 'index_profiles_on_first_name_and_last_name',
+          where: 'deleted_at IS NULL'
+      end
+    end
+
+    assert_result([])
+  end
+
+  def test_unindexed_deleted_at_is_reported
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :first_name
+        t.string :last_name
+        t.datetime :deleted_at
+        t.index [:first_name, :last_name],
+          name: 'index_profiles_on_first_name_and_last_name'
+      end
+    end
+
+    assert_result(['index_profiles_on_first_name_and_last_name'])
+  end
+
+  def test_indexed_discarded_at_is_not_reported
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :first_name
+        t.string :last_name
+        t.datetime :discarded_at
+        t.index [:first_name, :last_name],
+          name: 'index_profiles_on_first_name_and_last_name',
+          where: 'discarded_at IS NULL'
+      end
+    end
+
+    assert_result([])
+  end
+
+  def test_unindexed_discarded_at_is_reported
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.string :first_name
+        t.string :last_name
+        t.datetime :discarded_at
+        t.index [:first_name, :last_name],
+          name: 'index_profiles_on_first_name_and_last_name'
+      end
+    end
+
+    assert_result(['index_profiles_on_first_name_and_last_name'])
+  end
+end

data/test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb

@@ -1,19 +1,23 @@
-require 'test_helper'
+class ActiveRecordDoctor::Tasks::UnindexedForeignKeysTest < Minitest::Test
+  def test_unindexed_foreign_key_is_reported
+    Temping.create(:companies, temporary: false)
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.references :company, foreign_key: true, index: false
+      end
+    end
 
-require 'active_record_doctor/tasks/unindexed_foreign_keys'
- 
-class ActiveRecordDoctor::Tasks::UnindexedForeignKeysTest < ActiveSupport::TestCase
-  def test_unindexed_foreign_keys_are_reported
-    result = run_task
-
-    assert_equal({ "users" => ["profile_id"] }, result)
+    assert_equal({'users' => ['company_id']}, run_task)
   end
 
-  private
+  def test_indexed_foreign_key_is_not_reported
+    Temping.create(:companies, temporary: false)
+    Temping.create(:users, temporary: false) do
+      with_columns do |t|
+        t.references :company, foreign_key: true, index: true
+      end
+    end
 
-  def run_task
-    printer = SpyPrinter.new
-    ActiveRecordDoctor::Tasks::UnindexedForeignKeys.new(printer: printer).run
-    printer.unindexed_foreign_keys
+    assert_equal({}, run_task)
   end
 end

data/test/setup.rb

@@ -0,0 +1,97 @@
+# Configure Active Record.
+
+# We must import "uri" explicitly as otherwsie URI won't be accessible in
+# Ruby 2.7.2 / Rails 6.
+require "uri"
+
+require "active_record"
+
+# Connect to the database defined in the URL.
+ActiveRecord::Base.establish_connection(ENV.fetch("DATABASE_URL"))
+
+# We need to call #connection to enfore Active Record to actually establish
+# the connection.
+ActiveRecord::Base.connection
+
+
+
+# We need to mock Rails because some tasks depend on .eager_load! This must
+# happen AFTER loading active_record_doctor as otherwise it'd attempt to
+# install a Railtie.
+module Rails
+  class TestApplication
+    def eager_load!
+    end
+  end
+
+  def self.application
+    @application ||= TestApplication.new
+  end
+end
+
+
+
+# Load Active Record Doctor.
+require "active_record_doctor"
+
+
+
+# Configure the test suite.
+require "minitest"
+require "minitest/autorun"
+require "minitest/fork_executor"
+
+
+
+# temping is a test library for creating tables and models on the fly. We use
+# it instead of a fixed dummy Rails app created by the generator.
+require "temping"
+
+# Temping 3.10.0 is broken because it removes the tables in the order of
+# creation which fails if foreign key constraints are present.
+class Temping
+  class << self
+    alias_method :old_teardown, :teardown
+
+    def teardown
+      @model_klasses.reverse!
+      old_teardown
+
+      # This hack is required to avoid leaking temporary model classes defined
+      # by Temping. If we don't clear the cache then they'll be kept around and
+      # returned as valid models which will break tests.
+      ActiveSupport::DescendantsTracker.class_variable_get(:@@direct_descendants).clear
+    end
+  end
+end
+
+
+
+# Prepare the test class.
+class Minitest::Test
+  def teardown
+    # Remove temporary databases created by the current test case.
+    Temping.teardown
+  end
+
+  private
+
+  # Run the appropriate task. The task name is inferred from the test class.
+  def run_task
+    self.class.name.sub(/Test$/, '').constantize.run.first
+  end
+
+  # Assert results are equal without regards to the order of elements.
+  def assert_result(expected_result)
+    assert_equal(expected_result.sort_by(&:to_s), run_task.sort_by(&:to_s))
+  end
+end
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Run each test method in a separate process so that we avoid leaking
+# temporary models defined by temping. I'm not entirely sure but it seems to
+# be a problem with Rails caching those classes aggressively.
+# Minitest.parallel_executor = Minitest::ForkExecutor.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Greg Navis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-08 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,19 +53,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: minitest-fork_executor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: 
 email:
 - contact@gregnavis.com
@@ -75,77 +103,36 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE.txt
 - README.md
-- Rakefile
 - lib/active_record_doctor.rb
-- lib/active_record_doctor/compatibility.rb
 - lib/active_record_doctor/printers.rb
 - lib/active_record_doctor/printers/io_printer.rb
 - lib/active_record_doctor/railtie.rb
 - lib/active_record_doctor/tasks.rb
+- lib/active_record_doctor/tasks/base.rb
 - lib/active_record_doctor/tasks/extraneous_indexes.rb
+- lib/active_record_doctor/tasks/incorrect_boolean_presence_validation.rb
 - lib/active_record_doctor/tasks/missing_foreign_keys.rb
+- lib/active_record_doctor/tasks/missing_non_null_constraint.rb
+- lib/active_record_doctor/tasks/missing_presence_validation.rb
+- lib/active_record_doctor/tasks/missing_unique_indexes.rb
 - lib/active_record_doctor/tasks/undefined_table_references.rb
+- lib/active_record_doctor/tasks/unindexed_deleted_at.rb
 - lib/active_record_doctor/tasks/unindexed_foreign_keys.rb
 - lib/active_record_doctor/version.rb
 - lib/generators/active_record_doctor/add_indexes/USAGE
 - lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb
-- lib/tasks/active_record_doctor_tasks.rake
+- lib/tasks/active_record_doctor.rake
 - test/active_record_doctor/printers/io_printer_test.rb
 - test/active_record_doctor/tasks/extraneous_indexes_test.rb
+- test/active_record_doctor/tasks/incorrect_boolean_presence_validation_test.rb
 - test/active_record_doctor/tasks/missing_foreign_keys_test.rb
+- test/active_record_doctor/tasks/missing_non_null_constraint_test.rb
+- test/active_record_doctor/tasks/missing_presence_validation_test.rb
+- test/active_record_doctor/tasks/missing_unique_indexes_test.rb
 - test/active_record_doctor/tasks/undefined_table_references_test.rb
+- test/active_record_doctor/tasks/unindexed_deleted_at_test.rb
 - test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/comment.rb
-- test/dummy/app/models/contract.rb
-- test/dummy/app/models/employer.rb
-- test/dummy/app/models/profile.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/database.yml.travis
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/db/migrate/20160213101213_create_employers.rb
-- test/dummy/db/migrate/20160213101221_create_users.rb
-- test/dummy/db/migrate/20160213101232_create_profiles.rb
-- test/dummy/db/migrate/20160604081452_create_comments.rb
-- test/dummy/db/migrate/base_migration.rb
-- test/dummy/db/schema.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/support/spy_printer.rb
-- test/test_helper.rb
+- test/setup.rb
 homepage: https://github.com/gregnavis/active_record_doctor
 licenses:
 - MIT
@@ -165,65 +152,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: A cure for your Active Record ailments.
+summary: Identify database issues before they hit production.
 test_files:
-- test/test_helper.rb
+- test/setup.rb
 - test/active_record_doctor/printers/io_printer_test.rb
-- test/active_record_doctor/tasks/missing_foreign_keys_test.rb
+- test/active_record_doctor/tasks/incorrect_boolean_presence_validation_test.rb
+- test/active_record_doctor/tasks/unindexed_deleted_at_test.rb
 - test/active_record_doctor/tasks/extraneous_indexes_test.rb
-- test/active_record_doctor/tasks/undefined_table_references_test.rb
 - test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb
-- test/dummy/README.rdoc
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/bin/rake
-- test/dummy/bin/rails
-- test/dummy/bin/setup
-- test/dummy/bin/bundle
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/models/profile.rb
-- test/dummy/app/models/comment.rb
-- test/dummy/app/models/contract.rb
-- test/dummy/app/models/employer.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20160213101213_create_employers.rb
-- test/dummy/db/migrate/20160604081452_create_comments.rb
-- test/dummy/db/migrate/base_migration.rb
-- test/dummy/db/migrate/20160213101232_create_profiles.rb
-- test/dummy/db/migrate/20160213101221_create_users.rb
-- test/dummy/public/404.html
-- test/dummy/public/500.html
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/config/secrets.yml
-- test/dummy/config/application.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/database.yml.travis
-- test/dummy/config/environment.rb
-- test/dummy/config/database.yml
-- test/dummy/config/locales/en.yml
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/boot.rb
-- test/dummy/Rakefile
-- test/dummy/config.ru
-- test/support/spy_printer.rb
+- test/active_record_doctor/tasks/missing_unique_indexes_test.rb
+- test/active_record_doctor/tasks/missing_non_null_constraint_test.rb
+- test/active_record_doctor/tasks/missing_presence_validation_test.rb
+- test/active_record_doctor/tasks/undefined_table_references_test.rb
+- test/active_record_doctor/tasks/missing_foreign_keys_test.rb