railties 5.2.4.1 → 6.0.1

data/lib/rails/generators/rails/plugin/templates/app/controllers/%namespaced_name%/application_controller.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   class ApplicationController < ActionController::#{api? ? "API" : "Base"}
     #{ api? ? '# ' : '' }protect_from_forgery with: :exception
   end

data/lib/rails/generators/rails/plugin/templates/app/helpers/%namespaced_name%/application_helper.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   module ApplicationHelper
   end
 rb

data/lib/rails/generators/rails/plugin/templates/app/jobs/%namespaced_name%/application_job.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   class ApplicationJob < ActiveJob::Base
   end
 rb

data/lib/rails/generators/rails/plugin/templates/app/mailers/%namespaced_name%/application_mailer.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   class ApplicationMailer < ActionMailer::Base
     default from: 'from@example.com'
     layout 'mailer'

data/lib/rails/generators/rails/plugin/templates/app/models/%namespaced_name%/application_record.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
   end

data/lib/rails/generators/rails/plugin/templates/gitignore.tt

@@ -5,9 +5,10 @@ pkg/
 <% if sqlite3? -%>
 <%= dummy_path %>/db/*.sqlite3
 <%= dummy_path %>/db/*.sqlite3-journal
+<%= dummy_path %>/db/*.sqlite3-*
 <% end -%>
 <%= dummy_path %>/log/*.log
-<% unless options[:skip_yarn] -%>
+<% unless options[:skip_javascript] -%>
 <%= dummy_path %>/node_modules/
 <%= dummy_path %>/yarn-error.log
 <% end -%>

data/lib/rails/generators/rails/plugin/templates/lib/%namespaced_name%/engine.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   class Engine < ::Rails::Engine
   #{mountable? ? '  isolate_namespace ' + camelized_modules : ' '}
   #{api? ? "  config.generators.api_only = true" : ' '}

data/lib/rails/generators/rails/plugin/templates/lib/%namespaced_name%/railtie.rb.tt

@@ -1,4 +1,4 @@
-<%= wrap_in_modules <<-rb.strip_heredoc
+<%= wrap_in_modules <<~rb
   class Railtie < ::Rails::Railtie
   end
 rb

data/lib/rails/generators/rails/plugin/templates/test/test_helper.rb.tt

@@ -10,8 +10,7 @@ ActiveRecord::Migrator.migrations_paths << File.expand_path('../db/migrate', __d
 <% end -%>
 require "rails/test_help"
 
-# Filter out Minitest backtrace while allowing backtrace from other libraries
-# to be shown.
+# Filter out the backtrace from minitest while preserving the one from other libraries.
 Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
 <% unless engine? -%>

data/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

@@ -32,6 +32,20 @@ module Rails
       hook_for :helper, as: :scaffold do |invoked|
         invoke invoked, [ controller_name ]
       end
+
+      private
+
+        def permitted_params
+          attachments, others = attributes_names.partition { |name| attachments?(name) }
+          params = others.map { |name| ":#{name}" }
+          params += attachments.map { |name| "#{name}: []" }
+          params.join(", ")
+        end
+
+        def attachments?(name)
+          attribute = attributes.find { |attr| attr.name == name }
+          attribute&.attachments?
+        end
     end
   end
 end

data/lib/rails/generators/rails/scaffold_controller/templates/api_controller.rb.tt

@@ -54,7 +54,7 @@ class <%= controller_class_name %>Controller < ApplicationController
       <%- if attributes_names.empty? -%>
       params.fetch(:<%= singular_table_name %>, {})
       <%- else -%>
-      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
       <%- end -%>
     end
 end

data/lib/rails/generators/rails/scaffold_controller/templates/controller.rb.tt

@@ -61,7 +61,7 @@ class <%= controller_class_name %>Controller < ApplicationController
       <%- if attributes_names.empty? -%>
       params.fetch(:<%= singular_table_name %>, {})
       <%- else -%>
-      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
       <%- end -%>
     end
 end

data/lib/rails/generators/resource_helpers.rb

@@ -25,13 +25,8 @@ module Rails
         assign_controller_names!(controller_name.pluralize)
       end
 
-      # TODO Change this to private once we've dropped Ruby 2.2 support.
-      # Workaround for Ruby 2.2 "private attribute?" warning.
-      protected
-
-        attr_reader :controller_name, :controller_file_name
-
       private
+        attr_reader :controller_name, :controller_file_name
 
         def controller_class_path
           if options[:model_name]

data/lib/rails/generators/test_unit/integration/integration_generator.rb

@@ -10,6 +10,12 @@ module TestUnit # :nodoc:
       def create_test_files
         template "integration_test.rb", File.join("test/integration", class_path, "#{file_name}_test.rb")
       end
+
+      private
+
+        def file_name
+          @_file_name ||= super.sub(/_test\z/i, "")
+        end
     end
   end
 end

data/lib/rails/generators/test_unit/job/job_generator.rb

@@ -10,6 +10,11 @@ module TestUnit # :nodoc:
       def create_test_file
         template "unit_test.rb", File.join("test/jobs", class_path, "#{file_name}_job_test.rb")
       end
+
+      private
+        def file_name
+          @_file_name ||= super.sub(/_job\z/i, "")
+        end
     end
   end
 end

data/lib/rails/generators/test_unit/mailer/mailer_generator.rb

@@ -21,7 +21,7 @@ module TestUnit # :nodoc:
 
       private
         def file_name
-          @_file_name ||= super.gsub(/_mailer/i, "")
+          @_file_name ||= super.sub(/_mailer\z/i, "")
         end
     end
   end

data/lib/rails/generators/test_unit/model/templates/fixtures.yml.tt

@@ -1,4 +1,4 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 <% unless attributes.empty? -%>
 <% %w(one two).each do |name| %>
 <%= name %>:
@@ -7,7 +7,7 @@
   password_digest: <%%= BCrypt::Password.create('secret') %>
   <%- elsif attribute.reference? -%>
   <%= yaml_key_value(attribute.column_name.sub(/_id$/, ''), attribute.default || name) %>
-  <%- else -%>
+  <%- elsif !attribute.virtual? -%>
   <%= yaml_key_value(attribute.column_name, attribute.default) %>
   <%- end -%>
   <%- if attribute.polymorphic? -%>

data/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb

@@ -49,15 +49,20 @@ module TestUnit # :nodoc:
           attributes_names.map do |name|
             if %w(password password_confirmation).include?(name) && attributes.any?(&:password_digest?)
               ["#{name}", "'secret'"]
-            else
+            elsif !virtual?(name)
               ["#{name}", "@#{singular_table_name}.#{name}"]
             end
-          end.sort.to_h
+          end.compact.sort.to_h
         end
 
         def boolean?(name)
           attribute = attributes.find { |attr| attr.name == name }
-          attribute && attribute.type == :boolean
+          attribute&.type == :boolean
+        end
+
+        def virtual?(name)
+          attribute = attributes.find { |attr| attr.name == name }
+          attribute&.virtual?
         end
     end
   end

data/lib/rails/generators/test_unit/system/system_generator.rb

@@ -14,6 +14,11 @@ module TestUnit # :nodoc:
 
         template "system_test.rb", File.join("test/system", class_path, "#{file_name.pluralize}_test.rb")
       end
+
+      private
+        def file_name
+          @_file_name ||= super.sub(/_test\z/i, "")
+        end
     end
   end
 end

data/lib/rails/generators/testing/behaviour.rb

@@ -67,6 +67,9 @@ module Rails
         def run_generator(args = default_arguments, config = {})
           capture(:stdout) do
             args += ["--skip-bundle"] unless args.include? "--dev"
+            args |= ["--skip-bootsnap"] unless args.include? "--no-skip-bootsnap"
+            args |= ["--skip-webpack-install"] unless args.include? "--no-skip-webpack-install"
+
             generator_class.start(args, config.reverse_merge(destination_root: destination_root))
           end
         end

data/lib/rails/info.rb

@@ -41,7 +41,7 @@ module Rails
       alias inspect to_s
 
       def to_html
-        "<table>".dup.tap do |table|
+        (+"<table>").tap do |table|
           properties.each do |(name, value)|
             table << %(<tr><td class="name">#{CGI.escapeHTML(name.to_s)}</td>)
             formatted_value = if value.kind_of?(Array)
@@ -63,12 +63,12 @@ module Rails
 
     # The Ruby version and platform, e.g. "2.0.0-p247 (x86_64-darwin12.4.0)".
     property "Ruby version" do
-      "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})"
+      RUBY_DESCRIPTION
     end
 
     # The RubyGems version, if it's installed.
     property "RubyGems version" do
-      Gem::RubyGemsVersion
+      Gem::VERSION
     end
 
     property "Rack version" do

data/lib/rails/info_controller.rb

@@ -4,7 +4,7 @@ require "rails/application_controller"
 require "action_dispatch/routing/inspector"
 
 class Rails::InfoController < Rails::ApplicationController # :nodoc:
-  prepend_view_path ActionDispatch::DebugExceptions::RESCUES_TEMPLATE_PATH
+  prepend_view_path ActionDispatch::DebugView::RESCUES_TEMPLATE_PATH
   layout -> { request.xhr? ? false : "application" }
 
   before_action :require_local!

data/lib/rails/mailers_controller.rb

@@ -3,10 +3,11 @@
 require "rails/application_controller"
 
 class Rails::MailersController < Rails::ApplicationController # :nodoc:
-  prepend_view_path ActionDispatch::DebugExceptions::RESCUES_TEMPLATE_PATH
+  prepend_view_path ActionDispatch::DebugView::RESCUES_TEMPLATE_PATH
 
+  around_action :set_locale, only: :preview
+  before_action :find_preview, only: :preview
   before_action :require_local!, unless: :show_previews?
-  before_action :find_preview, :set_locale, only: :preview
 
   helper_method :part_query, :locale_query
 
@@ -38,7 +39,7 @@ class Rails::MailersController < Rails::ApplicationController # :nodoc:
           end
         else
           @part = find_preferred_part(request.format, Mime[:html], Mime[:text])
-          render action: "email", layout: false, formats: %w[html]
+          render action: "email", layout: false, formats: [:html]
         end
       else
         raise AbstractController::ActionNotFound, "Email '#{@email_action}' not found in #{@preview.name}"
@@ -92,6 +93,8 @@ class Rails::MailersController < Rails::ApplicationController # :nodoc:
     end
 
     def set_locale
-      I18n.locale = params[:locale] || I18n.default_locale
+      I18n.with_locale(params[:locale] || I18n.default_locale) do
+        yield
+      end
     end
 end

data/lib/rails/paths.rb

@@ -113,10 +113,11 @@ module Rails
       attr_accessor :glob
 
       def initialize(root, current, paths, options = {})
-        @paths    = paths
-        @current  = current
-        @root     = root
-        @glob     = options[:glob]
+        @paths   = paths
+        @current = current
+        @root    = root
+        @glob    = options[:glob]
+        @exclude = options[:exclude]
 
         options[:autoload_once] ? autoload_once! : skip_autoload_once!
         options[:eager_load]    ? eager_load!    : skip_eager_load!
@@ -189,13 +190,11 @@ module Rails
         raise "You need to set a path root" unless @root.path
         result = []
 
-        each do |p|
-          path = File.expand_path(p, @root.path)
+        each do |path|
+          path = File.expand_path(path, @root.path)
 
           if @glob && File.directory?(path)
-            Dir.chdir(path) do
-              result.concat(Dir.glob(@glob).map { |file| File.join path, file }.sort)
-            end
+            result.concat files_in(path)
           else
             result << path
           end
@@ -222,6 +221,17 @@ module Rails
       end
 
       alias to_a expanded
+
+      private
+
+        def files_in(path)
+          Dir.chdir(path) do
+            files = Dir.glob(@glob)
+            files -= @exclude if @exclude
+            files.map! { |file| File.join(path, file) }
+            files.sort
+          end
+        end
     end
   end
 end

data/lib/rails/railtie.rb

@@ -224,7 +224,7 @@ module Rails
     end
 
     def railtie_namespace #:nodoc:
-      @railtie_namespace ||= self.class.parents.detect { |n| n.respond_to?(:railtie_namespace) }
+      @railtie_namespace ||= self.class.module_parents.detect { |n| n.respond_to?(:railtie_namespace) }
     end
 
     protected

data/lib/rails/ruby_version_check.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2") && RUBY_ENGINE == "ruby"
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5.0") && RUBY_ENGINE == "ruby"
   desc = defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : "ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE})"
   abort <<-end_message
 
-    Rails 5 requires Ruby 2.2.2 or newer.
+    Rails 6 requires Ruby 2.5.0 or newer.
 
     You're running
       #{desc}
 
-    Please upgrade to Ruby 2.2.2 or newer to continue.
+    Please upgrade to Ruby 2.5.0 or newer to continue.
 
   end_message
 end

data/lib/rails/secrets.rb

@@ -2,7 +2,6 @@
 
 require "yaml"
 require "active_support/message_encryptor"
-require "active_support/core_ext/string/strip"
 
 module Rails
   # Greatly inspired by Ara T. Howard's magnificent sekrets gem. 😘

data/lib/rails/source_annotation_extractor.rb

@@ -1,141 +1,162 @@
 # frozen_string_literal: true
 
-# Implements the logic behind the rake tasks for annotations like
-#
-#   rails notes
-#   rails notes:optimize
-#
-# and friends. See <tt>rails -T notes</tt> and <tt>railties/lib/rails/tasks/annotations.rake</tt>.
-#
-# Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
-# represent the line where the annotation lives, its tag, and its text. Note
-# the filename is not stored.
-#
-# Annotations are looked for in comments and modulus whitespace they have to
-# start with the tag optionally followed by a colon. Everything up to the end
-# of the line (or closing ERB comment tag) is considered to be their text.
-class SourceAnnotationExtractor
-  Annotation = Struct.new(:line, :tag, :text) do
-    def self.directories
-      @@directories ||= %w(app config db lib test) + (ENV["SOURCE_ANNOTATION_DIRECTORIES"] || "").split(",")
-    end
+require "active_support/deprecation"
 
-    # Registers additional directories to be included
-    #   SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
-    def self.register_directories(*dirs)
-      directories.push(*dirs)
-    end
+module Rails
+  # Implements the logic behind <tt>Rails::Command::NotesCommand</tt>. See <tt>rails notes --help</tt> for usage information.
+  #
+  # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
+  # represent the line where the annotation lives, its tag, and its text. Note
+  # the filename is not stored.
+  #
+  # Annotations are looked for in comments and modulus whitespace they have to
+  # start with the tag optionally followed by a colon. Everything up to the end
+  # of the line (or closing ERB comment tag) is considered to be their text.
+  class SourceAnnotationExtractor
+    class Annotation < Struct.new(:line, :tag, :text)
+      def self.directories
+        @@directories ||= %w(app config db lib test)
+      end
 
-    def self.extensions
-      @@extensions ||= {}
-    end
+      # Registers additional directories to be included
+      #   Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
+      def self.register_directories(*dirs)
+        directories.push(*dirs)
+      end
 
-    # Registers new Annotations File Extensions
-    #   SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
-    def self.register_extensions(*exts, &block)
-      extensions[/\.(#{exts.join("|")})$/] = block
-    end
+      def self.tags
+        @@tags ||= %w(OPTIMIZE FIXME TODO)
+      end
 
-    register_extensions("builder", "rb", "rake", "yml", "yaml", "ruby") { |tag| /#\s*(#{tag}):?\s*(.*)$/ }
-    register_extensions("css", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
-    register_extensions("erb") { |tag| /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/ }
+      # Registers additional tags
+      #   Rails::SourceAnnotationExtractor::Annotation.register_tags("TESTME", "DEPRECATEME")
+      def self.register_tags(*additional_tags)
+        tags.push(*additional_tags)
+      end
+
+      def self.extensions
+        @@extensions ||= {}
+      end
 
-    # Returns a representation of the annotation that looks like this:
+      # Registers new Annotations File Extensions
+      #   Rails::SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
+      def self.register_extensions(*exts, &block)
+        extensions[/\.(#{exts.join("|")})$/] = block
+      end
+
+      register_extensions("builder", "rb", "rake", "yml", "yaml", "ruby") { |tag| /#\s*(#{tag}):?\s*(.*)$/ }
+      register_extensions("css", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
+      register_extensions("erb") { |tag| /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/ }
+
+      # Returns a representation of the annotation that looks like this:
+      #
+      #   [126] [TODO] This algorithm is simple and clearly correct, make it faster.
+      #
+      # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above.
+      # Otherwise the string contains just line and text.
+      def to_s(options = {})
+        s = +"[#{line.to_s.rjust(options[:indent])}] "
+        s << "[#{tag}] " if options[:tag]
+        s << text
+      end
+
+      # Used in annotations.rake
+      #:nodoc:
+      def self.notes_task_deprecation_warning
+        ActiveSupport::Deprecation.warn("This rake task is deprecated and will be removed in Rails 6.1. \nRefer to `rails notes --help` for more information.\n")
+        puts "\n"
+      end
+    end
+
+    # Prints all annotations with tag +tag+ under the root directories +app+,
+    # +config+, +db+, +lib+, and +test+ (recursively).
+    #
+    # If +tag+ is <tt>nil</tt>, annotations with either default or registered tags are printed.
+    #
+    # Specific directories can be explicitly set using the <tt>:dirs</tt> key in +options+.
+    #
+    #   Rails::SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true
+    #
+    # If +options+ has a <tt>:tag</tt> flag, it will be passed to each annotation's +to_s+.
     #
-    #   [126] [TODO] This algorithm is simple and clearly correct, make it faster.
+    # See <tt>#find_in</tt> for a list of file extensions that will be taken into account.
     #
-    # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above.
-    # Otherwise the string contains just line and text.
-    def to_s(options = {})
-      s = "[#{line.to_s.rjust(options[:indent])}] ".dup
-      s << "[#{tag}] " if options[:tag]
-      s << text
+    # This class method is the single entry point for the `rails notes` command.
+    def self.enumerate(tag = nil, options = {})
+      tag ||= Annotation.tags.join("|")
+      extractor = new(tag)
+      dirs = options.delete(:dirs) || Annotation.directories
+      extractor.display(extractor.find(dirs), options)
     end
-  end
 
-  # Prints all annotations with tag +tag+ under the root directories +app+,
-  # +config+, +db+, +lib+, and +test+ (recursively).
-  #
-  # Additional directories may be added using a comma-delimited list set using
-  # <tt>ENV['SOURCE_ANNOTATION_DIRECTORIES']</tt>.
-  #
-  # Directories may also be explicitly set using the <tt>:dirs</tt> key in +options+.
-  #
-  #   SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true
-  #
-  # If +options+ has a <tt>:tag</tt> flag, it will be passed to each annotation's +to_s+.
-  #
-  # See <tt>#find_in</tt> for a list of file extensions that will be taken into account.
-  #
-  # This class method is the single entry point for the rake tasks.
-  def self.enumerate(tag, options = {})
-    extractor = new(tag)
-    dirs = options.delete(:dirs) || Annotation.directories
-    extractor.display(extractor.find(dirs), options)
-  end
-
-  attr_reader :tag
-
-  def initialize(tag)
-    @tag = tag
-  end
+    attr_reader :tag
 
-  # Returns a hash that maps filenames under +dirs+ (recursively) to arrays
-  # with their annotations.
-  def find(dirs)
-    dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
-  end
+    def initialize(tag)
+      @tag = tag
+    end
 
-  # Returns a hash that maps filenames under +dir+ (recursively) to arrays
-  # with their annotations. Only files with annotations are included. Files
-  # with extension +.builder+, +.rb+, +.rake+, +.yml+, +.yaml+, +.ruby+,
-  # +.css+, +.js+ and +.erb+ are taken into account.
-  def find_in(dir)
-    results = {}
-
-    Dir.glob("#{dir}/*") do |item|
-      next if File.basename(item)[0] == ?.
-
-      if File.directory?(item)
-        results.update(find_in(item))
-      else
-        extension = Annotation.extensions.detect do |regexp, _block|
-          regexp.match(item)
-        end
+    # Returns a hash that maps filenames under +dirs+ (recursively) to arrays
+    # with their annotations.
+    def find(dirs)
+      dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
+    end
 
-        if extension
-          pattern = extension.last.call(tag)
-          results.update(extract_annotations_from(item, pattern)) if pattern
+    # Returns a hash that maps filenames under +dir+ (recursively) to arrays
+    # with their annotations. Files with extensions registered in
+    # <tt>Rails::SourceAnnotationExtractor::Annotation.extensions</tt> are
+    # taken into account. Only files with annotations are included.
+    def find_in(dir)
+      results = {}
+
+      Dir.glob("#{dir}/*") do |item|
+        next if File.basename(item)[0] == ?.
+
+        if File.directory?(item)
+          results.update(find_in(item))
+        else
+          extension = Annotation.extensions.detect do |regexp, _block|
+            regexp.match(item)
+          end
+
+          if extension
+            pattern = extension.last.call(tag)
+            results.update(extract_annotations_from(item, pattern)) if pattern
+          end
         end
       end
-    end
 
-    results
-  end
+      results
+    end
 
-  # If +file+ is the filename of a file that contains annotations this method returns
-  # a hash with a single entry that maps +file+ to an array of its annotations.
-  # Otherwise it returns an empty hash.
-  def extract_annotations_from(file, pattern)
-    lineno = 0
-    result = File.readlines(file, encoding: Encoding::BINARY).inject([]) do |list, line|
-      lineno += 1
-      next list unless line =~ pattern
-      list << Annotation.new(lineno, $1, $2)
+    # If +file+ is the filename of a file that contains annotations this method returns
+    # a hash with a single entry that maps +file+ to an array of its annotations.
+    # Otherwise it returns an empty hash.
+    def extract_annotations_from(file, pattern)
+      lineno = 0
+      result = File.readlines(file, encoding: Encoding::BINARY).inject([]) do |list, line|
+        lineno += 1
+        next list unless line =~ pattern
+        list << Annotation.new(lineno, $1, $2)
+      end
+      result.empty? ? {} : { file => result }
     end
-    result.empty? ? {} : { file => result }
-  end
 
-  # Prints the mapping from filenames to annotations in +results+ ordered by filename.
-  # The +options+ hash is passed to each annotation's +to_s+.
-  def display(results, options = {})
-    options[:indent] = results.flat_map { |f, a| a.map(&:line) }.max.to_s.size
-    results.keys.sort.each do |file|
-      puts "#{file}:"
-      results[file].each do |note|
-        puts "  * #{note.to_s(options)}"
+    # Prints the mapping from filenames to annotations in +results+ ordered by filename.
+    # The +options+ hash is passed to each annotation's +to_s+.
+    def display(results, options = {})
+      options[:indent] = results.flat_map { |f, a| a.map(&:line) }.max.to_s.size
+      results.keys.sort.each do |file|
+        puts "#{file}:"
+        results[file].each do |note|
+          puts "  * #{note.to_s(options)}"
+        end
+        puts
       end
-      puts
     end
   end
 end
+
+# Remove this deprecated class in the next minor version
+#:nodoc:
+SourceAnnotationExtractor = ActiveSupport::Deprecation::DeprecatedConstantProxy.
+  new("SourceAnnotationExtractor", "Rails::SourceAnnotationExtractor")