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::NODE_LTS_VERSION

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

Methods included from Database

#build_package_for_database, #convert_database_option_for_jruby, #deploy_package_for_database, #docker_for_database_build, #docker_for_database_deploy, #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

#initialize(*args) ⇒ AppGenerator

Returns a new instance of AppGenerator.



316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 316

def initialize(*args)
  super

  imply_options(OPTION_IMPLICATIONS, meta_options: META_OPTIONS)

  if !options[:skip_active_record] && !DATABASES.include?(options[:database])
    raise Error, "Invalid value for --database option. Supported preconfigurations are: #{DATABASES.join(", ")}."
  end

  @after_bundle_callbacks = []
end

Class Method Details

.apply_rails_template(template, destination) ⇒ Object

:nodoc:



308
309
310
311
312
313
314
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 308

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
 


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

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 



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

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

#create_app_files ⇒ Object 



349
350
351
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 349

def create_app_files
  build(:app)
end

#create_bin_files ⇒ Object 



353
354
355
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 353

def create_bin_files
  build(:bin)
end

#create_boot_file ⇒ Object 



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

def create_boot_file
  template "config/boot.rb"
end

#create_config_files ⇒ Object 



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

def create_config_files
  build(:config)
end

#create_credentials ⇒ Object 



387
388
389
390
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 387

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

#create_db_files ⇒ Object 



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

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

#create_dockerfiles ⇒ Object 



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

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

#create_lib_files ⇒ Object 



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

def create_lib_files
  build(:lib)
end

#create_log_files ⇒ Object 



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

def create_log_files
  build(:log)
end

#create_master_key ⇒ Object 



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

def create_master_key
  build(:master_key)
end

#create_public_files ⇒ Object 



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

def create_public_files
  build(:public_directory)
end

#create_root_files ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 333

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



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

def create_storage_files
  build(:storage)
end

#create_system_test_files ⇒ Object 



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

def create_system_test_files
  build(:system_test) if depends_on_system_test?
end

#create_test_files ⇒ Object 



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

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

#create_tmp_files ⇒ Object 



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

def create_tmp_files
  build(:tmp)
end

#create_vendor_files ⇒ Object 



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

def create_vendor_files
  build(:vendor)
end

#delete_action_cable_files_skipping_action_cable ⇒ Object 



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

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 



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

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 



498
499
500
501
502
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 498

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

#delete_api_initializers ⇒ Object 



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

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

#delete_app_assets_if_api_option ⇒ Object 



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

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 



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

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 



458
459
460
461
462
463
464
465
466
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 458

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 



492
493
494
495
496
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 492

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 



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

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 



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

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 



521
522
523
524
525
526
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 521

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 



468
469
470
471
472
473
474
475
476
477
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 468

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 



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

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 



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

def finish_template
  build(:leftovers)
end

#run_after_bundle_callbacks ⇒ Object 



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

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

#update_active_storage ⇒ Object 



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

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

#update_bin_files ⇒ Object 



357
358
359
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 357

def update_bin_files
  build(:bin_when_updating)
end

#update_config_files ⇒ Object 



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

def update_config_files
  build(:config_when_updating)
end