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

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

#initialize(*args) ⇒ AppGenerator

Returns a new instance of AppGenerator.



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 272

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

  # Force sprockets and JavaScript to be skipped when generating API only apps.
  # Can't modify options hash as it's frozen by default.
  if options[:api]
    self.options = options.merge(skip_asset_pipeline: true, skip_javascript: true).freeze
  end

  if options[:minimal]
    self.options = options.merge(
      skip_action_cable: true,
      skip_action_mailer: true,
      skip_action_mailbox: true,
      skip_action_text: true,
      skip_active_job: true,
      skip_active_storage: true,
      skip_bootsnap: true,
      skip_dev_gems: true,
      skip_javascript: true,
      skip_jbuilder: true,
      skip_system_test: true,
      skip_hotwire: true).freeze
  end

  @after_bundle_callbacks = []
end

Class Method Details



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

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 



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

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

#create_app_files ⇒ Object 



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

def create_app_files
  build(:app)
end

#create_bin_files ⇒ Object 



327
328
329
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 327

def create_bin_files
  build(:bin)
end

#create_boot_file ⇒ Object 



365
366
367
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 365

def create_boot_file
  template "config/boot.rb"
end

#create_config_files ⇒ Object 



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

def create_config_files
  build(:config)
end

#create_credentials ⇒ Object 



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

def create_credentials
  build(:credentials)
end

#create_db_files ⇒ Object 



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

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

#create_lib_files ⇒ Object 



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

def create_lib_files
  build(:lib)
end

#create_log_files ⇒ Object 



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

def create_log_files
  build(:log)
end

#create_master_key ⇒ Object 



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

def create_master_key
  build(:master_key)
end

#create_public_files ⇒ Object 



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

def create_public_files
  build(:public_directory)
end

#create_root_files ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 308

def create_root_files
  build(:readme)
  build(:rakefile)
  build(:ruby_version)
  build(:configru)

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

  build(:gemfile)
  build(:version_control)
end

#create_storage_files ⇒ Object 



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

def create_storage_files
  build(:storage) unless skip_active_storage?
end

#create_system_test_files ⇒ Object 



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

def create_system_test_files
  build(:system_test) if depends_on_system_test?
end

#create_test_files ⇒ Object 



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

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

#create_tmp_files ⇒ Object 



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

def create_tmp_files
  build(:tmp)
end

#create_vendor_files ⇒ Object 



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

def create_vendor_files
  build(:vendor)
end

#delete_action_cable_files_skipping_action_cable ⇒ Object 



478
479
480
481
482
483
484
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 478

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 



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

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 



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

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

#delete_api_initializers ⇒ Object 



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

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

#delete_app_assets_if_api_option ⇒ Object 



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

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 



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

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 



426
427
428
429
430
431
432
433
434
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 426

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 



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

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 



447
448
449
450
451
452
453
454
455
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 447

def delete_assets_initializer_skipping_sprockets
  if skip_sprockets?
    remove_file "config/initializers/assets.rb"
    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 



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

def delete_new_framework_defaults
  unless options[:update]
    remove_file "config/initializers/new_framework_defaults_7_0.rb"
  end
end

#delete_non_api_initializers_if_api_option ⇒ Object 



486
487
488
489
490
491
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 486

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 



436
437
438
439
440
441
442
443
444
445
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 436

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 



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

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 



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

def finish_template
  build(:leftovers)
end

#run_after_bundle_callbacks ⇒ Object 



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

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

#update_active_storage ⇒ Object 



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

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

#update_bin_files ⇒ Object 



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

def update_bin_files
  build(:bin_when_updating)
end

#update_config_files ⇒ Object 



347
348
349
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 347

def update_config_files
  build(:config_when_updating)
end