active_record_doctor 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc970595479a84692995f75b3e512f1b1a01dc6fc61eee9a738abbd402ac9e44
-  data.tar.gz: 3bd5807bc126459379478c24d14a5595a2ee207415cb71c86c82ebdfae5f19f3
+  metadata.gz: 89e283c2844a768587302646735a080d8db2b3514775083cc6bc74a25e7aff18
+  data.tar.gz: 975a75da213c565dba3ee7918ffe64d5b75d812059b8080d6a5134a2fb27028f
 SHA512:
-  metadata.gz: 4b0ac66a6f9037ce810ff73660735b816bc58d614dd7612b7c7849292741519cbecd6bdb7105c7392e01fc1621ce550e1b8ba0726573beca33ee6e10ec6e35da
-  data.tar.gz: c3d2d7b0448ccff98001c72fa6330b54f45364a43e3eff35ff7407d0e2aeaaf8c3070a3ce308992577fa41adf7cdde3a8ba2aa93db4c8955fd69e5ec7f29d03b
+  metadata.gz: ca4a89d161ef3a57ee325ea6551417b9e542967d2f932f383eca6e7394ba99f02cf08ac9cd699e98f1f59018669405220fe1175f80d31f60576fc606d2d3f5f6
+  data.tar.gz: 70644778b22b9fe2892d12704cdfb3d81337702e8770ca94f8410694e3a8b12ad931bc511bc5188f77726849fca7c87c1ce8fec059d647ea4225adf6ab1363ef

data/README.md

@@ -55,7 +55,7 @@ ActiveRecordDoctor::Rake::Task.new do |task|
   task.deps = []
 
   # A path to your active_record_doctor configuration file.
-  task.config_path = ::Rails.root.join(".active_record_doctor")
+  task.config_path = ::Rails.root.join(".active_record_doctor.rb")
 
   # A Proc called right before running detectors that should ensure your Active
   # Record models are preloaded and a database connection is ready.
@@ -111,7 +111,7 @@ If you want to use the default configuration then you don't have to do anything.
 Just run `active_record_doctor` in your project directory.
 
 If you want to customize the tool you should create a file named
-`.active_record_doctor` in your project root directory with content like:
+`.active_record_doctor.rb` in your project root directory with content like:
 
 ```ruby
 ActiveRecordDoctor.configure do

data/lib/active_record_doctor/rake/task.rb

@@ -68,9 +68,41 @@ module ActiveRecordDoctor
       end
 
       def config
-        @config ||= begin
-          path = config_path && File.exist?(config_path) ? config_path : nil
-          ActiveRecordDoctor.load_config_with_defaults(path)
+        @config ||=
+          ActiveRecordDoctor.load_config_with_defaults(effective_config_path)
+      end
+
+      def effective_config_path
+        if config_path.nil?
+          # No explicit config_path was set, so we're trying to use defaults.
+          legacy_default_path = Rails.root.join(".active_record_doctor")
+          new_default_path = Rails.root.join(".active_record_doctor.rb")
+
+          # First, if the legacy file exists we'll use it but show a warning.
+          if legacy_default_path.exist?
+            warn(<<~WARN.squish)
+              DEPRECATION WARNING: active_record_doctor is using the default
+              configuration file located in #{legacy_default_path.basename}. However,
+              that default will change to #{new_default_path.basename} in the future.
+
+              In order to avoid errors, please rename the file from
+              #{legacy_default_path.basename} to #{new_default_path.basename}.
+            WARN
+
+            return legacy_default_path
+          end
+
+          # Second, if the legacy file does NOT exist, but the new one does then
+          # we'll use that.
+          if new_default_path.exist?
+            return new_default_path
+          end
+
+          # Otherwise, there's no configuration file in use.
+          nil
+        else
+          # If an explicit configuration file was set then we use it as is.
+          config_path
         end
       end
 

data/lib/active_record_doctor/version.rb

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

data/lib/tasks/active_record_doctor.rake

@@ -19,6 +19,5 @@ ActiveRecordDoctor::Rake::Task.new do |task|
   # This file is imported when active_record_doctor is being used as part of a
   # Rails app so it's the right place for all Rails-specific settings.
   task.deps = [:environment]
-  task.config_path = Rails.root.join(".active_record_doctor")
   task.setup = -> { Rails.application.eager_load! }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord