[rail_inspector] Add test for FrameworkDefault

Now that its tested, its much easier to refactor with confidence

Author: skipkayhil

tools/rail_inspector/lib/rail_inspector/configuring.rb

@@ -64,7 +64,14 @@ def initialize(rails_path)
     def check
       [
         Check::GeneralConfiguration.new(self),
-        Check::FrameworkDefaults.new(self),
+        Check::FrameworkDefaults.new(
+          self,
+          framework_defaults_by_version,
+          doc
+            .versioned_defaults
+            .slice_before { |line| line.start_with?("####") }
+            .to_a,
+        ),
         Check::NewFrameworkDefaultsFile.new(
           self,
           framework_defaults_by_version[rails_version].keys,
@@ -77,12 +84,6 @@ 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
@@ -98,5 +99,12 @@ def error_message
         "Make sure new configurations are added to configuring.md#rails-general-configuration in alphabetical order.\n" +
         "Errors may be autocorrectable with the --autocorrect flag"
     end
+
+    private
+      def framework_defaults_by_version
+        @framework_defaults_by_version ||= Visitor::FrameworkDefault.new.tap { |visitor|
+          visitor.visit(files.application_configuration.parse)
+        }.config_map
+      end
   end
 end

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

@@ -8,12 +8,14 @@ module Check
       class FrameworkDefaults
         attr_reader :checker
 
-        def initialize(checker)
+        def initialize(checker, defaults_by_version, documented_defaults)
           @checker = checker
+          @defaults_by_version = defaults_by_version
+          @documented_defaults = documented_defaults
         end
 
         def check
-          header, *defaults_by_version = documented_defaults
+          header, *defaults_by_version = @documented_defaults
 
           checker.doc.versioned_defaults =
             header +
@@ -30,7 +32,7 @@ def check_defaults(defaults)
             version = header.match(/\d\.\d/)[0]
 
             generated_doc =
-              checker.framework_defaults_by_version[version]
+              @defaults_by_version[version]
                 .map do |config, value|
                   full_config =
                     case config
@@ -68,14 +70,6 @@ def check_defaults(defaults)
 
             [header, "", *generated_doc, ""]
           end
-
-          def documented_defaults
-            checker
-              .doc
-              .versioned_defaults
-              .slice_before { |line| line.start_with?("####") }
-              .to_a
-          end
       end
     end
   end

tools/rail_inspector/test/rail_inspector/configuring/check/framework_defaults_test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "rail_inspector/configuring"
+
+class FrameworkDefaultsTest < ActiveSupport::TestCase
+  def test_identifies_self_when_file_uses_config
+    defaults = {
+      "8.0" => {
+        "action_dispatch.strict_freshness" => "true",
+        "Regexp.timeout" => "1"
+      },
+      "8.1" => {
+        "self.yjit" => "!Rails.env.local?",
+        "action_controller.escape_json_responses" => "false",
+      }
+    }
+
+    doc = [
+      ["### Versioned Default Values"],
+      [
+        "#### Default Values for Target Version 8.1",
+        "",
+        "- [`config.action_controller.escape_json_responses`](#config-action-controller-escape-json-responses): `false`",
+        "- [`config.yjit`](#config-yjit): `!Rails.env.local?`",
+        "",
+      ],
+      [
+        "#### Default Values for Target Version 8.0",
+        "",
+        "- [`Regexp.timeout`](#regexp-timeout): `1`",
+        "- [`config.action_dispatch.strict_freshness`](#config-action-dispatch-strict-freshness): `true`",
+        "",
+      ],
+    ]
+
+    check(defaults, doc).check
+
+    assert_empty checker.errors
+  end
+
+  private
+    def check(defaults, doc)
+      @check ||= RailInspector::Configuring::Check::FrameworkDefaults.new(checker, defaults, doc)
+    end
+
+    def checker
+      @checker ||= RailInspector::Configuring.new("../..")
+    end
+end