Regexp-based ignores

This commit adds the ability to ignore columns, indexes, and other database
objects based on regular expressions matched against their names, so that it's
easier to ignore objects in bulk.

Author: fatkodima

lib/active_record_doctor/detectors/base.rb

@@ -170,7 +170,7 @@ def each_model(except: [], abstract: nil, existing_tables_only: false)
             case
             when model.name.start_with?("HABTM_")
               log("#{model.name} - has-belongs-to-many model; skipping")
-            when except.include?(model.name)
+            when ignored?(model.name, except)
               log("#{model.name} - ignored via the configuration; skipping")
             when abstract && !model.abstract_class?
               log("#{model.name} - non-abstract model; skipping")
@@ -200,7 +200,7 @@ def each_index(table_name, except: [], multicolumn_only: false)
         log(message) do
           indexes.each do |index|
             case
-            when except.include?(index.name)
+            when ignored?(index.name, except)
               log("#{index.name} - ignored via the configuration; skipping")
             when multicolumn_only && !index.columns.is_a?(Array)
               log("#{index.name} - single-column index; skipping")
@@ -217,7 +217,7 @@ def each_attribute(model, except: [], type: nil)
         log("Iterating over attributes of #{model.name}") do
           connection.columns(model.table_name).each do |column|
             case
-            when except.include?("#{model.name}.#{column.name}")
+            when ignored?("#{model.name}.#{column.name}", except)
               log("#{model.name}.#{column.name} - ignored via the configuration; skipping")
             when type && !Array(type).include?(column.type)
               log("#{model.name}.#{column.name} - ignored due to the #{column.type} type; skipping")
@@ -234,7 +234,7 @@ def each_column(table_name, only: nil, except: [])
         log("Iterating over columns of #{table_name}") do
           connection.columns(table_name).each do |column|
             case
-            when except.include?("#{table_name}.#{column.name}")
+            when ignored?("#{table_name}.#{column.name}", except)
               log("#{column.name} - ignored via the configuration; skipping")
             when only.nil? || only.include?(column.name)
               log(column.name.to_s) do
@@ -266,7 +266,7 @@ def each_table(except: [])
         log("Iterating over tables") do
           tables.each do |table|
             case
-            when except.include?(table)
+            when ignored?(table, except)
               log("#{table} - ignored via the configuration; skipping")
             else
               log(table) do
@@ -280,7 +280,7 @@ def each_table(except: [])
       def each_data_source(except: [])
         log("Iterating over data sources") do
           connection.data_sources.each do |data_source|
-            if except.include?(data_source)
+            if ignored?(data_source, except)
               log("#{data_source} - ignored via the configuration; skipping")
             else
               log(data_source) do
@@ -303,7 +303,7 @@ def each_association(model, except: [], type: [:has_many, :has_one, :belongs_to]
 
           associations.each do |association|
             case
-            when except.include?("#{model.name}.#{association.name}")
+            when ignored?("#{model.name}.#{association.name}", except)
               log("#{model.name}.#{association.name} - ignored via the configuration; skipping")
             when through && !association.is_a?(ActiveRecord::Reflection::ThroughReflection)
               log("#{model.name}.#{association.name} - is not a through association; skipping")
@@ -321,6 +321,10 @@ def each_association(model, except: [], type: [:has_many, :has_one, :belongs_to]
           end
         end
       end
+
+      def ignored?(name, patterns)
+        patterns.any? { |pattern| pattern === name } # rubocop:disable Style/CaseEquality
+      end
     end
   end
 end

lib/active_record_doctor/detectors/mismatched_foreign_key_type.rb

@@ -29,7 +29,7 @@ def detect
           each_foreign_key(table) do |foreign_key|
             from_column = column(table, foreign_key.column)
 
-            next if config(:ignore_columns).include?("#{table}.#{from_column.name}")
+            next if ignored?("#{table}.#{from_column.name}", config(:ignore_columns))
 
             to_table = foreign_key.to_table
             to_column = column(to_table, foreign_key.primary_key)

lib/active_record_doctor/detectors/missing_non_null_constraint.rb

@@ -26,14 +26,14 @@ def detect
         table_models = models.select(&:table_exists?).group_by(&:table_name)
 
         table_models.each do |table, models|
-          next if config(:ignore_tables).include?(table)
+          next if ignored?(table, config(:ignore_tables))
 
           concrete_models = models.reject do |model|
             model.abstract_class? || sti_base_model?(model)
           end
 
           connection.columns(table).each do |column|
-            next if config(:ignore_columns).include?("#{table}.#{column.name}")
+            next if ignored?("#{table}.#{column.name}", config(:ignore_columns))
             next if !column.null
             next if !concrete_models.all? { |model| non_null_needed?(model, column) }
             next if not_null_check_constraint_exists?(table, column)

lib/active_record_doctor/detectors/missing_unique_indexes.rb

@@ -81,15 +81,15 @@ def validations_without_indexes
       def has_ones_without_indexes # rubocop:disable Naming/PredicateName
         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)
+            next if ignored?(has_one.klass.name, config(:ignore_models))
 
             columns =
               if has_one.options[:as]
                 [has_one.type.to_s, has_one.foreign_key.to_s]
               else
                 [has_one.foreign_key.to_s]
               end
-            next if ignore_columns.include?("#{model.name}(#{columns.join(',')})")
+            next if ignored?("#{model.name}(#{columns.join(',')})", ignore_columns)
 
             table_name = has_one.klass.table_name
             next if unique_index?(table_name, columns)
@@ -136,7 +136,11 @@ def unique_index?(table_name, columns, scope = nil)
 
       def ignore_columns
         @ignore_columns ||= config(:ignore_columns).map do |column|
-          column.gsub(" ", "")
+          if column.is_a?(String)
+            column.gsub(" ", "")
+          else
+            column
+          end
         end
       end
 

test/active_record_doctor/detectors/extraneous_indexes_test.rb

@@ -215,6 +215,38 @@ def test_config_ignore_tables
     refute_problems
   end
 
+  def test_config_ignore_tables_regexp
+    create_table(:users_tmp) do |t|
+      t.index :id
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :extraneous_indexes,
+          ignore_tables: [/_tmp\\z/]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_tables_string_ignores_exact_match
+    create_table(:users) do |t|
+      t.index :id
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :extraneous_indexes,
+          ignore_tables: ["users_profiles"]
+      end
+    CONFIG
+
+    assert_problems(<<OUTPUT)
+remove index_users_on_id from users - coincides with the primary key on the table
+OUTPUT
+  end
+
   def test_config_global_ignore_tables
     create_table(:users) do |t|
       t.index :id
@@ -274,4 +306,24 @@ def test_config_detector_ignore_indexes
 
     refute_problems
   end
+
+  def test_config_detector_ignore_indexes_regexp
+    create_table(:users) do |t|
+      t.index :id
+      t.string :email
+      t.string :api_key
+
+      t.index :email, name: "index_users_on_email"
+      t.index [:email, :api_key], name: "index_users_on_email_and_api_key"
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :extraneous_indexes,
+          ignore_indexes: [/\\Aindex_users_/]
+      end
+    CONFIG
+
+    refute_problems
+  end
 end

test/active_record_doctor/detectors/incorrect_boolean_presence_validation_test.rb

@@ -35,13 +35,32 @@ def test_models_with_non_existent_tables_are_skipped
 
   def test_config_ignore_models
     create_table(:users) do |t|
-      t.string :email, null: false
-    end.define_model
+      t.boolean :active, null: false
+    end.define_model do
+      validates :active, presence: true
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_boolean_presence_validation,
+          ignore_models: ["TransientRecord::Models::User"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_models_regexp
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.define_model do
+      validates :active, presence: true
+    end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_boolean_presence_validation,
-          ignore_models: ["ModelFactory.User"]
+          ignore_models: [/User/]
       end
     CONFIG
 
@@ -50,12 +69,14 @@ def test_config_ignore_models
 
   def test_global_ignore_models
     create_table(:users) do |t|
-      t.string :email, null: false
-    end.define_model
+      t.boolean :active, null: false
+    end.define_model do
+      validates :active, presence: true
+    end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory.User"]
+        config.global :ignore_models, ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -64,13 +85,32 @@ def test_global_ignore_models
 
   def test_config_ignore_attributes
     create_table(:users) do |t|
-      t.string :email, null: false
-    end.define_model
+      t.boolean :active, null: false
+    end.define_model do
+      validates :active, presence: true
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :incorrect_boolean_presence_validation,
+          ignore_attributes: ["TransientRecord::Models::User.active"]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
+  def test_config_ignore_attributes_regexp
+    create_table(:users) do |t|
+      t.boolean :active_old, null: false
+    end.define_model do
+      validates :active_old, presence: true
+    end
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_boolean_presence_validation,
-          ignore_attributes: ["ModelFactory.User.email"]
+          ignore_attributes: [/_old\\z/]
       end
     CONFIG
 

test/active_record_doctor/detectors/incorrect_dependent_option_test.rb

@@ -502,7 +502,7 @@ def test_config_ignore_associations
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :incorrect_dependent_option,
-          ignore_associations: ["TransientRecord::Models::Company.users"]
+          ignore_associations: [/users/]
       end
     CONFIG
 

test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb

@@ -79,6 +79,24 @@ def test_config_ignore_tables
     refute_problems
   end
 
+  def test_config_ignore_tables_regexp
+    skip("MySQL always indexes foreign keys") if mysql?
+
+    create_table(:companies)
+    create_table(:users_tmp) do |t|
+      t.references :company, foreign_key: true, index: false
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :unindexed_foreign_keys,
+          ignore_tables: [/_tmp\\z/]
+      end
+    CONFIG
+
+    refute_problems
+  end
+
   def test_global_ignore_tables
     skip("MySQL always indexes foreign keys") if mysql?
 
@@ -113,4 +131,23 @@ def test_config_ignore_columns
 
     refute_problems
   end
+
+  def test_config_ignore_columns_regexp
+    skip("MySQL always indexes foreign keys") if mysql?
+
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.integer :company_id_tmp
+      t.foreign_key :companies, column: :company_id_tmp, index: false
+    end
+
+    config_file(<<-CONFIG)
+      ActiveRecordDoctor.configure do |config|
+        config.detector :unindexed_foreign_keys,
+          ignore_columns: [/_tmp\\z/]
+      end
+    CONFIG
+
+    refute_problems
+  end
 end