Remove spring as a default installation option (rails#42997)

David Heinemeier Hansson · web-flow · commit 21c9732fae9c · 2021-08-12T12:31:18.000+02:00
* Remove spring as a default installation option

Faster computers have meant that most apps won't see a big benefit from Spring on small to moderate size apps. Thus the pain of dealing with the occasional spring issue is no longer warranted by default.

* Errant end

* No longer an option

* Additional spring removals

* Pointer to docs is enough
diff --git a/activejob/test/support/integration/helper.rb b/activejob/test/support/integration/helper.rb
@@ -9,7 +9,7 @@
 dummy_app_path     = Dir.mktmpdir + "/dummy"
 dummy_app_template = File.expand_path("dummy_app_template.rb",  __dir__)
 args = Rails::Generators::ARGVScrubber.new(["new", dummy_app_path, "--skip-gemfile", "--skip-bundle",
-  "--skip-git", "--skip-spring", "-d", "sqlite3", "--skip-javascript", "--force", "--quiet",
+  "--skip-git", "-d", "sqlite3", "--skip-javascript", "--force", "--quiet",
   "--template", dummy_app_template]).prepare!
 Rails::Generators::AppGenerator.start args
 
diff --git a/guides/source/command_line.md b/guides/source/command_line.md
@@ -102,7 +102,6 @@ If you wish to skip some files or components from being generated, you can appen
 | `--skip-active-storage` | Skip Active Storage files                                   |
 | `--skip-action-cable`   | Skip Action Cable files                                     |
 | `--skip-sprockets`      | Skip Sprockets files                                        |
-| `--skip-spring`         | Don't install Spring application preloader                  |
 | `--skip-javascript`     | Skip JavaScript files                                       |
 | `--skip-turbolinks`     | Skip turbolinks gem                                         |
 | `--skip-test`           | Skip test files                                             |
diff --git a/guides/source/getting_started.md b/guides/source/getting_started.md
@@ -182,10 +182,6 @@ This will create a Rails application called Blog in a `blog` directory and
 install the gem dependencies that are already mentioned in `Gemfile` using
 `bundle install`.
 
-NOTE: If you're using Windows Subsystem for Linux then there are currently some
-limitations on file system notifications that mean you should disable the `spring`
-gem which you can do by running `rails new blog --skip-spring` instead.
-
 TIP: You can see all of the command line options that the Rails application
 generator accepts by running `rails new --help`.
 
diff --git a/guides/source/rails_application_templates.md b/guides/source/rails_application_templates.md
@@ -265,8 +265,7 @@ after_bundle do
 end
 ```
 
-The callbacks gets executed even if `--skip-bundle` and/or `--skip-spring` has
-been passed.
+The callbacks gets executed even if `--skip-bundle` has been passed.
 
 Advanced Usage
 --------------
diff --git a/railties/lib/rails/app_updater.rb b/railties/lib/rails/app_updater.rb
@@ -28,7 +28,6 @@ def generator_options
           options[:skip_action_cable]   = !defined?(ActionCable::Engine)
           options[:skip_sprockets]      = !defined?(Sprockets::Railtie)
           options[:skip_bootsnap]       = !defined?(Bootsnap)
-          options[:skip_spring]         = !defined?(Spring)
           options[:updating]            = true
           options
         end
diff --git a/railties/lib/rails/generators/app_base.rb b/railties/lib/rails/generators/app_base.rb
@@ -61,9 +61,6 @@ def self.add_shared_options_for(name)
         class_option :skip_sprockets,      type: :boolean, aliases: "-S", default: false,
                                            desc: "Skip Sprockets files"
 
-        class_option :skip_spring,         type: :boolean, default: false,
-                                           desc: "Don't install Spring application preloader"
-
         class_option :skip_javascript,     type: :boolean, aliases: "-J", default: name == "plugin",
                                            desc: "Skip JavaScript files"
 
@@ -395,10 +392,6 @@ def bundle_install?
         !(options[:skip_bundle] || options[:pretend])
       end
 
-      def spring_install?
-        !options[:skip_spring] && !options.dev? && Process.respond_to?(:fork) && !RUBY_PLATFORM.include?("cygwin")
-      end
-
       def webpack_install?
         !(options[:skip_javascript] || options[:skip_webpack_install])
       end
diff --git a/railties/lib/rails/generators/rails/app/app_generator.rb b/railties/lib/rails/generators/rails/app/app_generator.rb
@@ -98,7 +98,6 @@ def bin
       end
       chmod "bin", 0755 & ~File.umask, verbose: false
 
-      remove_file "bin/spring" unless spring_install?
       remove_file "bin/yarn" if options[:skip_javascript]
     end
 
@@ -123,7 +122,6 @@ def config
         template "environment.rb"
         template "cable.yml" unless options[:updating] || options[:skip_action_cable]
         template "puma.rb"   unless options[:updating]
-        template "spring.rb" if spring_install?
         template "storage.yml" unless options[:updating] || skip_active_storage?
 
         directory "environments"
@@ -328,7 +326,6 @@ def initialize(*args)
             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|
@@ -584,7 +581,7 @@ def file(*args, &block)
         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
diff --git a/railties/lib/rails/generators/rails/app/templates/Gemfile.tt b/railties/lib/rails/generators/rails/app/templates/Gemfile.tt
@@ -55,10 +55,8 @@ group :development do
   # Note: Interferes with etag cache testing. Can be configured to work on production: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md
   # gem "rack-mini-profiler", "~> 2.0"
 <%- 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 -%>
+  # Speed up rails commands in dev on slow machines / big apps. See: https://github.com/rails/spring
+  # gem "spring"
 end
 
 <%- if depends_on_system_test? -%>
diff --git a/railties/lib/rails/generators/rails/app/templates/bin/rails.tt b/railties/lib/rails/generators/rails/app/templates/bin/rails.tt
@@ -1,6 +1,3 @@
-<% if spring_install? -%>
-load File.expand_path("spring", __dir__)
-<% end -%>
 APP_PATH = File.expand_path("../config/application", __dir__)
 require_relative "../config/boot"
 require "rails/commands"
diff --git a/railties/lib/rails/generators/rails/app/templates/bin/rake.tt b/railties/lib/rails/generators/rails/app/templates/bin/rake.tt
@@ -1,6 +1,3 @@
-<% if spring_install? -%>
-load File.expand_path("spring", __dir__)
-<% end -%>
 require_relative "../config/boot"
 require "rake"
 Rake.application.run
diff --git a/railties/lib/rails/generators/rails/app/templates/bin/spring.tt b/railties/lib/rails/generators/rails/app/templates/bin/spring.tt
diff --git a/railties/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt
@@ -8,13 +8,8 @@ require "active_support/core_ext/integer/time"
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
-  <%-# Spring executes the reloaders when files change. -%>
-  <%- if spring_install? -%>
-  config.cache_classes = false
-  config.action_view.cache_template_loading = true
-  <%- else -%>
+  # Turn false under Spring and add config.action_view.cache_template_loading = true
   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
diff --git a/railties/lib/rails/generators/rails/app/templates/config/spring.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/spring.rb.tt
diff --git a/railties/lib/rails/generators/rails/plugin/plugin_generator.rb b/railties/lib/rails/generators/rails/plugin/plugin_generator.rb
@@ -120,7 +120,6 @@ def generate_test_dummy(force = false)
       opts = options.transform_keys(&:to_sym).except(*DUMMY_IGNORE_OPTIONS)
       opts[:force] = force
       opts[:skip_bundle] = true
-      opts[:skip_spring] = true
       opts[:skip_git] = true
       opts[:skip_turbolinks] = true
       opts[:skip_webpack_install] = true
diff --git a/railties/test/generators/api_app_generator_test.rb b/railties/test/generators/api_app_generator_test.rb
@@ -148,7 +148,6 @@ def default_files
         config/puma.rb
         config/routes.rb
         config/credentials.yml.enc
-        config/spring.rb
         config/storage.yml
         db
         db/seeds.rb
diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb
@@ -66,7 +66,6 @@
   config/puma.rb
   config/routes.rb
   config/credentials.yml.enc
-  config/spring.rb
   config/storage.yml
   db
   db/seeds.rb
@@ -331,19 +330,6 @@ def test_app_update_does_not_generate_assets_initializer_when_skip_sprockets_is_
     end
   end
 
-  def test_app_update_does_not_generate_spring_contents_when_skip_spring_is_given
-    app_root = File.join(destination_root, "myapp")
-    run_generator [app_root, "--skip-spring"]
-
-    stub_rails_application(app_root) do
-      generator = Rails::Generators::AppGenerator.new ["rails"], { update: true, skip_spring: true }, { destination_root: app_root, shell: @shell }
-      generator.send(:app_const)
-      quietly { generator.update_config_files }
-
-      assert_no_file "#{app_root}/config/spring.rb"
-    end
-  end
-
   def test_app_update_does_not_generate_action_cable_contents_when_skip_action_cable_is_given
     app_root = File.join(destination_root, "myapp")
     run_generator [app_root, "--skip-action-cable"]
@@ -469,7 +455,7 @@ def test_generator_skips_action_text_when_skip_active_storage_is_given
 
   def test_app_update_does_not_change_config_target_version
     app_root = File.join(destination_root, "myapp")
-    run_generator [app_root, "--skip-spring"]
+    run_generator [ app_root ]
 
     FileUtils.cd(app_root) do
       config = "config/application.rb"
@@ -881,60 +867,13 @@ def test_main_option
     assert_file "Gemfile", %r{^gem\s+["']rails["'],\s+github:\s+["']#{Regexp.escape("rails/rails")}["'],\s+branch:\s+["']main["']$}
   end
 
-  def test_spring
-    jruby_skip "spring doesn't run on JRuby"
-
-    run_generator
-
-    assert_gem "spring"
-    assert_file "bin/spring", %r{^\s*require "spring/binstub"}
-    assert_file "bin/rails", %r{^\s*load .+"spring"}
-    assert_file "bin/rake", %r{^\s*load .+"spring"}
-    assert_file("config/environments/test.rb") do |contents|
-      assert_match("config.cache_classes = false", contents)
-      assert_match("config.action_view.cache_template_loading = true", contents)
-    end
-  end
-
   def test_bundler_binstub
     generator([destination_root], skip_webpack_install: true)
     run_generator_instance
 
     assert_equal 1, @bundle_commands.count("binstubs bundler")
   end
 
-  def test_spring_no_fork
-    respond_to = Process.method(:respond_to?)
-    respond_to_stub = -> (name) { name != :fork && respond_to[name] }
-    Process.stub(:respond_to?, respond_to_stub) do
-      run_generator
-    end
-
-    assert_no_gem "spring"
-  end
-
-  def test_skip_spring
-    run_generator [destination_root, "--skip-spring"]
-
-    assert_no_file "config/spring.rb"
-    assert_no_gem "spring"
-    assert_file("config/environments/test.rb") do |contents|
-      assert_match("config.cache_classes = true", contents)
-    end
-    assert_file "bin/rails" do |contents|
-      assert_no_match %r{spring}, contents
-    end
-    assert_file "bin/rake" do |contents|
-      assert_no_match %r{spring}, contents
-    end
-  end
-
-  def test_spring_with_dev_option
-    run_generator [destination_root, "--dev", "--skip-bundle"]
-
-    assert_no_gem "spring"
-  end
-
   def test_skip_active_record_option
     run_generator [destination_root, "--skip-active-record"]
 
@@ -1200,7 +1139,6 @@ def test_minimal_rails_app
     assert_no_file "#{app_root}/config/cable.yml"
     assert_no_file "#{app_root}/bin/yarn"
     assert_no_file "#{app_root}/views/layouts/mailer.html.erb"
-    assert_no_file "#{app_root}/config/spring.rb"
     assert_no_file "#{app_root}/app/jobs/application.rb"
     assert_file "#{app_root}/app/views/layouts/application.html.erb" do |content|
       assert_no_match(/data-turbolinks-track/, content)
@@ -1226,7 +1164,6 @@ def test_minimal_rails_app
 
     assert_no_gem "webpacker", app_root
     assert_no_gem "jbuilder", app_root
-    assert_no_gem "spring", app_root
     assert_no_gem "web-console", app_root
   end
 
diff --git a/railties/test/generators/generators_test_helper.rb b/railties/test/generators/generators_test_helper.rb
@@ -94,7 +94,6 @@ def gemfile_locals
       {
         skip_active_storage: true,
         depend_on_bootsnap: false,
-        spring_install: false,
         depends_on_system_test: false,
         options: ActiveSupport::OrderedOptions.new,
       }
diff --git a/railties/test/generators/plugin_generator_test.rb b/railties/test/generators/plugin_generator_test.rb
@@ -651,14 +651,6 @@ def test_unnecessary_files_are_not_generated_in_dummy_application
     assert_no_directory "test/dummy/.git"
   end
 
-  def test_spring_binstub_is_not_generated_in_dummy_application
-    run_generator
-    assert_no_file "test/dummy/bin/spring"
-    assert_file "test/dummy/bin/rails" do |contents|
-      assert_no_match %r/spring/, contents
-    end
-  end
-
   def test_skipping_test_files
     run_generator [destination_root, "--skip-test"]
     assert_no_directory "test"
diff --git a/railties/test/isolation/abstract_unit.rb b/railties/test/isolation/abstract_unit.rb
@@ -511,7 +511,7 @@ def self.sh(cmd)
   FileUtils.rm_rf(app_template_path)
   FileUtils.mkdir_p(app_template_path)
 
-  sh "#{Gem.ruby} #{RAILS_FRAMEWORK_ROOT}/railties/exe/rails new #{app_template_path} --skip-bundle --skip-spring --no-rc --skip-webpack-install --quiet"
+  sh "#{Gem.ruby} #{RAILS_FRAMEWORK_ROOT}/railties/exe/rails new #{app_template_path} --skip-bundle --no-rc --skip-webpack-install --quiet"
   File.open("#{app_template_path}/config/boot.rb", "w") do |f|
     f.puts 'require "rails/all"'
   end
