Merge pull request rails#51690 from etiennebarrie/force-app-update

Turn app:update into a command to add --force

Author: rafaelfranca

railties/CHANGELOG.md

@@ -1,3 +1,14 @@
+*   Add options to bin/rails app:update.
+
+    `bin/rails app:update` now supports the same generic options that generators do:
+
+    * `--force`: Accept all changes to existing files
+    * `--skip`: Refuse all changes to existing files
+    * `--pretend`: Don't make any changes
+    * `--quiet`: Don't output all changes made
+
+    *Étienne Barrié*
+
 *   Implement Rails console commands and helpers with IRB v1.13's extension APIs
 
     Rails console users will now see `helper`, `controller`, `new_session`, and `app` under

railties/lib/rails/app_updater.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Rails
+  module Command
+    module App
+      class UpdateCommand < Base # :nodoc:
+        include Thor::Actions
+        add_runtime_options!
+
+        desc "update", "Update configs and some other initially generated files (or use just update:configs or update:bin)"
+        def perform
+          configs
+          bin
+          active_storage
+          display_upgrade_guide_info
+        end
+
+        desc "configs", "Update config files in the application config/ directory", hide: true
+        def configs
+          require_application!
+          app_generator.create_boot_file
+          app_generator.update_config_files
+        end
+
+        desc "bin", "Add or update executables in the application bin/ directory", hide: true
+        def bin
+          require_application!
+          app_generator.update_bin_files
+        end
+
+        desc "active_storage", "Run the active_storage:update command", hide: true
+        def active_storage
+          require_application!
+          app_generator.update_active_storage
+        end
+
+        private
+          def display_upgrade_guide_info
+            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
+
+          def app_generator
+            @app_generator ||= begin
+              gen = Rails::Generators::AppGenerator.new(["rails"], generator_options, destination_root: Rails.root)
+              gen.send(:valid_const?) unless File.exist?(Rails.root.join("config", "application.rb"))
+              gen
+            end
+          end
+
+          def generator_options
+            {
+              api:                 !!Rails.application.config.api_only,
+              update:              true,
+              name:                Rails.application.class.name.chomp("::Application").underscore,
+              skip_active_job:     !defined?(ActiveJob::Railtie),
+              skip_active_record:  !defined?(ActiveRecord::Railtie),
+              skip_active_storage: !defined?(ActiveStorage::Engine),
+              skip_action_mailer:  !defined?(ActionMailer::Railtie),
+              skip_action_mailbox: !defined?(ActionMailbox::Engine),
+              skip_action_text:    !defined?(ActionText::Engine),
+              skip_action_cable:   !defined?(ActionCable::Engine),
+              skip_test:           !defined?(Rails::TestUnitRailtie),
+              skip_system_test:    Rails.application.config.generators.system_tests.nil?,
+              asset_pipeline:      asset_pipeline,
+              skip_asset_pipeline: asset_pipeline.nil?,
+              skip_bootsnap:       !defined?(Bootsnap),
+            }.merge(options)
+          end
+
+          def asset_pipeline
+            case
+            when defined?(Sprockets::Railtie)
+              "sprockets"
+            when defined?(Propshaft::Railtie)
+              "propshaft"
+            else
+              nil
+            end
+          end
+      end
+    end
+  end
+end

railties/lib/rails/commands/app/update_command.rb

@@ -412,11 +412,6 @@ def create_credentials
         build(:credentials_diff_enroll)
       end
 
-      def display_upgrade_guide_info
-        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
-
       def create_boot_file
         template "config/boot.rb"
       end

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

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 namespace :app do
-  desc "Update configs and some other initially generated files (or use just update:configs or update:bin)"
-  task update: [ "update:configs", "update:bin", "update:active_storage", "update:upgrade_guide_info" ]
-
   desc "Apply the template supplied by LOCATION=(/path/to/template) or URL"
   task template: :environment do
     template = ENV["LOCATION"]
@@ -34,27 +31,4 @@ namespace :app do
       end
     end
   end
-
-  namespace :update do
-    require "rails/app_updater"
-
-    # desc "Update config files from your current rails install"
-    task :configs do
-      Rails::AppUpdater.invoke_from_app_generator :create_boot_file
-      Rails::AppUpdater.invoke_from_app_generator :update_config_files
-    end
-
-    # desc "Add new executables to the application bin/ directory"
-    task :bin do
-      Rails::AppUpdater.invoke_from_app_generator :update_bin_files
-    end
-
-    task :active_storage do
-      Rails::AppUpdater.invoke_from_app_generator :update_active_storage
-    end
-
-    task :upgrade_guide_info do
-      Rails::AppUpdater.invoke_from_app_generator :display_upgrade_guide_info
-    end
-  end
 end

railties/lib/rails/tasks/framework.rake

@@ -188,6 +188,34 @@ def test_app_update_create_new_framework_defaults
     assert_file defaults_path
   end
 
+  def test_app_update_supports_skip
+    run_generator
+    FileUtils.cd(destination_root) do
+      config = "config/application.rb"
+      File.open(config, "a") do |file|
+        file.puts "# some configuration"
+      end
+      assert_no_changes -> { File.readlines(config) } do
+        run_app_update(flags: "--skip")
+      end
+    end
+  end
+
+  def test_app_update_supports_pretend
+    run_generator
+    FileUtils.cd(destination_root) do
+      config = "config/application.rb"
+      File.open(config, "a") do |file|
+        file.puts "# some configuration"
+      end
+      assert_no_changes -> { File.readlines(config) } do
+        run_app_update(flags: "--pretend --force")
+      end
+      defaults_path = "config/initializers/new_framework_defaults_#{Rails::VERSION::MAJOR}_#{Rails::VERSION::MINOR}.rb"
+      assert_no_file defaults_path
+    end
+  end
+
   def test_app_update_does_not_create_rack_cors
     run_generator
     run_app_update
@@ -1500,13 +1528,13 @@ def run_generator_and_bundler(args)
       end
     end
 
-    def run_app_update(app_root = destination_root)
+    def run_app_update(app_root = destination_root, flags: "--force")
       Dir.chdir(app_root) do
         gemfile_contents = File.read("Gemfile")
         gemfile_contents.sub!(/^(gem "rails").*/, "\\1, path: #{File.expand_path("../../..", __dir__).inspect}")
         File.write("Gemfile", gemfile_contents)
 
-        quietly { system({ "BUNDLE_GEMFILE" => "Gemfile" }, "yes | bin/rails app:update", exception: true) }
+        quietly { system({ "BUNDLE_GEMFILE" => "Gemfile" }, "bin/rails app:update #{flags}", exception: true) }
       end
     end