active_record_doctor 1.5.0 → 1.8.0

data/test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::UnindexedForeignKeysTest < Minitest::Test
+  def test_unindexed_foreign_key_is_reported
+    skip("MySQL always indexes foreign keys") if mysql?
+
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true, index: false
+    end
+
+    assert_problems(<<OUTPUT)
+The following foreign keys should be indexed for performance reasons:
+  users company_id
+OUTPUT
+  end
+
+  def test_indexed_foreign_key_is_not_reported
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true, index: true
+    end
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/printers/io_printer_test.rb

@@ -1,20 +1,33 @@
-require 'test_helper'
+# frozen_string_literal: true
 
-require 'active_record_doctor/printers/io_printer'
+# Load all detectors
+class ActiveRecordDoctor::Printers::IOPrinterTest < Minitest::Test
+  def test_all_detectors_have_printers
+    ActiveRecordDoctor::Detectors::Base.subclasses.each do |detector_class|
+      name = detector_class.name.demodulize.underscore.to_sym
 
-class ActiveRecordDoctor::Printers::IOPrinterTest < ActiveSupport::TestCase
-  def test_print_unindexed_foreign_keys
-    assert_equal(<<EOF, print_unindexed_foreign_keys({ "users" => ["profile_id", "account_id"], "account" => ["group_id"] }))
-account group_id
-users account_id profile_id
-EOF
+      assert(
+        ActiveRecordDoctor::Printers::IOPrinter.method_defined?(name),
+        "IOPrinter should define #{name}"
+      )
+    end
+  end
+
+  def test_unindexed_foreign_keys
+    # rubocop:disable Layout/LineLength
+    assert_equal(<<OUTPUT, unindexed_foreign_keys({ "users" => ["profile_id", "account_id"], "account" => ["group_id"] }))
+The following foreign keys should be indexed for performance reasons:
+  account group_id
+  users account_id profile_id
+OUTPUT
+    # rubocop:enable Layout/LineLength
   end
 
   private
 
-  def print_unindexed_foreign_keys(argument)
+  def unindexed_foreign_keys(argument)
     io = StringIO.new
-    ActiveRecordDoctor::Printers::IOPrinter.new(io: io).print_unindexed_foreign_keys(argument)
+    ActiveRecordDoctor::Printers::IOPrinter.new(io).unindexed_foreign_keys(argument, {})
     io.string
   end
 end

data/test/model_factory.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ModelFactory
+  def self.cleanup
+    delete_models
+    drop_all_tables
+    GC.start
+  end
+
+  def self.drop_all_tables
+    connection = ActiveRecord::Base.connection
+    loop do
+      before = connection.tables.size
+      break if before.zero?
+
+      attempt_drop_all_tables(connection)
+      after = connection.tables.size
+
+      if before == after
+        raise("cannot delete temporary tables - most likely due to failing constraints")
+      end
+    end
+  end
+
+  def self.attempt_drop_all_tables(connection)
+    connection.tables.each do |table_name|
+      ActiveRecord::Migration.suppress_messages do
+        begin
+          connection.drop_table(table_name, force: :cascade)
+        rescue ActiveRecord::InvalidForeignKey, ActiveRecord::StatementInvalid
+          # The table cannot be dropped due to foreign key constraints so
+          # we'll try to drop it on another attempt.
+        end
+      end
+    end
+  end
+
+  def self.delete_models
+    Models.empty
+  end
+
+  def self.create_table(table_name, &block)
+    table_name = table_name.to_sym
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.create_table(table_name, &block)
+    end
+
+    # Return a proxy object allowing the caller to chain #create_model
+    # right after creating a table so that it can be followed by the model
+    # definition.
+    ModelDefinitionProxy.new(table_name)
+  end
+
+  def self.create_model(table_name, &block)
+    table_name = table_name.to_sym
+    klass = Class.new(ActiveRecord::Base, &block)
+    klass_name = table_name.to_s.classify
+    Models.const_set(klass_name, klass)
+  end
+
+  class ModelDefinitionProxy
+    def initialize(table_name)
+      @table_name = table_name
+    end
+
+    def create_model(&block)
+      ModelFactory.create_model(@table_name, &block)
+    end
+  end
+
+  module Models
+    def self.empty
+      constants.each do |name|
+        remove_const(name)
+      end
+    end
+  end
+end

data/test/setup.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+# 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.
+case ENV["DATABASE"]
+when "postgresql"
+  require "pg"
+  DEFAULT_DATABASE_URL = "postgres:///active_record_doctor_test"
+when "mysql"
+  require "mysql2"
+  DEFAULT_DATABASE_URL = "mysql2:///active_record_doctor_test"
+when nil
+  # rubocop:disable Style/StderrPuts
+  $stderr.puts(<<ERROR)
+The DATABASE environment variable is not set. It must be set before running the
+test suite. Valid values are "mysql" and "postgresql".
+ERROR
+  # rubocop:enable Style/StderrPuts
+  exit(1)
+else raise("unrecognized database #{ENV['DATABASE']}")
+end
+ActiveRecord::Base.establish_connection(ENV.fetch("DATABASE_URL", DEFAULT_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 detectors 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"
+
+require_relative "model_factory"
+
+# Prepare the test class.
+class Minitest::Test
+  def setup
+    # Ensure all remnants of previous test runs, most likely in form of tables,
+    # are removed.
+    ModelFactory.cleanup
+  end
+
+  def teardown
+    ModelFactory.cleanup
+  end
+
+  private
+
+  def postgresql?
+    ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+  end
+
+  def mysql?
+    ActiveRecord::Base.connection.adapter_name == "Mysql2"
+  end
+
+  def create_table(*args, &block)
+    ModelFactory.create_table(*args, &block)
+  end
+
+  def create_model(*args, &block)
+    ModelFactory.create_model(*args, &block)
+  end
+
+  # Return the detector class under test.
+  def detector_class
+    self.class.name.sub(/Test$/, "").constantize
+  end
+
+  # Run the appropriate detector. The detector name is inferred from the test class.
+  def run_detector
+    detector_class.run.first
+  end
+
+  def run_task
+    output = StringIO.new
+    printer = ActiveRecordDoctor::Printers::IOPrinter.new(output)
+    success = ActiveRecordDoctor::Task.new(detector_class, printer).run
+    [success, output.string]
+  end
+
+  def assert_problems(expected_output)
+    success, actual_output = run_task
+
+    assert_equal(expected_output, actual_output)
+    refute(success)
+  end
+
+  def refute_problems
+    success, actual_output = run_task
+
+    assert_equal("", actual_output)
+    assert(success)
+  end
+end
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Uncomment in case there's test case interference.
+Minitest.parallel_executor = Minitest::ForkExecutor.new

metadata

@@ -1,72 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Greg Navis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-30 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: minitest-fork_executor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
+        version: 1.0.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 0.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+description:
 email:
 - contact@gregnavis.com
 executables: []
@@ -75,84 +103,45 @@ 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/detectors.rb
+- lib/active_record_doctor/detectors/base.rb
+- lib/active_record_doctor/detectors/extraneous_indexes.rb
+- lib/active_record_doctor/detectors/incorrect_boolean_presence_validation.rb
+- lib/active_record_doctor/detectors/incorrect_dependent_option.rb
+- lib/active_record_doctor/detectors/missing_foreign_keys.rb
+- lib/active_record_doctor/detectors/missing_non_null_constraint.rb
+- lib/active_record_doctor/detectors/missing_presence_validation.rb
+- lib/active_record_doctor/detectors/missing_unique_indexes.rb
+- lib/active_record_doctor/detectors/undefined_table_references.rb
+- lib/active_record_doctor/detectors/unindexed_deleted_at.rb
+- lib/active_record_doctor/detectors/unindexed_foreign_keys.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/extraneous_indexes.rb
-- lib/active_record_doctor/tasks/missing_foreign_keys.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/task.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/detectors/extraneous_indexes_test.rb
+- test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb
+- test/active_record_doctor/detectors/incorrect_dependent_option_test.rb
+- test/active_record_doctor/detectors/missing_foreign_keys_test.rb
+- test/active_record_doctor/detectors/missing_non_null_constraint_test.rb
+- test/active_record_doctor/detectors/missing_presence_validation_test.rb
+- test/active_record_doctor/detectors/missing_unique_indexes_test.rb
+- test/active_record_doctor/detectors/undefined_table_references_test.rb
+- test/active_record_doctor/detectors/unindexed_deleted_at_test.rb
+- test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
 - test/active_record_doctor/printers/io_printer_test.rb
-- test/active_record_doctor/tasks/extraneous_indexes_test.rb
-- test/active_record_doctor/tasks/missing_foreign_keys_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/model_factory.rb
+- test/setup.rb
 homepage: https://github.com/gregnavis/active_record_doctor
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,73 +149,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.15
+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/active_record_doctor/detectors/extraneous_indexes_test.rb
+- test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb
+- test/active_record_doctor/detectors/incorrect_dependent_option_test.rb
+- test/active_record_doctor/detectors/missing_foreign_keys_test.rb
+- test/active_record_doctor/detectors/missing_non_null_constraint_test.rb
+- test/active_record_doctor/detectors/missing_presence_validation_test.rb
+- test/active_record_doctor/detectors/missing_unique_indexes_test.rb
+- test/active_record_doctor/detectors/undefined_table_references_test.rb
+- test/active_record_doctor/detectors/unindexed_deleted_at_test.rb
+- test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
 - test/active_record_doctor/printers/io_printer_test.rb
-- test/active_record_doctor/tasks/unindexed_deleted_at_test.rb
-- test/active_record_doctor/tasks/missing_foreign_keys_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/model_factory.rb
+- test/setup.rb