active_record_doctor 1.10.0 → 1.11.0

data/lib/active_record_doctor/detectors/missing_presence_validation.rb

@@ -23,13 +23,10 @@ module ActiveRecordDoctor
       end
 
       def detect
-        models(except: config(:ignore_models)).each do |model|
-          next unless model.table_exists?
-
-          connection.columns(model.table_name).each do |column|
+        each_model(except: config(:ignore_models), existing_tables_only: true) do |model|
+          each_attribute(model, except: config(:ignore_attributes)) do |column|
             next unless validator_needed?(model, column)
             next if validator_present?(model, column)
-            next if config(:ignore_attributes).include?("#{model}.#{column.name}")
 
             problem!(column: column.name, model: model.name)
           end
@@ -52,17 +49,23 @@ module ActiveRecordDoctor
 
       def inclusion_validator_present?(model, column)
         model.validators.any? do |validator|
+          validator_items = inclusion_validator_items(validator)
+          return true if validator_items.is_a?(Proc)
+
           validator.is_a?(ActiveModel::Validations::InclusionValidator) &&
             validator.attributes.include?(column.name.to_sym) &&
-            !validator.options.fetch(:in, []).include?(nil)
+            !validator_items.include?(nil)
         end
       end
 
       def exclusion_validator_present?(model, column)
         model.validators.any? do |validator|
+          validator_items = inclusion_validator_items(validator)
+          return true if validator_items.is_a?(Proc)
+
           validator.is_a?(ActiveModel::Validations::ExclusionValidator) &&
             validator.attributes.include?(column.name.to_sym) &&
-            validator.options.fetch(:in, []).include?(nil)
+            validator_items.include?(nil)
         end
       end
 
@@ -79,6 +82,10 @@ module ActiveRecordDoctor
             (validator.attributes & allowed_attributes).present?
         end
       end
+
+      def inclusion_validator_items(validator)
+        validator.options[:in] || validator.options[:within] || []
+      end
     end
   end
 end

data/lib/active_record_doctor/detectors/missing_unique_indexes.rb

@@ -35,9 +35,7 @@ module ActiveRecordDoctor
       end
 
       def validations_without_indexes
-        models(except: config(:ignore_models)).each do |model|
-          next unless model.table_exists?
-
+        each_model(except: config(:ignore_models), existing_tables_only: true) do |model|
           model.validators.each do |validator|
             scope = Array(validator.options.fetch(:scope, []))
 
@@ -57,18 +55,14 @@ module ActiveRecordDoctor
       end
 
       def has_ones_without_indexes # rubocop:disable Naming/PredicateName
-        models.each do |model|
-          has_ones = model.reflect_on_all_associations(:has_one)
-          has_ones.each do |has_one|
-            next if has_one.is_a?(ActiveRecord::Reflection::ThroughReflection) || has_one.scope
-
-            association_model = has_one.klass
-            next if config(:ignore_models).include?(association_model.name)
+        each_model do |model|
+          each_association(model, type: :has_one, has_scope: false, through: false) do |has_one|
+            next if config(:ignore_models).include?(has_one.klass.name)
 
             foreign_key = has_one.foreign_key
             next if ignore_columns.include?(foreign_key.to_s)
 
-            table_name = association_model.table_name
+            table_name = has_one.klass.table_name
             next if unique_index?(table_name, [foreign_key])
 
             problem!(model: model, table: table_name, columns: [foreign_key], problem: :has_ones)

data/lib/active_record_doctor/detectors/short_primary_key_type.rb

@@ -20,7 +20,7 @@ module ActiveRecordDoctor
       end
 
       def detect
-        tables(except: config(:ignore_tables)).each do |table|
+        each_table(except: config(:ignore_tables)) do |table|
           column = primary_key(table)
           next if column.nil?
           next if bigint?(column) || uuid?(column)

data/lib/active_record_doctor/detectors/undefined_table_references.rb

@@ -20,8 +20,8 @@ module ActiveRecordDoctor
       end
 
       def detect
-        models(except: config(:ignore_models)).each do |model|
-          next if model.table_exists? || views.include?(model.table_name)
+        each_model(except: config(:ignore_models), abstract: false) do |model|
+          next if connection.data_source_exists?(model.table_name)
 
           problem!(model: model.name, table: model.table_name)
         end

data/lib/active_record_doctor/detectors/unindexed_deleted_at.rb

@@ -31,20 +31,12 @@ module ActiveRecordDoctor
       end
 
       def detect
-        tables(except: config(:ignore_tables)).each do |table|
-          timestamp_columns = connection.columns(table).reject do |column|
-            config(:ignore_columns).include?("#{table}.#{column.name}")
-          end.select do |column|
-            config(:column_names).include?(column.name)
-          end
-
-          next if timestamp_columns.empty?
-
-          timestamp_columns.each do |timestamp_column|
-            indexes(table, except: config(:ignore_indexes)).each do |index|
-              next if index.where =~ /\b#{timestamp_column.name}\s+IS\s+(NOT\s+)?NULL\b/i
+        each_table(except: config(:ignore_tables)) do |table|
+          each_column(table, only: config(:column_names), except: config(:ignore_columns)) do |column|
+            each_index(table, except: config(:ignore_indexes)) do |index|
+              next if index.where =~ /\b#{column.name}\s+IS\s+(NOT\s+)?NULL\b/i
 
-              problem!(index: index.name, column_name: timestamp_column.name)
+              problem!(index: index.name, column_name: column.name)
             end
           end
         end

data/lib/active_record_doctor/detectors/unindexed_foreign_keys.rb

@@ -25,10 +25,8 @@ module ActiveRecordDoctor
       end
 
       def detect
-        tables(except: config(:ignore_tables)).each do |table|
-          connection.columns(table).each do |column|
-            next if config(:ignore_columns).include?("#{table}.#{column.name}")
-
+        each_table(except: config(:ignore_tables)) do |table|
+          each_column(table, except: config(:ignore_columns)) do |column|
             next unless foreign_key?(column)
             next if indexed?(table, column)
             next if indexed_as_polymorphic?(table, column)

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/version.rb

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

data/lib/active_record_doctor.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "active_record_doctor/railtie" if defined?(Rails) && defined?(Rails::Railtie)
+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"

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/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|