railties 5.2.7.1 → 6.1.4.6

data/lib/rails/generators/erb.rb

@@ -6,7 +6,6 @@ module Erb # :nodoc:
   module Generators # :nodoc:
     class Base < Rails::Generators::NamedBase #:nodoc:
       private
-
         def formats
           [format]
         end

data/lib/rails/generators/generated_attribute.rb

@@ -38,24 +38,24 @@ module Rails
         end
 
         private
-
-        # parse possible attribute options like :limit for string/text/binary/integer, :precision/:scale for decimals or :polymorphic for references/belongs_to
-        # when declaring options curly brackets should be used
-        def parse_type_and_options(type)
-          case type
-          when /(string|text|binary|integer)\{(\d+)\}/
-            return $1, limit: $2.to_i
-          when /decimal\{(\d+)[,.-](\d+)\}/
-            return :decimal, precision: $1.to_i, scale: $2.to_i
-          when /(references|belongs_to)\{(.+)\}/
-            type = $1
-            provided_options = $2.split(/[,.-]/)
-            options = Hash[provided_options.map { |opt| [opt.to_sym, true] }]
-            return type, options
-          else
-            return type, {}
+          # parse possible attribute options like :limit for string/text/binary/integer, :precision/:scale for decimals or :polymorphic for references/belongs_to
+          # when declaring options curly brackets should be used
+          def parse_type_and_options(type)
+            case type
+            when /(string|text|binary|integer)\{(\d+)\}/
+              return $1, limit: $2.to_i
+            when /decimal\{(\d+)[,.-](\d+)\}/
+              return :decimal, precision: $1.to_i, scale: $2.to_i
+            when /(references|belongs_to)\{(.+)\}/
+              type = $1
+              provided_options = $2.split(/[,.-]/)
+              options = Hash[provided_options.map { |opt| [opt.to_sym, true] }]
+
+              return type, options
+            else
+              return type, {}
+            end
           end
-        end
       end
 
       def initialize(name, type = nil, index_type = false, attr_options = {})
@@ -68,13 +68,15 @@ module Rails
 
       def field_type
         @field_type ||= case type
-                        when :integer              then :number_field
-                        when :float, :decimal      then :text_field
-                        when :time                 then :time_select
-                        when :datetime, :timestamp then :datetime_select
-                        when :date                 then :date_select
-                        when :text                 then :text_area
-                        when :boolean              then :check_box
+                        when :integer                  then :number_field
+                        when :float, :decimal          then :text_field
+                        when :time                     then :time_select
+                        when :datetime, :timestamp     then :datetime_select
+                        when :date                     then :date_select
+                        when :text                     then :text_area
+                        when :rich_text                then :rich_text_area
+                        when :boolean                  then :check_box
+                        when :attachment, :attachments then :file_field
                         else
                           :text_field
         end
@@ -90,18 +92,20 @@ module Rails
                      when :string                      then name == "type" ? "" : "MyString"
                      when :text                        then "MyText"
                      when :boolean                     then false
-                     when :references, :belongs_to     then nil
+                     when :references, :belongs_to,
+                          :attachment, :attachments,
+                          :rich_text                   then nil
                      else
                        ""
         end
       end
 
       def plural_name
-        name.sub(/_id$/, "").pluralize
+        name.delete_suffix("_id").pluralize
       end
 
       def singular_name
-        name.sub(/_id$/, "").singularize
+        name.delete_suffix("_id").singularize
       end
 
       def human_name
@@ -121,7 +125,7 @@ module Rails
       end
 
       def foreign_key?
-        !!(name =~ /_id$/)
+        name.end_with?("_id")
       end
 
       def reference?
@@ -133,7 +137,7 @@ module Rails
       end
 
       def required?
-        attr_options[:required]
+        reference? && Rails.application.config.active_record.belongs_to_required_by_default
       end
 
       def has_index?
@@ -152,8 +156,24 @@ module Rails
         type == :token
       end
 
+      def rich_text?
+        type == :rich_text
+      end
+
+      def attachment?
+        type == :attachment
+      end
+
+      def attachments?
+        type == :attachments
+      end
+
+      def virtual?
+        rich_text? || attachment? || attachments?
+      end
+
       def inject_options
-        "".dup.tap { |s| options_for_migration.each { |k, v| s << ", #{k}: #{v.inspect}" } }
+        (+"").tap { |s| options_for_migration.each { |k, v| s << ", #{k}: #{v.inspect}" } }
       end
 
       def inject_index_options
@@ -163,7 +183,6 @@ module Rails
       def options_for_migration
         @attr_options.dup.tap do |options|
           if required?
-            options.delete(:required)
             options[:null] = false
           end
 

data/lib/rails/generators/migration.rb

@@ -62,14 +62,14 @@ module Rails
         dir, base = File.split(destination)
         numbered_destination = File.join(dir, ["%migration_number%", base].join("_"))
 
-        create_migration numbered_destination, nil, config do
-          match = ERB.version.match(/\Aerb\.rb \[(?<version>[^ ]+) /)
-          if match && match[:version] >= "2.2.0" # Ruby 2.6+
+        file = create_migration numbered_destination, nil, config do
+          if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
             ERB.new(::File.binread(source), trim_mode: "-", eoutvar: "@output_buffer").result(context)
           else
             ERB.new(::File.binread(source), nil, "-", "@output_buffer").result(context)
           end
         end
+        Rails::Generators.add_generated_file(file)
       end
     end
   end

data/lib/rails/generators/model_helpers.rb

@@ -7,6 +7,15 @@ module Rails
     module ModelHelpers # :nodoc:
       PLURAL_MODEL_NAME_WARN_MESSAGE = "[WARNING] The model name '%s' was recognized as a plural, using the singular '%s' instead. " \
                                        "Override with --force-plural or setup custom inflection rules for this noun before running the generator."
+      IRREGULAR_MODEL_NAME_WARN_MESSAGE = <<~WARNING
+      [WARNING] Rails cannot recover singular form from its plural form '%s'.
+      Please setup custom inflection rules for this noun before running the generator in config/initializers/inflections.rb.
+      WARNING
+      INFLECTION_IMPOSSIBLE_ERROR_MESSAGE = <<~ERROR
+      Rails cannot recover the underscored form from its camelcase form '%s'.
+      Please use an underscored name instead, either '%s' or '%s'.
+      Or setup custom inflection rules for this noun before running the generator in config/initializers/inflections.rb.
+      ERROR
       mattr_accessor :skip_warn
 
       def self.included(base) #:nodoc:
@@ -15,16 +24,38 @@ module Rails
 
       def initialize(args, *_options)
         super
-        if name == name.pluralize && name.singularize != name.pluralize && !options[:force_plural]
+        if plural_model_name?(name) && !options[:force_plural]
           singular = name.singularize
           unless ModelHelpers.skip_warn
             say PLURAL_MODEL_NAME_WARN_MESSAGE % [name, singular]
-            ModelHelpers.skip_warn = true
           end
           name.replace singular
           assign_names!(name)
         end
+        if inflection_impossible?(name)
+          option1 = name.singularize.underscore
+          option2 = name.pluralize.underscore.singularize
+          raise Error, INFLECTION_IMPOSSIBLE_ERROR_MESSAGE % [name, option1, option2]
+        end
+        if irregular_model_name?(name) && ! ModelHelpers.skip_warn
+          say IRREGULAR_MODEL_NAME_WARN_MESSAGE % [name.pluralize]
+        end
+        ModelHelpers.skip_warn = true
       end
+
+      private
+        def plural_model_name?(name)
+          name == name.pluralize && name.singularize != name.pluralize
+        end
+
+        def irregular_model_name?(name)
+          name.singularize != name.pluralize.singularize
+        end
+
+        def inflection_impossible?(name)
+          name != name.underscore &&
+            name.singularize.underscore != name.pluralize.underscore.singularize
+        end
     end
   end
 end

data/lib/rails/generators/named_base.rb

@@ -22,7 +22,7 @@ module Rails
       no_tasks do
         def template(source, *args, &block)
           inside_template do
-            super
+            Rails::Generators.add_generated_file(super)
           end
         end
 
@@ -31,12 +31,8 @@ module Rails
         end
       end
 
-      # TODO Change this to private once we've dropped Ruby 2.2 support.
-      # Workaround for Ruby 2.2 "private attribute?" warning.
-      protected
-        attr_reader :file_name
-
       private
+        attr_reader :file_name
 
         # FIXME: We are avoiding to use alias because a bug on thor that make
         # this method public and add it to the task list.
@@ -217,7 +213,7 @@ module Rails
         #
         def self.check_class_collision(options = {}) # :doc:
           define_method :check_class_collision do
-            name = if respond_to?(:controller_class_name) # for ResourceHelpers
+            name = if respond_to?(:controller_class_name, true) # for ResourceHelpers
               controller_class_name
             else
               class_name

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

@@ -3,7 +3,8 @@ Description:
     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.

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

@@ -21,7 +21,6 @@ module Rails
         RUBY
       end
 
-      # TODO: Remove once this is fully in place
       def method_missing(meth, *args, &block)
         @generator.send(meth, *args, &block)
       end
@@ -67,9 +66,13 @@ module Rails
       template "gitignore", ".gitignore"
     end
 
+    def gitattributes
+      template "gitattributes", ".gitattributes"
+    end
+
     def version_control
       if !options[:skip_git] && !options[:pretend]
-        run "git init", capture: options[:quiet]
+        run "git init", capture: options[:quiet], abort_on_failure: false
       end
     end
 
@@ -80,8 +83,7 @@ module Rails
     def app
       directory "app"
 
-      keep_file "app/assets/images"
-      empty_directory_with_keep_file "app/assets/javascripts/channels" unless options[:skip_action_cable]
+      empty_directory_with_keep_file "app/assets/images"
 
       keep_file  "app/controllers/concerns"
       keep_file  "app/models/concerns"
@@ -92,16 +94,21 @@ 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_yarn_exist = File.exist?("bin/yarn")
-
       bin
+    end
 
-      if options[:api] && !bin_yarn_exist
-        remove_file "bin/yarn"
+    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
@@ -129,10 +136,12 @@ module Rails
       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")
+      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"
@@ -159,13 +168,13 @@ module Rails
           remove_file "config/initializers/cookies_serializer.rb"
         end
 
-        unless assets_config_exist
-          remove_file "config/initializers/assets.rb"
-        end
-
         unless csp_config_exist
           remove_file "config/initializers/content_security_policy.rb"
         end
+
+        unless permissions_policy_config_exist
+          remove_file "config/initializers/permissions_policy.rb"
+        end
       end
     end
 
@@ -213,7 +222,6 @@ module Rails
     end
 
     def test
-      empty_directory_with_keep_file "test/fixtures"
       empty_directory_with_keep_file "test/fixtures/files"
       empty_directory_with_keep_file "test/controllers"
       empty_directory_with_keep_file "test/mailers"
@@ -221,6 +229,7 @@ module Rails
       empty_directory_with_keep_file "test/helpers"
       empty_directory_with_keep_file "test/integration"
 
+      template "test/channels/application_cable/connection_test.rb"
       template "test/test_helper.rb"
     end
 
@@ -250,38 +259,70 @@ module Rails
     # We need to store the RAILS_DEV_PATH in a constant, otherwise the path
     # can change in Ruby 1.8.7 when we FileUtils.cd.
     RAILS_DEV_PATH = File.expand_path("../../../../../..", __dir__)
-    RESERVED_NAMES = %w[application destroy plugin runner test]
 
-    class AppGenerator < AppBase # :nodoc:
+    class AppGenerator < AppBase
+      # :stopdoc:
+
       WEBPACKS = %w( react vue angular elm stimulus )
 
       add_shared_options_for "application"
 
-      # Add bin/rails options
+      # 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 :webpack, type: :string, default: nil,
-                             desc: "Preconfigure for app-like JavaScript with Webpack (options: #{WEBPACKS.join('/')})"
+      class_option :webpack, type: :string, aliases: "--webpacker", default: nil,
+                             desc: "Preconfigure Webpack with a particular framework (options: #{WEBPACKS.join(", ")})"
+
+      class_option :skip_webpack_install, type: :boolean, default: false,
+                                          desc: "Don't run Webpack install"
 
       def initialize(*args)
         super
 
         if !options[:skip_active_record] && !DATABASES.include?(options[:database])
-          raise Error, "Invalid value for --database option. Supported for preconfiguration are: #{DATABASES.join(", ")}."
+          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, skip_yarn: true).freeze
+          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 :set_default_accessors!
@@ -292,10 +333,15 @@ module Rails
         build(:rakefile)
         build(:ruby_version)
         build(:configru)
-        build(:gitignore)   unless options[:skip_git]
-        build(:gemfile)     unless options[:skip_gemfile]
+
+        unless options[:skip_git]
+          build(:gitignore)
+          build(:gitattributes)
+        end
+
+        build(:gemfile) unless options[:skip_gemfile]
         build(:version_control)
-        build(:package_json) unless options[:skip_yarn]
+        build(:package_json) unless options[:skip_javascript]
       end
 
       def create_app_files
@@ -311,6 +357,18 @@ 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
+        end
+      end
+      remove_task :update_active_storage
+
       def create_config_files
         build(:config)
       end
@@ -329,7 +387,7 @@ module Rails
       end
 
       def display_upgrade_guide_info
-        say "\nAfter this, check Rails upgrade guide at http://guides.rubyonrails.org/upgrading_ruby_on_rails.html for more details about upgrading your app."
+        say "\nAfter this, check Rails upgrade guide at https://guides.rubyonrails.org/upgrading_ruby_on_rails.html for more details about upgrading your app."
       end
       remove_task :display_upgrade_guide_info
 
@@ -416,8 +474,15 @@ module Rails
       end
 
       def delete_js_folder_skipping_javascript
-        if options[:skip_javascript]
-          remove_dir "app/assets/javascripts"
+        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"
         end
       end
 
@@ -433,6 +498,12 @@ module Rails
         end
       end
 
+      def delete_active_job_folder_if_skipping_active_job
+        if options[:skip_active_job]
+          remove_dir "app/jobs"
+        end
+      end
+
       def delete_action_mailer_files_skipping_action_mailer
         if options[:skip_action_mailer]
           remove_file "app/views/layouts/mailer.html.erb"
@@ -444,8 +515,9 @@ module Rails
 
       def delete_action_cable_files_skipping_action_cable
         if options[:skip_action_cable]
-          remove_file "app/assets/javascripts/cable.js"
+          remove_dir "app/javascript/channels"
           remove_dir "app/channels"
+          remove_dir "test/channels"
         end
       end
 
@@ -453,6 +525,7 @@ module Rails
         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
       end
 
@@ -464,20 +537,17 @@ module Rails
 
       def delete_new_framework_defaults
         unless options[:update]
-          remove_file "config/initializers/new_framework_defaults_5_2.rb"
+          remove_file "config/initializers/new_framework_defaults_6_1.rb"
         end
       end
 
-      def delete_bin_yarn_if_skip_yarn_option
-        remove_file "bin/yarn" if options[:skip_yarn]
-      end
-
       def finish_template
         build(:leftovers)
       end
 
       public_task :apply_rails_template, :run_bundle
-      public_task :run_webpack, :generate_spring_binstubs
+      public_task :generate_bundler_binstub
+      public_task :run_webpack
 
       def run_after_bundle_callbacks
         @after_bundle_callbacks.each(&:call)
@@ -487,61 +557,22 @@ module Rails
         "rails new #{arguments.map(&:usage).join(' ')} [options]"
       end
 
-    private
+    # :startdoc:
 
+    private
       # Define file as an alias to create_file for backwards compatibility.
       def file(*args, &block)
         create_file(*args, &block)
       end
 
-      def app_name
-        @app_name ||= (defined_app_const_base? ? defined_app_name : File.basename(destination_root)).tr('\\', "").tr(". ", "_")
-      end
-
-      def defined_app_name
-        defined_app_const_base.underscore
-      end
-
-      def defined_app_const_base
-        Rails.respond_to?(:application) && defined?(Rails::Application) &&
-          Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "")
-      end
-
-      alias :defined_app_const_base? :defined_app_const_base
-
-      def app_const_base
-        @app_const_base ||= defined_app_const_base || app_name.gsub(/\W/, "_").squeeze("_").camelize
-      end
-      alias :camelized :app_const_base
-
-      def app_const
-        @app_const ||= "#{app_const_base}::Application"
-      end
-
-      def valid_const?
-        if app_const =~ /^\d/
-          raise Error, "Invalid application name #{app_name}. Please give a name which does not start with numbers."
-        elsif RESERVED_NAMES.include?(app_name)
-          raise Error, "Invalid application name #{app_name}. Please give a " \
-                       "name which does not match one of the reserved rails " \
-                       "words: #{RESERVED_NAMES.join(", ")}"
-        elsif Object.const_defined?(app_const_base)
-          raise Error, "Invalid application name #{app_name}, constant #{app_const_base} is already in use. Please choose another application name."
-        end
-      end
-
-      def mysql_socket
-        @mysql_socket ||= [
-          "/tmp/mysql.sock",                        # default
-          "/var/run/mysqld/mysqld.sock",            # debian/gentoo
-          "/var/tmp/mysql.sock",                    # freebsd
-          "/var/lib/mysql/mysql.sock",              # fedora
-          "/opt/local/lib/mysql/mysql.sock",        # fedora
-          "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
-          "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
-          "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
-          "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
-        ].find { |f| File.exist?(f) } unless Gem.win_platform?
+      # Registers a callback to be executed after bundle and spring binstubs
+      # have run.
+      #
+      #   after_bundle do
+      #     git add: '.'
+      #   end
+      def after_bundle(&block) # :doc:
+        @after_bundle_callbacks << block
       end
 
       def get_builder_class
@@ -569,11 +600,16 @@ module Rails
       end
 
       def self.default_rc_file
-        File.expand_path("~/.railsrc")
+        xdg_config_home = ENV["XDG_CONFIG_HOME"].presence || "~/.config"
+        xdg_railsrc = File.expand_path("rails/railsrc", xdg_config_home)
+        if File.exist?(xdg_railsrc)
+          xdg_railsrc
+        else
+          File.expand_path("~/.railsrc")
+        end
       end
 
       private
-
         def handle_version_request!(argument)
           if ["--version", "-v"].include?(argument)
             require "rails/version"