active_record_doctor 1.8.0 → 1.10.0

data/test/setup.rb

@@ -7,45 +7,25 @@
 require "uri"
 
 require "active_record"
+require "pg"
+require "mysql2"
 
-# 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))
+adapter = ENV.fetch("DATABASE_ADAPTER")
+ActiveRecord::Base.establish_connection(
+  adapter: adapter,
+  host: ENV["DATABASE_HOST"],
+  port: ENV["DATABASE_PORT"],
+  username: ENV["DATABASE_USERNAME"],
+  password: ENV["DATABASE_PASSWORD"],
+  database: "active_record_doctor_test"
+)
+
+puts "Using #{adapter}"
 
 # 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"
 
@@ -53,23 +33,52 @@ require "active_record_doctor"
 require "minitest"
 require "minitest/autorun"
 require "minitest/fork_executor"
-
 require_relative "model_factory"
 
+# 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
+
 # Prepare the test class.
 class Minitest::Test
+  include ModelFactory
+
   def setup
-    # Ensure all remnants of previous test runs, most likely in form of tables,
-    # are removed.
-    ModelFactory.cleanup
+    # Delete remnants (models and tables) of previous test case runs.
+    cleanup_models
   end
 
   def teardown
-    ModelFactory.cleanup
+    @config_path = nil
+
+    if @previous_dir
+      Dir.chdir(@previous_dir)
+      @previous_dir = nil
+    end
+
+    # Ensure all remnants of previous test runs, most likely in form of tables,
+    # are removed.
+    cleanup_models
   end
 
   private
 
+  attr_reader :config_path
+
+  def config_file(content)
+    @previous_dir = Dir.pwd
+
+    directory = Dir.mktmpdir("active_record_doctor")
+    @config_path = File.join(directory, ".active_record_doctor")
+    File.write(@config_path, content)
+    Dir.chdir(directory)
+
+    @config_path
+  end
+
   def postgresql?
     ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
   end
@@ -78,49 +87,34 @@ class Minitest::Test
     ActiveRecord::Base.connection.adapter_name == "Mysql2"
   end
 
-  def create_table(*args, &block)
-    ModelFactory.create_table(*args, &block)
+  def detector_name
+    self.class.name.sub(/Test$/, "").demodulize.underscore.to_sym
   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
+    io = StringIO.new
+    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+    success = runner.run_one(detector_name)
+    [success, io.string]
   end
 
-  def run_task
-    output = StringIO.new
-    printer = ActiveRecordDoctor::Printers::IOPrinter.new(output)
-    success = ActiveRecordDoctor::Task.new(detector_class, printer).run
-    [success, output.string]
+  def load_config
+    ActiveRecordDoctor.load_config_with_defaults(@config_path)
   end
 
   def assert_problems(expected_output)
-    success, actual_output = run_task
-
-    assert_equal(expected_output, actual_output)
-    refute(success)
+    success, output = run_detector
+    assert_equal(sort_lines(expected_output), sort_lines(output))
+    refute(success, "Expected the detector to return failure.")
   end
 
-  def refute_problems
-    success, actual_output = run_task
+  def refute_problems(expected_output = "")
+    success, output = run_detector
+    assert_equal(sort_lines(expected_output), sort_lines(output))
+    assert(success, "Expected the detector to return success.")
+  end
 
-    assert_equal("", actual_output)
-    assert(success)
+  def sort_lines(string)
+    string.split("\n").sort.join("\n")
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -104,37 +118,52 @@ files:
 - MIT-LICENSE.txt
 - README.md
 - lib/active_record_doctor.rb
+- lib/active_record_doctor/config.rb
+- lib/active_record_doctor/config/default.rb
+- lib/active_record_doctor/config/loader.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/incorrect_length_validation.rb
+- lib/active_record_doctor/detectors/mismatched_foreign_key_type.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/short_primary_key_type.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/errors.rb
+- lib/active_record_doctor/help.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/task.rb
+- lib/active_record_doctor/rake/task.rb
+- lib/active_record_doctor/runner.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.rake
+- test/active_record_doctor/config/loader_test.rb
+- test/active_record_doctor/config_test.rb
+- test/active_record_doctor/detectors/disable_test.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/incorrect_length_validation_test.rb
+- test/active_record_doctor/detectors/mismatched_foreign_key_type_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/short_primary_key_type_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/runner_test.rb
+- test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
 - test/model_factory.rb
 - test/setup.rb
 homepage: https://github.com/gregnavis/active_record_doctor
@@ -156,21 +185,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Identify database issues before they hit production.
 test_files:
+- test/active_record_doctor/config/loader_test.rb
+- test/active_record_doctor/config_test.rb
+- test/active_record_doctor/detectors/disable_test.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/incorrect_length_validation_test.rb
+- test/active_record_doctor/detectors/mismatched_foreign_key_type_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/short_primary_key_type_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/runner_test.rb
+- test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
 - test/model_factory.rb
 - test/setup.rb

data/lib/active_record_doctor/printers/io_printer.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecordDoctor
-  module Printers
-    # Default printer for displaying messages produced by active_record_doctor.
-    class IOPrinter
-      def initialize(io = $stdout)
-        @io = io
-      end
-
-      def unindexed_foreign_keys(unindexed_foreign_keys, _options)
-        return if unindexed_foreign_keys.empty?
-
-        @io.puts("The following foreign keys should be indexed for performance reasons:")
-        @io.puts(unindexed_foreign_keys.sort.map do |table, columns|
-          "  #{table} #{columns.sort.join(' ')}"
-        end.join("\n"))
-      end
-
-      def extraneous_indexes(extraneous_indexes, _options)
-        return if extraneous_indexes.empty?
-
-        @io.puts("The following indexes are extraneous and can be removed:")
-        extraneous_indexes.each do |index, details|
-          reason, *params = details
-          case reason
-          when :multi_column
-            @io.puts("  #{index} (can be handled by #{params.join(', ')})")
-          when :primary_key
-            @io.puts("  #{index} (is a primary key of #{params[0]})")
-          else
-            raise("unknown reason #{reason.inspect}")
-          end
-        end
-      end
-
-      def missing_foreign_keys(missing_foreign_keys, _options)
-        return if missing_foreign_keys.empty?
-
-        @io.puts("The following columns lack a foreign key constraint:")
-        @io.puts(missing_foreign_keys.sort.map do |table, columns|
-          "  #{table} #{columns.sort.join(' ')}"
-        end.join("\n"))
-      end
-
-      def undefined_table_references(models, options)
-        return if models.empty?
-
-        unless options.fetch(:views_checked)
-          @io.puts(<<WARNING)
-WARNING: Models backed by database views are supported only in Rails 5+ OR
-Rails 4.2 + PostgreSQL. It seems this is NOT your setup. Therefore, such models
-will be erroneously reported below as not having their underlying tables/views.
-Consider upgrading Rails or disabling this task temporarily.
-WARNING
-        end
-
-        @io.puts("The following models reference undefined tables:")
-        models.each do |model_name, table_name|
-          @io.puts("  #{model_name} (the table #{table_name} is undefined)")
-        end
-      end
-
-      def unindexed_deleted_at(indexes, _options)
-        return if indexes.empty?
-
-        @io.puts("The following indexes should include `deleted_at IS NULL`:")
-        indexes.each do |index|
-          @io.puts("  #{index}")
-        end
-      end
-
-      def missing_unique_indexes(indexes, _options)
-        return if indexes.empty?
-
-        @io.puts("The following indexes should be created to back model-level uniqueness validations:")
-        indexes.each do |table, arrays_of_columns|
-          arrays_of_columns.each do |columns|
-            @io.puts("  #{table}: #{columns.join(', ')}")
-          end
-        end
-      end
-
-      def missing_presence_validation(missing_presence_validators, _options)
-        return if missing_presence_validators.empty?
-
-        @io.puts("The following models and columns should have presence validations:")
-        missing_presence_validators.each do |model_name, array_of_columns|
-          @io.puts("  #{model_name}: #{array_of_columns.join(', ')}")
-        end
-      end
-
-      def missing_non_null_constraint(missing_non_null_constraints, _options)
-        return if missing_non_null_constraints.empty?
-
-        @io.puts("The following columns should be marked as `null: false`:")
-        missing_non_null_constraints.each do |table, columns|
-          @io.puts("  #{table}: #{columns.join(', ')}")
-        end
-      end
-
-      def incorrect_boolean_presence_validation(incorrect_boolean_presence_validations, _options)
-        return if incorrect_boolean_presence_validations.empty?
-
-        @io.puts("The presence of the following boolean columns is validated incorrectly:")
-        incorrect_boolean_presence_validations.each do |table, columns|
-          @io.puts("  #{table}: #{columns.join(', ')}")
-        end
-      end
-
-      def incorrect_dependent_option(problems, _options)
-        return if problems.empty?
-
-        @io.puts("The following associations might be using invalid dependent settings:")
-        problems.each do |model, associations|
-          associations.each do |(name, problem)|
-            # rubocop:disable Layout/LineLength
-            message =
-              case problem
-              when :suggest_destroy then "skips callbacks that are defined on the associated model - consider changing to `dependent: :destroy` or similar"
-              when :suggest_delete then "loads the associated model before deleting it - consider using `dependent: :delete`"
-              when :suggest_delete_all then "loads models one-by-one to invoke callbacks even though the related model defines none - consider using `dependent: :delete_all`"
-              else next
-              end
-            # rubocop:enable Layout/LineLength
-
-            @io.puts("  #{model}: #{name} #{message}")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/active_record_doctor/task.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecordDoctor
-  # Rake task for running a detector and reporting its results.
-  class Task
-    DEFAULT_PRINTER = ActiveRecordDoctor::Printers::IOPrinter.new
-
-    def initialize(detector_class, printer = DEFAULT_PRINTER)
-      @detector_class = detector_class
-      @printer = printer
-    end
-
-    def name
-      @detector_class.name.demodulize.underscore.to_sym
-    end
-
-    def description
-      @detector_class.description
-    end
-
-    def run
-      problems, options = @detector_class.run
-      @printer.public_send(name, problems, options)
-
-      problems.empty?
-    end
-  end
-end

data/test/active_record_doctor/printers/io_printer_test.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-# 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
-
-      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 unindexed_foreign_keys(argument)
-    io = StringIO.new
-    ActiveRecordDoctor::Printers::IOPrinter.new(io).unindexed_foreign_keys(argument, {})
-    io.string
-  end
-end