active_record_doctor 1.10.0 → 1.12.0

data/lib/active_record_doctor/logger/dummy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Logger
+    class Dummy # :nodoc:
+      def log(_message)
+        yield if block_given?
+      end
+    end
+  end
+end

data/lib/active_record_doctor/logger/hierarchical.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Logger
+    class Hierarchical # :nodoc:
+      def initialize(io)
+        @io = io
+        @nesting = 0
+      end
+
+      def log(message)
+        @io.puts("  " * @nesting + message.to_s)
+        return if !block_given?
+
+        @nesting += 1
+        result = yield
+        @nesting -= 1
+        result
+      end
+    end
+  end
+end

data/lib/active_record_doctor/logger.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Logger # :nodoc:
+  end
+end

data/lib/active_record_doctor/rake/task.rb

@@ -64,7 +64,7 @@ module ActiveRecordDoctor
       private
 
       def runner
-        @runner ||= ActiveRecordDoctor::Runner.new(config)
+        @runner ||= ActiveRecordDoctor::Runner.new(config: config, logger: logger)
       end
 
       def config
@@ -73,6 +73,15 @@ module ActiveRecordDoctor
           ActiveRecordDoctor.load_config_with_defaults(path)
         end
       end
+
+      def logger
+        @logger ||=
+          if ENV.include?("ACTIVE_RECORD_DOCTOR_DEBUG")
+            ActiveRecordDoctor::Logger::Hierarchical.new($stderr)
+          else
+            ActiveRecordDoctor::Logger::Dummy.new
+          end
+      end
     end
   end
 end

data/lib/active_record_doctor/runner.rb

@@ -5,14 +5,19 @@ module ActiveRecordDoctor # :nodoc:
   # and an output device for use by detectors.
   class Runner
     # io is injected via constructor parameters to facilitate testing.
-    def initialize(config, io = $stdout)
+    def initialize(config:, logger:, io: $stdout)
       @config = config
+      @logger = logger
       @io = io
     end
 
     def run_one(name)
       ActiveRecordDoctor.handle_exception do
-        ActiveRecordDoctor.detectors.fetch(name).run(config, io)
+        ActiveRecordDoctor.detectors.fetch(name).run(
+          config: config,
+          logger: logger,
+          io: io
+        )
       end
     end
 
@@ -36,6 +41,6 @@ module ActiveRecordDoctor # :nodoc:
 
     private
 
-    attr_reader :config, :io
+    attr_reader :config, :logger, :io
   end
 end

data/lib/active_record_doctor/utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecordDoctor
+  module Utils # :nodoc:
+    class << self
+      def postgresql?(connection = ActiveRecord::Base.connection)
+        ["PostgreSQL", "PostGIS"].include?(connection.adapter_name)
+      end
+
+      def mysql?(connection = ActiveRecord::Base.connection)
+        connection.adapter_name == "Mysql2"
+      end
+
+      def expression_indexes_unsupported?(connection = ActiveRecord::Base.connection)
+        (ActiveRecord::VERSION::STRING < "5.0") ||
+          # Active Record < 6 is unable to correctly parse expression indexes for MySQL.
+          (mysql?(connection) && ActiveRecord::VERSION::STRING < "6.0")
+      end
+    end
+  end
+end

data/lib/active_record_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordDoctor
-  VERSION = "1.10.0"
+  VERSION = "1.12.0"
 end

data/lib/active_record_doctor.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require "active_record_doctor/railtie" if defined?(Rails) && defined?(Rails::Railtie)
+require "active_record_doctor/utils"
+require "active_record_doctor/logger"
+require "active_record_doctor/logger/dummy"
+require "active_record_doctor/logger/hierarchical"
 require "active_record_doctor/detectors"
 require "active_record_doctor/detectors/base"
 require "active_record_doctor/detectors/missing_presence_validation"
@@ -22,6 +26,7 @@ require "active_record_doctor/runner"
 require "active_record_doctor/version"
 require "active_record_doctor/config"
 require "active_record_doctor/config/loader"
+require "active_record_doctor/rake/task"
 
 module ActiveRecordDoctor # :nodoc:
 end

data/lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb

@@ -10,16 +10,16 @@ module ActiveRecordDoctor
       migration_descriptions = read_migration_descriptions(path)
       now = Time.now
 
-      migration_descriptions.each_with_index do |(table, columns), index|
+      migration_descriptions.each_with_index do |(table, indexes), index|
         timestamp = (now + index).strftime("%Y%m%d%H%M%S")
         file_name = "db/migrate/#{timestamp}_index_foreign_keys_in_#{table}.rb"
-        create_file(file_name, content(table, columns).tap { |x| puts x })
+        create_file(file_name, content(table, indexes).tap { |x| puts x })
       end
     end
 
     private
 
-    INPUT_LINE = /^add an index on (\w+)\.(\w+) - .*$/.freeze
+    INPUT_LINE = /^add an index on (\w+)\((.+)\) - .*$/.freeze
     private_constant :INPUT_LINE
 
     def read_migration_descriptions(path)
@@ -34,41 +34,41 @@ module ActiveRecordDoctor
         end
 
         table = match[1]
-        column = match[2]
+        columns = match[2].split(",").map(&:strip)
 
-        tables_to_columns[table] << column
+        tables_to_columns[table] << columns
       end
 
       tables_to_columns
     end
 
-    def content(table, columns)
+    def content(table, indexes)
       # In order to properly indent the resulting code, we must disable the
       # rubocop rule below.
 
       <<MIGRATION
 class IndexForeignKeysIn#{table.camelize} < ActiveRecord::Migration#{migration_version}
   def change
-#{add_indexes(table, columns)}
+#{add_indexes(table, indexes)}
   end
 end
 MIGRATION
     end
 
-    def add_indexes(table, columns)
-      columns.map do |column|
-        add_index(table, column)
+    def add_indexes(table, indexes)
+      indexes.map do |columns|
+        add_index(table, columns)
       end.join("\n")
     end
 
-    def add_index(table, column)
+    def add_index(table, columns)
       connection = ActiveRecord::Base.connection
 
-      index_name = connection.index_name(table, column)
+      index_name = connection.index_name(table, columns)
       if index_name.size > connection.index_name_length
-        "    add_index :#{table}, :#{column}, name: '#{index_name.first(connection.index_name_length)}'"
+        "    add_index :#{table}, #{columns.inspect}, name: '#{index_name.first(connection.index_name_length)}'"
       else
-        "    add_index :#{table}, :#{column}"
+        "    add_index :#{table}, #{columns.inspect}"
       end
     end
 

data/test/active_record_doctor/detectors/disable_test.rb

@@ -6,7 +6,7 @@ class ActiveRecordDoctor::Detectors::DisableTest < Minitest::Test
   def test_disabling
     create_table(:users) do |t|
       t.string :name, null: true
-    end.create_model do
+    end.define_model do
       validates :name, presence: true
     end
 

data/test/active_record_doctor/detectors/extraneous_indexes_test.rb

@@ -7,7 +7,7 @@ class ActiveRecordDoctor::Detectors::ExtraneousIndexesTest < Minitest::Test
     end
 
     assert_problems(<<OUTPUT)
-remove index_users_on_id - coincides with the primary key on the table
+remove index_users_on_id from users - coincides with the primary key on the table
 OUTPUT
   end
 
@@ -28,7 +28,7 @@ OUTPUT
     end
 
     assert_problems(<<OUTPUT)
-remove index_profiles_on_user_id - coincides with the primary key on the table
+remove index_profiles_on_user_id from profiles - coincides with the primary key on the table
 OUTPUT
   end
 
@@ -42,7 +42,7 @@ OUTPUT
     ActiveRecord::Base.connection.add_index :users, :email, name: "index_users_on_email"
 
     assert_problems(<<OUTPUT)
-remove index_users_on_email - can be replaced by unique_index_on_users_email
+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
 
@@ -59,7 +59,7 @@ OUTPUT
     end
 
     assert_problems(<<OUTPUT)
-remove index_users_on_last_name - can be replaced by index_users_on_last_name_and_first_name_and_email or unique_index_on_users_last_name_and_first_name
+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
 
@@ -78,7 +78,7 @@ OUTPUT
     ActiveRecord::Base.connection.add_index :users, [:last_name, :first_name]
 
     assert_problems(<<OUTPUT)
-remove index_users_on_last_name_and_first_name - can be replaced by index_users_on_last_name_and_first_name_and_email or unique_index_on_users_last_name_and_first_name
+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
 
@@ -91,10 +91,36 @@ OUTPUT
     end
 
     assert_problems(<<OUTPUT)
-remove index_users_on_last_name_and_first_name - can be replaced by index_users_on_first_name
+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
@@ -139,6 +165,33 @@ OUTPUT
     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

data/test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -5,7 +5,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
     create_table(:users) do |t|
       t.string :email, null: false
       t.boolean :active, null: false
-    end.create_model do
+    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.
@@ -13,14 +13,14 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
     end
 
     assert_problems(<<~OUTPUT)
-      replace the `presence` validator on ModelFactory::Models::User.active with `inclusion` - `presence` can't be used on booleans
+      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.create_model do
+    end.define_model do
       validates :active, inclusion: { in: [true, false] }
     end
 
@@ -28,7 +28,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   end
 
   def test_models_with_non_existent_tables_are_skipped
-    create_model(:User)
+    define_model(:User)
 
     refute_problems
   end
@@ -36,7 +36,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   def test_config_ignore_models
     create_table(:users) do |t|
       t.string :email, null: false
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
@@ -51,7 +51,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   def test_global_ignore_models
     create_table(:users) do |t|
       t.string :email, null: false
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
@@ -65,7 +65,7 @@ class ActiveRecordDoctor::Detectors::IncorrectBooleanPresenceValidationTest < Mi
   def test_config_ignore_attributes
     create_table(:users) do |t|
       t.string :email, null: false
-    end.create_model
+    end.define_model
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|