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::ASSET_PIPELINE_OPTIONS, 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.



342
343
344
345
346
347
348
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 342

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:



334
335
336
337
338
339
340
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 334

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
 


588
589
590
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 588

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 



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

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

#create_app_files ⇒ Object 



371
372
373
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 371

def create_app_files
  build(:app)
end

#create_bin_files ⇒ Object 



375
376
377
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 375

def create_bin_files
  build(:bin)
end

#create_boot_file ⇒ Object 



424
425
426
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 424

def create_boot_file
  template "config/boot.rb"
end

#create_cifiles ⇒ Object 



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

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

#create_config_files ⇒ Object 



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

def create_config_files
  build(:config)
end

#create_credentials ⇒ Object 



419
420
421
422
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 419

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

#create_db_files ⇒ Object 



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

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

#create_devcontainer_files ⇒ Object 



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

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

#create_dockerfiles ⇒ Object 



391
392
393
394
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 391

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

#create_lib_files ⇒ Object 



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

def create_lib_files
  build(:lib)
end

#create_log_files ⇒ Object 



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

def create_log_files
  build(:log)
end

#create_master_key ⇒ Object 



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

def create_master_key
  build(:master_key)
end

#create_public_files ⇒ Object 



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

def create_public_files
  build(:public_directory)
end

#create_root_files ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 355

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 



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

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

#create_storage_files ⇒ Object 



466
467
468
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 466

def create_storage_files
  build(:storage) unless skip_storage?
end

#create_system_test_files ⇒ Object 



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

def create_system_test_files
  build(:system_test) if depends_on_system_test?
end

#create_test_files ⇒ Object 



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

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

#create_tmp_files ⇒ Object 



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

def create_tmp_files
  build(:tmp)
end

#create_vendor_files ⇒ Object 



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

def create_vendor_files
  build(:vendor)
end

#delete_action_cable_files_skipping_action_cable ⇒ Object 



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

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 



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

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 



530
531
532
533
534
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 530

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

#delete_api_initializers ⇒ Object 



560
561
562
563
564
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 560

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

#delete_app_assets_if_api_option ⇒ Object 



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

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

#delete_app_helpers_if_api_option ⇒ Object 



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

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 



489
490
491
492
493
494
495
496
497
498
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 489

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 



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

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



511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 511

def delete_assets_initializer_skipping_sprockets_and_propshaft
  if skip_sprockets? && skip_propshaft?
    remove_file "config/initializers/assets.rb"
  end

  if skip_sprockets?
    remove_file "app/assets/config/manifest.js"
    remove_dir  "app/assets/config"
    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 



566
567
568
569
570
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 566

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 



553
554
555
556
557
558
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 553

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

#delete_public_files_if_api_option ⇒ Object 



500
501
502
503
504
505
506
507
508
509
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 500

def delete_public_files_if_api_option
  if options[:api]
    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 



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

def finish_template
  build(:leftovers)
end

#run_after_bundle_callbacks ⇒ Object 



584
585
586
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 584

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

#update_active_storage ⇒ Object 



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

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

#update_bin_files ⇒ Object 



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

def update_bin_files
  build(:bin_when_updating)
end

#update_config_files ⇒ Object 



410
411
412
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 410

def update_config_files
  build(:config_when_updating)
end