Class: Armadura::AppBuilder

Inherits:
Rails::AppBuilder
  • Object
show all
Extended by:
Forwardable
Includes:
Actions
Defined in:
lib/armadura/app_builder.rb

Instance Method Summary collapse

Methods included from Actions

#action_mailer_host, #configure_application_file, #configure_environment, #replace_in_file

Instance Method Details

#add_bullet_gem_configuration ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/armadura/app_builder.rb', line 62

def add_bullet_gem_configuration
  config = <<-RUBY
  config.after_initialize do
Bullet.enable = true
Bullet.bullet_logger = true
Bullet.rails_logger = true
  end

  RUBY

  inject_into_file(
    "config/environments/development.rb",
    config,
    after: "config.action_mailer.raise_delivery_errors = true\n",
  )
end

#configure_action_mailer ⇒ Object 



307
308
309
310
311
 
# File 'lib/armadura/app_builder.rb', line 307

def configure_action_mailer
  action_mailer_host "development", %{"localhost:3000"}
  action_mailer_host "test", %{"www.example.com"}
  action_mailer_host "production", %{ENV.fetch("APPLICATION_HOST")}
end

#configure_action_mailer_in_specs ⇒ Object 



282
283
284
 
# File 'lib/armadura/app_builder.rb', line 282

def configure_action_mailer_in_specs
  copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb'
end

#configure_active_job ⇒ Object 



313
314
315
316
 
# File 'lib/armadura/app_builder.rb', line 313

def configure_active_job
  configure_application_file "config.active_job.queue_adapter = :sidekiq"
  configure_environment "test", "config.active_job.queue_adapter = :inline"
end

#configure_automatic_deployment ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/armadura/app_builder.rb', line 379

def configure_automatic_deployment
  deploy_command = <<-YML.strip_heredoc
  deployment:
    staging:
      branch: master
      commands:
        - bin/deploy staging
  YML

  append_file "circle.yml", deploy_command
end

#configure_capybara_webkit ⇒ Object 



286
287
288
 
# File 'lib/armadura/app_builder.rb', line 286

def configure_capybara_webkit
  copy_file "capybara_webkit.rb", "spec/support/capybara_webkit.rb"
end

#configure_ci ⇒ Object 



269
270
271
 
# File 'lib/armadura/app_builder.rb', line 269

def configure_ci
  template "circle.yml.erb", "circle.yml"
end

#configure_generators ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/armadura/app_builder.rb', line 104

def configure_generators
  config = <<-RUBY

config.generators do |generate|
  generate.helper false
  generate.javascript_engine false
  generate.request_specs false
  generate.routing_specs false
  generate.stylesheets false
  generate.test_framework :rspec
  generate.view_specs false
end

  RUBY

  inject_into_class 'config/application.rb', 'Application', config
end

#configure_i18n_for_missing_translations ⇒ Object 



277
278
279
280
 
# File 'lib/armadura/app_builder.rb', line 277

def configure_i18n_for_missing_translations
  raise_on_missing_translations_in("development")
  raise_on_missing_translations_in("test")
end

#configure_i18n_for_test_environment ⇒ Object 



273
274
275
 
# File 'lib/armadura/app_builder.rb', line 273

def configure_i18n_for_test_environment
  copy_file "i18n.rb", "spec/support/i18n.rb"
end

#configure_quiet_assets ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/armadura/app_builder.rb', line 87

def configure_quiet_assets
  config = <<-RUBY
config.assets.quiet = true
  RUBY

  inject_into_class "config/application.rb", "Application", config
end

#configure_rack_timeout ⇒ Object 



295
296
297
298
299
300
301
 
# File 'lib/armadura/app_builder.rb', line 295

def configure_rack_timeout
  rack_timeout_config = <<-RUBY
Rack::Timeout.timeout = (ENV["RACK_TIMEOUT"] || 10).to_i
  RUBY

  append_file "config/environments/production.rb", rack_timeout_config
end

#configure_rspec ⇒ Object 



262
263
264
265
266
267
 
# File 'lib/armadura/app_builder.rb', line 262

def configure_rspec
  remove_file "spec/rails_helper.rb"
  remove_file "spec/spec_helper.rb"
  copy_file "rails_helper.rb", "spec/rails_helper.rb"
  copy_file "spec_helper.rb", "spec/spec_helper.rb"
end

#configure_sidekiq ⇒ Object 



318
319
320
 
# File 'lib/armadura/app_builder.rb', line 318

def configure_sidekiq
  copy_file "sidekiq.yml", "config/sidekiq.yml", force: true
end

#configure_simple_form ⇒ Object 



303
304
305
 
# File 'lib/armadura/app_builder.rb', line 303

def configure_simple_form
  bundle_command "exec rails generate simple_form:install"
end

#configure_smtp ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/armadura/app_builder.rb', line 134

def configure_smtp
  copy_file 'smtp.rb', 'config/smtp.rb'

  prepend_file 'config/environments/production.rb',
    %{require Rails.root.join("config/smtp")\n}

  config = <<-RUBY

  config.action_mailer.delivery_method = :smtp
  config.action_mailer.smtp_settings = SMTP_SETTINGS
  RUBY

  inject_into_file 'config/environments/production.rb', config,
    after: "config.action_mailer.raise_delivery_errors = false"
end

#configure_spec_support_features ⇒ Object 



257
258
259
260
 
# File 'lib/armadura/app_builder.rb', line 257

def configure_spec_support_features
  empty_directory_with_keep_file 'spec/features'
  empty_directory_with_keep_file 'spec/support/features'
end

#configure_time_formats ⇒ Object 



290
291
292
293
 
# File 'lib/armadura/app_builder.rb', line 290

def configure_time_formats
  remove_file "config/locales/en.yml"
  template "config_locales_en.yml.erb", "config/locales/en.yml"
end

#copy_dotfiles ⇒ Object 



348
349
350
 
# File 'lib/armadura/app_builder.rb', line 348

def copy_dotfiles
  directory("dotfiles", ".")
end

#copy_miscellaneous_files ⇒ Object 



409
410
411
412
413
 
# File 'lib/armadura/app_builder.rb', line 409

def copy_miscellaneous_files
  copy_file "browserslist", "browserslist"
  copy_file "errors.rb", "config/initializers/errors.rb"
  copy_file "json_encoding.rb", "config/initializers/json_encoding.rb"
end

#create_application_layout ⇒ Object 



217
218
219
220
221
 
# File 'lib/armadura/app_builder.rb', line 217

def create_application_layout
  template 'armadura_layout.html.erb.erb',
    'app/views/layouts/application.html.erb',
    force: true
end

#create_database ⇒ Object 



228
229
230
 
# File 'lib/armadura/app_builder.rb', line 228

def create_database
  bundle_command 'exec rake db:create db:migrate'
end

#create_deploy_script ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/armadura/app_builder.rb', line 361

def create_deploy_script
  copy_file "bin_deploy", "bin/deploy"

  instructions = <<-MARKDOWN

## Deploying

If you have previously run the `./bin/setup` script,
you can deploy to staging and production with:

$ ./bin/deploy staging
$ ./bin/deploy production
  MARKDOWN

  append_file "README.md", instructions
  run "chmod a+x bin/deploy"
end

#create_github_repo(repo_name) ⇒ Object 



391
392
393
 
# File 'lib/armadura/app_builder.rb', line 391

def create_github_repo(repo_name)
  run "hub create #{repo_name}"
end

#create_heroku_apps(flags) ⇒ Object 



356
357
358
359
 
# File 'lib/armadura/app_builder.rb', line 356

def create_heroku_apps(flags)
  create_staging_heroku_app(flags)
  create_production_heroku_app(flags)
end

#create_partials_directory ⇒ Object 



197
198
199
 
# File 'lib/armadura/app_builder.rb', line 197

def create_partials_directory
  empty_directory 'app/views/application'
end

#create_shared_css_overrides ⇒ Object 



210
211
212
213
214
215
 
# File 'lib/armadura/app_builder.rb', line 210

def create_shared_css_overrides
  copy_file(
    "_css_overrides.html.erb",
    "app/views/application/_css_overrides.html.erb",
  )
end

#create_shared_flashes ⇒ Object 



201
202
203
204
 
# File 'lib/armadura/app_builder.rb', line 201

def create_shared_flashes
  copy_file "_flashes.html.erb", "app/views/application/_flashes.html.erb"
  copy_file "flashes_helper.rb", "app/helpers/flashes_helper.rb"
end

#create_shared_javascripts ⇒ Object 



206
207
208
 
# File 'lib/armadura/app_builder.rb', line 206

def create_shared_javascripts
  copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
end

#customize_error_pages ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/armadura/app_builder.rb', line 415

def customize_error_pages
  meta_tags =<<-EOS
  <meta charset="utf-8" />
  <meta name="ROBOTS" content="NOODP" />
  <meta name="viewport" content="initial-scale=1" />
  EOS

  %w(500 404 422).each do |page|
    inject_into_file "public/#{page}.html", meta_tags, after: "<head>\n"
    replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
  end
end

#disallow_wrapping_parameters ⇒ Object 



193
194
195
 
# File 'lib/armadura/app_builder.rb', line 193

def disallow_wrapping_parameters
  remove_file "config/initializers/wrap_parameters.rb"
end

#enable_database_cleaner ⇒ Object 



246
247
248
 
# File 'lib/armadura/app_builder.rb', line 246

def enable_database_cleaner
  copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
end

#enable_rack_canonical_host ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/armadura/app_builder.rb', line 150

def enable_rack_canonical_host
  config = <<-RUBY

  if ENV.fetch("HEROKU_APP_NAME", "").include?("staging-pr-")
ENV["APPLICATION_HOST"] = ENV["HEROKU_APP_NAME"] + ".herokuapp.com"
  end

  config.middleware.use Rack::CanonicalHost, ENV.fetch("APPLICATION_HOST")
  RUBY

  inject_into_file(
    "config/environments/production.rb",
    config,
    after: "Rails.application.configure do",
  )
end

#enable_rack_deflater ⇒ Object 



167
168
169
 
# File 'lib/armadura/app_builder.rb', line 167

def enable_rack_deflater
  configure_environment "production", "config.middleware.use Rack::Deflater"
end

#gemfile ⇒ Object 



26
27
28
 
# File 'lib/armadura/app_builder.rb', line 26

def gemfile
  template "Gemfile.erb", "Gemfile"
end

#generate_factories_file ⇒ Object 



126
127
128
 
# File 'lib/armadura/app_builder.rb', line 126

def generate_factories_file
  copy_file "factories.rb", "spec/factories.rb"
end

#generate_rspec ⇒ Object 



322
323
324
 
# File 'lib/armadura/app_builder.rb', line 322

def generate_rspec
  generate 'rspec:install'
end

#gitignore ⇒ Object 



22
23
24
 
# File 'lib/armadura/app_builder.rb', line 22

def gitignore
  copy_file "armadura_gitignore", ".gitignore"
end

#init_git ⇒ Object 



352
353
354
 
# File 'lib/armadura/app_builder.rb', line 352

def init_git
  run 'git init'
end

#provide_dev_prime_task ⇒ Object 



100
101
102
 
# File 'lib/armadura/app_builder.rb', line 100

def provide_dev_prime_task
  copy_file 'dev.rake', 'lib/tasks/dev.rake'
end

#provide_setup_script ⇒ Object 



95
96
97
98
 
# File 'lib/armadura/app_builder.rb', line 95

def provide_setup_script
  template "bin_setup", "bin/setup", force: true
  run "chmod a+x bin/setup"
end

#provide_shoulda_matchers_config ⇒ Object 



250
251
252
253
254
255
 
# File 'lib/armadura/app_builder.rb', line 250

def provide_shoulda_matchers_config
  copy_file(
    "shoulda_matchers_config_rspec.rb",
    "spec/support/shoulda_matchers.rb"
  )
end

#raise_on_delivery_errors ⇒ Object 



41
42
43
44
 
# File 'lib/armadura/app_builder.rb', line 41

def raise_on_delivery_errors
  replace_in_file 'config/environments/development.rb',
    'raise_delivery_errors = false', 'raise_delivery_errors = true'
end

#raise_on_missing_assets_in_test ⇒ Object 



37
38
39
 
# File 'lib/armadura/app_builder.rb', line 37

def raise_on_missing_assets_in_test
  configure_environment "test", "config.assets.raise_runtime_errors = true"
end

#raise_on_unpermitted_parameters ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/armadura/app_builder.rb', line 79

def raise_on_unpermitted_parameters
  config = <<-RUBY
config.action_controller.action_on_unpermitted_parameters = :raise
  RUBY

  inject_into_class "config/application.rb", "Application", config
end

#readme ⇒ Object 



18
19
20
 
# File 'lib/armadura/app_builder.rb', line 18

def readme
  template 'README.md.erb', 'README.md'
end

#remove_config_comment_lines ⇒ Object 



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/armadura/app_builder.rb', line 428

def remove_config_comment_lines
  config_files = [
    "application.rb",
    "environment.rb",
    "environments/development.rb",
    "environments/production.rb",
    "environments/test.rb",
  ]

  config_files.each do |config_file|
    path = File.join(destination_root, "config/#{config_file}")

    accepted_content = File.readlines(path).reject do |line|
      line =~ /^.*#.*$/ || line =~ /^$\n/
    end

    File.open(path, "w") do |file|
      accepted_content.each { |line| file.puts line }
    end
  end
end

#remove_routes_comment_lines ⇒ Object 



450
451
452
453
454
 
# File 'lib/armadura/app_builder.rb', line 450

def remove_routes_comment_lines
  replace_in_file 'config/routes.rb',
    /Rails\.application\.routes\.draw do.*end/m,
    "Rails.application.routes.draw do\nend"
end

#remove_turbolinks ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/armadura/app_builder.rb', line 46

def remove_turbolinks
  replace_in_file(
    "app/assets/javascripts/application.js",
    "//= require turbolinks",
    ""
  )
end

#replace_default_puma_configuration ⇒ Object 



326
327
328
 
# File 'lib/armadura/app_builder.rb', line 326

def replace_default_puma_configuration
  copy_file "puma.rb", "config/puma.rb", force: true
end

#replace_gemfile(path) ⇒ Object 



232
233
234
235
236
237
238
239
240
 
# File 'lib/armadura/app_builder.rb', line 232

def replace_gemfile(path)
  template 'Gemfile.erb', 'Gemfile', force: true do |content|
    if path
      content.gsub(%r{gem .armadura.}) { |s| %{#{s}, path: "#{path}"} }
    else
      content
    end
  end
end

#set_ruby_to_version_being_used ⇒ Object 



242
243
244
 
# File 'lib/armadura/app_builder.rb', line 242

def set_ruby_to_version_being_used
  create_file '.ruby-version', "#{Armadura::RUBY_VERSION}\n"
end

#set_test_delivery_method ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/armadura/app_builder.rb', line 54

def set_test_delivery_method
  inject_into_file(
    "config/environments/development.rb",
    "\n  config.action_mailer.delivery_method = :file",
    after: "config.action_mailer.raise_delivery_errors = true",
  )
end

#set_up_factory_girl_for_rspec ⇒ Object 



122
123
124
 
# File 'lib/armadura/app_builder.rb', line 122

def set_up_factory_girl_for_rspec
  copy_file 'factory_girl_rspec.rb', 'spec/support/factory_girl.rb'
end

#set_up_forego ⇒ Object 



330
331
332
 
# File 'lib/armadura/app_builder.rb', line 330

def set_up_forego
  copy_file "Procfile", "Procfile"
end

#set_up_hound ⇒ Object 



130
131
132
 
# File 'lib/armadura/app_builder.rb', line 130

def set_up_hound
  copy_file "hound.yml", ".hound.yml"
end

#setup_asset_host ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/armadura/app_builder.rb', line 171

def setup_asset_host
  replace_in_file 'config/environments/production.rb',
    "# config.action_controller.asset_host = 'http://assets.example.com'",
    'config.action_controller.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'

  replace_in_file 'config/initializers/assets.rb',
    "config.assets.version = '1.0'",
    'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'

  config = <<-EOD
config.public_file_server.headers = {
"Cache-Control" => "public, max-age=31557600",
  }
  EOD

  configure_environment("production", config)
end

#setup_bundler_audit ⇒ Object 



400
401
402
403
 
# File 'lib/armadura/app_builder.rb', line 400

def setup_bundler_audit
  copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
  append_file "Rakefile", %{\ntask default: "bundler:audit"\n}
end

#setup_default_directories ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/armadura/app_builder.rb', line 334

def setup_default_directories
  [
    'app/views/pages',
    'spec/lib',
    'spec/controllers',
    'spec/helpers',
    'spec/support/matchers',
    'spec/support/mixins',
    'spec/support/shared_examples'
  ].each do |dir|
    empty_directory_with_keep_file dir
  end
end

#setup_default_rake_task ⇒ Object 



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/armadura/app_builder.rb', line 456

def setup_default_rake_task
  append_file 'Rakefile' do
    <<-EOS
task(:default).clear
task default: [:spec]

if defined? RSpec
  task(:spec).clear
  RSpec::Core::RakeTask.new(:spec) do |t|
t.verbose = false
  end
end
    EOS
  end
end

#setup_rack_mini_profiler ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/armadura/app_builder.rb', line 30

def setup_rack_mini_profiler
  copy_file(
    "rack_mini_profiler.rb",
    "config/initializers/rack_mini_profiler.rb",
  )
end

#setup_secret_token ⇒ Object 



189
190
191
 
# File 'lib/armadura/app_builder.rb', line 189

def setup_secret_token
  template 'secrets.yml', 'config/secrets.yml', force: true
end

#setup_segment ⇒ Object 



395
396
397
398
 
# File 'lib/armadura/app_builder.rb', line 395

def setup_segment
  copy_file '_analytics.html.erb',
    'app/views/application/_analytics.html.erb'
end

#setup_spring ⇒ Object 



405
406
407
 
# File 'lib/armadura/app_builder.rb', line 405

def setup_spring
  bundle_command "exec spring binstub --all"
end

#use_postgres_config_template ⇒ Object 



223
224
225
226
 
# File 'lib/armadura/app_builder.rb', line 223

def use_postgres_config_template
  template 'postgresql_database.yml.erb', 'config/database.yml',
    force: true
end