railties 6.0.0.beta3 → 6.0.0.rc1

data/lib/rails/generators/generated_attribute.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/time"
+require "active_support/deprecation"
 
 module Rails
   module Generators
@@ -51,6 +52,12 @@ module Rails
               type = $1
               provided_options = $2.split(/[,.-]/)
               options = Hash[provided_options.map { |opt| [opt.to_sym, true] }]
+
+              if options[:required]
+                ActiveSupport::Deprecation.warn("Passing {required} option has no effect on the model generator. It will be removed in Rails 6.1.\n")
+                options.delete(:required)
+              end
+
               return type, options
             else
               return type, {}
@@ -68,13 +75,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,7 +99,9 @@ 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
@@ -133,7 +144,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,6 +163,22 @@ 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
         (+"").tap { |s| options_for_migration.each { |k, v| s << ", #{k}: #{v.inspect}" } }
       end
@@ -163,7 +190,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/named_base.rb

@@ -187,6 +187,7 @@ module Rails
 
         def attributes_names # :doc:
           @attributes_names ||= attributes.each_with_object([]) do |a, names|
+            next if a.attachments?
             names << a.column_name
             names << "password_confirmation" if a.password_digest?
             names << "#{a.name}_type" if a.polymorphic?

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

@@ -28,7 +28,7 @@ ruby <%= "'#{RUBY_VERSION}'" -%>
 
 <% if depend_on_bootsnap? -%>
 # Reduces boot times through caching; required in config/boot.rb
-gem 'bootsnap', '>= 1.4.1', require: false
+gem 'bootsnap', '>= 1.4.2', require: false
 
 <%- end -%>
 <%- if options.api? -%>
@@ -69,8 +69,8 @@ group :test do
   # Adds support for Capybara system testing and selenium driver
   gem 'capybara', '>= 2.15'
   gem 'selenium-webdriver'
-  # Easy installation and use of chromedriver to run system tests with Chrome
-  gem 'chromedriver-helper'
+  # Easy installation and use of web drivers to run system tests with browsers
+  gem 'webdrivers'
 end
 <%- end -%>
 

data/lib/rails/generators/rails/app/templates/app/javascript/packs/application.js.tt

@@ -13,3 +13,11 @@ require("@rails/activestorage").start()
 <%- unless options[:skip_action_cable] -%>
 require("channels")
 <%- end -%>
+
+
+// Uncomment to copy all static images under ../images to the output folder and reference
+// them with the image_pack_tag helper in views (e.g <%%= image_pack_tag 'rails.png' %>)
+// or the `imagePath` JavaScript helper below.
+//
+// const images = require.context('../images', true)
+// const imagePath = (name) => images(name, true)

data/lib/rails/generators/rails/app/templates/bin/setup.tt

@@ -8,7 +8,8 @@ def system!(*args)
 end
 
 FileUtils.chdir APP_ROOT do
-  # This script is a starting point to setup your application.
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
   # Add necessary setup steps to this file.
 
   puts '== Installing dependencies =='
@@ -27,7 +28,7 @@ FileUtils.chdir APP_ROOT do
   # end
 
   puts "\n== Preparing database =="
-  system! 'bin/rails db:setup'
+  system! 'bin/rails db:prepare'
 <% end -%>
 
   puts "\n== Removing old logs and tempfiles =="

data/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt

@@ -15,9 +15,11 @@ Rails.application.configure do
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
   if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    <%- unless options.api? -%>
     config.action_controller.perform_caching = true
     config.action_controller.enable_fragment_cache_logging = true
 
+    <%- end -%>
     config.cache_store = :memory_store
     config.public_file_server.headers = {
       'Cache-Control' => "public, max-age=#{2.days.to_i}"

data/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt

@@ -12,7 +12,9 @@ Rails.application.configure do
 
   # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
+  <%- unless options.api? -%>
   config.action_controller.perform_caching = true
+  <%- end -%>
 
   # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
   # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).

data/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt

@@ -1,11 +1,16 @@
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
-
-  # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
+  <%# Spring executes the reloaders when files change. %>
+  <%- if spring_install? -%>
+  config.cache_classes = false
+  <%- else -%>
   config.cache_classes = true
+  <%- end -%>
 
   # Do not eager load code on boot. This avoids loading your whole application
   # just for the purpose of running a single test. If you are using a tool that

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

@@ -1 +1 @@
-<%= ENV["RBENV_VERSION"] || ENV["rvm_ruby_string"] || "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}" -%>
+<%= ENV["RBENV_VERSION"] || ENV["rvm_ruby_string"] || "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}" %>

data/lib/rails/generators/rails/assets/assets_generator.rb

@@ -3,7 +3,10 @@
 module Rails
   module Generators
     class AssetsGenerator < NamedBase # :nodoc:
+      class_option :javascripts, type: :boolean, desc: "Generate JavaScripts"
       class_option :stylesheets, type: :boolean, desc: "Generate Stylesheets"
+
+      class_option :javascript_engine, desc: "Engine for JavaScripts"
       class_option :stylesheet_engine, desc: "Engine for Stylesheets"
 
       private
@@ -11,6 +14,10 @@ module Rails
           file_name
         end
 
+        hook_for :javascript_engine do |javascript_engine|
+          invoke javascript_engine, [name] if options[:javascripts]
+        end
+
         hook_for :stylesheet_engine do |stylesheet_engine|
           invoke stylesheet_engine, [name] if options[:stylesheets]
         end

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

@@ -35,8 +35,9 @@ module Rails
           end
 
           def edit_gemfile
-            database_gem_name, _ = gem_for_database
-            gsub_file("Gemfile", all_database_gems_regex, database_gem_name)
+            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
@@ -48,6 +49,15 @@ module Rails
               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

data/lib/rails/generators/rails/plugin/plugin_generator.rb

@@ -144,17 +144,6 @@ task default: :test
       end
     end
 
-    def javascripts
-      return if options.skip_javascript?
-
-      if mountable?
-        template "rails/javascripts.js",
-                 "app/assets/javascripts/#{namespaced_name}/application.js"
-      elsif full?
-        empty_directory_with_keep_file "app/assets/javascripts/#{namespaced_name}"
-      end
-    end
-
     def bin(force = false)
       bin_file = engine? ? "bin/rails.tt" : "bin/test.tt"
       template bin_file, force: force do |content|
@@ -236,10 +225,6 @@ task default: :test
         build(:stylesheets) unless api?
       end
 
-      def create_javascript_files
-        build(:javascripts) unless api?
-      end
-
       def create_bin_files
         build(:bin)
       end

data/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

@@ -32,6 +32,14 @@ module Rails
       hook_for :helper, as: :scaffold do |invoked|
         invoke invoked, [ controller_name ]
       end
+
+      private
+
+        def permitted_params
+          params = attributes_names.map { |name| ":#{name}" }.join(", ")
+          params += attributes.select(&:attachments?).map { |a| ", #{a.name}: []" }.join
+          params
+        end
     end
   end
 end

data/lib/rails/generators/rails/scaffold_controller/templates/api_controller.rb.tt

@@ -54,7 +54,7 @@ class <%= controller_class_name %>Controller < ApplicationController
       <%- if attributes_names.empty? -%>
       params.fetch(:<%= singular_table_name %>, {})
       <%- else -%>
-      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
       <%- end -%>
     end
 end

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

@@ -61,7 +61,7 @@ class <%= controller_class_name %>Controller < ApplicationController
       <%- if attributes_names.empty? -%>
       params.fetch(:<%= singular_table_name %>, {})
       <%- else -%>
-      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
       <%- end -%>
     end
 end

data/lib/rails/generators/test_unit/model/templates/fixtures.yml.tt

@@ -1,4 +1,4 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 <% unless attributes.empty? -%>
 <% %w(one two).each do |name| %>
 <%= name %>:
@@ -7,7 +7,7 @@
   password_digest: <%%= BCrypt::Password.create('secret') %>
   <%- elsif attribute.reference? -%>
   <%= yaml_key_value(attribute.column_name.sub(/_id$/, ''), attribute.default || name) %>
-  <%- else -%>
+  <%- elsif !attribute.virtual? -%>
   <%= yaml_key_value(attribute.column_name, attribute.default) %>
   <%- end -%>
   <%- if attribute.polymorphic? -%>

data/lib/rails/mailers_controller.rb

@@ -5,8 +5,9 @@ require "rails/application_controller"
 class Rails::MailersController < Rails::ApplicationController # :nodoc:
   prepend_view_path ActionDispatch::DebugView::RESCUES_TEMPLATE_PATH
 
+  around_action :set_locale, only: :preview
+  before_action :find_preview, only: :preview
   before_action :require_local!, unless: :show_previews?
-  before_action :find_preview, :set_locale, only: :preview
 
   helper_method :part_query, :locale_query
 
@@ -38,7 +39,7 @@ class Rails::MailersController < Rails::ApplicationController # :nodoc:
           end
         else
           @part = find_preferred_part(request.format, Mime[:html], Mime[:text])
-          render action: "email", layout: false, formats: %w[html]
+          render action: "email", layout: false, formats: [:html]
         end
       else
         raise AbstractController::ActionNotFound, "Email '#{@email_action}' not found in #{@preview.name}"
@@ -92,6 +93,8 @@ class Rails::MailersController < Rails::ApplicationController # :nodoc:
     end
 
     def set_locale
-      I18n.locale = params[:locale] || I18n.default_locale
+      I18n.with_locale(params[:locale] || I18n.default_locale) do
+        yield
+      end
     end
 end

data/lib/rails/source_annotation_extractor.rb

@@ -29,6 +29,16 @@ module Rails
         directories.push(*dirs)
       end
 
+      def self.tags
+        @@tags ||= %w(OPTIMIZE FIXME TODO)
+      end
+
+      # Registers additional tags
+      #   Rails::SourceAnnotationExtractor::Annotation.register_tags("TESTME", "DEPRECATEME")
+      def self.register_tags(*additional_tags)
+        tags.push(*additional_tags)
+      end
+
       def self.extensions
         @@extensions ||= {}
       end
@@ -66,6 +76,8 @@ module Rails
     # Prints all annotations with tag +tag+ under the root directories +app+,
     # +config+, +db+, +lib+, and +test+ (recursively).
     #
+    # If +tag+ is <tt>nil</tt>, annotations with either default or registered tags are printed.
+    #
     # Specific directories can be explicitly set using the <tt>:dirs</tt> key in +options+.
     #
     #   Rails::SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true
@@ -75,7 +87,8 @@ module Rails
     # See <tt>#find_in</tt> for a list of file extensions that will be taken into account.
     #
     # This class method is the single entry point for the `rails notes` command.
-    def self.enumerate(tag, options = {})
+    def self.enumerate(tag = nil, options = {})
+      tag ||= Annotation.tags.join("|")
       extractor = new(tag)
       dirs = options.delete(:dirs) || Annotation.directories
       extractor.display(extractor.find(dirs), options)

data/lib/rails/tasks.rb

@@ -15,6 +15,7 @@ require "rake"
   routes
   tmp
   yarn
+  zeitwerk
 ).tap { |arr|
   arr << "statistics" if Rake.application.current_scope.empty?
 }.each do |task|

data/lib/rails/tasks/zeitwerk.rake

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+ensure_classic_mode = ->() do
+  if Rails.autoloaders.zeitwerk_enabled?
+    abort <<~EOS
+      Please, enable temporarily :classic mode:
+
+        # config/application.rb
+        config.autoloader = :classic
+
+      and try again. When all is good, you can delete that line.
+    EOS
+  end
+end
+
+eager_load = ->() do
+  Rails.configuration.eager_load_namespaces.each(&:eager_load!)
+end
+
+mismatches = []
+check_directory = ->(directory, parent) do
+  # test/mailers/previews might not exist.
+  return unless File.exists?(directory)
+
+  Dir.foreach(directory) do |entry|
+    next if entry.start_with?(".")
+    next if parent == Object && entry == "concerns"
+
+    abspath = File.join(directory, entry)
+
+    if File.directory?(abspath) || abspath.end_with?(".rb")
+      print "."
+      cname = File.basename(abspath, ".rb").camelize.to_sym
+      if parent.const_defined?(cname, false)
+        if File.directory?(abspath)
+          check_directory[abspath, parent.const_get(cname)]
+        end
+      else
+        mismatches << [abspath, parent, cname]
+      end
+    end
+  end
+end
+
+report = ->() do
+  puts
+  if mismatches.empty?
+    puts "All is good!"
+    puts "Please, remember to delete `config.autoloader = :classic` from config/application.rb."
+  else
+    mismatches.each do |abspath, parent, cname|
+      relpath = abspath.sub(%r{\A#{Regexp.escape(Rails.root.to_path)}/}, "")
+      cpath = parent == Object ? cname : "#{parent.name}::#{cname}"
+      puts "expected #{relpath} to define #{cpath}"
+    end
+    puts
+    puts <<~EOS
+      Please revise the reported mismatches. You can normally fix them by adding
+      acronyms to config/initializers/inflections.rb or renaming the constants.
+    EOS
+  end
+end
+
+namespace :zeitwerk do
+  desc "Checks project structure for Zeitwerk compatibility"
+  task check: :environment do
+    ensure_classic_mode[]
+    eager_load[]
+
+    $stdout.sync = true
+    ActiveSupport::Dependencies.autoload_paths.each do |autoload_path|
+      check_directory[autoload_path, Object]
+    end
+    puts
+
+    report[]
+  end
+end