Class: Rails::AppBuilder

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

Instance Method Details

#app ⇒ Object 



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

def app
  directory "app"

  keep_file "app/assets/images"
  empty_directory_with_keep_file "app/assets/javascripts/channels" unless options[:skip_action_cable]

  keep_file  "app/controllers/concerns"
  keep_file  "app/models/concerns"
end

#bin ⇒ Object 



90
91
92
93
94
95
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 90

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

#bin_when_updating ⇒ Object 



97
98
99
100
101
102
103
104
105
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 97

def bin_when_updating
  bin_yarn_exist = File.exist?("bin/yarn")

  bin

  if options[:api] && !bin_yarn_exist
    remove_file "bin/yarn"
  end
end

#config ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 107

def config
  empty_directory "config"

  inside "config" do
    template "routes.rb"
    template "application.rb"
    template "environment.rb"
    template "cable.yml" unless options[:skip_action_cable]
    template "puma.rb"   unless options[: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 



244
245
246
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 244

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

#config_when_updating ⇒ Object 



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
168
169
170
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 125

def config_when_updating
  cookie_serializer_config_exist = 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")

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

  config

  unless cookie_serializer_config_exist
    gsub_file "config/initializers/cookies_serializer.rb", /json(?!,)/, "marshal"
  end

  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 options[: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 options[:api]
    unless cookie_serializer_config_exist
      remove_file "config/initializers/cookies_serializer.rb"
    end

    unless assets_config_exist
      remove_file "config/initializers/assets.rb"
    end

    unless csp_config_exist
      remove_file "config/initializers/content_security_policy.rb"
    end
  end
end

#configru ⇒ Object 



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

def configru
  template "config.ru"
end

#credentials ⇒ Object 



181
182
183
184
185
186
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 181

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 



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

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

#db ⇒ Object 



192
193
194
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 192

def db
  directory "db"
end

#gemfile ⇒ Object 



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

def gemfile
  template "Gemfile"
end

#gitignore ⇒ Object 



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

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

#lib ⇒ Object 



196
197
198
199
200
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 196

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

#log ⇒ Object 



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

def log
  empty_directory_with_keep_file "log"
end

#master_key ⇒ Object 



172
173
174
175
176
177
178
179
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 172

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

#package_json ⇒ Object 



76
77
78
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 76

def package_json
  template "package.json"
end

#public_directory ⇒ Object 



206
207
208
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 206

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

#rakefile ⇒ Object 



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

def rakefile
  template "Rakefile"
end

#readme ⇒ Object 



50
51
52
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 50

def readme
  copy_file "README.md", "README.md"
end

#ruby_version ⇒ Object 



54
55
56
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 54

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

#storage ⇒ Object 



210
211
212
213
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 210

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

#system_test ⇒ Object 



227
228
229
230
231
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 227

def system_test
  empty_directory_with_keep_file "test/system"

  template "test/application_system_test_case.rb"
end

#test ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 215

def test
  empty_directory_with_keep_file "test/fixtures"
  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 



233
234
235
236
237
238
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 233

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 



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

def vendor
  empty_directory_with_keep_file "vendor"
end

#version_control ⇒ Object 



70
71
72
73
74
 
# File 'lib/rails/generators/rails/app/app_generator.rb', line 70

def version_control
  if !options[:skip_git] && !options[:pretend]
    run "git init", capture: options[:quiet]
  end
end