Merge pull request rails#55450 from skipkayhil/hm-zzrsyxvtowtwrrym

[rail_inspector] Fix linting defaults post-release

Author: rafaelfranca

tools/rail_inspector/lib/rail_inspector/configuring.rb

@@ -3,6 +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
@@ -43,29 +46,6 @@ def method_missing(name, ...)
       end
     end
 
-    class Doc
-      attr_accessor :general_config, :versioned_defaults
-
-      def initialize(content)
-        @before, @versioned_defaults, @general_config, @after =
-          content
-            .split("\n")
-            .slice_before do |line|
-              [
-                "### Versioned Default Values",
-                "### Rails General Configuration",
-                "### Configuring Assets"
-              ].include?(line)
-            end
-            .to_a
-      end
-
-      def to_s
-        (@before + @versioned_defaults + @general_config + @after).join("\n") +
-          "\n"
-      end
-    end
-
     attr_reader :errors, :files
 
     def initialize(rails_path)
@@ -82,13 +62,23 @@ 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,
+          framework_defaults_by_version,
+          doc.versioned_defaults,
+        ),
+        Check::NewFrameworkDefaultsFile.new(
+          self,
+          framework_defaults_by_version[rails_version].keys,
+          files.new_framework_defaults.read
+        ),
+      ].each(&:check)
     end
 
     def doc
-      @doc ||= Configuring::Doc.new(files.doc_path.read)
+      @doc ||= Configuring::Document.parse(files.doc_path.read)
     end
 
     def rails_version
@@ -106,5 +96,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

@@ -1,133 +1,67 @@
 # 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)
+        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
-
-          NewFrameworkDefaultsFile.new(
-            checker,
-            visitor.config_map[checker.rails_version].keys,
-            checker.files.new_framework_defaults.read
-          ).check
+          expected_text = +""
 
-          checker.doc.versioned_defaults =
-            header +
-              defaults_by_version
-                .map { |defaults| check_defaults(defaults) }
-                .flatten
-        end
+          expected_text =
+            @defaults_by_version.reverse_each.map { |version, defaults|
+              expected_text = +"#### Default Values for Target Version #{version}\n"
 
-        private
-          def app_config_tree
-            checker.files.application_configuration.parse
-          end
+              expected_text << "\n" unless defaults.empty?
 
-          def check_defaults(defaults)
-            header, configs = defaults[0], defaults[2, defaults.length - 3]
-            configs ||= []
+              defaults.map { |config, value|
+                full_config =
+                  case config
+                  when /^[A-Z]/
+                    config
+                  when /^self/
+                    config.sub("self", "config")
+                  else
+                    "config.#{config}"
+                  end
 
-            version = header.match(/\d\.\d/)[0]
+                "- [`#{full_config}`](##{full_config.tr("._", "-").downcase}): `#{value}`\n"
+              }.sort.each { |t| expected_text << t }
 
-            generated_doc =
-              visitor.config_map[version]
-                .map do |config, value|
-                  full_config =
-                    case config
-                    when /^[A-Z]/
-                      config
-                    when /^self/
-                      config.sub("self", "config")
-                    else
-                      "config.#{config}"
-                    end
+              expected_text
+            }.join("\n")
 
-                  "- [`#{full_config}`](##{full_config.tr("._", "-").downcase}): `#{value}`"
-                end
-                .sort
+          config_diff =
+            Tempfile.create("expected") do |doc|
+              doc << expected_text
+              doc.flush
 
-            config_diff =
-              Tempfile.create("expected") do |doc|
-                doc << generated_doc.join("\n")
-                doc.flush
+              Tempfile.create("actual") do |code|
+                code << @documented_defaults
+                code.flush
 
-                Tempfile.create("actual") do |code|
-                  code << configs.join("\n")
-                  code.flush
-
-                  `git diff --color --no-index #{doc.path} #{code.path}`
-                end
+                `git diff --color --no-index #{doc.path} #{code.path}`
               end
+            end
 
-            checker.errors << <<~MESSAGE unless config_diff.empty?
-              #{checker.files.application_configuration}: Incorrect load_defaults docs
-              --- Expected
-              +++ Actual
-              #{config_diff.split("\n")[5..].join("\n")}
-            MESSAGE
-
-            [header, "", *generated_doc, ""]
-          end
-
-          def documented_defaults
-            checker
-              .doc
-              .versioned_defaults
-              .slice_before { |line| line.start_with?("####") }
-              .to_a
-          end
+          checker.errors << <<~MESSAGE unless config_diff.empty?
+            #{checker.files.application_configuration}: Incorrect load_defaults docs
+            --- Expected
+            +++ Actual
+            #{config_diff.split("\n")[5..].join("\n")}
+          MESSAGE
 
-          def visitor
-            @visitor ||=
-              begin
-                visitor = Visitor::FrameworkDefault.new
-                visitor.visit(app_config_tree)
-                visitor
-              end
-          end
+          checker.doc.versioned_defaults = expected_text
+        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/lib/rail_inspector/configuring/document.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RailInspector
+  class Configuring
+    class Document
+      class << self
+        def parse(text)
+          before, *versioned_defaults, general_config, after =
+            text
+              .split("\n")
+              .slice_before do |line|
+                [
+                  "#### Default Values for Target Version",
+                  "### Rails General Configuration",
+                  "### Configuring Assets"
+                ].any? { |s| line.start_with?(s) }
+              end
+              .to_a
+
+          new(before, versioned_defaults.flatten.join("\n"), general_config, after)
+        end
+      end
+
+      attr_accessor :general_config, :versioned_defaults
+
+      def initialize(before, versioned_defaults, general_config, after)
+        @before, @versioned_defaults, @general_config, @after =
+          before, versioned_defaults, general_config, after
+      end
+
+      def to_s
+        (@before + [@versioned_defaults] + @general_config + @after).join("\n") +
+          "\n"
+      end
+    end
+  end
+end