Class: Rails::Generators::AppGenerator

Inherits:
AppBase
  • Object
show all
Defined in:
lib/rails/commands/application/application_command.rb,
lib/rails/generators/rails/app/app_generator.rb

Overview

:nodoc:

Constant Summary collapse

OPTION_IMPLICATIONS =

:nodoc:

AppBase::OPTION_IMPLICATIONS.merge(
  skip_git: [:skip_decrypted_diffs],
  minimal: [
    :skip_action_cable,
    :skip_action_mailbox,
    :skip_action_mailer,
    :skip_action_text,
    :skip_active_job,
    :skip_active_storage,
    :skip_bootsnap,
    :skip_dev_gems,
    :skip_hotwire,
    :skip_javascript,
    :skip_jbuilder,
    :skip_system_test,
  ],
  api: [
    :skip_asset_pipeline,
    :skip_javascript,
  ],
) do |option, implications, more_implications|
  implications + more_implications
end
META_OPTIONS =

:nodoc:

[:minimal]

Constants inherited from AppBase

Rails::Generators::AppBase::BUN_VERSION, Rails::Generators::AppBase::CSS_OPTIONS, Rails::Generators::AppBase::JAVASCRIPT_OPTIONS, Rails::Generators::AppBase::NODE_LTS_VERSION

Constants included from AppName

Rails::Generators::AppName::RESERVED_NAMES

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, edge_branch, strict_args_position

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

#initialize(*args) ⇒ AppGenerator

Returns a new instance of AppGenerator.



330
331
332
333
334
335
336
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 330

def initialize(*args)
  super

  imply_options(OPTION_IMPLICATIONS, meta_options: META_OPTIONS)

  @after_bundle_callbacks = []
end

Class Method Details

.apply_rails_template(template, destination) ⇒ Object

:nodoc:



322
323
324
325
326
327
328
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 322

def self.apply_rails_template(template, destination) # :nodoc:
  generator = new([destination], { template: template }, { destination_root: destination })
  generator.set_default_accessors!
  generator.apply_rails_template
  generator.run_bundle
  generator.run_after_bundle_callbacks
end
 


575
576
577
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 575

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

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/rails/commands/application/application_command.rb', line 11

def self.exit_on_failure?
  true
end

Instance Method Details

#create_active_record_files ⇒ Object 



416
417
418
419
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 416

def create_active_record_files
  return if options[:skip_active_record]
  build(:database_yml)
end

#create_app_files ⇒ Object 



359
360
361
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 359

def create_app_files
  build(:app)
end

#create_bin_files ⇒ Object 



363
364
365
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 363

def create_bin_files
  build(:bin)
end

#create_boot_file ⇒ Object 



412
413
414
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 412

def create_boot_file
  template "config/boot.rb"
end

#create_cifiles ⇒ Object 



389
390
391
392
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 389

def create_cifiles
  return if skip_ci?
  build(:cifiles)
end

#create_config_files ⇒ Object 



394
395
396
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 394

def create_config_files
  build(:config)
end

#create_credentials ⇒ Object 



407
408
409
410
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 407

def create_credentials
  build(:credentials)
  build(:credentials_diff_enroll)
end

#create_db_files ⇒ Object 



421
422
423
424
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 421

def create_db_files
  return if options[:skip_active_record]
  build(:db)
end

#create_devcontainer_files ⇒ Object 



463
464
465
466
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 463

def create_devcontainer_files
  return if skip_devcontainer? || options[:dummy_app]
  build(:devcontainer)
end

#create_dockerfiles ⇒ Object 



379
380
381
382
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 379

def create_dockerfiles
  return if options[:skip_docker] || options[:dummy_app]
  build(:dockerfiles)
end

#create_lib_files ⇒ Object 



426
427
428
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 426

def create_lib_files
  build(:lib)
end

#create_log_files ⇒ Object 



430
431
432
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 430

def create_log_files
  build(:log)
end

#create_master_key ⇒ Object 



403
404
405
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 403

def create_master_key
  build(:master_key)
end

#create_public_files ⇒ Object 



434
435
436
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 434

def create_public_files
  build(:public_directory)
end

#create_root_files ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 343

def create_root_files
  build(:readme)
  build(:rakefile)
  build(:node_version) if using_node?
  build(:ruby_version)
  build(:configru)

  unless options[:skip_git]
    build(:gitignore)
    build(:gitattributes)
  end

  build(:gemfile)
  build(:version_control)
end

#create_rubocop_file ⇒ Object 



384
385
386
387
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 384

def create_rubocop_file
  return if skip_rubocop?
  build(:rubocop)
end

#create_script_folder ⇒ Object 



438
439
440
441
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 438

def create_script_folder
  return if options[:dummy_app]
  build(:script)
end

#create_storage_files ⇒ Object 



459
460
461
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 459

def create_storage_files
  build(:storage) unless skip_storage?
end

#create_system_test_files ⇒ Object 



455
456
457
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 455

def create_system_test_files
  build(:system_test) if depends_on_system_test?
end

#create_test_files ⇒ Object 



451
452
453
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 451

def create_test_files
  build(:test) unless options[:skip_test]
end

#create_tmp_files ⇒ Object 



443
444
445
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 443

def create_tmp_files
  build(:tmp)
end

#create_vendor_files ⇒ Object 



447
448
449
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 447

def create_vendor_files
  build(:vendor)
end

#delete_action_cable_files_skipping_action_cable ⇒ Object 



533
534
535
536
537
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 533

def delete_action_cable_files_skipping_action_cable
  if options[:skip_action_cable]
    remove_dir "app/javascript/channels"
  end
end

#delete_action_mailer_files_skipping_action_mailer ⇒ Object 



524
525
526
527
528
529
530
531
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 524

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_active_job_folder_if_skipping_active_job ⇒ Object 



518
519
520
521
522
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 518

def delete_active_job_folder_if_skipping_active_job
  if options[:skip_active_job]
    remove_dir "app/jobs"
  end
end

#delete_api_initializers ⇒ Object 



545
546
547
548
549
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 545

def delete_api_initializers
  unless options[:api]
    remove_file "config/initializers/cors.rb"
  end
end

#delete_app_assets_if_api_option ⇒ Object 



468
469
470
471
472
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 468

def delete_app_assets_if_api_option
  if options[:api]
    remove_dir "app/assets"
  end
end

#delete_app_helpers_if_api_option ⇒ Object 



474
475
476
477
478
479
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 474

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 



481
482
483
484
485
486
487
488
489
490
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 481

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"
      remove_dir  "app/views/pwa"
    end
  end
end

#delete_application_record_skipping_active_record ⇒ Object 



512
513
514
515
516
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 512

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_asset_pipeline ⇒ Object 



504
505
506
507
508
509
510
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 504

def delete_assets_initializer_skipping_asset_pipeline
  if skip_asset_pipeline?
    remove_file "config/initializers/assets.rb"
    remove_file "app/assets/stylesheets/application.css"
    create_file "app/assets/stylesheets/application.css", "/* Application styles */\n" unless options[:api]
  end
end

#delete_new_framework_defaults ⇒ Object 



551
552
553
554
555
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 551

def delete_new_framework_defaults
  unless options[:update]
    remove_file "config/initializers/new_framework_defaults_#{Rails::VERSION::MAJOR}_#{Rails::VERSION::MINOR}.rb"
  end
end

#delete_non_api_initializers_if_api_option ⇒ Object 



539
540
541
542
543
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 539

def delete_non_api_initializers_if_api_option
  if options[:api]
    remove_file "config/initializers/content_security_policy.rb"
  end
end

#delete_public_files_if_api_option ⇒ Object 



492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 492

def delete_public_files_if_api_option
  if options[:api]
    remove_file "public/400.html"
    remove_file "public/404.html"
    remove_file "public/406-unsupported-browser.html"
    remove_file "public/422.html"
    remove_file "public/500.html"
    remove_file "public/icon.png"
    remove_file "public/icon.svg"
  end
end

#finish_template ⇒ Object 



557
558
559
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 557

def finish_template
  build(:leftovers)
end

#run_after_bundle_callbacks ⇒ Object 



571
572
573
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 571

def run_after_bundle_callbacks
  @after_bundle_callbacks.each(&:call)
end

#update_active_storage ⇒ Object 



372
373
374
375
376
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 372

def update_active_storage
  unless skip_active_storage?
    rails_command "active_storage:update", inline: true
  end
end

#update_bin_files ⇒ Object 



367
368
369
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 367

def update_bin_files
  build(:bin_when_updating)
end

#update_config_files ⇒ Object 



398
399
400
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 398

def update_config_files
  build(:config_when_updating)
end