Class: Rails::AppBuilder
- 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 collapse
- #app ⇒ Object
- #bin ⇒ Object
- #bin_when_updating ⇒ Object
- #cifiles ⇒ Object
- #config ⇒ Object
- #config_target_version ⇒ Object
- #config_when_updating ⇒ Object
- #configru ⇒ Object
- #credentials ⇒ Object
- #credentials_diff_enroll ⇒ Object
- #database_yml ⇒ Object
- #db ⇒ Object
- #devcontainer ⇒ Object
- #dockerfiles ⇒ Object
- #gemfile ⇒ Object
- #gitattributes ⇒ Object
- #gitignore ⇒ Object
- #lib ⇒ Object
- #log ⇒ Object
- #master_key ⇒ Object
- #node_version ⇒ Object
- #public_directory ⇒ Object
- #rakefile ⇒ Object
- #readme ⇒ Object
- #rubocop ⇒ Object
- #ruby_version ⇒ Object
- #script ⇒ Object
- #storage ⇒ Object
- #system_test ⇒ Object
- #test ⇒ Object
- #tmp ⇒ Object
- #vendor ⇒ Object
- #version_control ⇒ Object
Instance Method Details
#app ⇒ Object
102 103 104 105 106 107 108 109 |
# 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 ⇒ Object
111 112 113 114 115 116 117 |
# 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?)].compact) directory "bin", { exclude_pattern: exclude_pattern } do |content| "#{shebang}\n" + content end chmod "bin", 0755 & ~File.umask, verbose: false end |
#bin_when_updating ⇒ Object
119 120 121 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 119 def bin_when_updating bin end |
#cifiles ⇒ Object
86 87 88 89 90 |
# 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 ⇒ Object
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# 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" 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 ⇒ Object
273 274 275 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 273 def config_target_version @config_target_version || Rails::VERSION::STRING.to_f end |
#config_when_updating ⇒ Object
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 142 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 !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 ⇒ Object
66 67 68 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 66 def configru template "config.ru" end |
#credentials ⇒ Object
200 201 202 203 204 205 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 200 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 ⇒ Object
207 208 209 210 211 212 213 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 207 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 ⇒ Object
215 216 217 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 215 def database_yml template database.template, "config/database.yml" end |
#db ⇒ Object
219 220 221 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 219 def db directory "db" end |
#devcontainer ⇒ Object
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 277 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, skip_solid: [:skip_solid], pretend: [:pretend] } Rails::Generators::DevcontainerGenerator.new([], ).invoke_all end |
#dockerfiles ⇒ Object
78 79 80 81 82 83 84 |
# 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 |
#gemfile ⇒ Object
62 63 64 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 62 def gemfile template "Gemfile" end |
#gitattributes ⇒ Object
74 75 76 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 74 def gitattributes template "gitattributes", ".gitattributes" end |
#gitignore ⇒ Object
70 71 72 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 70 def gitignore template "gitignore", ".gitignore" end |
#lib ⇒ Object
223 224 225 226 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 223 def lib empty_directory "lib" empty_directory_with_keep_file "lib/tasks" end |
#log ⇒ Object
228 229 230 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 228 def log empty_directory_with_keep_file "log" end |
#master_key ⇒ Object
191 192 193 194 195 196 197 198 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 191 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 master_key_generator.ignore_master_key_file_silently end |
#node_version ⇒ Object
58 59 60 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 58 def node_version template "node-version", ".node-version" end |
#public_directory ⇒ Object
232 233 234 235 236 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 232 def public_directory return if [:update] && [:api] directory "public", "public", recursive: false end |
#rakefile ⇒ Object
46 47 48 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 46 def rakefile template "Rakefile" end |
#readme ⇒ Object
50 51 52 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 50 def readme copy_file "README.md", "README.md" end |
#rubocop ⇒ Object
92 93 94 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 92 def rubocop template "rubocop.yml", ".rubocop.yml" end |
#ruby_version ⇒ Object
54 55 56 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 54 def ruby_version template "ruby-version", ".ruby-version" end |
#script ⇒ Object
238 239 240 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 238 def script empty_directory_with_keep_file "script" end |
#storage ⇒ Object
242 243 244 245 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 242 def storage empty_directory_with_keep_file "storage" empty_directory_with_keep_file "tmp/storage" end |
#system_test ⇒ Object
258 259 260 261 262 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 258 def system_test empty_directory_with_keep_file "test/system" template "test/application_system_test_case.rb" end |
#test ⇒ Object
247 248 249 250 251 252 253 254 255 256 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 247 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 ⇒ Object
264 265 266 267 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 264 def tmp empty_directory_with_keep_file "tmp" empty_directory_with_keep_file "tmp/pids" end |
#vendor ⇒ Object
269 270 271 |
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 269 def vendor empty_directory_with_keep_file "vendor" end |
#version_control ⇒ Object
96 97 98 99 100 |
# 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 |