Merge pull request #30219 from yhirano55/fix_app_generator_api_options

Refactor `--api` option of the app generator

7 files changed, 48 insertions, 29 deletions

diff --git a/railties/lib/rails/generators/rails/app/templates/app/controllers/application_controller.rb.tt b/railties/lib/rails/generators/rails/app/templates/app/controllers/application_controller.rb.tt
index 185c0017f1..938eff8ed0 100644
--- a/railties/lib/rails/generators/rails/app/templates/app/controllers/application_controller.rb.tt
+++ b/railties/lib/rails/generators/rails/app/templates/app/controllers/application_controller.rb.tt
@@ -1,2 +1,2 @@
-class ApplicationController < ActionController::<%= options[:api] ? "API" : "Base" %>
+class ApplicationController < ActionController::<%= options.api? ? "API" : "Base" %>
 end
diff --git a/railties/lib/rails/generators/rails/app/templates/bin/setup.tt b/railties/lib/rails/generators/rails/app/templates/bin/setup.tt
index a53d1fb0a9..233b5a1d95 100644
--- a/railties/lib/rails/generators/rails/app/templates/bin/setup.tt
+++ b/railties/lib/rails/generators/rails/app/templates/bin/setup.tt
@@ -15,12 +15,12 @@ chdir APP_ROOT do
   puts '== Installing dependencies =='
   system! 'gem install bundler --conservative'
   system('bundle check') || system!('bundle install')
-<% unless options[:skip_yarn] -%>
+<% unless options.skip_yarn? -%>
 
   # Install JavaScript dependencies if using Yarn
   # system('bin/yarn')
 <% end -%>
-<% unless options.skip_active_record -%>
+<% unless options.skip_active_record? -%>
 
   # puts "\n== Copying sample files =="
   # unless File.exist?('config/database.yml')
diff --git a/railties/lib/rails/generators/rails/app/templates/bin/update.tt b/railties/lib/rails/generators/rails/app/templates/bin/update.tt
index 5b6e50883e..d744bec32f 100644
--- a/railties/lib/rails/generators/rails/app/templates/bin/update.tt
+++ b/railties/lib/rails/generators/rails/app/templates/bin/update.tt
@@ -15,7 +15,7 @@ chdir APP_ROOT do
   puts '== Installing dependencies =='
   system! 'gem install bundler --conservative'
   system('bundle check') || system!('bundle install')
-<% unless options.skip_active_record -%>
+<% unless options.skip_active_record? -%>
 
   puts "\n== Updating database =="
   system! 'bin/rails db:migrate'
diff --git a/railties/lib/rails/generators/rails/app/templates/config/application.rb b/railties/lib/rails/generators/rails/app/templates/config/application.rb
index e9edad5309..eec973caa5 100644
--- a/railties/lib/rails/generators/rails/app/templates/config/application.rb
+++ b/railties/lib/rails/generators/rails/app/templates/config/application.rb
@@ -31,7 +31,7 @@ module <%= app_const_base %>
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
-<%- if options[:api] -%>
+<%- if options.api? -%>
 
     # Only loads a smaller set of middleware suitable for API only apps.
     # Middleware like session, flash, cookies can be added back manually.
diff --git a/railties/lib/rails/generators/rails/app/templates/gitignore b/railties/lib/rails/generators/rails/app/templates/gitignore
index 64ed09dc4b..d8eeb1772d 100644
--- a/railties/lib/rails/generators/rails/app/templates/gitignore
+++ b/railties/lib/rails/generators/rails/app/templates/gitignore
@@ -24,13 +24,13 @@
 # Ignore uploaded files in development
 /storage/*
 
-<% unless options[:skip_yarn] -%>
+<% unless options.skip_yarn? -%>
 /node_modules
 /yarn-error.log
 
 <% end -%>
 
-<% unless options[:api] -%>
+<% unless options.api? -%>
 /public/assets
 <% end -%>
 .byebug_history
diff --git a/railties/test/generators/api_app_generator_test.rb b/railties/test/generators/api_app_generator_test.rb
index 58617510d7..ba7f7bb5f3 100644
--- a/railties/test/generators/api_app_generator_test.rb
+++ b/railties/test/generators/api_app_generator_test.rb
@@ -35,26 +35,26 @@ class ApiAppGeneratorTest < Rails::Generators::TestCase
   def test_api_modified_files
     run_generator
 
+    assert_file ".gitignore" do |content|
+      assert_no_match(/\/public\/asserts/, content)
+    end
+
     assert_file "Gemfile" do |content|
       assert_no_match(/gem 'coffee-rails'/, content)
       assert_no_match(/gem 'sass-rails'/, content)
       assert_no_match(/gem 'web-console'/, content)
+      assert_no_match(/gem 'capybara'/, content)
+      assert_no_match(/gem 'selenium-webdriver'/, content)
       assert_match(/# gem 'jbuilder'/, content)
+      assert_match(/# gem 'rack-cors'/, content)
     end
 
-    assert_file "config/application.rb" do |content|
-      assert_match(/config.api_only = true/, content)
-    end
-
-    assert_file "config/initializers/cors.rb"
-
-    assert_file "config/initializers/wrap_parameters.rb"
-
+    assert_file "config/application.rb", /config\.api_only = true/
     assert_file "app/controllers/application_controller.rb", /ActionController::API/
   end
 
   def test_generator_if_skip_action_cable_is_given
-    run_generator [destination_root, "--skip-action-cable"]
+    run_generator [destination_root, "--api", "--skip-action-cable"]
     assert_file "config/application.rb", /#\s+require\s+["']action_cable\/engine["']/
     assert_no_file "config/cable.yml"
     assert_no_file "app/channels"
@@ -87,20 +87,49 @@ class ApiAppGeneratorTest < Rails::Generators::TestCase
   private
 
     def default_files
-      files = %W(
-        .gitignore
+      %w(.gitignore
+        .ruby-version
+        README.md
         Gemfile
         Rakefile
         config.ru
+        app/channels
         app/controllers
         app/mailers
         app/models
+        app/views/layouts
         app/views/layouts/mailer.html.erb
         app/views/layouts/mailer.text.erb
+        bin/bundle
+        bin/rails
+        bin/rake
+        bin/setup
+        bin/update
+        config/application.rb
+        config/boot.rb
+        config/cable.yml
+        config/environment.rb
         config/environments
+        config/environments/development.rb
+        config/environments/production.rb
+        config/environments/test.rb
         config/initializers
+        config/initializers/application_controller_renderer.rb
+        config/initializers/backtrace_silencers.rb
+        config/initializers/cors.rb
+        config/initializers/filter_parameter_logging.rb
+        config/initializers/inflections.rb
+        config/initializers/mime_types.rb
+        config/initializers/wrap_parameters.rb
         config/locales
+        config/locales/en.yml
+        config/puma.rb
+        config/routes.rb
+        config/secrets.yml
+        config/spring.rb
+        config/storage.yml
         db
+        db/seeds.rb
         lib
         lib/tasks
         log
@@ -111,8 +140,6 @@ class ApiAppGeneratorTest < Rails::Generators::TestCase
         tmp
         vendor
       )
-      files.concat %w(bin/bundle bin/rails bin/rake)
-      files
     end
 
     def skipped_files
@@ -130,7 +157,7 @@ class ApiAppGeneratorTest < Rails::Generators::TestCase
          public/500.html
          public/apple-touch-icon-precomposed.png
          public/apple-touch-icon.png
-         public/favicon.icon
+         public/favicon.ico
          package.json
       )
     end
diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb
index ccb437c74d..1183dcd34d 100644
--- a/railties/test/generators/app_generator_test.rb
+++ b/railties/test/generators/app_generator_test.rb
@@ -537,14 +537,6 @@ class AppGeneratorTest < Rails::Generators::TestCase
     end
   end
 
-  def test_generator_if_api_is_given
-    run_generator [destination_root, "--api"]
-    assert_file "Gemfile" do |content|
-      assert_no_match(/capybara/, content)
-      assert_no_match(/selenium-webdriver/, content)
-    end
-  end
-
   def test_inclusion_of_javascript_runtime
     run_generator
     if defined?(JRUBY_VERSION)