Class: Rails::AppBuilder

Inherits:
Object show all
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

Instance Method Details

#app ⇒ Object 


79
80
81
82
83
84
85
86
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 79

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 


88
89
90
91
92
93
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 88

def bin
  directory "bin" do |content|
    "#{shebang}\n" + content
  end
  chmod "bin", 0755 & ~File.umask, verbose: false
end

#bin_when_updating ⇒ Object 


95
96
97
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 95

def bin_when_updating
  bin
end

#config ⇒ Object 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 99

def config
  empty_directory "config"

  inside "config" do
    template "routes.rb" unless options[:updating]
    template "application.rb"
    template "environment.rb"
    template "cable.yml" unless options[:updating] || options[:skip_action_cable]
    template "puma.rb"   unless options[:updating]
    template "storage.yml" unless options[:updating] || skip_active_storage?

    directory "environments"
    directory "initializers"
    directory "locales" unless options[:updating]
  end
end

#config_target_version ⇒ Object 


241
242
243
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 241

def config_target_version
  defined?(@config_target_version) ? @config_target_version : Rails::VERSION::STRING.to_f
end

#config_when_updating ⇒ Object 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 116

def config_when_updating
  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")
  asset_manifest_exist            = File.exist?("app/assets/config/manifest.js")
  asset_app_stylesheet_exist      = File.exist?("app/assets/stylesheets/application.css")
  csp_config_exist                = File.exist?("config/initializers/content_security_policy.rb")
  permissions_policy_config_exist = File.exist?("config/initializers/permissions_policy.rb")

  @config_target_version = Rails.application.config.loaded_config_version || "5.0"

  config

  if !options[: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? && skip_propshaft? && !assets_config_exist
    remove_file "config/initializers/assets.rb"
  end

  if skip_sprockets? && !asset_manifest_exist
    remove_file "app/assets/config/manifest.js"
  end

  if skip_sprockets? && !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 options[:api]
    unless csp_config_exist
      remove_file "config/initializers/content_security_policy.rb"
    end

    unless permissions_policy_config_exist
      remove_file "config/initializers/permissions_policy.rb"
    end
  end

  if !skip_sprockets?
    insert_into_file "config/application.rb", %(require "sprockets/railtie"), after: /require\(["']rails\/all["']\)\n/
  end
end

#configru ⇒ Object 


61
62
63
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 61

def configru
  template "config.ru"
end

#credentials ⇒ Object 


178
179
180
181
182
183
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 178

def credentials
  return if options[:pretend] || options[:dummy_app]

  require "rails/generators/rails/credentials/credentials_generator"
  Rails::Generators::CredentialsGenerator.new([], quiet: options[:quiet]).add_credentials_file_silently
end

#database_yml ⇒ Object 


185
186
187
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 185

def database_yml
  template "config/databases/#{options[:database]}.yml", "config/database.yml"
end

#db ⇒ Object 


189
190
191
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 189

def db
  directory "db"
end

#gemfile ⇒ Object 


57
58
59
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 57

def gemfile
  template "Gemfile"
end

#gitattributes ⇒ Object 


69
70
71
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 69

def gitattributes
  template "gitattributes", ".gitattributes"
end

#gitignore ⇒ Object 


65
66
67
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 65

def gitignore
  template "gitignore", ".gitignore"
end

#lib ⇒ Object 


193
194
195
196
197
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 193

def lib
  empty_directory "lib"
  empty_directory_with_keep_file "lib/tasks"
  empty_directory_with_keep_file "lib/assets"
end

#log ⇒ Object 


199
200
201
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 199

def log
  empty_directory_with_keep_file "log"
end

#master_key ⇒ Object 


169
170
171
172
173
174
175
176
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 169

def master_key
  return if options[:pretend] || options[:dummy_app]

  require "rails/generators/rails/master_key/master_key_generator"
  master_key_generator = Rails::Generators::MasterKeyGenerator.new([], quiet: options[:quiet], force: options[:force])
  master_key_generator.add_master_key_file_silently
  master_key_generator.ignore_master_key_file_silently
end

#public_directory ⇒ Object 


203
204
205
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 203

def public_directory
  directory "public", "public", recursive: false
end

#rakefile ⇒ Object 


45
46
47
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 45

def rakefile
  template "Rakefile"
end

#readme ⇒ Object 


49
50
51
 
# File 'railties/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 'railties/lib/rails/generators/rails/app/app_generator.rb', line 53

def ruby_version
  template "ruby-version", ".ruby-version"
end

#storage ⇒ Object 


207
208
209
210
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 207

def storage
  empty_directory_with_keep_file "storage"
  empty_directory_with_keep_file "tmp/storage"
end

#system_test ⇒ Object 


224
225
226
227
228
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 224

def system_test
  empty_directory_with_keep_file "test/system"

  template "test/application_system_test_case.rb"
end

#test ⇒ Object 


212
213
214
215
216
217
218
219
220
221
222
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 212

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 


230
231
232
233
234
235
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 230

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 


237
238
239
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 237

def vendor
  empty_directory_with_keep_file "vendor"
end

#version_control ⇒ Object 


73
74
75
76
77
 
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 73

def version_control
  if !options[:skip_git] && !options[:pretend]
    run git_init_command, capture: options[:quiet], abort_on_failure: false
  end
end