railties 6.0.0 → 7.1.3.2

data/lib/rails/generators/rails/benchmark/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Generate benchmarks to compare performance optimizations.
+
+    Makes use of the `benchmark-ips` gem as it provides a number of benefits like:
+     - Simple significance test
+     - Automatic warmup
+     - No need to specify the number of iterations
+
+Example:
+    `bin/rails generate benchmark opt_compare`
+
+    This will create:
+        script/benchmarks/opt_compare.rb
+
+    You can run the generated benchmark file using:
+        `ruby script/benchmarks/opt_compare.rb`
+
+    You can specify different reports:
+        `bin/rails generate benchmark opt_compare patch1 patch2 patch3`

data/lib/rails/generators/rails/benchmark/benchmark_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+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"]
+
+      def generate_layout
+        add_ips_to_gemfile unless ips_installed?
+        template("benchmark.rb.tt", "script/benchmarks/#{file_name}.rb")
+      end
+
+    private
+      def add_ips_to_gemfile
+        gem(IPS_GEM_NAME, group: [:development, :test])
+      end
+
+      def ips_installed?
+        in_root do
+          return File.read("Gemfile").match?(IPS_GEM_USED_REGEXP)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../../config/environment"
+
+# Any benchmarking setup goes here...
+
+
+
+Benchmark.ips do |x|
+<%- reports.each do |report| -%>
+  x.report("<%= report %>") { }
+<%- end -%>
+
+  x.compare!
+end

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

@@ -1,6 +1,6 @@
 Description:
-    Stubs out a new controller and its views. Pass the controller name, either
-    CamelCased or under_scored, and a list of views as arguments.
+    Generates a new controller and its views. Pass the controller name, either
+    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:
-    `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,7 +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 :assets, type: :boolean
+      class_option :parent, type: :string, default: "ApplicationController", desc: "The parent class for the generated controller"
 
       check_class_collision suffix: "Controller"
 
@@ -17,14 +17,18 @@ module Rails
       def add_routes
         return if options[:skip_routes]
         return if actions.empty?
-        route generate_routing_code
+        routing_code = actions.map { |action| "get '#{file_name}/#{action}'" }.join("\n")
+        route routing_code, namespace: regular_class_path
       end
 
-      hook_for :template_engine, :test_framework, :helper, :assets do |generator|
+      hook_for :template_engine, :test_framework, :helper do |generator|
         invoke generator, [ remove_possible_suffix(name), actions ]
       end
 
       private
+        def parent_class_name
+          options[:parent]
+        end
 
         def file_name
           @_file_name ||= remove_possible_suffix(super)
@@ -33,45 +37,6 @@ module Rails
         def remove_possible_suffix(name)
           name.sub(/_?controller$/i, "")
         end
-
-        # This method creates nested route entry for namespaced resources.
-        # For eg. rails g controller foo/bar/baz index show
-        # Will generate -
-        # namespace :foo do
-        #   namespace :bar do
-        #     get 'baz/index'
-        #     get 'baz/show'
-        #   end
-        # end
-        def generate_routing_code
-          depth = 0
-          lines = []
-
-          # Create 'namespace' ladder
-          # namespace :foo do
-          #   namespace :bar do
-          regular_class_path.each do |ns|
-            lines << indent("namespace :#{ns} do\n", depth * 2)
-            depth += 1
-          end
-
-          # Create route
-          #     get 'baz/index'
-          #     get 'baz/show'
-          actions.each do |action|
-            lines << indent(%{get '#{file_name}/#{action}'\n}, depth * 2)
-          end
-
-          # Create `end` ladder
-          #   end
-          # end
-          until depth.zero?
-            depth -= 1
-            lines << indent("end\n", depth * 2)
-          end
-
-          lines.join
-        end
     end
   end
 end

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

@@ -1,9 +1,5 @@
-<% if namespaced? -%>
-require_dependency "<%= namespaced_path %>/application_controller"
-
-<% end -%>
 <% 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 `rails credentials:edit`."
+          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,22 +40,52 @@ 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
 
             def gem_entry_for(*gem_name_and_version)
-              gem_name_and_version.map! { |segment| "'#{segment}'" }
+              gem_name_and_version.map! { |segment| "\"#{segment}\"" }
               "gem #{gem_name_and_version.join(", ")}"
             end
         end

data/lib/rails/generators/rails/encrypted_file/encrypted_file_generator.rb

@@ -8,8 +8,12 @@ module Rails
     class EncryptedFileGenerator < Base # :nodoc:
       def add_encrypted_file_silently(file_path, key_path, template = encrypted_file_template)
         unless File.exist?(file_path)
-          setup = { content_path: file_path, key_path: key_path, env_key: "RAILS_MASTER_KEY", raise_if_missing_key: true }
-          ActiveSupport::EncryptedFile.new(setup).write(template)
+          ActiveSupport::EncryptedFile.new(
+            content_path: file_path,
+            key_path: key_path,
+            env_key: "RAILS_MASTER_KEY",
+            raise_if_missing_key: true
+          ).write(template)
         end
       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/generator/USAGE

@@ -1,9 +1,9 @@
 Description:
-    Stubs out a new generator at lib/generators. Pass the generator name as an argument,
+    Generates a new generator at lib/generators. Pass the generator name as an argument,
     either CamelCased or snake_cased.
 
 Example:
-    `rails generate generator Awesome`
+    `bin/rails generate generator Awesome`
 
     creates a standard awesome generator:
         lib/generators/awesome/

data/lib/rails/generators/rails/generator/generator_generator.rb

@@ -15,7 +15,6 @@ module Rails
       hook_for :test_framework
 
       private
-
         def generator_dir
           if options[:namespace]
             File.join("lib", "generators", regular_class_path, file_name)

data/lib/rails/generators/rails/generator/templates/%file_name%_generator.rb.tt

@@ -1,3 +1,3 @@
 class <%= class_name %>Generator < Rails::Generators::NamedBase
-  source_root File.expand_path('templates', __dir__)
+  source_root File.expand_path("templates", __dir__)
 end

data/lib/rails/generators/rails/generator/templates/USAGE.tt

@@ -2,7 +2,7 @@ Description:
     Explain the generator
 
 Example:
-    rails generate <%= file_name %> Thing
+    bin/rails generate <%= file_name %> Thing
 
     This will create:
         what/will/it/create

data/lib/rails/generators/rails/helper/USAGE

@@ -1,13 +1,12 @@
 Description:
-    Stubs out a new helper. Pass the helper name, either CamelCased
+    Generates a new helper. Pass the helper name, either CamelCased
     or under_scored.
 
     To create a helper within a module, specify the helper name as a
     path like 'parent_module/helper_name'.
 
 Example:
-    `rails generate helper CreditCard`
+    `bin/rails generate helper CreditCard`
 
     Credit card helper.
         Helper:     app/helpers/credit_card_helper.rb
-

data/lib/rails/generators/rails/integration_test/USAGE

@@ -1,10 +1,10 @@
 Description:
-    Stubs out a new integration test. Pass the name of the test, either
+    Generates a new integration test. Pass the name of the test, either
     CamelCased or under_scored, as an argument.
 
     This generator invokes the current integration tool, which defaults to
     TestUnit.
 
 Example:
-    `rails generate integration_test GeneralStories` creates a GeneralStories
+    `bin/rails generate integration_test GeneralStories` creates a GeneralStories
     integration test in test/integration/general_stories_test.rb

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

@@ -1,35 +1,45 @@
 Description:
-    Stubs out a new database migration. Pass the migration name, either
+    Generates a new database migration. Pass the migration name, either
     CamelCased or under_scored, and an optional list of attribute pairs as arguments.
 
     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:
-    `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
 
-    `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:
-    `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.