railties 6.1.6 → 7.1.2

data/lib/rails/generators/rails/app/USAGE

@@ -1,15 +1,31 @@
 Description:
-    The 'rails new' command creates a new Rails application with a default
+    The `rails new` command creates a new Rails application with a default
     directory structure and configuration at the path you specify.
 
     You can specify extra command-line arguments to be used every time
-    'rails new' runs in the .railsrc configuration file in your home directory,
+    `rails new` runs in the .railsrc configuration file in your home directory,
     or in $XDG_CONFIG_HOME/rails/railsrc if XDG_CONFIG_HOME is set.
 
     Note that the arguments specified in the .railsrc file don't affect the
-    defaults values shown above in this help message.
+    default values shown above in this help message.
 
-Example:
-    rails new ~/Code/Ruby/weblog
+    You can specify which version to use when creating a new rails application 
+    using `rails _<version>_ new`.
 
-    This generates a skeletal Rails installation in ~/Code/Ruby/weblog.
+Examples:
+    `rails new ~/Code/Ruby/weblog`
+
+    This generates a new Rails app in ~/Code/Ruby/weblog.
+
+    `rails _<version>_ new weblog`
+
+    This generates a new Rails app with the provided version in ./weblog.
+
+    `rails new weblog --api`
+
+    This generates a new Rails app in API mode in ./weblog.
+
+    `rails new weblog --skip-action-mailer`
+
+    This generates a new Rails app without Action Mailer in ./weblog.
+    Any part of Rails can be skipped during app generation.

data/lib/rails/generators/rails/app/app_generator.rb

@@ -21,8 +21,8 @@ module Rails
         RUBY
       end
 
-      def method_missing(meth, *args, &block)
-        @generator.send(meth, *args, &block)
+      def method_missing(...)
+        @generator.send(...)
       end
   end
 
@@ -54,6 +54,10 @@ module Rails
       template "ruby-version", ".ruby-version"
     end
 
+    def node_version
+      template "node-version", ".node-version"
+    end
+
     def gemfile
       template "Gemfile"
     end
@@ -70,16 +74,20 @@ module Rails
       template "gitattributes", ".gitattributes"
     end
 
+    def dockerfiles
+      template "Dockerfile"
+      template "dockerignore", ".dockerignore"
+
+      template "docker-entrypoint", "bin/docker-entrypoint"
+      chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false
+    end
+
     def version_control
       if !options[:skip_git] && !options[:pretend]
-        run "git init", capture: options[:quiet], abort_on_failure: false
+        run git_init_command, capture: options[:quiet], abort_on_failure: false
       end
     end
 
-    def package_json
-      template "package.json"
-    end
-
     def app
       directory "app"
 
@@ -94,58 +102,42 @@ module Rails
         "#{shebang}\n" + content
       end
       chmod "bin", 0755 & ~File.umask, verbose: false
-
-      remove_file "bin/spring" unless spring_install?
-      remove_file "bin/yarn" if options[:skip_javascript]
     end
 
     def bin_when_updating
       bin
     end
 
-    def yarn_when_updating
-      template "bin/yarn", force: true do |content|
-        "#{shebang}\n" + content
-      end
-
-      chmod "bin", 0755 & ~File.umask, verbose: false
-    end
-
     def config
       empty_directory "config"
 
       inside "config" do
-        template "routes.rb"
+        template "routes.rb" unless options[:update]
         template "application.rb"
         template "environment.rb"
-        template "cable.yml" unless options[:skip_action_cable]
-        template "puma.rb"   unless options[:skip_puma]
-        template "spring.rb" if spring_install?
-        template "storage.yml" unless skip_active_storage?
+        template "cable.yml" unless options[:update] || options[:skip_action_cable]
+        template "puma.rb"   unless options[:update]
+        template "storage.yml" unless options[:update] || skip_active_storage?
 
         directory "environments"
         directory "initializers"
-        directory "locales"
+        directory "locales" unless options[:update]
       end
     end
 
     def config_when_updating
-      cookie_serializer_config_exist = File.exist?("config/initializers/cookies_serializer.rb")
-      action_cable_config_exist      = File.exist?("config/cable.yml")
-      active_storage_config_exist    = File.exist?("config/storage.yml")
-      rack_cors_config_exist         = File.exist?("config/initializers/cors.rb")
-      assets_config_exist            = File.exist?("config/initializers/assets.rb")
-      csp_config_exist               = File.exist?("config/initializers/content_security_policy.rb")
+      action_cable_config_exist       = File.exist?("config/cable.yml")
+      active_storage_config_exist     = File.exist?("config/storage.yml")
+      rack_cors_config_exist          = File.exist?("config/initializers/cors.rb")
+      assets_config_exist             = File.exist?("config/initializers/assets.rb")
+      asset_manifest_exist            = File.exist?("app/assets/config/manifest.js")
+      asset_app_stylesheet_exist      = File.exist?("app/assets/stylesheets/application.css")
+      csp_config_exist                = File.exist?("config/initializers/content_security_policy.rb")
       permissions_policy_config_exist = File.exist?("config/initializers/permissions_policy.rb")
 
       @config_target_version = Rails.application.config.loaded_config_version || "5.0"
 
       config
-      configru
-
-      unless cookie_serializer_config_exist
-        gsub_file "config/initializers/cookies_serializer.rb", /json(?!,)/, "marshal"
-      end
 
       if !options[:skip_action_cable] && !action_cable_config_exist
         template "config/cable.yml"
@@ -155,19 +147,23 @@ module Rails
         template "config/storage.yml"
       end
 
-      if options[:skip_sprockets] && !assets_config_exist
+      if skip_sprockets? && skip_propshaft? && !assets_config_exist
         remove_file "config/initializers/assets.rb"
       end
 
+      if skip_sprockets? && !asset_manifest_exist
+        remove_file "app/assets/config/manifest.js"
+      end
+
+      if skip_sprockets? && !asset_app_stylesheet_exist
+        remove_file "app/assets/stylesheets/application.css"
+      end
+
       unless rack_cors_config_exist
         remove_file "config/initializers/cors.rb"
       end
 
       if options[:api]
-        unless cookie_serializer_config_exist
-          remove_file "config/initializers/cookies_serializer.rb"
-        end
-
         unless csp_config_exist
           remove_file "config/initializers/content_security_policy.rb"
         end
@@ -191,7 +187,15 @@ module Rails
       return if options[:pretend] || options[:dummy_app]
 
       require "rails/generators/rails/credentials/credentials_generator"
-      Rails::Generators::CredentialsGenerator.new([], quiet: options[:quiet]).add_credentials_file_silently
+      Rails::Generators::CredentialsGenerator.new([], quiet: true).add_credentials_file
+    end
+
+    def credentials_diff_enroll
+      return if options[:skip_decrypted_diffs] || options[:dummy_app] || options[:pretend]
+
+      @generator.shell.mute do
+        rails_command "credentials:diff --enroll", inline: true, shell: @generator.shell
+      end
     end
 
     def database_yml
@@ -263,74 +267,73 @@ module Rails
     class AppGenerator < AppBase
       # :stopdoc:
 
-      WEBPACKS = %w( react vue angular elm stimulus )
-
       add_shared_options_for "application"
 
       # Add rails command options
-      class_option :version, type: :boolean, aliases: "-v", group: :rails,
-                             desc: "Show Rails version number and quit"
-
-      class_option :api, type: :boolean,
-                         desc: "Preconfigure smaller stack for API only apps"
-
-      class_option :minimal, type: :boolean,
-                             desc: "Preconfigure a minimal rails app"
-
-      class_option :skip_bundle, type: :boolean, aliases: "-B", default: false,
-                                 desc: "Don't run bundle install"
+      class_option :version, type: :boolean, aliases: "-v", group: :rails, desc: "Show Rails version number and quit"
+      class_option :api, type: :boolean, desc: "Preconfigure smaller stack for API only apps"
+      class_option :minimal, type: :boolean, desc: "Preconfigure a minimal rails app"
+      class_option :javascript, type: :string, aliases: ["-j", "--js"], default: "importmap", desc: "Choose JavaScript approach [options: importmap (default), bun, webpack, esbuild, rollup]"
+      class_option :css, type: :string, aliases: "-c", desc: "Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass] check https://github.com/rails/cssbundling-rails for more options"
+      class_option :skip_bundle, type: :boolean, aliases: "-B", default: nil, desc: "Don't run bundle install"
+      class_option :skip_decrypted_diffs, type: :boolean, default: nil, desc: "Don't configure git to show decrypted diffs of encrypted credentials"
+
+      OPTION_IMPLICATIONS = # :nodoc:
+        AppBase::OPTION_IMPLICATIONS.merge(
+          skip_git: [:skip_decrypted_diffs],
+          minimal: [
+            :skip_action_cable,
+            :skip_action_mailbox,
+            :skip_action_mailer,
+            :skip_action_text,
+            :skip_active_job,
+            :skip_active_storage,
+            :skip_bootsnap,
+            :skip_dev_gems,
+            :skip_hotwire,
+            :skip_javascript,
+            :skip_jbuilder,
+            :skip_system_test,
+          ],
+          api: [
+            :skip_asset_pipeline,
+            :skip_javascript,
+          ],
+        ) do |option, implications, more_implications|
+          implications + more_implications
+        end
 
-      class_option :webpack, type: :string, aliases: "--webpacker", default: nil,
-                             desc: "Preconfigure Webpack with a particular framework (options: #{WEBPACKS.join(", ")})"
+      META_OPTIONS = [:minimal] # :nodoc:
 
-      class_option :skip_webpack_install, type: :boolean, default: false,
-                                          desc: "Don't run Webpack install"
+      def self.apply_rails_template(template, destination) # :nodoc:
+        generator = new([destination], { template: template }, { destination_root: destination })
+        generator.set_default_accessors!
+        generator.apply_rails_template
+        generator.run_bundle
+        generator.run_after_bundle_callbacks
+      end
 
       def initialize(*args)
         super
 
+        imply_options(OPTION_IMPLICATIONS, meta_options: META_OPTIONS)
+
         if !options[:skip_active_record] && !DATABASES.include?(options[:database])
           raise Error, "Invalid value for --database option. Supported preconfigurations are: #{DATABASES.join(", ")}."
         end
 
-        # Force sprockets and yarn to be skipped when generating API only apps.
-        # Can't modify options hash as it's frozen by default.
-        if options[:api]
-          self.options = options.merge(skip_sprockets: true, skip_javascript: true).freeze
-        end
-
-        if options[:minimal]
-          self.options = options.merge(
-            skip_action_cable: true,
-            skip_action_mailer: true,
-            skip_action_mailbox: true,
-            skip_action_text: true,
-            skip_active_job: true,
-            skip_active_storage: true,
-            skip_bootsnap: true,
-            skip_dev_gems: true,
-            skip_javascript: true,
-            skip_jbuilder: true,
-            skip_spring: true,
-            skip_system_test: true,
-            skip_webpack_install: true,
-            skip_turbolinks: true).tap do |option|
-              if option[:webpack]
-                option[:skip_webpack_install] = false
-                option[:skip_javascript] = false
-              end
-            end.freeze
-        end
-
         @after_bundle_callbacks = []
       end
 
+      public_task :report_implied_options
       public_task :set_default_accessors!
       public_task :create_root
+      public_task :target_rails_prerelease
 
       def create_root_files
         build(:readme)
         build(:rakefile)
+        build(:node_version) if using_node?
         build(:ruby_version)
         build(:configru)
 
@@ -339,9 +342,8 @@ module Rails
           build(:gitattributes)
         end
 
-        build(:gemfile) unless options[:skip_gemfile]
+        build(:gemfile)
         build(:version_control)
-        build(:package_json) unless options[:skip_javascript]
       end
 
       def create_app_files
@@ -357,11 +359,6 @@ module Rails
       end
       remove_task :update_bin_files
 
-      def update_bin_yarn
-        build(:yarn_when_updating)
-      end
-      remove_task :update_bin_yarn
-
       def update_active_storage
         unless skip_active_storage?
           rails_command "active_storage:update", inline: true
@@ -369,6 +366,11 @@ module Rails
       end
       remove_task :update_active_storage
 
+      def create_dockerfiles
+        return if options[:skip_docker] || options[:dummy_app]
+        build(:dockerfiles)
+      end
+
       def create_config_files
         build(:config)
       end
@@ -384,6 +386,7 @@ module Rails
 
       def create_credentials
         build(:credentials)
+        build(:credentials_diff_enroll)
       end
 
       def display_upgrade_guide_info
@@ -434,7 +437,7 @@ module Rails
       end
 
       def create_storage_files
-        build(:storage) unless skip_active_storage?
+        build(:storage)
       end
 
       def delete_app_assets_if_api_option
@@ -473,22 +476,16 @@ module Rails
         end
       end
 
-      def delete_js_folder_skipping_javascript
-        if options[:skip_javascript] && !options[:minimal]
-          remove_dir "app/javascript"
-        end
-      end
-
-      def delete_js_packs_when_minimal_skipping_webpack
-        if options[:minimal] && options[:skip_webpack_install]
-          remove_dir "app/javascript/packs"
-          keep_file  "app/javascript"
+      def delete_assets_initializer_skipping_sprockets_and_propshaft
+        if skip_sprockets? && skip_propshaft?
+          remove_file "config/initializers/assets.rb"
         end
-      end
 
-      def delete_assets_initializer_skipping_sprockets
-        if options[:skip_sprockets]
-          remove_file "config/initializers/assets.rb"
+        if skip_sprockets?
+          remove_file "app/assets/config/manifest.js"
+          remove_dir  "app/assets/config"
+          remove_file "app/assets/stylesheets/application.css"
+          create_file "app/assets/stylesheets/application.css", "/* Application styles */\n" unless options[:api]
         end
       end
 
@@ -523,7 +520,6 @@ module Rails
 
       def delete_non_api_initializers_if_api_option
         if options[:api]
-          remove_file "config/initializers/cookies_serializer.rb"
           remove_file "config/initializers/content_security_policy.rb"
           remove_file "config/initializers/permissions_policy.rb"
         end
@@ -537,7 +533,7 @@ module Rails
 
       def delete_new_framework_defaults
         unless options[:update]
-          remove_file "config/initializers/new_framework_defaults_6_1.rb"
+          remove_file "config/initializers/new_framework_defaults_#{Rails::VERSION::MAJOR}_#{Rails::VERSION::MINOR}.rb"
         end
       end
 
@@ -545,9 +541,12 @@ module Rails
         build(:leftovers)
       end
 
-      public_task :apply_rails_template, :run_bundle
+      public_task :apply_rails_template
+      public_task :run_bundle
       public_task :generate_bundler_binstub
-      public_task :run_webpack
+      public_task :run_javascript
+      public_task :run_hotwire
+      public_task :run_css
 
       def run_after_bundle_callbacks
         @after_bundle_callbacks.each(&:call)
@@ -565,7 +564,7 @@ module Rails
         create_file(*args, &block)
       end
 
-      # Registers a callback to be executed after bundle and spring binstubs
+      # Registers a callback to be executed after bundle binstubs
       # have run.
       #
       #   after_bundle do

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

@@ -0,0 +1,103 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=<%= gem_ruby_version %>
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages needed to build gems<%= using_node? ? " and node modules" : "" %>
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y <%= dockerfile_build_packages.join(" ") %>
+
+<% if using_node? -%>
+# Install JavaScript dependencies
+ARG NODE_VERSION=<%= node_version %>
+ARG YARN_VERSION=<%= dockerfile_yarn_version %>
+ENV PATH=/usr/local/node/bin:$PATH
+RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
+    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
+    npm install -g yarn@$YARN_VERSION && \
+    rm -rf /tmp/node-build-master
+
+<% end -%>
+<% if using_bun? -%>
+ENV BUN_INSTALL=/usr/local/bun
+ENV PATH=/usr/local/bun/bin:$PATH
+ARG BUN_VERSION=<%= dockerfile_bun_version %>
+RUN curl -fsSL https://bun.sh/install | bash -s -- "bun-v${BUN_VERSION}"
+
+<% end -%>
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git<% if depend_on_bootsnap? -%> && \
+    bundle exec bootsnap precompile --gemfile<% end %>
+
+<% if using_node? -%>
+# Install node modules
+COPY package.json yarn.lock ./
+RUN yarn install --frozen-lockfile
+
+<% end -%>
+<% if using_bun? -%>
+# Install node modules
+COPY package.json bun.lockb ./
+RUN bun install --frozen-lockfile
+
+<% end -%>
+# Copy application code
+COPY . .
+
+<% if depend_on_bootsnap? -%>
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+<% end -%>
+<% unless dockerfile_binfile_fixups.empty? -%>
+# Adjust binfiles to be executable on Linux
+<%= "RUN " + dockerfile_binfile_fixups.join(" && \\\n    ") %>
+
+<% end -%>
+<% unless options.api? || skip_asset_pipeline? -%>
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+<% end -%>
+
+# Final stage for app image
+FROM base
+
+<% unless dockerfile_deploy_packages.empty? -%>
+# Install packages needed for deployment
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y <%= dockerfile_deploy_packages.join(" ") %> && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+<% end -%>
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN useradd rails --create-home --shell /bin/bash && \
+    chown -R rails:rails <%= dockerfile_chown_directories.join(" ") %>
+USER rails:rails
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

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

@@ -1,78 +1,68 @@
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+source "https://rubygems.org"
 
-ruby <%= "'#{RUBY_VERSION}'" -%>
+ruby <%= "\"#{gem_ruby_version}\"" -%>
 
-<% unless gemfile_entries.first&.comment -%>
-
-<% end -%>
-<% gemfile_entries.each do |gem| -%>
-<% if gem.comment -%>
-
-# <%= gem.comment %>
-<% end -%>
-<%= gem.commented_out ? '# ' : '' %>gem '<%= gem.name %>'<%= %(, '#{gem.version}') if gem.version -%>
-<% if gem.options.any? -%>
-, <%= gem.options.map { |k,v|
-  "#{k}: #{v.inspect.gsub('"', '\'')}" }.join(', ') %>
-<% end -%>
+<% gemfile_entries.each do |gemfile_entry| %>
+<%= gemfile_entry %>
 <% end -%>
+<% unless options.minimal? -%>
 
-# Use Active Model has_secure_password
-# gem 'bcrypt', '~> 3.1.7'
-<% unless skip_active_storage? -%>
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
 
-# Use Active Storage variant
-# gem 'image_processing', '~> 1.2'
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
 <% end -%>
 
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ <%= bundler_windows_platforms %> jruby ]
 <% if depend_on_bootsnap? -%>
+
 # Reduces boot times through caching; required in config/boot.rb
-gem 'bootsnap', '>= 1.4.4', require: false
+gem "bootsnap", require: false
+<% end -%>
+<% unless skip_active_storage? -%>
 
-<%- end -%>
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+<% end -%>
 <%- if options.api? -%>
-# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
-# gem 'rack-cors'
 
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin Ajax possible
+# gem "rack-cors"
 <%- end -%>
-<% if RUBY_ENGINE == 'ruby' -%>
+<% if RUBY_ENGINE == "ruby" -%>
+
 group :development, :test do
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri <%= bundler_windows_platforms %> ]
 end
-
 <% end -%>
+
 group :development do
 <%- unless options.api? || options.skip_dev_gems? -%>
-  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
-  <%- if options.dev? || options.edge? || options.master? -%>
-  gem 'web-console', github: 'rails/web-console'
-  <%- else -%>
-  gem 'web-console', '>= 4.1.0'
-  <%- end -%>
-  # Display performance information such as SQL time and flame graphs for each request in your browser.
-  # Can be configured to work on production as well see: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md
-  gem 'rack-mini-profiler', '~> 2.0'
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+<%- end -%>
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+<%- if RUBY_VERSION >= "3.1" && RUBY_VERSION < "3.2" -%>
+
+  gem "error_highlight", ">= 0.4.0", platforms: [:ruby]
 <%- end -%>
-<% if depend_on_listen? -%>
-  gem 'listen', '~> 3.3'
-<% end -%>
-<% if spring_install? -%>
-  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-  gem 'spring'
-<% end -%>
 end
 
 <%- if depends_on_system_test? -%>
 group :test do
-  # Adds support for Capybara system testing and selenium driver
-  gem 'capybara', '>= 3.26'
-  gem 'selenium-webdriver', '>= 4.0.0.rc1'
-  # Easy installation and use of web drivers to run system tests with browsers
-  gem 'webdrivers'
+  # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
+  gem "capybara"
+  gem "selenium-webdriver"
+<%- if RUBY_VERSION < "3.0" -%>
+  gem "webdrivers"
+<%- end -%>
 end
-
 <%- end -%>
-# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]