Class: Rails::Generators::AppGenerator
- Inherits:
-
AppBase
show all
- Defined in:
- railties/lib/rails/commands/application/application_command.rb,
railties/lib/rails/generators/rails/app/app_generator.rb
Overview
Constant Summary
collapse
- WEBPACKS =
%w( react vue angular elm stimulus )
Constants included
from AppName
Rails::Generators::AppName::RESERVED_NAMES
Constants included
from Database
Database::DATABASES, Database::JDBC_DATABASES
Instance Attribute Summary
Attributes inherited from AppBase
#rails_template
Class Method Summary
collapse
Instance Method Summary
collapse
Methods inherited from AppBase
add_shared_options_for, strict_args_position
Methods included from Database
#convert_database_option_for_jruby, #gem_for_database
Methods inherited from Base
base_root, class_option, default_source_root, desc, hide!, hook_for, inherited, namespace, remove_hook_for, source_root
Methods included from Actions
#add_source, #environment, #gem, #gem_group, #generate, #git, #github, #initializer, #lib, #rails_command, #rake, #rakefile, #readme, #route, #vendor
Constructor Details
Returns a new instance of AppGenerator.
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 274
def initialize(*args)
super
if !options[:skip_active_record] && !DATABASES.include?(options[:database])
raise Error, "Invalid value for --database option. Supported preconfigurations are: #{DATABASES.join(", ")}."
end
if options[:api]
self.options = options.merge(skip_sprockets: true, skip_javascript: true).freeze
end
@after_bundle_callbacks = []
end
|
Class Method Details
499
500
501
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 499
def self.banner
"rails new #{arguments.map(&:usage).join(' ')} [options]"
end
|
.exit_on_failure? ⇒ Boolean
We want to exit on failure to be kind to other libraries This is only when accessing via CLI
11
12
13
|
# File 'railties/lib/rails/commands/application/application_command.rb', line 11
def self.exit_on_failure?
true
end
|
Instance Method Details
#create_active_record_files ⇒ Object
350
351
352
353
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 350
def create_active_record_files
return if options[:skip_active_record]
build(:database_yml)
end
|
#create_app_files ⇒ Object
304
305
306
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 304
def create_app_files
build(:app)
end
|
#create_bin_files ⇒ Object
308
309
310
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 308
def create_bin_files
build(:bin)
end
|
#create_boot_file ⇒ Object
346
347
348
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 346
def create_boot_file
template "config/boot.rb"
end
|
#create_config_files ⇒ Object
324
325
326
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 324
def create_config_files
build(:config)
end
|
#create_credentials ⇒ Object
337
338
339
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 337
def create_credentials
build(:credentials)
end
|
#create_db_files ⇒ Object
355
356
357
358
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 355
def create_db_files
return if options[:skip_active_record]
build(:db)
end
|
#create_lib_files ⇒ Object
360
361
362
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 360
def create_lib_files
build(:lib)
end
|
#create_log_files ⇒ Object
364
365
366
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 364
def create_log_files
build(:log)
end
|
#create_master_key ⇒ Object
333
334
335
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 333
def create_master_key
build(:master_key)
end
|
#create_public_files ⇒ Object
368
369
370
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 368
def create_public_files
build(:public_directory)
end
|
#create_root_files ⇒ Object
293
294
295
296
297
298
299
300
301
302
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 293
def create_root_files
build(:readme)
build(:rakefile)
build(:ruby_version)
build(:configru)
build(:gitignore) unless options[:skip_git]
build(:gemfile) unless options[:skip_gemfile]
build(:version_control)
build(:package_json) unless options[:skip_javascript]
end
|
#create_storage_files ⇒ Object
388
389
390
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 388
def create_storage_files
build(:storage) unless skip_active_storage?
end
|
#create_system_test_files ⇒ Object
384
385
386
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 384
def create_system_test_files
build(:system_test) if depends_on_system_test?
end
|
#create_test_files ⇒ Object
380
381
382
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 380
def create_test_files
build(:test) unless options[:skip_test]
end
|
#create_tmp_files ⇒ Object
372
373
374
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 372
def create_tmp_files
build(:tmp)
end
|
#create_vendor_files ⇒ Object
376
377
378
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 376
def create_vendor_files
build(:vendor)
end
|
#delete_action_cable_files_skipping_action_cable ⇒ Object
455
456
457
458
459
460
461
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 455
def delete_action_cable_files_skipping_action_cable
if options[:skip_action_cable]
remove_dir "app/javascript/channels"
remove_dir "app/channels"
remove_dir "test/channels"
end
end
|
#delete_action_mailer_files_skipping_action_mailer ⇒ Object
446
447
448
449
450
451
452
453
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 446
def delete_action_mailer_files_skipping_action_mailer
if options[:skip_action_mailer]
remove_file "app/views/layouts/mailer.html.erb"
remove_file "app/views/layouts/mailer.text.erb"
remove_dir "app/mailers"
remove_dir "test/mailers"
end
end
|
#delete_api_initializers ⇒ Object
471
472
473
474
475
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 471
def delete_api_initializers
unless options[:api]
remove_file "config/initializers/cors.rb"
end
end
|
#delete_app_assets_if_api_option ⇒ Object
392
393
394
395
396
397
398
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 392
def delete_app_assets_if_api_option
if options[:api]
remove_dir "app/assets"
remove_dir "lib/assets"
remove_dir "tmp/cache/assets"
end
end
|
#delete_app_helpers_if_api_option ⇒ Object
400
401
402
403
404
405
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 400
def delete_app_helpers_if_api_option
if options[:api]
remove_dir "app/helpers"
remove_dir "test/helpers"
end
end
|
#delete_app_views_if_api_option ⇒ Object
407
408
409
410
411
412
413
414
415
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 407
def delete_app_views_if_api_option
if options[:api]
if options[:skip_action_mailer]
remove_dir "app/views"
else
remove_file "app/views/layouts/application.html.erb"
end
end
end
|
#delete_application_record_skipping_active_record ⇒ Object
440
441
442
443
444
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 440
def delete_application_record_skipping_active_record
if options[:skip_active_record]
remove_file "app/models/application_record.rb"
end
end
|
#delete_assets_initializer_skipping_sprockets ⇒ Object
434
435
436
437
438
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 434
def delete_assets_initializer_skipping_sprockets
if options[:skip_sprockets]
remove_file "config/initializers/assets.rb"
end
end
|
#delete_bin_yarn ⇒ Object
483
484
485
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 483
def delete_bin_yarn
remove_file "bin/yarn" if options[:skip_javascript]
end
|
#delete_js_folder_skipping_javascript ⇒ Object
428
429
430
431
432
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 428
def delete_js_folder_skipping_javascript
if options[:skip_javascript]
remove_dir "app/javascript"
end
end
|
#delete_new_framework_defaults ⇒ Object
477
478
479
480
481
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 477
def delete_new_framework_defaults
unless options[:update]
remove_file "config/initializers/new_framework_defaults_6_1.rb"
end
end
|
#delete_non_api_initializers_if_api_option ⇒ Object
463
464
465
466
467
468
469
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 463
def delete_non_api_initializers_if_api_option
if options[:api]
remove_file "config/initializers/cookies_serializer.rb"
remove_file "config/initializers/content_security_policy.rb"
remove_file "config/initializers/feature_policy.rb"
end
end
|
#delete_public_files_if_api_option ⇒ Object
417
418
419
420
421
422
423
424
425
426
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 417
def delete_public_files_if_api_option
if options[:api]
remove_file "public/404.html"
remove_file "public/422.html"
remove_file "public/500.html"
remove_file "public/apple-touch-icon-precomposed.png"
remove_file "public/apple-touch-icon.png"
remove_file "public/favicon.ico"
end
end
|
#display_upgrade_guide_info ⇒ Object
341
342
343
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 341
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
|
#finish_template ⇒ Object
487
488
489
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 487
def finish_template
build(:leftovers)
end
|
#run_after_bundle_callbacks ⇒ Object
495
496
497
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 495
def run_after_bundle_callbacks
@after_bundle_callbacks.each(&:call)
end
|
#update_active_storage ⇒ Object
317
318
319
320
321
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 317
def update_active_storage
unless skip_active_storage?
rails_command "active_storage:update"
end
end
|
#update_bin_files ⇒ Object
312
313
314
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 312
def update_bin_files
build(:bin_when_updating)
end
|
#update_config_files ⇒ Object
328
329
330
|
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 328
def update_config_files
build(:config_when_updating)
end
|