railties 5.2.0 → 6.1.0

data/lib/rails/paths.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 module Rails
   module Paths
     # This object is an extended hash that behaves as root of the <tt>Rails::Paths</tt> system.
@@ -98,7 +100,6 @@ module Rails
       end
 
     private
-
       def filter_by(&block)
         all_paths.find_all(&block).flat_map { |path|
           paths = path.existent
@@ -113,10 +114,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!
@@ -180,6 +182,14 @@ module Rails
         @paths
       end
 
+      def paths
+        raise "You need to set a path root" unless @root.path
+
+        map do |p|
+          Pathname.new(@root.path).join(p)
+        end
+      end
+
       def extensions # :nodoc:
         $1.split(",") if @glob =~ /\{([\S]+)\}/
       end
@@ -189,13 +199,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 +230,14 @@ module Rails
       end
 
       alias to_a expanded
+
+      private
+        def files_in(path)
+          files = Dir.glob(@glob, base: path)
+          files -= @exclude if @exclude
+          files.map! { |file| File.join(path, file) }
+          files.sort
+        end
     end
   end
 end

data/lib/rails/rack/logger.rb

@@ -30,14 +30,13 @@ module Rails
       end
 
       private
-
         def call_app(request, env) # :doc:
           instrumenter = ActiveSupport::Notifications.instrumenter
           instrumenter.start "request.action_dispatch", request: request
           logger.info { started_request_message(request) }
-          resp = @app.call(env)
-          resp[2] = ::Rack::BodyProxy.new(resp[2]) { finish(request) }
-          resp
+          status, headers, body = @app.call(env)
+          body = ::Rack::BodyProxy.new(body) { finish(request) }
+          [status, headers, body]
         rescue Exception
           finish(request)
           raise
@@ -48,9 +47,9 @@ module Rails
         # Started GET "/session/new" for 127.0.0.1 at 2012-09-26 14:51:42 -0700
         def started_request_message(request) # :doc:
           'Started %s "%s" for %s at %s' % [
-            request.request_method,
+            request.raw_request_method,
             request.filtered_path,
-            request.ip,
+            request.remote_ip,
             Time.now.to_default_s ]
         end
 

data/lib/rails/railtie/configurable.rb

@@ -27,7 +27,6 @@ module Rails
         end
 
         private
-
           def method_missing(*args, &block)
             instance.send(*args, &block)
           end

data/lib/rails/railtie/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rails/configuration"
+require "active_support/core_ext/symbol/starts_ends_with"
 
 module Rails
   class Railtie
@@ -87,10 +88,9 @@ module Rails
       end
 
     private
-
       def method_missing(name, *args, &blk)
-        if name.to_s =~ /=$/
-          @@options[$`.to_sym] = args.first
+        if name.end_with?("=")
+          @@options[:"#{name[0..-2]}"] = args.first
         elsif @@options.key?(name)
           @@options[name]
         else

data/lib/rails/railtie.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rails/initializable"
+require "active_support/descendants_tracker"
 require "active_support/inflector"
 require "active_support/core_ext/module/introspection"
 require "active_support/core_ext/module/delegation"
@@ -42,7 +43,7 @@ module Rails
   #   end
   #
   #   # lib/my_gem.rb
-  #   require 'my_gem/railtie' if defined?(Rails)
+  #   require "my_gem/railtie" if defined?(Rails::Railtie)
   #
   # == Initializers
   #
@@ -91,7 +92,7 @@ module Rails
   #
   #   class MyRailtie < Rails::Railtie
   #     rake_tasks do
-  #       load 'path/to/my_railtie.tasks'
+  #       load "path/to/my_railtie.tasks"
   #     end
   #   end
   #
@@ -101,13 +102,30 @@ module Rails
   #
   #   class MyRailtie < Rails::Railtie
   #     generators do
-  #       require 'path/to/my_railtie_generator'
+  #       require "path/to/my_railtie_generator"
   #     end
   #   end
   #
   # Since filenames on the load path are shared across gems, be sure that files you load
   # through a railtie have unique names.
   #
+  # == Run another program when the Rails server starts
+  #
+  # In development, it's very usual to have to run another process next to the Rails Server. In example
+  # you might want to start the Webpack or React server. Or maybe you need to run your job scheduler process
+  # like Sidekiq. This is usually done by opening a new shell and running the program from here.
+  #
+  # Rails allow you to specify a +server+ block which will get called when a Rails server starts.
+  # This way, your users don't need to remember to have to open a new shell and run another program, making
+  # this less confusing for everyone.
+  # It can be used like this:
+  #
+  # class MyRailtie < Rails::Railtie
+  #   server do
+  #     WebpackServer.start
+  #   end
+  # end
+  #
   # == Application and Engine
   #
   # An engine is nothing more than a railtie with some initializers already set. And since
@@ -118,6 +136,7 @@ module Rails
   class Railtie
     autoload :Configuration, "rails/railtie/configuration"
 
+    extend ActiveSupport::DescendantsTracker
     include Initializable
 
     ABSTRACT_RAILTIES = %w(Rails::Railtie Rails::Engine Rails::Application)
@@ -127,13 +146,7 @@ module Rails
       delegate :config, to: :instance
 
       def subclasses
-        @subclasses ||= []
-      end
-
-      def inherited(base)
-        unless base.abstract_railtie?
-          subclasses << base
-        end
+        super.reject(&:abstract_railtie?)
       end
 
       def rake_tasks(&blk)
@@ -152,6 +165,10 @@ module Rails
         register_block_for(:generators, &blk)
       end
 
+      def server(&blk)
+        register_block_for(:server, &blk)
+      end
+
       def abstract_railtie?
         ABSTRACT_RAILTIES.include?(name)
       end
@@ -192,6 +209,7 @@ module Rails
             super
           end
         end
+        ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
         # receives an instance variable identifier, set the variable value if is
         # blank and append given block to value, which will be used later in
@@ -224,11 +242,10 @@ 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
-
       def run_console_blocks(app) #:nodoc:
         each_registered_block(:console) { |block| block.call(app) }
       end
@@ -246,8 +263,11 @@ module Rails
         each_registered_block(:rake_tasks) { |block| instance_exec(app, &block) }
       end
 
-    private
+      def run_server_blocks(app) #:nodoc:
+        each_registered_block(:server) { |block| block.call(app) }
+      end
 
+    private
       # run `&block` in every registered block in `#register_block_for`
       def each_registered_block(type, &block)
         klass = self.class

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,148 @@
 # 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
+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
 
-    # Registers additional directories to be included
-    #   SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
-    def self.register_directories(*dirs)
-      directories.push(*dirs)
-    end
+      # Registers additional directories to be included
+      #   Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
+      def self.register_directories(*dirs)
+        directories.push(*dirs)
+      end
 
-    def self.extensions
-      @@extensions ||= {}
-    end
+      def self.tags
+        @@tags ||= %w(OPTIMIZE FIXME TODO)
+      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
+      # Registers additional tags
+      #   Rails::SourceAnnotationExtractor::Annotation.register_tags("TESTME", "DEPRECATEME")
+      def self.register_tags(*additional_tags)
+        tags.push(*additional_tags)
+      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*%>/ }
+      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
+    end
+
+    # Prints all annotations with tag +tag+ under the root directories +app+,
+    # +config+, +db+, +lib+, and +test+ (recursively).
     #
-    #   [126] [TODO] This algorithm is simple and clearly correct, make it faster.
+    # If +tag+ is <tt>nil</tt>, annotations with either default or registered tags are printed.
     #
-    # 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
+    # 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+.
+    #
+    # 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 `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).start_with?(".")
+
+        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

data/lib/rails/tasks/engine.rake

@@ -53,7 +53,7 @@ namespace :db do
   desc "Rolls the schema back to the previous version (specify steps w/ STEP=n)."
   app_task "rollback"
 
-  desc "Create a db/schema.rb file that can be portably used against any database supported by Active Record"
+  desc "Creates a database schema file (either db/schema.rb or db/structure.sql, depending on `config.active_record.schema_format`)"
   app_task "schema:dump"
 
   desc "Load a schema.rb file into the database"
@@ -65,9 +65,6 @@ namespace :db do
   desc "Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the database first)"
   app_task "setup"
 
-  desc "Dump the database structure to an SQL file"
-  app_task "structure:dump"
-
   desc "Retrieves the current schema version number"
   app_task "version"
 

data/lib/rails/tasks/framework.rake

@@ -2,13 +2,13 @@
 
 namespace :app do
   desc "Update configs and some other initially generated files (or use just update:configs or update:bin)"
-  task update: [ "update:configs", "update:bin", "update:upgrade_guide_info" ]
+  task update: [ "update:configs", "update:bin", "update:active_storage", "update:upgrade_guide_info" ]
 
   desc "Applies the template supplied by LOCATION=(/path/to/template) or URL"
   task template: :environment do
     template = ENV["LOCATION"]
     raise "No LOCATION value given. Please set LOCATION either as path to a file or a URL" if template.blank?
-    template = File.expand_path(template) if template !~ %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://}
+    template = File.expand_path(template) unless %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://}.match?(template)
     require "rails/generators"
     require "rails/generators/rails/app/app_generator"
     generator = Rails::Generators::AppGenerator.new [Rails.root], {}, { destination_root: Rails.root }
@@ -40,7 +40,7 @@ namespace :app do
   namespace :update do
     require "rails/app_updater"
 
-    # desc "Update config/boot.rb from your current rails install"
+    # desc "Update config files from your current rails install"
     task :configs do
       Rails::AppUpdater.invoke_from_app_generator :create_boot_file
       Rails::AppUpdater.invoke_from_app_generator :update_config_files
@@ -51,8 +51,18 @@ namespace :app do
       Rails::AppUpdater.invoke_from_app_generator :update_bin_files
     end
 
+    task :active_storage do
+      Rails::AppUpdater.invoke_from_app_generator :update_active_storage
+    end
+
     task :upgrade_guide_info do
       Rails::AppUpdater.invoke_from_app_generator :display_upgrade_guide_info
     end
   end
+
+  namespace :binstub do
+    task :yarn do
+      Rails::AppUpdater.invoke_from_app_generator :update_bin_yarn
+    end
+  end
 end

data/lib/rails/tasks/log.rake

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 namespace :log do
-
   ##
   # Truncates all/specified log files
   # ENV['LOGS']

data/lib/rails/tasks/misc.rake

@@ -12,7 +12,7 @@ task about: :environment do
 end
 
 namespace :time do
-  desc "List all time zones, list by two-letter country code (`rails time:zones[US]`), or list by UTC offset (`rails time:zones[-8]`)"
+  desc "List all time zones, list by two-letter country code (`bin/rails time:zones[US]`), or list by UTC offset (`bin/rails time:zones[-8]`)"
   task :zones, :country_or_offset do |t, args|
     zones, offset = ActiveSupport::TimeZone.all, nil
 

data/lib/rails/tasks/statistics.rake

@@ -3,20 +3,24 @@
 # While global constants are bad, many 3rd party tools depend on this one (e.g
 # rspec-rails & cucumber-rails). So a deprecation warning is needed if we want
 # to remove it.
-STATS_DIRECTORIES = [
+STATS_DIRECTORIES ||= [
   %w(Controllers        app/controllers),
   %w(Helpers            app/helpers),
   %w(Jobs               app/jobs),
   %w(Models             app/models),
   %w(Mailers            app/mailers),
+  %w(Mailboxes          app/mailboxes),
   %w(Channels           app/channels),
   %w(JavaScripts        app/assets/javascripts),
+  %w(JavaScript         app/javascript),
   %w(Libraries          lib/),
   %w(APIs               app/apis),
   %w(Controller\ tests  test/controllers),
   %w(Helper\ tests      test/helpers),
   %w(Model\ tests       test/models),
   %w(Mailer\ tests      test/mailers),
+  %w(Mailbox\ tests     test/mailboxes),
+  %w(Channel\ tests     test/channels),
   %w(Job\ tests         test/jobs),
   %w(Integration\ tests test/integration),
   %w(System\ tests      test/system),