railties 6.1.6 → 7.1.2

data/lib/rails/commands/server/server_command.rb

@@ -3,13 +3,12 @@
 require "fileutils"
 require "action_dispatch"
 require "rails"
-require "active_support/core_ext/string/filters"
-require "active_support/core_ext/symbol/starts_ends_with"
 require "rails/dev_caching"
 require "rails/command/environment_argument"
+require "rails/rackup/server"
 
 module Rails
-  class Server < ::Rack::Server
+  class Server < Rackup::Server
     class Options
       def parse!(args)
         Rails::Command::ServerCommand.new([], args).server_options
@@ -80,13 +79,13 @@ module Rails
         console.formatter = Rails.logger.formatter
         console.level = Rails.logger.level
 
-        unless ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDOUT)
-          Rails.logger.extend(ActiveSupport::Logger.broadcast(console))
+        unless ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDERR, STDOUT)
+          Rails.logger.broadcast_to(console)
         end
       end
 
       def use_puma?
-        server.to_s == "Rack::Handler::Puma"
+        server.to_s.end_with?("Handler::Puma")
       end
   end
 
@@ -94,30 +93,32 @@ module Rails
     class ServerCommand < Base # :nodoc:
       include EnvironmentArgument
 
+      RACK_HANDLER_GEMS = %w(cgi webrick scgi thin puma unicorn falcon)
       # Hard-coding a bunch of handlers here as we don't have a public way of
-      # querying them from the Rack::Handler registry.
-      RACK_SERVERS = %w(cgi fastcgi webrick lsws scgi thin puma unicorn falcon)
+      # querying them from the Rackup::Handler registry.
+      RACK_HANDLERS = RACK_HANDLER_GEMS + %w(fastcgi lsws)
+      RECOMMENDED_SERVER = "puma"
 
       DEFAULT_PORT = 3000
       DEFAULT_PIDFILE = "tmp/pids/server.pid"
 
       class_option :port, aliases: "-p", type: :numeric,
-        desc: "Runs Rails on the specified port - defaults to 3000.", banner: :port
+        desc: "Run Rails on the specified port - defaults to 3000.", banner: :port
       class_option :binding, aliases: "-b", type: :string,
-        desc: "Binds Rails to the specified IP - defaults to 'localhost' in development and '0.0.0.0' in other environments'.",
+        desc: "Bind Rails to the specified IP - defaults to 'localhost' in development and '0.0.0.0' in other environments'.",
         banner: :IP
       class_option :config, aliases: "-c", type: :string, default: "config.ru",
-        desc: "Uses a custom rackup configuration.", banner: :file
+        desc: "Use a custom rackup configuration.", banner: :file
       class_option :daemon, aliases: "-d", type: :boolean, default: false,
-        desc: "Runs server as a Daemon."
+        desc: "Run server as a Daemon."
       class_option :using, aliases: "-u", type: :string,
-        desc: "Specifies the Rack server used to run the application (thin/puma/webrick).", banner: :name
+        desc: "Specify the Rack server used to run the application (thin/puma/webrick).", banner: :name
       class_option :pid, aliases: "-P", type: :string,
-        desc: "Specifies the PID file - defaults to #{DEFAULT_PIDFILE}."
+        desc: "Specify the PID file - defaults to #{DEFAULT_PIDFILE}."
       class_option :dev_caching, aliases: "-C", type: :boolean, default: nil,
-        desc: "Specifies whether to perform caching in development."
+        desc: "Specify whether to perform caching in development."
       class_option :restart, type: :boolean, default: nil, hide: true
-      class_option :early_hints, type: :boolean, default: nil, desc: "Enables HTTP/2 early hints."
+      class_option :early_hints, type: :boolean, default: nil, desc: "Enable HTTP/2 early hints."
       class_option :log_to_stdout, type: :boolean, default: nil, optional: true,
         desc: "Whether to log to stdout. Enabled by default in development when not daemonized."
 
@@ -127,8 +128,8 @@ module Rails
         @original_options = local_options - %w( --restart )
       end
 
+      desc "server", "Start the Rails server"
       def perform
-        extract_environment_option_from_argument
         set_application_directory!
         prepare_restart
 
@@ -228,7 +229,7 @@ module Rails
         end
 
         def restart_command
-          "bin/rails server #{@original_options.join(" ")} --restart"
+          "#{executable} #{@original_options.join(" ")} --restart"
         end
 
         def early_hints
@@ -245,30 +246,32 @@ module Rails
           File.expand_path(options[:pid] || ENV.fetch("PIDFILE", DEFAULT_PIDFILE))
         end
 
-        def self.banner(*)
-          "rails server -u [thin/puma/webrick] [options]"
-        end
-
         def prepare_restart
           FileUtils.rm_f(pid) if options[:restart]
         end
 
         def rack_server_suggestion(server)
-          if server.in?(RACK_SERVERS)
+          if server.nil?
+            <<~MSG
+              Could not find a server gem. Maybe you need to add one to the Gemfile?
+
+                gem "#{RECOMMENDED_SERVER}"
+
+              Run `#{executable} --help` for more options.
+            MSG
+          elsif server.in?(RACK_HANDLER_GEMS)
             <<~MSG
               Could not load server "#{server}". Maybe you need to the add it to the Gemfile?
 
                 gem "#{server}"
 
-              Run `bin/rails server --help` for more options.
+              Run `#{executable} --help` for more options.
             MSG
           else
-            suggestion = Rails::Command::Spellchecker.suggest(server, from: RACK_SERVERS)
-            suggestion_msg = "Maybe you meant #{suggestion.inspect}?" if suggestion
-
+            error = CorrectableNameError.new("Could not find server '#{server}'.", server, RACK_HANDLERS)
             <<~MSG
-              Could not find server "#{server}". #{suggestion_msg}
-              Run `bin/rails server --help` for more options.
+              #{error.detailed_message}
+              Run `#{executable} --help` for more options.
             MSG
           end
         end
@@ -277,7 +280,7 @@ module Rails
           say <<~MSG
             => Booting #{ActiveSupport::Inflector.demodulize(server)}
             => Rails #{Rails.version} application starting in #{Rails.env} #{url}
-            => Run `bin/rails server --help` for more startup options
+            => Run `#{executable} --help` for more startup options
           MSG
         end
     end

data/lib/rails/commands/test/USAGE

@@ -0,0 +1,14 @@
+Examples:
+    You can run a single test by appending a line number to a filename:
+
+        <%= executable %> test/models/user_test.rb:27
+
+    You can run multiple tests with in a line range by appending the line range to a filename:
+
+        <%= executable %> test/models/user_test.rb:10-20
+
+    You can run multiple files and directories at the same time:
+
+        <%= executable %> test/controllers test/integration/login_test.rb
+
+    By default test failures and errors are reported inline during a run.

data/lib/rails/commands/test/test_command.rb

@@ -1,37 +1,79 @@
 # frozen_string_literal: true
 
 require "rails/command"
+require "rails/commands/rake/rake_command"
 require "rails/test_unit/runner"
 require "rails/test_unit/reporter"
 
 module Rails
   module Command
     class TestCommand < Base # :nodoc:
+      def self.executable(*args)
+        args.empty? ? Rails::TestUnitReporter.executable : super
+      end
+
       no_commands do
-        def help
-          say "Usage: #{Rails::TestUnitReporter.executable} [options] [files or directories]"
-          say ""
-          say "You can run a single test by appending a line number to a filename:"
-          say ""
-          say "    #{Rails::TestUnitReporter.executable} test/models/user_test.rb:27"
-          say ""
-          say "You can run multiple files and directories at the same time:"
-          say ""
-          say "    #{Rails::TestUnitReporter.executable} test/controllers test/integration/login_test.rb"
+        def help(command_name = nil, *)
+          super
+          if command_name == "test"
+            say ""
+            say self.class.class_usage
+          end
           say ""
-          say "By default test failures and errors are reported inline during a run."
-          say ""
-
           Minitest.run(%w(--help))
         end
       end
 
-      def perform(*)
+      desc "test [PATHS...]", "Run tests except system tests"
+      def perform(*args)
         $LOAD_PATH << Rails::Command.root.join("test").to_s
 
         Rails::TestUnit::Runner.parse_options(args)
+        run_prepare_task if self.args.none?(EXACT_TEST_ARGUMENT_PATTERN)
         Rails::TestUnit::Runner.run(args)
       end
+
+      # Define Thor tasks to avoid going through Rake and booting twice when using bin/rails test:*
+      Rails::TestUnit::Runner::TEST_FOLDERS.each do |name|
+        desc name, "Run tests in test/#{name}"
+        define_method(name) do |*args|
+          perform("test/#{name}", *args)
+        end
+      end
+
+      desc "all", "Run all tests, including system tests"
+      def all(*args)
+        perform("test/**/*_test.rb", *args)
+      end
+
+      desc "functionals", "Run tests in test/controllers, test/mailers, and test/functional"
+      def functionals(*args)
+        perform("test/controllers", "test/mailers", "test/functional", *args)
+      end
+
+      desc "units", "Run tests in test/models, test/helpers, and test/unit"
+      def units(*args)
+        perform("test/models", "test/helpers", "test/unit", *args)
+      end
+
+      desc "system", "Run system tests only"
+      def system(*args)
+        perform("test/system", *args)
+      end
+
+      desc "generators", "Run tests in test/lib/generators"
+      def generators(*args)
+        perform("test/lib/generators", *args)
+      end
+
+      private
+        EXACT_TEST_ARGUMENT_PATTERN = /^-n|^--name\b|#{Rails::TestUnit::Runner::PATH_ARGUMENT_PATTERN}/
+
+        def run_prepare_task
+          Rails::Command::RakeCommand.perform("test:prepare", [], {})
+        rescue UnrecognizedCommandError => error
+          raise unless error.name == "test:prepare"
+        end
     end
   end
 end

data/lib/rails/commands/unused_routes/unused_routes_command.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "rails/commands/routes/routes_command"
+
+module Rails
+  module Command
+    class UnusedRoutesCommand < Rails::Command::Base # :nodoc:
+      hide_command!
+      class_option :controller, aliases: "-c", desc: "Filter by a specific controller, e.g. PostsController or Admin::PostsController."
+      class_option :grep, aliases: "-g", desc: "Grep routes by a specific pattern."
+
+      class RouteInfo
+        def initialize(route)
+          requirements = route.requirements
+          @controller_name = requirements[:controller]
+          @action_name = requirements[:action]
+          @controller_class = (@controller_name.to_s.camelize + "Controller").safe_constantize
+        end
+
+        def unused?
+          controller_class_missing? || (action_missing? && template_missing?)
+        end
+
+        private
+          def view_path(root)
+            File.join(root.path, @controller_name, @action_name)
+          end
+
+          def controller_class_missing?
+            @controller_name && @controller_class.nil?
+          end
+
+          def template_missing?
+            @controller_class && @controller_class.try(:view_paths).to_a.flat_map { |path| Dir["#{view_path(path)}.*"] }.none?
+          end
+
+          def action_missing?
+            @controller_class && @controller_class.instance_methods.exclude?(@action_name.to_sym)
+          end
+      end
+
+      def perform(*)
+        boot_application!
+        require "action_dispatch/routing/inspector"
+
+        say(inspector.format(formatter, routes_filter))
+
+        exit(1) if routes.any?
+      end
+
+      private
+        def inspector
+          ActionDispatch::Routing::RoutesInspector.new(routes)
+        end
+
+        def routes
+          @routes ||= begin
+            routes = Rails.application.routes.routes.select do |route|
+              RouteInfo.new(route).unused?
+            end
+
+            ActionDispatch::Journey::Routes.new(routes)
+          end
+        end
+
+        def formatter
+          ActionDispatch::Routing::ConsoleFormatter::Unused.new
+        end
+
+        def routes_filter
+          options.symbolize_keys.slice(:controller, :grep)
+        end
+    end
+  end
+end

data/lib/rails/commands/version/version_command.rb

@@ -3,6 +3,7 @@
 module Rails
   module Command
     class VersionCommand < Base # :nodoc:
+      desc "version", "Show the Rails version"
       def perform
         Rails::Command.invoke :application, [ "--version" ]
       end

data/lib/rails/configuration.rb

@@ -7,17 +7,17 @@ require "rails/rack"
 
 module Rails
   module Configuration
-    # MiddlewareStackProxy is a proxy for the Rails middleware stack that allows
+    # MiddlewareStackProxy is a proxy for the \Rails middleware stack that allows
     # you to configure middlewares in your application. It works basically as a
     # command recorder, saving each command to be applied after initialization
     # over the default middleware stack, so you can add, swap, or remove any
-    # middleware in Rails.
+    # middleware in \Rails.
     #
     # You can add your own middlewares by using the +config.middleware.use+ method:
     #
     #     config.middleware.use Magical::Unicorns
     #
-    # This will put the <tt>Magical::Unicorns</tt> middleware on the end of the stack.
+    # This will put the +Magical::Unicorns+ middleware on the end of the stack.
     # You can use +insert_before+ if you wish to add a middleware before another:
     #
     #     config.middleware.insert_before Rack::Head, Magical::Unicorns
@@ -34,8 +34,8 @@ module Rails
     #
     #     config.middleware.move_before ActionDispatch::Flash, Magical::Unicorns
     #
-    # This will move the <tt>Magical::Unicorns</tt> middleware before the
-    # <tt>ActionDispatch::Flash</tt>. You can also move it after:
+    # This will move the +Magical::Unicorns+ middleware before the
+    # +ActionDispatch::Flash+. You can also move it after:
     #
     #     config.middleware.move_after ActionDispatch::Flash, Magical::Unicorns
     #
@@ -49,48 +49,43 @@ module Rails
         @delete_operations = delete_operations
       end
 
-      def insert_before(*args, &block)
-        @operations << -> middleware { middleware.insert_before(*args, &block) }
+      def insert_before(...)
+        @operations << -> middleware { middleware.insert_before(...) }
       end
-      ruby2_keywords(:insert_before) if respond_to?(:ruby2_keywords, true)
 
       alias :insert :insert_before
 
-      def insert_after(*args, &block)
-        @operations << -> middleware { middleware.insert_after(*args, &block) }
+      def insert_after(...)
+        @operations << -> middleware { middleware.insert_after(...) }
       end
-      ruby2_keywords(:insert_after) if respond_to?(:ruby2_keywords, true)
 
-      def swap(*args, &block)
-        @operations << -> middleware { middleware.swap(*args, &block) }
+      def swap(...)
+        @operations << -> middleware { middleware.swap(...) }
       end
-      ruby2_keywords(:swap) if respond_to?(:ruby2_keywords, true)
 
-      def use(*args, &block)
-        @operations << -> middleware { middleware.use(*args, &block) }
+      def use(...)
+        @operations << -> middleware { middleware.use(...) }
       end
-      ruby2_keywords(:use) if respond_to?(:ruby2_keywords, true)
 
-      def delete(*args, &block)
-        @delete_operations << -> middleware { middleware.delete(*args, &block) }
+      def delete(...)
+        @delete_operations << -> middleware { middleware.delete(...) }
       end
 
-      def move_before(*args, &block)
-        @delete_operations << -> middleware { middleware.move_before(*args, &block) }
+      def move_before(...)
+        @delete_operations << -> middleware { middleware.move_before(...) }
       end
 
       alias :move :move_before
 
-      def move_after(*args, &block)
-        @delete_operations << -> middleware { middleware.move_after(*args, &block) }
+      def move_after(...)
+        @delete_operations << -> middleware { middleware.move_after(...) }
       end
 
-      def unshift(*args, &block)
-        @operations << -> middleware { middleware.unshift(*args, &block) }
+      def unshift(...)
+        @operations << -> middleware { middleware.unshift(...) }
       end
-      ruby2_keywords(:unshift) if respond_to?(:ruby2_keywords, true)
 
-      def merge_into(other) #:nodoc:
+      def merge_into(other) # :nodoc:
         (@operations + @delete_operations).each do |operation|
           operation.call(other)
         end
@@ -106,7 +101,7 @@ module Rails
         attr_reader :operations, :delete_operations
     end
 
-    class Generators #:nodoc:
+    class Generators # :nodoc:
       attr_accessor :aliases, :options, :templates, :fallbacks, :colorize_logging, :api_only
       attr_reader :hidden_namespaces, :after_generate_callbacks
 

data/lib/rails/console/app.rb

@@ -9,9 +9,7 @@ module Rails
     # instance, pass a non-false value as the parameter.
     def app(create = false)
       @app_integration_instance = nil if create
-      @app_integration_instance ||= new_session do |sess|
-        sess.host! "www.example.com"
-      end
+      @app_integration_instance ||= new_session
     end
 
     # create a new session. If a block is given, the new session will be yielded
@@ -19,7 +17,6 @@ module Rails
     def new_session
       app = Rails.application
       session = ActionDispatch::Integration::Session.new(app)
-      yield session if block_given?
 
       # This makes app.url_for and app.foo_path available in the console
       session.extend(app.routes.url_helpers)

data/lib/rails/console/helpers.rb

@@ -4,14 +4,14 @@ module Rails
   module ConsoleMethods
     # Gets the helper methods available to the controller.
     #
-    # This method assumes an +ApplicationController+ exists, and it extends +ActionController::Base+
+    # This method assumes an +ApplicationController+ exists, and that it extends ActionController::Base.
     def helper
       ApplicationController.helpers
     end
 
     # Gets a new instance of a controller object.
     #
-    # This method assumes an +ApplicationController+ exists, and it extends +ActionController::Base+
+    # This method assumes an +ApplicationController+ exists, and that it extends ActionController::Base.
     def controller
       @controller ||= ApplicationController.new
     end

data/lib/rails/deprecator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  def self.deprecator # :nodoc:
+    @deprecator ||= ActiveSupport::Deprecation.new
+  end
+end

data/lib/rails/engine/configuration.rb

@@ -9,12 +9,45 @@ module Rails
       attr_accessor :middleware, :javascript_path
       attr_writer :eager_load_paths, :autoload_once_paths, :autoload_paths
 
+      # An array of custom autoload paths to be added to the ones defined
+      # automatically by Rails. These won't be eager loaded, unless you push
+      # them to +eager_load_paths+ too, which is recommended.
+      #
+      # This collection is empty by default, it accepts strings and +Pathname+
+      # objects.
+      #
+      # If you'd like to add +lib+ to it, please see +autoload_lib+.
+      attr_reader :autoload_paths
+
+      # An array of custom autoload once paths. These won't be eager loaded
+      # unless you push them to +eager_load_paths+ too, which is recommended.
+      #
+      # This collection is empty by default, it accepts strings and +Pathname+
+      # objects.
+      #
+      # If you'd like to add +lib+ to it, please see +autoload_lib_once+.
+      attr_reader :autoload_once_paths
+
+      # An array of custom eager load paths to be added to the ones defined
+      # automatically by Rails. Anything in this collection is considered to be
+      # an autoload path regardless of whether it was added to +autoload_paths+.
+      #
+      # This collection is empty by default, it accepts strings and +Pathname+
+      # objects.
+      #
+      # If you'd like to add +lib+ to it, please see +autoload_lib+.
+      attr_reader :eager_load_paths
+
       def initialize(root = nil)
         super()
         @root = root
         @generators = app_generators.dup
         @middleware = Rails::Configuration::MiddlewareStackProxy.new
         @javascript_path = "javascript"
+
+        @autoload_paths = []
+        @autoload_once_paths = []
+        @eager_load_paths = []
       end
 
       # Holds generators configuration:
@@ -44,20 +77,23 @@ module Rails
                                            exclude: ["assets", javascript_path]
           paths.add "app/assets",          glob: "*"
           paths.add "app/controllers",     eager_load: true
-          paths.add "app/channels",        eager_load: true, glob: "**/*_channel.rb"
+          paths.add "app/channels",        eager_load: true
           paths.add "app/helpers",         eager_load: true
           paths.add "app/models",          eager_load: true
           paths.add "app/mailers",         eager_load: true
           paths.add "app/views"
 
+          # If you add more lib subdirectories here that should not be managed
+          # by the main autoloader, please update the config.autoload_lib call
+          # in the template that generates config/application.rb accordingly.
           paths.add "lib",                 load_path: true
           paths.add "lib/assets",          glob: "*"
           paths.add "lib/tasks",           glob: "**/*.rake"
 
           paths.add "config"
-          paths.add "config/environments", glob: "#{Rails.env}.rb"
+          paths.add "config/environments", glob: -"#{Rails.env}.rb"
           paths.add "config/initializers", glob: "**/*.rb"
-          paths.add "config/locales",      glob: "*.{rb,yml}"
+          paths.add "config/locales",      glob: "**/*.{rb,yml}"
           paths.add "config/routes.rb"
           paths.add "config/routes",       glob: "**/*.rb"
 
@@ -68,6 +104,8 @@ module Rails
           paths.add "vendor",              load_path: true
           paths.add "vendor/assets",       glob: "*"
 
+          paths.add "test/mailers/previews", autoload: true
+
           paths
         end
       end
@@ -76,16 +114,22 @@ module Rails
         @root = paths.path = Pathname.new(value).expand_path
       end
 
-      def eager_load_paths
-        @eager_load_paths ||= paths.eager_load
+      # Private method that adds custom autoload paths to the ones defined by
+      # +paths+.
+      def all_autoload_paths # :nodoc:
+        autoload_paths + paths.autoload_paths
       end
 
-      def autoload_once_paths
-        @autoload_once_paths ||= paths.autoload_once
+      # Private method that adds custom autoload once paths to the ones defined
+      # by +paths+.
+      def all_autoload_once_paths # :nodoc:
+        autoload_once_paths + paths.autoload_once
       end
 
-      def autoload_paths
-        @autoload_paths ||= paths.autoload_paths
+      # Private method that adds custom eager load paths to the ones defined by
+      # +paths+.
+      def all_eager_load_paths # :nodoc:
+        eager_load_paths + paths.eager_load
       end
     end
   end