railties 7.0.8 → 7.1.3.4

data/lib/rails/generators/rails/credentials/credentials_generator.rb

@@ -7,49 +7,54 @@ require "active_support/encrypted_configuration"
 module Rails
   module Generators
     class CredentialsGenerator < Base # :nodoc:
+      argument :content_path, default: "config/credentials.yml.enc"
+      argument :key_path, default: "config/master.key"
+      class_option :skip_secret_key_base, type: :boolean
+
       def add_credentials_file
-        unless credentials.content_path.exist?
-          template = credentials_template
+        in_root do
+          return if File.exist?(content_path)
 
-          say "Adding #{credentials.content_path} to store encrypted credentials."
+          say "Adding #{content_path} to store encrypted credentials."
           say ""
+
+          content = render_template_to_encrypted_file
+
           say "The following content has been encrypted with the Rails master key:"
           say ""
-          say template, :on_green
+          say content, :on_green
           say ""
-
-          add_credentials_file_silently(template)
-
           say "You can edit encrypted credentials with `bin/rails credentials:edit`."
           say ""
         end
       end
 
-      def add_credentials_file_silently(template = nil)
-        unless credentials.content_path.exist?
-          credentials.write(credentials_template)
-        end
-      end
-
       private
-        def credentials
+        def encrypted_file
           ActiveSupport::EncryptedConfiguration.new(
-            config_path: "config/credentials.yml.enc",
-            key_path: "config/master.key",
+            config_path: content_path,
+            key_path: key_path,
             env_key: "RAILS_MASTER_KEY",
             raise_if_missing_key: true
           )
         end
 
-        def credentials_template
-          <<~YAML
-            # aws:
-            #   access_key_id: 123
-            #   secret_access_key: 345
+        def secret_key_base
+          @secret_key_base ||= SecureRandom.hex(64)
+        end
+
+        def render_template_to_encrypted_file
+          empty_directory File.dirname(content_path)
+
+          content = nil
+
+          encrypted_file.change do |tmp_path|
+            template("credentials.yml", tmp_path, force: true, verbose: false) do |rendered|
+              content = rendered
+            end
+          end
 
-            # Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
-            secret_key_base: #{SecureRandom.hex(64)}
-          YAML
+          content
         end
     end
   end

data/lib/rails/generators/rails/credentials/templates/credentials.yml.tt

@@ -0,0 +1,8 @@
+# aws:
+#   access_key_id: 123
+#   secret_access_key: 345
+<% unless options.skip_secret_key_base? -%>
+
+# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
+secret_key_base: <%= secret_key_base %>
+<% end -%>

data/lib/rails/generators/rails/db/system/change/change_generator.rb

@@ -40,16 +40,46 @@ module Rails
             gsub_file("Gemfile", gem_entry_regex_for(name), gem_entry_for(name, *version))
           end
 
+          def edit_dockerfile
+            dockerfile_path = File.expand_path("Dockerfile", destination_root)
+            return unless File.exist?(dockerfile_path)
+
+            build_name = docker_for_database_build
+            deploy_name = docker_for_database_deploy
+            if build_name
+              gsub_file("Dockerfile", all_docker_builds_regex, build_name)
+            end
+            if deploy_name
+              gsub_file("Dockerfile", all_docker_deploys_regex, deploy_name)
+            end
+          end
+
           private
             def all_database_gems
               DATABASES.map { |database| gem_for_database(database) }
             end
 
+            def all_docker_builds
+              DATABASES.map { |database| docker_for_database_build(database).nil? ? nil : docker_for_database_build(database) }.compact!
+            end
+
+            def all_docker_deploys
+              DATABASES.map { |database| docker_for_database_deploy(database).nil? ? nil : docker_for_database_deploy(database) }.compact!
+            end
+
             def all_database_gems_regex
               all_database_gem_names = all_database_gems.map(&:first)
               /(\b#{all_database_gem_names.join('\b|\b')}\b)/
             end
 
+            def all_docker_builds_regex
+              /(\b#{all_docker_builds.join('\b|\b')}\b)/
+            end
+
+            def all_docker_deploys_regex
+              /(\b#{all_docker_deploys.join('\b|\b')}\b)/
+            end
+
             def gem_entry_regex_for(gem_name)
               /^gem.*\b#{gem_name}\b.*/
             end

data/lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb

@@ -26,8 +26,7 @@ module Rails
       end
 
       def add_key_file_silently(key_path, key = nil)
-        create_file key_path, key || ActiveSupport::EncryptedFile.generate_key
-        key_path.chmod 0600
+        create_file key_path, key || ActiveSupport::EncryptedFile.generate_key, perm: 0600
       end
 
       def ignore_key_file(key_path, ignore: key_ignore(key_path))

data/lib/rails/generators/rails/migration/USAGE

@@ -5,31 +5,41 @@ Description:
     A migration class is generated in db/migrate prefixed by a timestamp of the current date and time.
 
     You can name your migration in either of these formats to generate add/remove
-    column lines from supplied attributes: AddColumnsToTable or RemoveColumnsFromTable
+    column lines from supplied attributes: add_{columns}_to_{table} or remove_{columns}_from_{table}.
 
-Example:
-    `bin/rails generate migration AddSslFlag`
+    A migration name containing JoinTable will generate join tables for use with
+    has_and_belongs_to_many associations.
+
+    You can also name your migration create_{table} along with any attributes to generate a regular table.
+
+Examples:
+    `bin/rails generate migration add_ssl_flag`
 
     If the current date is May 14, 2008 and the current time 09:09:12, this creates the AddSslFlag migration
     db/migrate/20080514090912_add_ssl_flag.rb
 
-    `bin/rails generate migration AddTitleBodyToPost title:string body:text published:boolean`
+    `bin/rails generate migration add_title_body_published_to_post title:string body:text published:boolean`
 
-    This will create the AddTitleBodyToPost in db/migrate/20080514090912_add_title_body_to_post.rb with this in the Change migration:
+    This will create db/migrate/20080514090912_add_title_body_published_to_post.rb with this in the migration:
 
       add_column :posts, :title, :string
       add_column :posts, :body, :text
       add_column :posts, :published, :boolean
 
-Migration names containing JoinTable will generate join tables for use with
-has_and_belongs_to_many associations.
+    `bin/rails generate migration create_media_join_table artists musics:uniq`
 
-Example:
-    `bin/rails g migration CreateMediaJoinTable artists musics:uniq`
-
-    will create the migration
+    This will create a join table migration:
 
     create_join_table :artists, :musics do |t|
       # t.index [:artist_id, :music_id]
       t.index [:music_id, :artist_id], unique: true
     end
+
+    `bin/rails generate migration create_users email:string`
+
+    This will create the migration:
+
+    create_table :users do |t|
+      t.string :email
+      t.timestamps
+    end

data/lib/rails/generators/rails/model/model_generator.rb

@@ -9,6 +9,10 @@ module Rails
 
       argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
       hook_for :orm, required: true, desc: "ORM to be invoked"
+
+      class << self
+        delegate(:desc, to: :orm_generator)
+      end
     end
   end
 end

data/lib/rails/generators/rails/plugin/USAGE

@@ -1,10 +1,21 @@
 Description:
-    The 'rails plugin new' command creates a skeleton for developing any
-    kind of Rails extension with ability to run tests using dummy Rails
-    application.
+    The `rails plugin new` command creates a Rails plugin with the ability
+    to run tests using a dummy Rails application. A plugin is a gem with
+    either a railtie or an engine.
 
-Example:
-    rails plugin new ~/Code/Ruby/blog
+Examples:
+    `rails plugin new ~/Code/Ruby/blog`
 
-    This generates a skeletal Rails plugin in ~/Code/Ruby/blog.
+    This generates a Rails railtie gem in ~/Code/Ruby/blog.
     See the README in the newly created plugin to get going.
+
+    `rails plugin new blog --full`
+
+    This generates a full Rails engine gem in ./blog. The `--mountable`
+    option may also be used to generate a mountable, namespace-isolated
+    engine with assets and layouts.
+
+    `rails plugin new blog --mountable --skip-asset-pipeline`
+
+    This generates a mountable Rails engine gem at ./blog without an asset
+    pipeline. Any part of Rails can be skipped during plugin generation.

data/lib/rails/generators/rails/plugin/plugin_generator.rb

@@ -28,14 +28,14 @@ module Rails
 
         empty_directory_with_keep_file "app/models/concerns"
         empty_directory_with_keep_file "app/controllers/concerns"
-        remove_dir "app/mailers" if skip_action_mailer?
+        remove_dir "app/mailers" if options[:skip_action_mailer]
         remove_dir "app/jobs" if options[:skip_active_job]
       elsif full?
         empty_directory_with_keep_file "app/models"
         empty_directory_with_keep_file "app/controllers"
         empty_directory_with_keep_file "app/models/concerns"
         empty_directory_with_keep_file "app/controllers/concerns"
-        empty_directory_with_keep_file "app/mailers" unless skip_action_mailer?
+        empty_directory_with_keep_file "app/mailers" unless options[:skip_action_mailer]
         empty_directory_with_keep_file "app/jobs" unless options[:skip_active_job]
 
         unless api?
@@ -68,10 +68,7 @@ module Rails
 
     def version_control
       if !options[:skip_git] && !options[:pretend]
-        run "git init", capture: options[:quiet], abort_on_failure: false
-        if user_default_branch.strip.empty?
-          `git symbolic-ref HEAD refs/heads/main`
-        end
+        run git_init_command, capture: options[:quiet], abort_on_failure: false
       end
     end
 
@@ -127,10 +124,6 @@ module Rails
     def test_dummy_config
       template "rails/boot.rb", "#{dummy_path}/config/boot.rb", force: true
 
-      insert_into_file "#{dummy_path}/config/application.rb", <<~RUBY, after: /^Bundler\.require.+\n/
-        require #{namespaced_name.inspect}
-      RUBY
-
       if mountable?
         template "rails/routes.rb", "#{dummy_path}/config/routes.rb", force: true
       end
@@ -191,11 +184,6 @@ module Rails
         append_file gemfile_in_app_path, entry
       end
     end
-
-    private
-      def user_default_branch
-        @user_default_branch ||= `git config init.defaultbranch`
-      end
   end
 
   module Generators
@@ -226,12 +214,14 @@ module Rails
       def initialize(*args)
         @dummy_path = nil
         super
+        imply_options
 
         if !engine? || !with_dummy_app?
           self.options = options.merge(skip_asset_pipeline: true).freeze
         end
       end
 
+      public_task :report_implied_options
       public_task :set_default_accessors!
       public_task :create_root
 

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

@@ -13,7 +13,7 @@ gemspec
 # Start debugger with binding.b [https://github.com/ruby/debug]
 # gem "debug", ">= 1.0.0"
 <% end -%>
-<% if RUBY_PLATFORM.match?(/bccwin|cygwin|emx|mingw|mswin|wince|java/) -%>
+<% if RUBY_PLATFORM.match?(/mingw|mswin|java/) -%>
 
-gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+gem "tzinfo-data", platforms: %i[ <%= bundler_windows_platforms %> jruby ]
 <% end -%>

data/lib/rails/generators/rails/plugin/templates/MIT-LICENSE.tt

@@ -1,4 +1,4 @@
-Copyright <%= Date.today.year %> <%= author %>
+Copyright <%= author %>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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

@@ -11,21 +11,5 @@ APP_PATH = File.expand_path("../<%= dummy_path -%>/config/application", __dir__)
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
 
-<% if include_all_railties? -%>
-require "rails/all"
-<% else -%>
-require "rails"
-# Pick the frameworks you want:
-require "active_model/railtie"
-<%= comment_if :skip_active_job %>require "active_job/railtie"
-<%= comment_if :skip_active_record %>require "active_record/railtie"
-<%= comment_if :skip_active_storage %>require "active_storage/engine"
-require "action_controller/railtie"
-<%= comment_if :skip_action_mailer %>require "action_mailer/railtie"
-<%= comment_if :skip_action_mailbox %>require "action_mailbox/engine"
-<%= comment_if :skip_action_text %>require "action_text/engine"
-require "action_view/railtie"
-<%= comment_if :skip_action_cable %>require "action_cable/engine"
-<%= comment_if :skip_test %>require "rails/test_unit/railtie"
-<% end -%>
+<%= rails_require_statement %>
 require "rails/engine/commands"

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

@@ -9,8 +9,6 @@
 /<%= dummy_path %>/db/*.sqlite3-*
 <% end -%>
 /<%= dummy_path %>/log/*.log
-<% unless skip_active_storage? -%>
 /<%= dummy_path %>/storage/
-<% end -%>
 /<%= dummy_path %>/tmp/
 <% end -%>

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

@@ -12,10 +12,10 @@ require "rails/test_help"
 
 <% unless options[:skip_active_record] -%>
 # Load fixtures from the engine
-if ActiveSupport::TestCase.respond_to?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__)
-  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
-  ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
+if ActiveSupport::TestCase.respond_to?(:fixture_paths=)
+  ActiveSupport::TestCase.fixture_paths = [File.expand_path("fixtures", __dir__)]
+  ActionDispatch::IntegrationTest.fixture_paths = ActiveSupport::TestCase.fixture_paths
+  ActiveSupport::TestCase.file_fixture_path = File.expand_path("fixtures", __dir__) + "/files"
   ActiveSupport::TestCase.fixtures :all
 end
 <% end -%>

data/lib/rails/generators/rails/resource/resource_generator.rb

@@ -16,6 +16,12 @@ module Rails
                              desc: "Actions for the resource controller"
 
       hook_for :resource_route, required: true
+
+      class << self
+        def desc(description = nil)
+          ERB.new(File.read(usage_path)).result(binding)
+        end
+      end
     end
   end
 end

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

@@ -8,7 +8,8 @@ module Rails
       remove_hook_for :resource_controller
       remove_class_option :actions
 
-      class_option :api, type: :boolean
+      class_option :api, type: :boolean,
+        desc: "Generate API-only controller and tests, with no view templates"
       class_option :resource_route, type: :boolean
 
       hook_for :scaffold_controller, required: true

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

@@ -13,7 +13,7 @@ module Rails
       class_option :orm, banner: "NAME", type: :string, required: true,
                          desc: "ORM to generate the controller for"
       class_option :api, type: :boolean,
-                         desc: "Generates API controller"
+                         desc: "Generate API controller"
 
       class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
 

data/lib/rails/generators/test_case.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "rails/generators"
-require "rails/generators/testing/behaviour"
+require "rails/generators/testing/behavior"
 require "rails/generators/testing/setup_and_teardown"
 require "rails/generators/testing/assertions"
 require "fileutils"
@@ -28,7 +28,7 @@ module Rails
     #     setup :prepare_destination
     #   end
     class TestCase < ActiveSupport::TestCase
-      include Rails::Generators::Testing::Behaviour
+      include Rails::Generators::Testing::Behavior
       include Rails::Generators::Testing::SetupAndTeardown
       include Rails::Generators::Testing::Assertions
       include FileUtils

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

@@ -11,7 +11,7 @@ module TestUnit # :nodoc:
       check_class_collision suffix: "ControllerTest"
 
       class_option :api, type: :boolean,
-                         desc: "Generates API functional tests"
+                         desc: "Generate API functional tests"
 
       class_option :system_tests, type: :string,
                          desc: "Skip system test files"

data/lib/rails/generators/testing/{behaviour.rb → behavior.rb}

@@ -11,7 +11,7 @@ require "rails/generators"
 module Rails
   module Generators
     module Testing
-      module Behaviour
+      module Behavior
         extend ActiveSupport::Concern
         include ActiveSupport::Testing::Stream
 
@@ -107,6 +107,9 @@ module Rails
             Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
           end
       end
+
+      include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+      deprecate_constant "Behaviour", "Rails::Generators::Testing::Behavior", deprecator: Rails.deprecator
     end
   end
 end

data/lib/rails/generators.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-activesupport_path = File.expand_path("../../../activesupport/lib", __dir__)
-$:.unshift(activesupport_path) if File.directory?(activesupport_path) && !$:.include?(activesupport_path)
-
 require "thor/group"
 require "rails/command"
 
@@ -33,7 +30,7 @@ module Rails
       rails: {
         actions: "-a",
         orm: "-o",
-        javascripts: "-j",
+        javascripts: ["-j", "--js"],
         resource_controller: "-c",
         scaffold_controller: "-c",
         stylesheets: "-y",
@@ -93,7 +90,7 @@ module Rails
       end
 
       # Hold configured generators fallbacks. If a plugin developer wants a
-      # generator group to fallback to another group in case of missing generators,
+      # generator group to fall back to another group in case of missing generators,
       # they can add a fallback.
       #
       # For example, shoulda is considered a test_framework and is an extension
@@ -166,7 +163,8 @@ module Rails
 
       # Show help message with available generators.
       def help(command = "generate")
-        puts "Usage: rails #{command} GENERATOR [args] [options]"
+        puts "Usage:"
+        puts "  bin/rails #{command} GENERATOR [args] [options]"
         puts
         puts "General options:"
         puts "  -h, [--help]     # Print generator's options and usage"
@@ -264,16 +262,10 @@ module Rails
           run_after_generate_callback if config[:behavior] == :invoke
         else
           options = sorted_groups.flat_map(&:last)
-          error   = Command::Base::CorrectableError.new("Could not find generator '#{namespace}'.", namespace, options)
-
-          if error.respond_to?(:detailed_message)
-            formatted_message = error.detailed_message
-          else
-            formatted_message = error.message
-          end
+          error = Command::CorrectableNameError.new("Could not find generator '#{namespace}'.", namespace, options)
 
           puts <<~MSG
-            #{formatted_message}
+            #{error.detailed_message}
             Run `bin/rails generate --help` for more options.
           MSG
         end

data/lib/rails/health_controller.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Rails
+  # Built-in Health Check Endpoint
+  #
+  # \Rails also comes with a built-in health check endpoint that is reachable at
+  # the +/up+ path. This endpoint will return a 200 status code if the app has
+  # booted with no exceptions, and a 500 status code otherwise.
+  #
+  # In production, many applications are required to report their status upstream,
+  # whether it's to an uptime monitor that will page an engineer when things go
+  # wrong, or a load balancer or Kubernetes controller used to determine a pod's
+  # health. This health check is designed to be a one-size fits all that will work
+  # in many situations.
+  #
+  # While any newly generated \Rails applications will have the health check at
+  # +/up+, you can configure the path to be anything you'd like in your
+  # <tt>"config/routes.rb"</tt>:
+  #
+  #   Rails.application.routes.draw do
+  #     get "healthz" => "rails/health#show", as: :rails_health_check
+  #   end
+  #
+  # The health check will now be accessible via the +/healthz+ path.
+  #
+  # NOTE: This endpoint does not reflect the status of all of your application's
+  # dependencies, such as the database or redis cluster. Replace
+  # <tt>"rails/health#show"</tt> with your own controller action if you have
+  # application specific needs.
+  #
+  # Think carefully about what you want to check as it can lead to situations
+  # where your application is being restarted due to a third-party service going
+  # bad. Ideally, you should design your application to handle those outages
+  # gracefully.
+  class HealthController < ActionController::Base
+    rescue_from(Exception) { render_down }
+
+    def show
+      render_up
+    end
+
+    private
+      def render_up
+        render html: html_status(color: "green")
+      end
+
+      def render_down
+        render html: html_status(color: "red"), status: 500
+      end
+
+      def html_status(color:)
+        %(<!DOCTYPE html><html><body style="background-color: #{color}"></body></html>).html_safe
+      end
+  end
+end

data/lib/rails/info.rb

@@ -4,7 +4,7 @@ require "cgi"
 
 module Rails
   # This module helps build the runtime properties that are displayed in
-  # Rails::InfoController responses. These include the active Rails version,
+  # Rails::InfoController responses. These include the active \Rails version,
   # Ruby version, Rack version, and so on.
   module Info
     mattr_accessor :properties, default: []

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::DebugView::RESCUES_TEMPLATE_PATH
+  prepend_view_path ActionDispatch::DebugView::RESCUES_TEMPLATE_PATHS
   layout -> { request.xhr? ? false : "application" }
 
   before_action :require_local!
@@ -19,12 +19,12 @@ class Rails::InfoController < Rails::ApplicationController # :nodoc:
   end
 
   def routes
-    if path = params[:path]
-      path = URI::DEFAULT_PARSER.escape path
-      normalized_path = with_leading_slash path
+    if query = params[:query]
+      query = URI::DEFAULT_PARSER.escape query
+
       render json: {
-        exact: match_route { |it| it.match normalized_path },
-        fuzzy: match_route { |it| it.spec.to_s.match path }
+        exact: matching_routes(query: query, exact_match: true),
+        fuzzy: matching_routes(query: query, exact_match: false)
       }
     else
       @routes_inspector = ActionDispatch::Routing::RoutesInspector.new(_routes.routes)
@@ -33,11 +33,31 @@ class Rails::InfoController < Rails::ApplicationController # :nodoc:
   end
 
   private
-    def match_route
-      _routes.routes.filter_map { |route| route.path.spec.to_s if yield route.path }
-    end
+    def matching_routes(query:, exact_match:)
+      return [] if query.blank?
+
+      normalized_path = ("/" + query).squeeze("/")
+      query_without_url_or_path_suffix = query.gsub(/(\w)(_path$)/, '\1').gsub(/(\w)(_url$)/, '\1')
+
+      _routes.routes.filter_map do |route|
+        route_wrapper = ActionDispatch::Routing::RouteWrapper.new(route)
+
+        if exact_match
+          match = route.path.match(normalized_path)
+          match ||= (query_without_url_or_path_suffix === route_wrapper.name)
+        else
+          match = route_wrapper.path.match(query)
+          match ||= route_wrapper.name.include?(query_without_url_or_path_suffix)
+        end
+
+        match ||= (query === route_wrapper.verb)
+
+        unless match
+          controller_action = URI::DEFAULT_PARSER.escape(route_wrapper.reqs)
+          match = exact_match ? (query === controller_action) : controller_action.include?(query)
+        end
 
-    def with_leading_slash(path)
-      ("/" + path).squeeze("/")
+        route_wrapper.path if match
+      end
     end
 end