railties 7.0.8 → 7.1.0.beta1

data/lib/rails/generators/rails/app/templates/config/puma.rb.tt

@@ -1,43 +1,34 @@
+# This configuration file will be evaluated by Puma. The top-level methods that
+# are invoked here are part of Puma's configuration DSL. For more information
+# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
+
 # Puma can serve each request in a thread from an internal thread pool.
 # The `threads` method setting takes two numbers: a minimum and maximum.
 # Any libraries that use thread pools should be configured to match
 # the maximum value specified for Puma. Default is set to 5 threads for minimum
 # and maximum; this matches the default thread size of Active Record.
-#
 max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
 min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
 threads min_threads_count, max_threads_count
 
+# Specifies that the worker count should equal the number of processors in production.
+if ENV["RAILS_ENV"] == "production"
+  worker_count = Integer(ENV.fetch("WEB_CONCURRENCY") { Concurrent.physical_processor_count })
+  workers worker_count if worker_count > 1
+end
+
 # Specifies the `worker_timeout` threshold that Puma will use to wait before
 # terminating a worker in development environments.
-#
 worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
 
 # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
-#
 port ENV.fetch("PORT") { 3000 }
 
 # Specifies the `environment` that Puma will run in.
-#
 environment ENV.fetch("RAILS_ENV") { "development" }
 
 # Specifies the `pidfile` that Puma will use.
 pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
 
-# Specifies the number of `workers` to boot in clustered mode.
-# Workers are forked web server processes. If using threads and workers together
-# the concurrency of the application would be max `threads` * `workers`.
-# Workers do not work on JRuby or Windows (both of which do not support
-# processes).
-#
-# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
-
-# Use the `preload_app!` method when specifying a `workers` number.
-# This directive tells Puma to first boot the application and load code
-# before forking the application. This takes advantage of Copy On Write
-# process behavior so workers use less memory.
-#
-# preload_app!
-
 # Allow puma to be restarted by `bin/rails restart` command.
 plugin :tmp_restart

data/lib/rails/generators/rails/app/templates/config/routes.rb.tt

@@ -1,6 +1,10 @@
 Rails.application.routes.draw do
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
+  # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
+  # Can be used by load balancers and uptime monitors to verify that the app is live.
+  get "up" => "rails/health#show", as: :rails_health_check
+
   # Defines the root path route ("/")
   # root "articles#index"
 end

data/lib/rails/generators/rails/app/templates/db/seeds.rb.tt

@@ -1,7 +1,9 @@
-# This file should contain all the record creation needed to seed the database with its default values.
+# This file should ensure the existence of records required to run the application in every environment (production,
+# development, test). The code here should be idempotent so that it can be executed at any point in every environment.
 # The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
 #
-# Examples:
+# Example:
 #
-#   movies = Movie.create([{ name: "Star Wars" }, { name: "Lord of the Rings" }])
-#   Character.create(name: "Luke", movie: movies.first)
+#   ["Action", "Comedy", "Drama", "Horror"].each do |genre_name|
+#     MovieGenre.find_or_create_by!(name: genre_name)
+#   end

data/lib/rails/generators/rails/app/templates/docker-entrypoint.tt

@@ -0,0 +1,10 @@
+#!/bin/bash -e
+
+<% unless skip_active_record? -%>
+# If running the rails server then create or migrate existing database
+if [ "${*}" == "./bin/rails server" ]; then
+  ./bin/rails db:prepare
+fi
+
+<% end -%>
+exec "${@}"

data/lib/rails/generators/rails/app/templates/dockerignore.tt

@@ -0,0 +1,43 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all environment files.
+/.env*
+!/.env.example
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+<% if keeps? -%>
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+<% end -%>
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+<% if keeps? -%>
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+<% end -%>
+<% unless options.api? -%>
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+<% end -%>

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

@@ -7,12 +7,6 @@
 # Ignore bundler config.
 /.bundle
 
-<% if sqlite3? -%>
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-*
-
-<% end -%>
 # Ignore all logfiles and tempfiles.
 /log/*
 /tmp/*
@@ -26,8 +20,7 @@
 !/tmp/pids/.keep
 <% end -%>
 
-<% unless skip_active_storage? -%>
-# Ignore uploaded files in development.
+# Ignore storage (uploaded files in development and any SQLite databases).
 /storage/*
 <% if keeps? -%>
 !/storage/.keep
@@ -35,7 +28,6 @@
 !/tmp/storage/
 !/tmp/storage/.keep
 <% end -%>
-<% end -%>
 <% unless options.api? -%>
 
 /public/assets

data/lib/rails/generators/rails/app/templates/node-version.tt

@@ -0,0 +1 @@
+<%= node_version %>

data/lib/rails/generators/rails/app/templates/test/channels/application_cable/connection_test.rb.tt

@@ -1,11 +1,13 @@
 require "test_helper"
 
-class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
-  # test "connects with cookies" do
-  #   cookies.signed[:user_id] = 42
-  #
-  #   connect
-  #
-  #   assert_equal connection.user_id, "42"
-  # end
+module ApplicationCable
+  class ConnectionTest < ActionCable::Connection::TestCase
+    # test "connects with cookies" do
+    #   cookies.signed[:user_id] = 42
+    #
+    #   connect
+    #
+    #   assert_equal connection.user_id, "42"
+    # end
+  end
 end

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

@@ -2,18 +2,20 @@ ENV["RAILS_ENV"] ||= "test"
 require_relative "../config/environment"
 require "rails/test_help"
 
-class ActiveSupport::TestCase
-  # Run tests in parallel with specified workers
+module ActiveSupport
+  class TestCase
+    # Run tests in parallel with specified workers
 <% if Process.respond_to?(:fork) && !Gem.win_platform? -%>
-  parallelize(workers: :number_of_processors)
+    parallelize(workers: :number_of_processors)
 <%- else -%>
-  parallelize(workers: :number_of_processors, with: :threads)
+    parallelize(workers: :number_of_processors, with: :threads)
 <% end -%>
 
 <% unless options[:skip_active_record] -%>
-  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
-  fixtures :all
+    # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+    fixtures :all
 
 <% end -%>
-  # Add more helper methods to be used by all tests here...
+    # Add more helper methods to be used by all tests here...
+  end
 end

data/lib/rails/generators/rails/application_record/application_record_generator.rb

@@ -4,6 +4,10 @@ module Rails
   module Generators
     class ApplicationRecordGenerator < Base # :nodoc:
       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/benchmark/benchmark_generator.rb

@@ -6,6 +6,7 @@ module Rails
   module Generators
     class BenchmarkGenerator < NamedBase
       IPS_GEM_NAME = "benchmark-ips"
+      IPS_GEM_USED_REGEXP = /gem.*\b#{IPS_GEM_NAME}\b.*/
 
       argument :reports, type: :array, default: ["before", "after"]
 
@@ -21,7 +22,7 @@ module Rails
 
       def ips_installed?
         in_root do
-          return File.read("Gemfile").match?(/gem.*\b#{IPS_GEM_NAME}\b.*/)
+          return File.read("Gemfile").match?(IPS_GEM_USED_REGEXP)
         end
       end
     end

data/lib/rails/generators/rails/controller/USAGE

@@ -1,6 +1,6 @@
 Description:
     Generates a new controller and its views. Pass the controller name, either
-    CamelCased or under_scored, and a list of views as arguments.
+    CamelCased or under_scored, and a list of actions as arguments.
 
     To create a controller within a module, specify the controller name as a
     path like 'parent_module/controller_name'.
@@ -8,11 +8,19 @@ Description:
     This generates a controller class in app/controllers and invokes helper,
     template engine, assets, and test framework generators.
 
-Example:
-    `bin/rails generate controller CreditCards open debit credit close`
+Examples:
+    `bin/rails generate controller credit_cards open debit credit close`
 
-    CreditCards controller with URLs like /credit_cards/debit.
+    This generates a `CreditCardsController` with routes like /credit_cards/debit.
         Controller: app/controllers/credit_cards_controller.rb
         Test:       test/controllers/credit_cards_controller_test.rb
         Views:      app/views/credit_cards/debit.html.erb [...]
         Helper:     app/helpers/credit_cards_helper.rb
+
+    `bin/rails generate controller users index --skip-routes`
+
+    This generates a `UsersController` with an index action and no routes.
+
+    `bin/rails generate controller admin/dashboard --parent=admin_controller`
+
+    This generates a `Admin::DashboardController` with an `AdminController` parent class.

data/lib/rails/generators/rails/controller/controller_generator.rb

@@ -6,6 +6,7 @@ module Rails
       argument :actions, type: :array, default: [], banner: "action action"
       class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
       class_option :helper, type: :boolean
+      class_option :parent, type: :string, default: "ApplicationController", desc: "The parent class for the generated controller"
 
       check_class_collision suffix: "Controller"
 
@@ -25,6 +26,10 @@ module Rails
       end
 
       private
+        def parent_class_name
+          options[:parent]
+        end
+
         def file_name
           @_file_name ||= remove_possible_suffix(super)
         end

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

@@ -1,5 +1,5 @@
 <% module_namespacing do -%>
-class <%= class_name %>Controller < ApplicationController
+class <%= class_name %>Controller < <%= parent_class_name.classify %>
 <% actions.each do |action| -%>
   def <%= action %>
   end

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/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