railties 5.2.0 → 6.1.0

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,29 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module Rails
+  module Generators
+    class BenchmarkGenerator < NamedBase
+      IPS_GEM_NAME = "benchmark-ips"
+
+      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?(/gem.*\b#{IPS_GEM_NAME}\b.*/)
+        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,5 +1,5 @@
 Description:
-    Stubs out a new controller and its views. Pass the controller name, either
+    Generates a new controller and its views. Pass the controller name, either
     CamelCased or under_scored, and a list of views as arguments.
 
     To create a controller within a module, specify the controller name as a
@@ -9,7 +9,7 @@ Description:
     template engine, assets, and test framework generators.
 
 Example:
-    `rails generate controller CreditCards open debit credit close`
+    `bin/rails generate controller CreditCards open debit credit close`
 
     CreditCards controller with URLs like /credit_cards/debit.
         Controller: app/controllers/credit_cards_controller.rb

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

@@ -17,50 +17,21 @@ 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
+      hook_for :template_engine, :test_framework, :helper, :assets do |generator|
+        invoke generator, [ remove_possible_suffix(name), actions ]
+      end
 
       private
+        def file_name
+          @_file_name ||= remove_possible_suffix(super)
+        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
+        def remove_possible_suffix(name)
+          name.sub(/_?controller$/i, "")
         end
     end
   end

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

@@ -2,7 +2,6 @@
 
 require "rails/generators/base"
 require "rails/generators/rails/master_key/master_key_generator"
-require "active_support/core_ext/string/strip"
 require "active_support/encrypted_configuration"
 
 module Rails
@@ -43,13 +42,13 @@ module Rails
         end
 
         def credentials_template
-          <<-YAML.strip_heredoc
-          # aws:
-          #   access_key_id: 123
-          #   secret_access_key: 345
+          <<~YAML
+            # aws:
+            #   access_key_id: 123
+            #   secret_access_key: 345
 
-          # Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
-          secret_key_base: #{SecureRandom.hex(64)}
+            # Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
+            secret_key_base: #{SecureRandom.hex(64)}
           YAML
         end
     end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Rails
+  module Generators
+    module Db
+      module System
+        class ChangeGenerator < Base # :nodoc:
+          include Database
+          include AppName
+
+          class_option :to, required: true,
+            desc: "The database system to switch to."
+
+          def self.default_generator_root
+            path = File.expand_path(File.join(base_name, "app"), base_root)
+            path if File.exist?(path)
+          end
+
+          def initialize(*)
+            super
+
+            unless DATABASES.include?(options[:to])
+              raise Error, "Invalid value for --to option. Supported preconfigurations are: #{DATABASES.join(", ")}."
+            end
+
+            opt = options.dup
+            opt[:database] ||= opt[:to]
+            self.options = opt.freeze
+          end
+
+          def edit_database_config
+            template("config/databases/#{options[:database]}.yml", "config/database.yml")
+          end
+
+          def edit_gemfile
+            name, version = gem_for_database
+            gsub_file("Gemfile", all_database_gems_regex, name)
+            gsub_file("Gemfile", gem_entry_regex_for(name), gem_entry_for(name, *version))
+          end
+
+          private
+            def all_database_gems
+              DATABASES.map { |database| gem_for_database(database) }
+            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 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 #{gem_name_and_version.join(", ")}"
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails/generators/base"
-require "active_support/core_ext/string/strip"
 require "active_support/encrypted_file"
 
 module Rails
@@ -9,17 +8,21 @@ 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
 
       private
         def encrypted_file_template
-          <<-YAML.strip_heredoc
-          # aws:
-          #   access_key_id: 123
-          #   secret_access_key: 345
+          <<~YAML
+            # aws:
+            #   access_key_id: 123
+            #   secret_access_key: 345
 
           YAML
         end

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

@@ -27,6 +27,7 @@ module Rails
 
       def add_key_file_silently(key_path, key = nil)
         create_file key_path, key || ActiveSupport::EncryptedFile.generate_key
+        key_path.chmod 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/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/helper/helper_generator.rb

@@ -10,6 +10,11 @@ module Rails
       end
 
       hook_for :test_framework
+
+      private
+        def file_name
+          @_file_name ||= super.sub(/_helper\z/i, "")
+        end
     end
   end
 end

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,5 +1,5 @@
 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.
@@ -8,12 +8,12 @@ Description:
     column lines from supplied attributes: AddColumnsToTable or RemoveColumnsFromTable
 
 Example:
-    `rails generate migration AddSslFlag`
+    `bin/rails generate migration AddSslFlag`
 
     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 AddTitleBodyToPost 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:
 
@@ -25,7 +25,7 @@ Migration names containing JoinTable will generate join tables for use with
 has_and_belongs_to_many associations.
 
 Example:
-    `rails g migration CreateMediaJoinTable artists musics:uniq`
+    `bin/rails g migration CreateMediaJoinTable artists musics:uniq`
 
     will create the migration
 

data/lib/rails/generators/rails/model/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Stubs out a new model. Pass the model name, either CamelCased or
+    Generates a new model. Pass the model name, either CamelCased or
     under_scored, and an optional list of attribute pairs as arguments.
 
     Attribute pairs are field:type arguments specifying the
@@ -29,7 +29,7 @@ Available field types:
     Just after the field name you can specify a type like text or boolean.
     It will generate the column with the associated SQL type. For instance:
 
-        `rails generate model post title:string body:text`
+        `bin/rails generate model post title:string body:text`
 
     will generate a title column with a varchar type and a body column with a text
     type. If no type is specified the string type will be used by default.
@@ -49,47 +49,47 @@ Available field types:
 
     You can also consider `references` as a kind of type. For instance, if you run:
 
-        `rails generate model photo title:string album:references`
+        `bin/rails generate model photo title:string album:references`
 
     It will generate an `album_id` column. You should generate these kinds of fields when
     you will use a `belongs_to` association, for instance. `references` also supports
     polymorphism, you can enable polymorphism like this:
 
-        `rails generate model product supplier:references{polymorphic}`
+        `bin/rails generate model product supplier:references{polymorphic}`
 
     For integer, string, text and binary fields, an integer in curly braces will
     be set as the limit:
 
-        `rails generate model user pseudo:string{30}`
+        `bin/rails generate model user pseudo:string{30}`
 
     For decimal, two integers separated by a comma in curly braces will be used
     for precision and scale:
 
-        `rails generate model product 'price:decimal{10,2}'`
+        `bin/rails generate model product 'price:decimal{10,2}'`
 
     You can add a `:uniq` or `:index` suffix for unique or standard indexes
     respectively:
 
-        `rails generate model user pseudo:string:uniq`
-        `rails generate model user pseudo:string:index`
+        `bin/rails generate model user pseudo:string:uniq`
+        `bin/rails generate model user pseudo:string:index`
 
     You can combine any single curly brace option with the index options:
 
-        `rails generate model user username:string{30}:uniq`
-        `rails generate model product supplier:references{polymorphic}:index`
+        `bin/rails generate model user username:string{30}:uniq`
+        `bin/rails generate model product supplier:references{polymorphic}:index`
 
     If you require a `password_digest` string column for use with
     has_secure_password, you can specify `password:digest`:
 
-        `rails generate model user password:digest`
+        `bin/rails generate model user password:digest`
 
     If you require a `token` string column for use with
     has_secure_token, you can specify `auth_token:token`:
 
-        `rails generate model user auth_token:token`
+        `bin/rails generate model user auth_token:token`
 
 Examples:
-    `rails generate model account`
+    `bin/rails generate model account`
 
         For Active Record and TestUnit it creates:
 
@@ -98,11 +98,11 @@ Examples:
             Fixtures:   test/fixtures/accounts.yml
             Migration:  db/migrate/XXX_create_accounts.rb
 
-    `rails generate model post title:string body:text published:boolean`
+    `bin/rails generate model post title:string body:text published:boolean`
 
         Creates a Post model with a string title, text body, and published flag.
 
-    `rails generate model admin/account`
+    `bin/rails generate model admin/account`
 
         For Active Record and TestUnit it creates:
 
@@ -111,4 +111,3 @@ Examples:
             Test:       test/models/admin/account_test.rb
             Fixtures:   test/fixtures/admin/accounts.yml
             Migration:  db/migrate/XXX_create_admin_accounts.rb
-