Class: Rails::Generators::AppGenerator

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `AppBase`, `Base`, Thor::Group
Instance Chain: self, `AppBase`, `AppName`, `Database`, `Base`, `Actions`, Thor::Actions, Thor::Group
Inherits:	Rails::Generators::AppBase `::Object` Thor::Group Rails::Generators::Base Rails::Generators::AppBase Rails::Generators::AppGenerator
Defined in:	railties/lib/rails/generators/rails/app/app_generator.rb, railties/lib/rails/commands/application/application_command.rb

Constant Summary

META_OPTIONS = Internal use only
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 306
```
[:minimal]
```

OPTION_IMPLICATIONS = Internal use only
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 281

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

Class Attribute Summary

.exit_on_failure? ⇒ Boolean readonly Internal use only

We want to exit on failure to be kind to other libraries This is only when accessing via CLI.

`Base` - Inherited

.exit_on_failure?

Class Method Summary

.apply_rails_template(template, destination) Internal use only
.banner Internal use only
.new(*args) ⇒ AppGenerator constructor Internal use only

`AppBase` - Inherited

.add_shared_options_for, .edge_branch, .new, .strict_args_position

`Base` - Inherited

.base_root	Returns the base root for a common set of generators.
.default_source_root	Returns the default source root for a given generator.
.desc	Tries to get the description from a USAGE file one folder above the source root otherwise uses a default description.
.hide!	Convenience method to hide this generator from the available ones when running rails generator command.
.hook_for	Invoke a generator based on the value supplied by the user to the given option named “name”.
.namespace	Convenience method to get the namespace from the class name.
.remove_hook_for	Remove a previously added hook.
.source_root	Returns the source root for this generator using default_source_root as default.
.add_shebang_option!	Small macro to add ruby as an option to the generator with proper default value plus an instance helper method called shebang.
.banner	Use Rails default banner.
.base_name	Sets the base_name taking into account the current class namespace.
.default_aliases_for_option	Returns default aliases for the option name given doing a lookup in aliases.
.default_for_option	Returns default for the option name given doing a lookup in config.
.default_generator_root,
.default_value_for_option	Returns the default value for the option name given doing a lookup in options.
.generator_name	Removes the namespaces and get the generator name.
.usage_path,
.class_option	Make class option aware of options and aliases.
.inherited	Cache source root and add lib/generators/base/generator/templates to source paths.
.hooks	Keep hooks configuration that are used on prepare_for_invocation.
.prepare_for_invocation	Prepare class invocation to search on `::Rails` namespace if a previous added hook is being used.

Instance Attribute Summary

Instance Method Summary

#after_bundle(&block) private

Registers a callback to be executed after bundle binstubs have run.
#file(*args, &block) private

Define file as an alias to create_file for backwards compatibility.
#get_builder_class private
#create_active_record_files Internal use only
#create_app_files Internal use only
#create_bin_files Internal use only
#create_boot_file Internal use only
#create_config_files Internal use only
#create_credentials Internal use only
#create_db_files Internal use only
#create_dockerfiles Internal use only
#create_lib_files Internal use only
#create_log_files Internal use only
#create_master_key Internal use only
#create_public_files Internal use only
#create_root_files Internal use only
#create_storage_files Internal use only
#create_system_test_files Internal use only
#create_test_files Internal use only
#create_tmp_files Internal use only
#create_vendor_files Internal use only
#delete_action_cable_files_skipping_action_cable Internal use only
#delete_action_mailer_files_skipping_action_mailer Internal use only
#delete_active_job_folder_if_skipping_active_job Internal use only
#delete_api_initializers Internal use only
#delete_app_assets_if_api_option Internal use only
#delete_app_helpers_if_api_option Internal use only
#delete_app_views_if_api_option Internal use only
#delete_application_record_skipping_active_record Internal use only
#delete_assets_initializer_skipping_sprockets_and_propshaft Internal use only
#delete_new_framework_defaults Internal use only
#delete_non_api_initializers_if_api_option Internal use only
#delete_public_files_if_api_option Internal use only
#display_upgrade_guide_info Internal use only
#finish_template Internal use only
#run_after_bundle_callbacks Internal use only
#update_active_storage Internal use only
#update_bin_files Internal use only
#update_config_files Internal use only

`AppBase` - Inherited

#add_bundler_platforms, #bundle_command, #bundler_windows_platforms, #cable_gemfile_entry, #css_gemfile_entry, #dockerfile_binfile_fixups, #dockerfile_build_packages, #dockerfile_bun_version, #dockerfile_chown_directories, #dockerfile_deploy_packages, #dockerfile_yarn_version, #edge_branch, #empty_directory_with_keep_file, #exec_bundle_command, #gem_ruby_version, #generate_bundler_binstub, #git_init_command, #hotwire_gemfile_entry, #javascript_gemfile_entry, #jbuilder_gemfile_entry, #keep_file, #node_version, #rails_gemfile_entry, #rails_version_specifier, #run_bundle, #run_css, #run_hotwire, #run_javascript, #target_rails_prerelease, #user_default_branch, #apply_rails_template, #asset_pipeline_gemfile_entry, #build, #builder, #comment_if, #create_root, #database_gemfile_entry, #deduce_implied_options, #gemfile_entries,
#imply_options	Options.
#rails_require_statement, #report_implied_options, #required_railties, #set_default_accessors!, #web_server_gemfile_entry

`AppName` - Included

#app_const, #app_const_base, #app_name,
#camelized	Alias for AppName#app_const_base.
#original_app_name

`Database` - Included

#build_package_for_database, #convert_database_option_for_jruby, #deploy_package_for_database, #docker_for_database_build, #docker_for_database_deploy, #gem_for_database, #initialize, #mysql_socket

`Base` - Inherited

#class_collisions	Check whether the given class names are already taken by user application or Ruby on `::Rails`.
#extract_last_module	Takes in an array of nested modules and extracts the last module.
#indent,
#module_namespacing	Wrap block with namespace of current application if namespace exists and is not skipped.
#namespace, #namespace_dirs, #namespaced_path, #wrap_with_namespace

`Actions` - Included

#add_source	Add the given source to `Gemfile`
#application	Alias for Actions#environment.
#environment	Adds configuration code to a Rails runtime environment.
#gem	Adds a `gem` declaration to the `Gemfile` for the specified gem.
#gem_group	Wraps gem entries inside a group.
#generate	Runs another generator.
#git	Runs one or more git commands.
#github,
#initializer	Creates an initializer file in `config/initializers/`.
#lib	Creates a file in `lib/`.
#rails_command	Runs the specified Rails command.
#rake	Runs the specified Rake task.
#rakefile	Creates a Rake tasks file in `lib/tasks/`.
#readme	Reads the given file at the source root and prints it in the console.
#route	Make an entry in Rails routing file `config/routes.rb`.
#vendor	Creates a file in `vendor/`.
#append_file_with_newline	Append string to a file with a newline if necessary.
#execute_command	Runs the supplied command using either “rake …” or “rails …” based on the executor parameter provided.
#indentation	Indent the `Gemfile` to the depth of @indentation.
#log	Define log for backwards compatibility.
#match_file,
#optimize_indentation	Returns optimized string with indentation.
#quote	Always returns value in double quotes.
#rebase_indentation	Alias for Actions#optimize_indentation.
#route_namespace_pattern,
#with_indentation	Manage `Gemfile` indentation for a DSL action block.
#initialize

Constructor Details

.new(*args) ⇒ `AppGenerator`

This method is for internal use only.

[ GitHub ]

# File 'railties/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 Attribute Details

.exit_on_failure? ⇒ `Boolean` (readonly)

This method is for internal use only.

We want to exit on failure to be kind to other libraries This is only when accessing via CLI

[ GitHub ]

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


def self.exit_on_failure?
  true
end

Class Method Details

.apply_rails_template(template, destination)

This method is for internal use only.

[ GitHub ]

# File 'railties/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

Instance Method Details

#after_bundle(&block) (private)

Registers a callback to be executed after bundle binstubs have run.

after_bundle do
  git add: '.'
end

[ GitHub ]

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


def after_bundle(&block) # :doc:
  @after_bundle_callbacks << block
end

#create_active_record_files

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

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


def create_app_files
  build(:app)
end

#create_bin_files

This method is for internal use only.

[ GitHub ]

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


def create_bin_files
  build(:bin)
end

#create_boot_file

This method is for internal use only.

[ GitHub ]

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


def create_boot_file
  template "config/boot.rb"
end

#create_config_files

This method is for internal use only.

[ GitHub ]

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


def create_config_files
  build(:config)
end

#create_credentials

This method is for internal use only.

[ GitHub ]

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


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

#create_db_files

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

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


def create_lib_files
  build(:lib)
end

#create_log_files

This method is for internal use only.

[ GitHub ]

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


def create_log_files
  build(:log)
end

#create_master_key

This method is for internal use only.

[ GitHub ]

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


def create_master_key
  build(:master_key)
end

#create_public_files

This method is for internal use only.

[ GitHub ]

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


def create_public_files
  build(:public_directory)
end

#create_root_files

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

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


def create_storage_files
  build(:storage)
end

#create_system_test_files

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

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


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

#create_tmp_files

This method is for internal use only.

[ GitHub ]

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


def create_tmp_files
  build(:tmp)
end

#create_vendor_files

This method is for internal use only.

[ GitHub ]

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


def create_vendor_files
  build(:vendor)
end

#delete_action_cable_files_skipping_action_cable

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

# File 'railties/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

#file(*args, &block) (private)

Define file as an alias to create_file for backwards compatibility.

[ GitHub ]

# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 564


def file(*args, &block)
  create_file(*args, &block)
end

#finish_template

This method is for internal use only.

[ GitHub ]

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


def finish_template
  build(:leftovers)
end

#get_builder_class (private)

[ GitHub ]

# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 578


def get_builder_class
  defined?(::AppBuilder) ? ::AppBuilder : Rails::AppBuilder
end

#run_after_bundle_callbacks

This method is for internal use only.

[ GitHub ]

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


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

#update_active_storage

This method is for internal use only.

[ GitHub ]

# File 'railties/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

This method is for internal use only.

[ GitHub ]

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


def update_bin_files
  build(:bin_when_updating)
end

#update_config_files

This method is for internal use only.

[ GitHub ]

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


def update_config_files
  build(:config_when_updating)
end

Class: Rails::Generators::AppGenerator

Constant Summary

Database - Included

AppName - Included

AppBase - Inherited

Class Attribute Summary

Base - Inherited

Class Method Summary

AppBase - Inherited

Base - Inherited

Instance Attribute Summary

AppBase - Inherited

AppName - Included

Base - Inherited

Instance Method Summary

AppBase - Inherited

AppName - Included

Database - Included

Base - Inherited

Actions - Included

Constructor Details

.new(*args) ⇒ AppGenerator

Class Attribute Details

.exit_on_failure? ⇒ Boolean (readonly)

Class Method Details

.apply_rails_template(template, destination)

.banner

Instance Method Details

#after_bundle(&block) (private)

#create_active_record_files

#create_app_files

#create_bin_files

#create_boot_file

#create_config_files

#create_credentials

#create_db_files

#create_dockerfiles

#create_lib_files

#create_log_files

#create_master_key

#create_public_files

#create_root_files

#create_storage_files

#create_system_test_files

#create_test_files

#create_tmp_files

#create_vendor_files

#delete_action_cable_files_skipping_action_cable

#delete_action_mailer_files_skipping_action_mailer

#delete_active_job_folder_if_skipping_active_job

#delete_api_initializers

#delete_app_assets_if_api_option

#delete_app_helpers_if_api_option

#delete_app_views_if_api_option

#delete_application_record_skipping_active_record

#delete_assets_initializer_skipping_sprockets_and_propshaft

#delete_new_framework_defaults

#delete_non_api_initializers_if_api_option

#delete_public_files_if_api_option

#display_upgrade_guide_info

#file(*args, &block) (private)

#finish_template

#get_builder_class (private)

#run_after_bundle_callbacks

#update_active_storage

#update_bin_files

#update_config_files

`Database` - Included

`AppName` - Included

`AppBase` - Inherited

`Base` - Inherited

`AppBase` - Inherited

`Base` - Inherited

`AppBase` - Inherited

`AppName` - Included

`Base` - Inherited

`AppBase` - Inherited

`AppName` - Included

`Database` - Included

`Base` - Inherited

`Actions` - Included

.new(*args) ⇒ `AppGenerator`

.exit_on_failure? ⇒ `Boolean` (readonly)