Class: Spark::AppBuilder

Inherits:
Rails::AppBuilder
  • Object
show all
Includes:
Actions
Defined in:
lib/spark/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_jasmine_spec_sample ⇒ Object 



183
184
185
 
# File 'lib/spark/app_builder.rb', line 183

def add_jasmine_spec_sample
  copy_file "spec/javascripts/application.spec.js", "spec/javascripts/application.spec.js"
end

#add_root_route ⇒ Object 



300
301
302
 
# File 'lib/spark/app_builder.rb', line 300

def add_root_route
  route "root 'high_voltage/pages#show', id: 'home'"
end

#configure_action_mailer ⇒ Object 



206
207
208
209
210
 
# File 'lib/spark/app_builder.rb', line 206

def configure_action_mailer
  action_mailer_host "development", %{"localhost:3000"}
  action_mailer_host "test", %{"localhost:9887"}
  action_mailer_host "production", %{ENV.fetch("HOST")}
end

#configure_action_mailer_in_specs ⇒ Object 



192
193
194
 
# File 'lib/spark/app_builder.rb', line 192

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

#configure_active_job ⇒ Object 



212
213
214
215
216
217
 
# File 'lib/spark/app_builder.rb', line 212

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

#configure_exception_notification ⇒ Object 



67
68
69
70
 
# File 'lib/spark/app_builder.rb', line 67

def configure_exception_notification
  template 'config/initializers/exception_notification.rb.erb',
    'config/initializers/exception_notification.rb'
end

#configure_generators ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/spark/app_builder.rb', line 45

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 



187
188
189
190
 
# File 'lib/spark/app_builder.rb', line 187

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

#configure_jasmine_rails ⇒ Object 



179
180
181
 
# File 'lib/spark/app_builder.rb', line 179

def configure_jasmine_rails
  bundle_command "exec rails generate jasmine_rails:install"
end

#configure_locales_load_from_folders ⇒ Object 



227
228
229
230
231
232
233
234
 
# File 'lib/spark/app_builder.rb', line 227

def configure_locales_load_from_folders
  config = <<-RUBY
config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}')]
  RUBY

  gsub_file 'config/application.rb', /config\.i18n\.load_path.+/, config
  uncomment_lines 'config/application.rb', /config\.i18n\.load_path/
end

#configure_mailsocio ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/spark/app_builder.rb', line 72

def configure_mailsocio
  config = <<-RUBY

  config.action_mailer.delivery_method = :mailsocio
  config.action_mailer.smtp_settings = {
account_id: ENV.fetch("MAILSOCIO_ACCOUNT_ID"),
api_key: ENV.fetch("MAILSOCIO_API_KEY")
  }
  RUBY

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

#configure_rspec ⇒ Object 



172
173
174
175
176
177
 
# File 'lib/spark/app_builder.rb', line 172

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

#configure_simple_form ⇒ Object 



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

def configure_simple_form
  # Here we suppress simple_form warning that simple_form hasn't been configured
  bundle_command "exec rails generate simple_form:install --bootstrap > /dev/null 2>&1"
end

#configure_spec_support_features ⇒ Object 



162
163
164
165
166
167
168
169
170
 
# File 'lib/spark/app_builder.rb', line 162

def configure_spec_support_features
  empty_directory_with_keep_file 'spec/lib'
  empty_directory_with_keep_file 'spec/features'

  empty_directory_with_keep_file 'spec/support/matchers'
  empty_directory_with_keep_file 'spec/support/mixins'
  empty_directory_with_keep_file 'spec/support/shared_examples'
  empty_directory_with_keep_file 'spec/support/features'
end

#configure_time_formats ⇒ Object 



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

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

#copy_miscellaneous_files ⇒ Object 



276
277
278
279
 
# File 'lib/spark/app_builder.rb', line 276

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

#create_application_layout ⇒ Object 



134
135
136
137
138
 
# File 'lib/spark/app_builder.rb', line 134

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

#create_database ⇒ Object 



145
146
147
 
# File 'lib/spark/app_builder.rb', line 145

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

#create_home_page ⇒ Object 



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

def create_home_page
  copy_file 'views/pages/home.html.erb',
    'app/views/pages/home.html.erb'
end

#create_partials ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/spark/app_builder.rb', line 110

def create_partials
  empty_directory 'app/views/application'

  copy_file 'views/application/_stylesheet.html.erb',
    'app/views/application/_stylesheet.html.erb'
  copy_file 'views/application/_flashes.html.erb',
    'app/views/application/_flashes.html.erb'
  copy_file 'views/application/_javascript.html.erb',
    'app/views/application/_javascript.html.erb'
  copy_file 'views/application/_navigation.html.erb',
    'app/views/application/_navigation.html.erb'
  copy_file 'views/application/_navigation_links.html.erb',
    'app/views/application/_navigation_links.html.erb'
  copy_file 'views/application/_analytics.html.erb',
    'app/views/application/_analytics.html.erb'
  copy_file 'views/application/_footer.html.erb',
    'app/views/application/_footer.html.erb'
end

#customize_error_pages ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/spark/app_builder.rb', line 281

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 



106
107
108
 
# File 'lib/spark/app_builder.rb', line 106

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

#enable_database_cleaner ⇒ Object 



158
159
160
 
# File 'lib/spark/app_builder.rb', line 158

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

#fix_i18n_deprecation_warning ⇒ Object 



219
220
221
222
223
224
225
 
# File 'lib/spark/app_builder.rb', line 219

def fix_i18n_deprecation_warning
  config = <<-RUBY
config.i18n.enforce_available_locales = true
  RUBY

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

#generate_rspec ⇒ Object 



236
237
238
 
# File 'lib/spark/app_builder.rb', line 236

def generate_rspec
  generate 'rspec:install'
end

#gitignore_files ⇒ Object 



262
263
264
265
 
# File 'lib/spark/app_builder.rb', line 262

def gitignore_files
  remove_file '.gitignore'
  copy_file 'dot_gitignore', '.gitignore'
end

#init_git ⇒ Object 



267
268
269
 
# File 'lib/spark/app_builder.rb', line 267

def init_git
  run 'git init'
end

#provide_dev_prime_task ⇒ Object 



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

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

#provide_setup_script ⇒ Object 



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

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

#raise_on_delivery_errors ⇒ Object 



9
10
11
12
 
# File 'lib/spark/app_builder.rb', line 9

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

#raise_on_unpermitted_parameters ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/spark/app_builder.rb', line 28

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 



5
6
7
 
# File 'lib/spark/app_builder.rb', line 5

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

#remove_routes_comment_lines ⇒ Object 



294
295
296
297
298
 
# File 'lib/spark/app_builder.rb', line 294

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

#replace_gemfile ⇒ Object 



149
150
151
152
 
# File 'lib/spark/app_builder.rb', line 149

def replace_gemfile
  remove_file 'Gemfile'
  template 'Gemfile.erb', 'Gemfile'
end

#run_bin_setup ⇒ Object 



320
321
322
 
# File 'lib/spark/app_builder.rb', line 320

def run_bin_setup
  run "./bin/setup"
end

#set_ruby_to_version_being_used ⇒ Object 



154
155
156
 
# File 'lib/spark/app_builder.rb', line 154

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

#set_test_delivery_method ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/spark/app_builder.rb', line 14

def set_test_delivery_method
  config = <<-RUBY

  config.action_mailer.delivery_method = :smtp
  config.action_mailer.smtp_settings = { :address => "localhost", :port => 1025 }
  RUBY

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

#set_up_factory_girl_for_rspec ⇒ Object 



63
64
65
 
# File 'lib/spark/app_builder.rb', line 63

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

#setup_asset_host ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/spark/app_builder.rb', line 86

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("HOST"))'

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

  inject_into_file(
    "config/environments/production.rb",
    '  config.static_cache_control = "public, max-age=#{1.year.to_i}"',
    after: serve_static_files_line
  )
end

#setup_bundler_audit ⇒ Object 



271
272
273
274
 
# File 'lib/spark/app_builder.rb', line 271

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

#setup_default_rake_task ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/spark/app_builder.rb', line 304

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_figaro ⇒ Object 



244
245
246
 
# File 'lib/spark/app_builder.rb', line 244

def setup_figaro
  copy_file 'config/application.yml.sample', 'config/application.yml.sample'
end

#setup_foreman ⇒ Object 



240
241
242
 
# File 'lib/spark/app_builder.rb', line 240

def setup_foreman
  copy_file 'Procfile', 'Procfile'
end

#setup_javascripts ⇒ Object 



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

def setup_javascripts
  remove_file 'app/assets/javascripts/application.js'
  copy_file 'assets/application.js',
    'app/assets/javascripts/application.js'
end

#setup_secret_token ⇒ Object 



102
103
104
 
# File 'lib/spark/app_builder.rb', line 102

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

#setup_stylesheets ⇒ Object 



248
249
250
251
252
253
254
 
# File 'lib/spark/app_builder.rb', line 248

def setup_stylesheets
  remove_file 'app/assets/stylesheets/application.css'
  copy_file 'assets/application.scss',
    'app/assets/stylesheets/application.scss'
  copy_file 'assets/disable_animation.scss',
    'vendor/assets/stylesheets/disable_animation.scss'
end

#use_postgres_config_template ⇒ Object 



140
141
142
143
 
# File 'lib/spark/app_builder.rb', line 140

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