Class: Rails::AppBuilder
| Relationships & Source Files | |
| Inherits: | Object |
| Defined in: | railties/lib/rails/generators/rails/app/app_generator.rb |
Overview
The application builder allows you to override elements of the application generator without being forced to reverse the operations of the default generator.
This allows you to override entire operations, like the creation of the Gemfile, README, or JavaScript files, without needing to know exactly what those operations do so you can create another template action.
class CustomAppBuilder < Rails::AppBuilder def test @generator.gem "rspec-rails", group: [:development, :test] run "bundle install" generate "rspec:install" end end
Instance Method Summary
- #app
- #bin
- #bin_when_updating
- #cifiles
- #config
- #config_target_version
- #config_when_updating
- #configru
- #credentials
- #credentials_diff_enroll
- #database_yml
- #db
- #devcontainer
- #dockerfiles
- #env
- #gemfile
- #gitattributes
- #gitignore
- #lib
- #log
- #master_key
- #node_version
- #public_directory
- #rakefile
- #readme
- #rubocop
- #ruby_version
- #script
- #storage
- #system_test
- #test
- #tmp
- #vendor
- #version_control
Instance Method Details
#app
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 102
def app directory "app" empty_directory_with_keep_file "app/assets/images" keep_file "app/controllers/concerns" keep_file "app/models/concerns" end
#bin
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 111
def bin exclude_pattern = Regexp.union([(/thrust/ if skip_thruster?), (/rubocop/ if skip_rubocop?), (/brakeman/ if skip_brakeman?), (/bundler-audit/ if skip_bundler_audit?)].compact) directory "bin", { exclude_pattern: exclude_pattern } do |content| "#{shebang}\n" + content end chmod "bin", 0755 & ~File.umask, verbose: false end
#bin_when_updating
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 119
def bin_when_updating bin end
#cifiles
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 86
def cifiles empty_directory ".github/workflows" template "github/ci.yml", ".github/workflows/ci.yml" template "github/dependabot.yml", ".github/dependabot.yml" end
#config
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 123
def config empty_directory "config" inside "config" do template "routes.rb" unless [:update] template "application.rb" template "environment.rb" template "bundler-audit.yml" unless skip_bundler_audit? template "bootsnap.rb" if depend_on_bootsnap? template "cable.yml" unless [:update] || skip_action_cable? template "ci.rb" template "puma.rb" template "storage.yml" unless [:update] || skip_active_storage? directory "environments" directory "initializers" directory "locales" unless [:update] end end
#config_target_version
[ GitHub ]#config_when_updating
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 143
def config_when_updating action_cable_config_exist = File.exist?("config/cable.yml") active_storage_config_exist = File.exist?("config/storage.yml") ci_config_exist = File.exist?("config/ci.rb") bundle_audit_config_exist = File.exist?("config/bundler-audit.yml") rack_cors_config_exist = File.exist?("config/initializers/cors.rb") assets_config_exist = File.exist?("config/initializers/assets.rb") asset_app_stylesheet_exist = File.exist?("app/assets/stylesheets/application.css") csp_config_exist = File.exist?("config/initializers/content_security_policy.rb") @config_target_version = Rails.application.config.loaded_config_version || "5.0" config if !skip_action_cable? && !action_cable_config_exist template "config/cable.yml" end if !skip_active_storage? && !active_storage_config_exist template "config/storage.yml" end if !ci_config_exist template "config/ci.rb" end if skip_asset_pipeline? && !assets_config_exist remove_file "config/initializers/assets.rb" end if skip_asset_pipeline? && !asset_app_stylesheet_exist remove_file "app/assets/stylesheets/application.css" end unless rack_cors_config_exist remove_file "config/initializers/cors.rb" end if !skip_bundler_audit? && !bundle_audit_config_exist template "config/bundler-audit.yml" end if [:api] unless csp_config_exist remove_file "config/initializers/content_security_policy.rb" end end end
#configru
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 66
def configru template "config.ru" end
#credentials
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 206
def credentials return if [:pretend] || [:dummy_app] require "rails/generators/rails/credentials/credentials_generator" Rails::Generators::CredentialsGenerator.new([], quiet: true).add_credentials_file end
#credentials_diff_enroll
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 213
def credentials_diff_enroll return if [:skip_decrypted_diffs] || [:dummy_app] || [:pretend] @generator.shell.mute do rails_command "credentials:diff --enroll", inline: true, shell: @generator.shell end end
#database_yml
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 221
def database_yml template database.template, "config/database.yml" end
#db
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 225
def db directory "db" end
#devcontainer
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 284
def devcontainer = { database: [:database], redis: [:skip_solid] && !([:skip_action_cable] && [:skip_active_job]), kamal: ![:skip_kamal], system_test: depends_on_system_test?, active_storage: ![:skip_active_storage], dev: [:dev], node: using_node?, app_name: app_name, app_folder: File.basename(app_path), skip_solid: [:skip_solid], pretend: [:pretend] } Rails::Generators::DevcontainerGenerator.new([], ).invoke_all end
#dockerfiles
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 78
def dockerfiles template "Dockerfile" template "dockerignore", ".dockerignore" template "docker-entrypoint", "bin/docker-entrypoint" chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false end
#env
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 200
def env return if [:pretend] || [:dummy_app] template "env", ".env" end
#gemfile
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 62
def gemfile template "Gemfile" end
#gitattributes
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 74
def gitattributes template "gitattributes", ".gitattributes" end
#gitignore
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 70
def gitignore template "gitignore", ".gitignore" end
#lib
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 229
def lib empty_directory "lib" empty_directory_with_keep_file "lib/tasks" end
#log
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 234
def log empty_directory_with_keep_file "log" end
#master_key
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 192
def master_key return if [:pretend] || [:dummy_app] require "rails/generators/rails/master_key/master_key_generator" master_key_generator = Rails::Generators::MasterKeyGenerator.new([], quiet: [:quiet], force: [:force]) master_key_generator.add_master_key_file_silently end
#node_version
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 58
def node_version template "node-version", ".node-version" end
#public_directory
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 238
def public_directory return if [:update] && [:api] directory "public", "public", recursive: false end
#rakefile
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 46
def rakefile template "Rakefile" end
#readme
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 50
def readme copy_file "README.md", "README.md" end
#rubocop
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 92
def rubocop template "rubocop.yml", ".rubocop.yml" end
#ruby_version
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 54
def ruby_version template "ruby-version", ".ruby-version" end
#script
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 244
def script empty_directory_with_keep_file "script" end
#storage
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 248
def storage empty_directory_with_keep_file "storage" empty_directory_with_keep_file "tmp/storage" end
#system_test
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 264
def system_test if devcontainer? && depends_on_system_test? empty_directory_with_keep_file "test/system" template "test/application_system_test_case.rb" end end
#test
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 253
def test empty_directory_with_keep_file "test/fixtures/files" empty_directory_with_keep_file "test/controllers" empty_directory_with_keep_file "test/mailers" empty_directory_with_keep_file "test/models" empty_directory_with_keep_file "test/helpers" empty_directory_with_keep_file "test/integration" template "test/test_helper.rb" end
#tmp
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 271
def tmp empty_directory_with_keep_file "tmp" empty_directory_with_keep_file "tmp/pids" end
#vendor
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 276
def vendor empty_directory_with_keep_file "vendor" end
#version_control
[ GitHub ]# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 96
def version_control if ![:skip_git] && ![:pretend] run git_init_command, capture: [:quiet], abort_on_failure: false end end