Class: Rails::AppBuilder
- Inherits:
-
Object
- Object
- Rails::AppBuilder
- Defined in:
- 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
- #config ⇒ Object
- #config_target_version ⇒ Object
- #config_when_updating ⇒ Object
- #configru ⇒ Object
- #credentials ⇒ Object
- #database_yml ⇒ Object
- #db ⇒ Object
- #gemfile ⇒ Object
- #gitattributes ⇒ Object
- #gitignore ⇒ Object
- #lib ⇒ Object
- #log ⇒ Object
- #master_key ⇒ Object
- #package_json ⇒ Object
- #public_directory ⇒ Object
- #rakefile ⇒ Object
- #readme ⇒ Object
- #ruby_version ⇒ Object
- #storage ⇒ Object
- #system_test ⇒ Object
- #test ⇒ Object
- #tmp ⇒ Object
- #vendor ⇒ Object
- #version_control ⇒ Object
- #yarn_when_updating ⇒ Object
Instance Method Details
#app ⇒ Object
83 84 85 86 87 88 89 90 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 83 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
92 93 94 95 96 97 98 99 100 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 92 def bin directory "bin" do |content| "#{shebang}\n" + content end chmod "bin", 0755 & ~File.umask, verbose: false remove_file "bin/spring" unless spring_install? remove_file "bin/yarn" if [:skip_javascript] end |
#bin_when_updating ⇒ Object
102 103 104 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 102 def bin_when_updating bin end |
#config ⇒ Object
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 114 def config empty_directory "config" inside "config" do template "routes.rb" template "application.rb" template "environment.rb" template "cable.yml" unless [:skip_action_cable] template "puma.rb" unless [:skip_puma] template "spring.rb" if spring_install? template "storage.yml" unless skip_active_storage? directory "environments" directory "initializers" directory "locales" end end |
#config_target_version ⇒ Object
253 254 255 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 253 def config_target_version defined?(@config_target_version) ? @config_target_version : Rails::VERSION::STRING.to_f end |
#config_when_updating ⇒ Object
132 133 134 135 136 137 138 139 140 141 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 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 132 def config_when_updating = File.exist?("config/initializers/cookies_serializer.rb") action_cable_config_exist = File.exist?("config/cable.yml") active_storage_config_exist = File.exist?("config/storage.yml") rack_cors_config_exist = File.exist?("config/initializers/cors.rb") assets_config_exist = File.exist?("config/initializers/assets.rb") csp_config_exist = File.exist?("config/initializers/content_security_policy.rb") = File.exist?("config/initializers/permissions_policy.rb") @config_target_version = Rails.application.config.loaded_config_version || "5.0" config configru unless gsub_file "config/initializers/cookies_serializer.rb", /json(?!,)/, "marshal" end 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 [:skip_sprockets] && !assets_config_exist remove_file "config/initializers/assets.rb" end unless rack_cors_config_exist remove_file "config/initializers/cors.rb" end if [:api] unless remove_file "config/initializers/cookies_serializer.rb" end unless csp_config_exist remove_file "config/initializers/content_security_policy.rb" end unless remove_file "config/initializers/permissions_policy.rb" end end end |
#configru ⇒ Object
61 62 63 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 61 def configru template "config.ru" end |
#credentials ⇒ Object
190 191 192 193 194 195 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 190 def credentials return if [:pretend] || [:dummy_app] require "rails/generators/rails/credentials/credentials_generator" Rails::Generators::CredentialsGenerator.new([], quiet: [:quiet]).add_credentials_file_silently end |
#database_yml ⇒ Object
197 198 199 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 197 def database_yml template "config/databases/#{[:database]}.yml", "config/database.yml" end |
#db ⇒ Object
201 202 203 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 201 def db directory "db" end |
#gemfile ⇒ Object
57 58 59 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 57 def gemfile template "Gemfile" end |
#gitattributes ⇒ Object
69 70 71 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 69 def gitattributes template "gitattributes", ".gitattributes" end |
#gitignore ⇒ Object
65 66 67 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 65 def gitignore template "gitignore", ".gitignore" end |
#lib ⇒ Object
205 206 207 208 209 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 205 def lib empty_directory "lib" empty_directory_with_keep_file "lib/tasks" empty_directory_with_keep_file "lib/assets" end |
#log ⇒ Object
211 212 213 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 211 def log empty_directory_with_keep_file "log" end |
#master_key ⇒ Object
181 182 183 184 185 186 187 188 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 181 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 |
#package_json ⇒ Object
79 80 81 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 79 def package_json template "package.json" end |
#public_directory ⇒ Object
215 216 217 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 215 def public_directory directory "public", "public", recursive: false end |
#rakefile ⇒ Object
45 46 47 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 45 def rakefile template "Rakefile" end |
#readme ⇒ Object
49 50 51 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 49 def readme copy_file "README.md", "README.md" end |
#ruby_version ⇒ Object
53 54 55 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 53 def ruby_version template "ruby-version", ".ruby-version" end |
#storage ⇒ Object
219 220 221 222 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 219 def storage empty_directory_with_keep_file "storage" empty_directory_with_keep_file "tmp/storage" end |
#system_test ⇒ Object
236 237 238 239 240 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 236 def system_test empty_directory_with_keep_file "test/system" template "test/application_system_test_case.rb" end |
#test ⇒ Object
224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 224 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/channels/application_cable/connection_test.rb" template "test/test_helper.rb" end |
#tmp ⇒ Object
242 243 244 245 246 247 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 242 def tmp empty_directory_with_keep_file "tmp" empty_directory_with_keep_file "tmp/pids" empty_directory "tmp/cache" empty_directory "tmp/cache/assets" end |
#vendor ⇒ Object
249 250 251 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 249 def vendor empty_directory_with_keep_file "vendor" end |
#version_control ⇒ Object
73 74 75 76 77 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 73 def version_control if ![:skip_git] && ![:pretend] run "git init", capture: [:quiet], abort_on_failure: false end end |
#yarn_when_updating ⇒ Object
106 107 108 109 110 111 112 |
# File 'lib/rails/generators/rails/app/app_generator.rb', line 106 def yarn_when_updating template "bin/yarn", force: true do |content| "#{shebang}\n" + content end chmod "bin", 0755 & ~File.umask, verbose: false end |