[rail_inspector] Extract NewFrameworkDefaultsFile

To make it easier to change what gets passed to the FrameworkDefaults
check.

Author: skipkayhil

tools/rail_inspector/lib/rail_inspector/configuring.rb

@@ -3,7 +3,9 @@
 require "pathname"
 require_relative "./configuring/check/general_configuration"
 require_relative "./configuring/check/framework_defaults"
+require_relative "./configuring/check/new_framework_defaults_file"
 require_relative "./configuring/document"
+require_relative "./visitor/framework_default"
 
 module RailInspector
   class Configuring
@@ -60,15 +62,27 @@ def initialize(rails_path)
     end
 
     def check
-      [Check::GeneralConfiguration, Check::FrameworkDefaults].each do |check|
-        check.new(self).check
-      end
+      [
+        Check::GeneralConfiguration.new(self),
+        Check::FrameworkDefaults.new(self),
+        Check::NewFrameworkDefaultsFile.new(
+          self,
+          framework_defaults_by_version[rails_version].keys,
+          files.new_framework_defaults.read
+        ),
+      ].each(&:check)
     end
 
     def doc
       @doc ||= Configuring::Document.parse(files.doc_path.read)
     end
 
+    def framework_defaults_by_version
+      @framework_defaults_by_version ||= Visitor::FrameworkDefault.new.tap { |visitor|
+        visitor.visit(files.application_configuration.parse)
+      }.config_map
+    end
+
     def rails_version
       @rails_version ||= files.rails_version.read.to_f.to_s
     end

tools/rail_inspector/lib/rail_inspector/configuring/check/framework_defaults.rb

@@ -1,44 +1,11 @@
 # frozen_string_literal: true
 
 require "tempfile"
-require_relative "../../visitor/framework_default"
 
 module RailInspector
   class Configuring
     module Check
       class FrameworkDefaults
-        class NewFrameworkDefaultsFile
-          attr_reader :checker, :visitor
-
-          # Defaults are strings like:
-          #   self.yjit
-          #   action_controller.escape_json_responses
-          def initialize(checker, defaults, file_content)
-            @checker = checker
-            @defaults = defaults
-            @file_content = file_content
-          end
-
-          def check
-            @defaults.each do |config|
-              if config.start_with? "self"
-                next if @file_content.include? config.gsub(/^self/, "config")
-                next if @file_content.include? config.gsub(/^self/, "configuration")
-              end
-
-              next if @file_content.include? config
-
-              next if config == "self.yjit"
-
-              checker.errors << <<~MESSAGE
-                #{checker.files.new_framework_defaults}: Missing new default
-                #{config}
-
-              MESSAGE
-            end
-          end
-        end
-
         attr_reader :checker
 
         def initialize(checker)
@@ -48,12 +15,6 @@ def initialize(checker)
         def check
           header, *defaults_by_version = documented_defaults
 
-          NewFrameworkDefaultsFile.new(
-            checker,
-            visitor.config_map[checker.rails_version].keys,
-            checker.files.new_framework_defaults.read
-          ).check
-
           checker.doc.versioned_defaults =
             header +
               defaults_by_version
@@ -62,18 +23,14 @@ def check
         end
 
         private
-          def app_config_tree
-            checker.files.application_configuration.parse
-          end
-
           def check_defaults(defaults)
             header, configs = defaults[0], defaults[2, defaults.length - 3]
             configs ||= []
 
             version = header.match(/\d\.\d/)[0]
 
             generated_doc =
-              visitor.config_map[version]
+              checker.framework_defaults_by_version[version]
                 .map do |config, value|
                   full_config =
                     case config
@@ -119,15 +76,6 @@ def documented_defaults
               .slice_before { |line| line.start_with?("####") }
               .to_a
           end
-
-          def visitor
-            @visitor ||=
-              begin
-                visitor = Visitor::FrameworkDefault.new
-                visitor.visit(app_config_tree)
-                visitor
-              end
-          end
       end
     end
   end

tools/rail_inspector/lib/rail_inspector/configuring/check/new_framework_defaults_file.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RailInspector
+  class Configuring
+    module Check
+      class NewFrameworkDefaultsFile
+        attr_reader :checker, :visitor
+
+        # Defaults are strings like:
+        #   self.yjit
+        #   action_controller.escape_json_responses
+        def initialize(checker, defaults, file_content)
+          @checker = checker
+          @defaults = defaults
+          @file_content = file_content
+        end
+
+        def check
+          @defaults.each do |config|
+            if config.start_with? "self"
+              next if @file_content.include? config.gsub(/^self/, "config")
+              next if @file_content.include? config.gsub(/^self/, "configuration")
+            end
+
+            next if @file_content.include? config
+
+            next if config == "self.yjit"
+
+            checker.errors << <<~MESSAGE
+              #{checker.files.new_framework_defaults}: Missing new default
+              #{config}
+
+            MESSAGE
+          end
+        end
+      end
+    end
+  end
+end

tools/rail_inspector/test/rail_inspector/configuring/check/framework_defaults_test.rb renamed to tools/rail_inspector/test/rail_inspector/configuring/check/new_framework_defaults_file_test.rb

@@ -3,7 +3,7 @@
 require "test_helper"
 require "rail_inspector/configuring"
 
-class TestFrameworkDefaults < ActiveSupport::TestCase
+class NewFrameworkDefaultsFileTest < ActiveSupport::TestCase
   def test_identifies_self_when_file_uses_config
     defaults = ["self.log_file_size"]
 
@@ -30,7 +30,7 @@ def test_identifies_self_when_file_uses_configuration
 
   private
     def check(defaults, file_content)
-      @check ||= RailInspector::Configuring::Check::FrameworkDefaults::NewFrameworkDefaultsFile.new(checker, defaults, file_content)
+      @check ||= RailInspector::Configuring::Check::NewFrameworkDefaultsFile.new(checker, defaults, file_content)
     end
 
     def checker