active_record_doctor 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94e700a1c78ee5e9657d1107578c2932a84acba7f592ab6a416e5c063520a311
-  data.tar.gz: 8496adb8a597250ec95276fc9fbad50397667f7de2336f80405203b3a3c2a459
+  metadata.gz: 7c93e45a93d9c11392978f37626379bd322e4827aac59ca6f51400e33a009813
+  data.tar.gz: e3e920647f6b68fdec23d7e23e7e4ff3653cb8823673e56b0916d1247cbb3864
 SHA512:
-  metadata.gz: 79803ef2db49147fdf2daf5983a3f36fb895704d150347442bebdc192a6980ecb8cd438c23fe335941284e0a39aee8c3e1a725bfe3845c7a0d3dde03830068dc
-  data.tar.gz: 2feb5b594c369dc3d39e0f85540724474e5caa7573e0d0f18a5dcddd63d12113ec4c670ef374b475f237bd3d75fe7281bca0b0d219aac6582cbddbe59bdc2340
+  metadata.gz: 54c002741991dc91c4afd46de5472d64be0ba02457d23df39bd16297a12f4192023679d281d9bc353a5de5a0c357ea960666967d820316fe5fdaceee36f99d6d
+  data.tar.gz: bb17cb57cc708b9d7e751bb79e341aac2df4de4adc5f59d2cf254ef564c0a481b8e8872f1eac34a37246eda9145a78abbb41511150bc064932504645e36453fd

data/README.md

@@ -17,6 +17,7 @@ can detect:
 * mismatched foreign key types - [`active_record_doctor:mismatched_foreign_key_type`](#detecting-mismatched-foreign-key-types)
 * tables without primary keys - [`active_record_doctor:table_without_primary_key`](#detecting-tables-without-primary-keys)
 * tables without timestamps - [`active_record_doctor:table_without_timestamps`](#detecting-tables-without-timestamps)
+* unused tables - [`active_record_doctor:unused_tables](#detecting-unused-tables)
 
 It can also:
 
@@ -665,15 +666,35 @@ Supported configuration options:
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_tables` - tables whose timestamp columns existence should not be checked
 
-## Ruby and Rails Compatibility Policy
+### Detecting Unused Tables
+
+**WARNING**: this detector is disabled by default and has to be turned on explicitly.
+
+When a table is not used by the application it should usually be dropped from the database.
+
+Running the command below will list all tables that are not referenced by any model:
+
+```
+bundle exec rake active_record_doctor:unused_tables
+```
+
+The output of the command looks like this:
+
+```
+The users table is not referenced by any Rails model and can be dropped
+```
 
-The goal of the policy is to ensure proper functioning in reasonable
-combinations of Ruby and Rails versions. Specifically:
+Supported configuration options:
+
+- `enabled` - set to `true` to enable the detector
+- `ignore_tables` - tables that are not represented by models but cannot yet be dropped from the database (i.e. because the deployed version of the code may still be reading it)
+
+## Ruby and Rails Compatibility Policy
 
-1. If a Rails version is officially supported by the Rails Core Team then it's
+1. `active_record_doctor` supports all Ruby on Rails versions that are supported
+   by the Rails core team.
+2. If a Ruby version is compatible with a supported Rails version then it's also
    supported by `active_record_doctor`.
-2. If a Ruby version is compatible with a supported Rails version then it's
-   also supported by `active_record_doctor`.
 3. Only the most recent teeny Ruby versions and patch Rails versions are supported.
 
 ## Author

data/lib/active_record_doctor/config/default.rb

@@ -83,4 +83,8 @@ ActiveRecordDoctor.configure do
     enabled: true,
     ignore_tables: [],
     ignore_columns: []
+
+  detector :unused_tables,
+    enabled: false,
+    ignore_tables: []
 end

data/lib/active_record_doctor/detectors/incorrect_length_validation.rb

@@ -18,9 +18,12 @@ module ActiveRecordDoctor
 
       private
 
-      def message(model:, attribute:, table:, database_maximum:, model_maximum:)
+      def message(model:, column:, table:, database_maximum:, model_maximum:)
+        attribute = column.name
         # rubocop:disable Layout/LineLength
-        if database_maximum && model_maximum
+        if database_maximum && column.respond_to?(:array?) && column.array?
+          "the schema limits each #{table}.#{attribute} array element to #{database_maximum} characters - use a custom validation for this attribute or add it to the ignore list"
+        elsif database_maximum && model_maximum
           "the schema limits #{table}.#{attribute} to #{database_maximum} characters but the length validator on #{model}.#{attribute} enforces a maximum of #{model_maximum} characters - set both limits to the same value or remove both"
         elsif database_maximum && model_maximum.nil?
           "the schema limits #{table}.#{attribute} to #{database_maximum} characters but there's no length validator on #{model}.#{attribute} - remove the database limit or add the validator"
@@ -40,7 +43,7 @@ module ActiveRecordDoctor
 
             problem!(
               model: model.name,
-              attribute: column.name,
+              column: column,
               table: model.table_name,
               database_maximum: database_maximum,
               model_maximum: model_maximum

data/lib/active_record_doctor/detectors/missing_presence_validation.rb

@@ -93,14 +93,14 @@ module ActiveRecordDoctor
               when ActiveModel::Validations::InclusionValidator
                 validator_items = inclusion_or_exclusion_validator_items(validator)
                 (validator.attributes & attribute_names).present? &&
-                  (validator_items.is_a?(Proc) || validator_items.exclude?(nil))
+                  (dynamic_validator_items?(validator_items) || validator_items.exclude?(nil))
 
               # An exclusion validator ensures the column is not nil if it covers
               # the column and excludes nil as an allowed value explicitly.
               when ActiveModel::Validations::ExclusionValidator
                 validator_items = inclusion_or_exclusion_validator_items(validator)
                 (validator.attributes & attribute_names).present? &&
-                  (validator_items.is_a?(Proc) || validator_items.include?(nil))
+                  (dynamic_validator_items?(validator_items) || validator_items.include?(nil))
 
               end
             end
@@ -172,6 +172,12 @@ module ActiveRecordDoctor
         validator.options[:in] || validator.options[:within] || []
       end
 
+      # The allowed values can be a Proc or a method name (Symbol) that's resolved
+      # at validation time, so the set of values isn't known statically.
+      def dynamic_validator_items?(validator_items)
+        validator_items.is_a?(Proc) || validator_items.is_a?(Symbol)
+      end
+
       # Determines whether the given column is used as a counter cache column by
       # a has_many association on the model.
       def counter_cache_column?(model, column)

data/lib/active_record_doctor/detectors/unused_tables.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "active_record_doctor/detectors/base"
+
+module ActiveRecordDoctor
+  module Detectors
+    class UnusedTables < Base # :nodoc:
+      @description = "detect tables not referenced by any model"
+      @config = {
+        ignore_tables: {
+          description: "tables whose corresponding models should not be checked for existence",
+          global: true
+        }
+      }
+
+      private
+
+      def message(table:)
+        "The #{table} table is not referenced by any Rails model and can be dropped"
+      end
+
+      def detect
+        each_table(except: config(:ignore_tables)) do |table|
+          next if models.any? { |model| model.table_name == table }
+
+          problem!(table: table)
+        end
+      end
+    end
+  end
+end

data/lib/active_record_doctor/version.rb

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

data/lib/active_record_doctor.rb

@@ -22,6 +22,7 @@ require "active_record_doctor/detectors/short_primary_key_type"
 require "active_record_doctor/detectors/mismatched_foreign_key_type"
 require "active_record_doctor/detectors/table_without_primary_key"
 require "active_record_doctor/detectors/table_without_timestamps"
+require "active_record_doctor/detectors/unused_tables"
 require "active_record_doctor/errors"
 require "active_record_doctor/help"
 require "active_record_doctor/runner"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Greg Navis
@@ -23,20 +23,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-fork_executor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.27'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -111,16 +139,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: transient_record
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +192,7 @@ files:
 - 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/detectors/unused_tables.rb
 - lib/active_record_doctor/errors.rb
 - lib/active_record_doctor/help.rb
 - lib/active_record_doctor/logger.rb
@@ -197,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Identify database issues before they hit production.
 test_files: []