railties 7.1.3.4 → 8.0.1

data/lib/rails/commands/console/irb_console.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "irb/helper_method"
+require "irb/command"
+
+module Rails
+  class Console
+    class RailsHelperBase < IRB::HelperMethod::Base
+    end
+
+    class ControllerHelper < RailsHelperBase
+      description "Gets helper methods available to ApplicationController."
+
+      # This method assumes an +ApplicationController+ exists, and that it extends ActionController::Base.
+      def execute
+        ApplicationController.helpers
+      end
+    end
+
+    class ControllerInstance < RailsHelperBase
+      description "Gets a new instance of ApplicationController."
+
+      # This method assumes an +ApplicationController+ exists, and that it extends ActionController::Base.
+      def execute
+        @controller ||= ApplicationController.new
+      end
+    end
+
+    class NewSession < RailsHelperBase
+      description "[Deprecated] Please use `app(true)` instead."
+
+      def execute(*)
+        app = Rails.application
+        session = ActionDispatch::Integration::Session.new(app)
+
+        # This makes app.url_for and app.foo_path available in the console
+        session.extend(app.routes.url_helpers)
+        session.extend(app.routes.mounted_helpers)
+
+        session
+      end
+    end
+
+    class AppInstance < NewSession
+      description "Creates a new ActionDispatch::Integration::Session and memoizes it. Use `app(true)` to create a new instance."
+
+      def execute(create = false)
+        @app_integration_instance = nil if create
+        @app_integration_instance ||= super
+      end
+    end
+
+    class ReloadHelper < RailsHelperBase
+      description "Reloads the Rails application."
+
+      def execute
+        puts "Reloading..."
+        Rails.application.reloader.reload!
+      end
+    end
+
+    IRB::HelperMethod.register(:helper, ControllerHelper)
+    IRB::HelperMethod.register(:controller, ControllerInstance)
+    IRB::HelperMethod.register(:new_session, NewSession)
+    IRB::HelperMethod.register(:app, AppInstance)
+    IRB::HelperMethod.register(:reload!, ReloadHelper)
+
+    class IRBConsole
+      def initialize(app)
+        @app = app
+
+        require "irb"
+        require "irb/completion"
+      end
+
+      def name
+        "IRB"
+      end
+
+      def start
+        IRB.setup(nil)
+
+        if !Rails.env.local? && !ENV.key?("IRB_USE_AUTOCOMPLETE")
+          IRB.conf[:USE_AUTOCOMPLETE] = false
+        end
+
+        env = colorized_env
+        prompt_prefix = "%N(#{env})"
+        IRB.conf[:IRB_NAME] = @app.name
+
+        IRB.conf[:PROMPT][:RAILS_PROMPT] = {
+          PROMPT_I: "#{prompt_prefix}> ",
+          PROMPT_S: "#{prompt_prefix}%l ",
+          PROMPT_C: "#{prompt_prefix}* ",
+          RETURN: "=> %s\n"
+        }
+
+        if current_filter = IRB.conf[:BACKTRACE_FILTER]
+          IRB.conf[:BACKTRACE_FILTER] = -> (backtrace) do
+            backtrace = current_filter.call(backtrace)
+            Rails.backtrace_cleaner.filter(backtrace)
+          end
+        else
+          IRB.conf[:BACKTRACE_FILTER] = -> (backtrace) do
+            Rails.backtrace_cleaner.filter(backtrace)
+          end
+        end
+
+        # Respect user's choice of prompt mode.
+        IRB.conf[:PROMPT_MODE] = :RAILS_PROMPT if IRB.conf[:PROMPT_MODE] == :DEFAULT
+        IRB::Irb.new.run(IRB.conf)
+      end
+
+      def colorized_env
+        case Rails.env
+        when "development"
+          IRB::Color.colorize("dev", [:BLUE])
+        when "test"
+          IRB::Color.colorize("test", [:BLUE])
+        when "production"
+          IRB::Color.colorize("prod", [:RED])
+        else
+          Rails.env
+        end
+      end
+    end
+  end
+end

data/lib/rails/commands/credentials/USAGE

@@ -38,8 +38,8 @@ Set up Git to Diff Credentials:
     Running the command enrolls the project such that all credentials files use the
     "rails_credentials" diff driver in .gitattributes.
 
-    Additionally since Git requires the driver itself to be set up in a config file
-    that isn't tracked Rails automatically ensures it's configured when running
+    Additionally, since Git requires the driver itself to be set up in a config file
+    that isn't tracked, Rails automatically ensures it's configured when running
     `<%= executable(:edit) %>`.
 
     Otherwise each co-worker would have to run enable manually, including on each new
@@ -48,8 +48,8 @@ Set up Git to Diff Credentials:
     To disenroll from this feature, run `<%= executable(:diff) %> --disenroll`.
 
 Editing Credentials:
-    This will open a temporary file in `$VISUAL` or `$EDITOR` with the decrypted
-    contents to edit the encrypted credentials.
+    `<%= executable(:edit) %>` will open a temporary file in `$VISUAL` or `$EDITOR`
+    with the decrypted contents to edit the encrypted credentials.
 
     When the temporary file is next saved the contents are encrypted and written to
     `config/credentials.yml.enc` while the file itself is destroyed to prevent credentials

data/lib/rails/commands/credentials/credentials_command.rb

@@ -20,8 +20,8 @@ module Rails
         load_generators
 
         if environment_specified?
-          @content_path = "config/credentials/#{environment}.yml.enc" unless config.key?(:content_path)
-          @key_path = "config/credentials/#{environment}.key" unless config.key?(:key_path)
+          @content_path = "config/credentials/#{environment}.yml.enc" unless config.overridden?(:content_path)
+          @key_path = "config/credentials/#{environment}.key" unless config.overridden?(:key_path)
         end
 
         ensure_encryption_key_has_been_added
@@ -128,7 +128,11 @@ module Rails
         end
 
         def extract_environment_from_path(path)
-          available_environments.find { |env| path.end_with?("#{env}.yml.enc") }
+          available_environments.find { |env| path.end_with?("#{env}.yml.enc") } || extract_custom_environment(path)
+        end
+
+        def extract_custom_environment(path)
+          path =~ %r{config/credentials/(.+)\.yml\.enc} && $1
         end
     end
   end

data/lib/rails/commands/dbconsole/dbconsole_command.rb

@@ -16,28 +16,29 @@ module Rails
 
     def start
       adapter_class.dbconsole(db_config, @options)
-    rescue NotImplementedError
-      abort "Unknown command-line client for #{db_config.database}."
+    rescue NotImplementedError, ActiveRecord::AdapterNotFound, LoadError => error
+      abort error.message
     end
 
     def db_config
-      return @db_config if defined?(@db_config)
-
-      # If the user provided a database, use that. Otherwise find
-      # the first config in the database.yml
-      if database
-        @db_config = configurations.configs_for(env_name: environment, name: database, include_hidden: true)
-      else
-        @db_config = configurations.find_db_config(environment)
-      end
+      @db_config ||= begin
+        # If the user provided a database, use that. Otherwise find
+        # the first config in the database.yml
+        config = if database
+          @db_config = configurations.configs_for(env_name: environment, name: database, include_hidden: true)
+        else
+          @db_config = configurations.find_db_config(environment)
+        end
 
-      unless @db_config
-        missing_db = database ? "'#{database}' database is not" : "No databases are"
-        raise ActiveRecord::AdapterNotSpecified,
-          "#{missing_db} configured for '#{environment}'. Available configuration: #{configurations.inspect}"
-      end
+        unless config
+          missing_db = database ? "'#{database}' database is not" : "No databases are"
+          raise ActiveRecord::AdapterNotSpecified,
+            "#{missing_db} configured for '#{environment}'. Available configuration: #{configurations.inspect}"
+        end
 
-      @db_config
+        config.validate!
+        config
+      end
     end
 
     def database
@@ -50,11 +51,9 @@ module Rails
 
     private
       def adapter_class
-        if ActiveRecord::Base.respond_to?(db_config.adapter_class_method)
-          ActiveRecord::Base.public_send(db_config.adapter_class_method)
-        else
-          ActiveRecord::ConnectionAdapters::AbstractAdapter
-        end
+        ActiveRecord::ConnectionAdapters.resolve(db_config.adapter)
+      rescue LoadError
+        ActiveRecord::ConnectionAdapters::AbstractAdapter
       end
 
       def configurations # :doc:
@@ -62,14 +61,6 @@ module Rails
         ActiveRecord::Base.configurations = Rails.application.config.database_configuration
         ActiveRecord::Base.configurations
       end
-
-      def find_cmd_and_exec(commands, *args) # :doc:
-        Rails.deprecator.warn(<<~MSG.squish)
-          Rails::DBConsole#find_cmd_and_exec is deprecated and will be removed in Rails 7.2.
-          Please use find_cmd_and_exec on the connection adapter class instead.
-        MSG
-        ActiveRecord::Base.connection.find_cmd_and_exec(commands, *args)
-      end
   end
 
   module Command

data/lib/rails/commands/dev/dev_command.rb

@@ -5,7 +5,7 @@ require "rails/dev_caching"
 module Rails
   module Command
     class DevCommand < Base # :nodoc:
-      desc "cache", "Toggle development mode caching on/off"
+      desc "cache", "Toggle Action Controller development mode caching on/off"
       def cache
         Rails::DevCaching.enable_by_file
       end

data/lib/rails/commands/devcontainer/devcontainer_command.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/devcontainer/devcontainer_generator"
+
+module Rails
+  module Command
+    class DevcontainerCommand < Base # :nodoc:
+      desc "devcontainer", "Generate a Dev Container setup based on current application configuration"
+      def perform(*)
+        boot_application!
+
+        say "Generating Dev Container with the following options:"
+        devcontainer_options.each do |option, value|
+          say "#{option}: #{value}"
+        end
+
+        Rails::Generators::DevcontainerGenerator.new([], devcontainer_options).invoke_all
+      end
+
+      private
+        def devcontainer_options
+          @devcontainer_options ||= {
+            app_name: Rails.application.railtie_name.chomp("_application"),
+            database: !!defined?(ActiveRecord) && database,
+            active_storage: !!defined?(ActiveStorage),
+            redis: !!((defined?(ActionCable) && !defined?(SolidCable)) || (defined?(ActiveJob) && !defined?(SolidQueue))),
+            system_test: File.exist?("test/application_system_test_case.rb"),
+            node: File.exist?(".node-version"),
+            kamal: File.exist?("config/deploy.yml"),
+          }
+        end
+
+        def database
+          adapter = ActiveRecord::Base.connection_db_config.adapter
+          adapter == "mysql2" ? "mysql" : adapter
+        end
+    end
+  end
+end

data/lib/rails/commands/rake/rake_command.rb

@@ -18,7 +18,7 @@ module Rails
 
         def perform(task, args, config)
           with_rake(task, *args) do |rake|
-            if unrecognized_task = rake.top_level_tasks.find { |task| !rake.lookup(task[/[^\[]+/]) }
+            if unrecognized_task = (rake.top_level_tasks - ["default"]).find { |task| !rake.lookup(task[/[^\[]+/]) }
               @rake_tasks = rake.tasks
               raise UnrecognizedCommandError.new(unrecognized_task)
             end

data/lib/rails/commands/runner/runner_command.rb

@@ -7,6 +7,8 @@ module Rails
     class RunnerCommand < Base # :nodoc:
       include EnvironmentArgument
 
+      class_option :skip_executor, type: :boolean, aliases: "-w", desc: "Don't wrap with Rails Executor", default: false
+
       no_commands do
         def help(command_name = nil, *)
           super
@@ -30,19 +32,20 @@ module Rails
 
         ARGV.replace(command_argv)
 
+        wrap_with_executor = !options[:skip_executor]
         if code_or_file == "-"
-          Rails.application.executor.wrap(source: "application.runner.railties") do
+          conditional_executor(wrap_with_executor, source: "application.runner.railties") do
             eval($stdin.read, TOPLEVEL_BINDING, "stdin")
           end
         elsif File.exist?(code_or_file)
           expanded_file_path = File.expand_path code_or_file
           $0 = expanded_file_path
-          Rails.application.executor.wrap(source: "application.runner.railties") do
+          conditional_executor(wrap_with_executor, source: "application.runner.railties") do
             Kernel.load expanded_file_path
           end
         else
           begin
-            Rails.application.executor.wrap(source: "application.runner.railties") do
+            conditional_executor(wrap_with_executor, source: "application.runner.railties") do
               eval(code_or_file, TOPLEVEL_BINDING, __FILE__, __LINE__)
             end
           rescue SyntaxError, NameError => e
@@ -62,6 +65,14 @@ module Rails
       end
 
       private
+        def conditional_executor(enabled, **args, &block)
+          if enabled
+            Rails.application.executor.wrap(**args, &block)
+          else
+            yield
+          end
+        end
+
         def looks_like_a_file_path?(code_or_file)
           code_or_file.ends_with?(".rb")
         end

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

@@ -114,7 +114,7 @@ module Rails
       class_option :using, aliases: "-u", type: :string,
         desc: "Specify the Rack server used to run the application (thin/puma/webrick).", banner: :name
       class_option :pid, aliases: "-P", type: :string,
-        desc: "Specify the PID file - defaults to #{DEFAULT_PIDFILE}."
+        desc: "Specify the PID file. Defaults to #{DEFAULT_PIDFILE} in development."
       class_option :dev_caching, aliases: "-C", type: :boolean, default: nil,
         desc: "Specify whether to perform caching in development."
       class_option :restart, type: :boolean, default: nil, hide: true
@@ -243,11 +243,13 @@ module Rails
         end
 
         def pid
-          File.expand_path(options[:pid] || ENV.fetch("PIDFILE", DEFAULT_PIDFILE))
+          default_pidfile = environment == "development" ? DEFAULT_PIDFILE : nil
+          pid = options[:pid] || ENV["PIDFILE"] || default_pidfile
+          File.expand_path(pid) if pid
         end
 
         def prepare_restart
-          FileUtils.rm_f(pid) if options[:restart]
+          FileUtils.rm_f(pid) if pid && options[:restart]
         end
 
         def rack_server_suggestion(server)

data/lib/rails/commands/stats/stats_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    class StatsCommand < Base # :nodoc:
+      desc "stats", "Report code statistics (KLOCs, etc) from the application or engine"
+      def perform
+        require "rails/code_statistics"
+        boot_application!
+
+        stat_directories = Rails::CodeStatistics.directories.map do |name, dir|
+          [name, Rails::Command.application_root.join(dir)]
+        end.select { |name, dir| File.directory?(dir) }
+
+        Rails::CodeStatistics.new(*stat_directories).to_s
+      end
+    end
+  end
+end

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

@@ -31,6 +31,8 @@ module Rails
         Rails::TestUnit::Runner.parse_options(args)
         run_prepare_task if self.args.none?(EXACT_TEST_ARGUMENT_PATTERN)
         Rails::TestUnit::Runner.run(args)
+      rescue Rails::TestUnit::InvalidTestError => error
+        raise ArgumentError, error.message
       end
 
       # Define Thor tasks to avoid going through Rake and booting twice when using bin/rails test:*

data/lib/rails/configuration.rb

@@ -131,8 +131,17 @@ module Rails
         @after_generate_callbacks << block
       end
 
+      def apply_rubocop_autocorrect_after_generate!
+        after_generate do |files|
+          parsable_files = files.filter { |file| File.exist?(file) && file.end_with?(".rb") }
+          unless parsable_files.empty?
+            system(RbConfig.ruby, "bin/rubocop", "-A", "--fail-level=E", "--format=quiet", *parsable_files, exception: true)
+          end
+        end
+      end
+
       def method_missing(method, *args)
-        method = method.to_s.delete_suffix("=").to_sym
+        method = method.name.delete_suffix("=").to_sym
 
         if args.empty?
           if method == :rails

data/lib/rails/console/methods.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Rails.deprecator.warn(<<~MSG, caller_locations(0..1))
+`rails/console/methods` has been deprecated and will be removed in Rails 8.1.
+Please directly use IRB's extension API to add new commands or helpers to the console.
+For more details, please visit: https://github.com/ruby/irb/blob/master/EXTEND_IRB.md
+MSG

data/lib/rails/dev_caching.rb

@@ -12,10 +12,10 @@ module Rails
 
         if File.exist?(FILE)
           delete_cache_file
-          puts "Development mode is no longer being cached."
+          puts "Action Controller caching disabled for development mode."
         else
           create_cache_file
-          puts "Development mode is now being cached."
+          puts "Action Controller caching enabled for development mode."
         end
 
         FileUtils.touch "tmp/restart.txt"

data/lib/rails/engine/configuration.rb

@@ -6,7 +6,7 @@ module Rails
   class Engine
     class Configuration < ::Rails::Railtie::Configuration
       attr_reader :root
-      attr_accessor :middleware, :javascript_path
+      attr_accessor :middleware, :javascript_path, :route_set_class, :default_scope
       attr_writer :eager_load_paths, :autoload_once_paths, :autoload_paths
 
       # An array of custom autoload paths to be added to the ones defined
@@ -44,6 +44,8 @@ module Rails
         @generators = app_generators.dup
         @middleware = Rails::Configuration::MiddlewareStackProxy.new
         @javascript_path = "javascript"
+        @route_set_class = ActionDispatch::Routing::RouteSet
+        @default_scope = nil
 
         @autoload_paths = []
         @autoload_once_paths = []

data/lib/rails/engine/lazy_route_set.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "action_dispatch/routing/route_set"
+
+module Rails
+  class Engine
+    class LazyRouteSet < ActionDispatch::Routing::RouteSet # :nodoc:
+      class NamedRouteCollection < ActionDispatch::Routing::RouteSet::NamedRouteCollection
+        def route_defined?(name)
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+      end
+
+      module ProxyUrlHelpers
+        def url_for(options)
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+
+        def full_url_for(options)
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+
+        def route_for(name, *args)
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+
+        def optimize_routes_generation?
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+
+        def polymorphic_url(record_or_hash_or_array, options = {})
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+
+        def polymorphic_path(record_or_hash_or_array, options = {})
+          Rails.application&.reload_routes_unless_loaded
+          super
+        end
+      end
+
+      def initialize(config = DEFAULT_CONFIG)
+        super
+        self.named_routes = NamedRouteCollection.new
+        named_routes.url_helpers_module.prepend(method_missing_module)
+        named_routes.path_helpers_module.prepend(method_missing_module)
+      end
+
+      def generate_extras(options, recall = {})
+        Rails.application&.reload_routes_unless_loaded
+
+        super(options, recall)
+      end
+
+      def generate_url_helpers(supports_path)
+        super.tap { |mod| mod.singleton_class.prepend(ProxyUrlHelpers) }
+      end
+
+      def call(req)
+        Rails.application&.reload_routes_unless_loaded
+        super
+      end
+
+      def draw(&block)
+        Rails.application&.reload_routes_unless_loaded
+        super
+      end
+
+      def recognize_path(path, environment = {})
+        Rails.application&.reload_routes_unless_loaded
+        super
+      end
+
+      def recognize_path_with_request(...)
+        Rails.application&.reload_routes_unless_loaded
+        super
+      end
+
+      def routes
+        Rails.application&.reload_routes_unless_loaded
+        super
+      end
+
+      private
+        def method_missing_module
+          @method_missing_module ||= Module.new do
+            private
+              def method_missing(...)
+                if Rails.application&.reload_routes_unless_loaded
+                  public_send(...)
+                else
+                  super
+                end
+              end
+
+              def respond_to_missing?(...)
+                if Rails.application&.reload_routes_unless_loaded
+                  respond_to?(...)
+                else
+                  super
+                end
+              end
+          end
+        end
+    end
+  end
+end