Class: Tirantes::AppBuilder

Inherits:
Rails::AppBuilder
  • Object
show all
Includes:
Actions
Defined in:
lib/tirantes/app_builder.rb

Instance Method Summary collapse

Methods included from Actions

#action_mailer_host, #concat_file, #configure_environment, #download_file, #replace_in_file

Instance Method Details

#configure_action_mailerObject



201
202
203
204
205
206
# File 'lib/tirantes/app_builder.rb', line 201

def configure_action_mailer
  action_mailer_host 'development', "#{app_name}.local"
  action_mailer_host 'test', 'www.example.com'
  action_mailer_host 'staging', "staging.#{app_name}.com"
  action_mailer_host 'production', "#{app_name}.com"
end

#configure_background_jobs_for_minitestObject



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

def configure_background_jobs_for_minitest
  copy_file 'background_jobs_minitest.rb', 'test/support/background_jobs.rb'
  run 'rails g delayed_job:active_record'
end

#configure_exception_notifierObject



79
80
81
# File 'lib/tirantes/app_builder.rb', line 79

def configure_exception_notifier
  copy_file 'exception_notification.rb', 'config/initializers/exception_notification.rb'
end

#configure_generatorsObject



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

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 :mini_test, :spec => true, :fixture => true
  generate.view_specs false
end

  RUBY

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

#configure_minitestObject



161
162
163
164
# File 'lib/tirantes/app_builder.rb', line 161

def configure_minitest
  remove_file 'test/test_helper.rb'
  copy_file 'test_helper.rb', 'test/test_helper.rb'
end

#configure_pretty_formatterObject



179
180
181
182
183
184
185
# File 'lib/tirantes/app_builder.rb', line 179

def configure_pretty_formatter
  config = <<-RUBY
config.log_formatter = PrettyFormatter.formatter

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

#configure_pumaObject



212
213
214
# File 'lib/tirantes/app_builder.rb', line 212

def configure_puma
  copy_file 'puma.rb', 'config/puma.rb'
end

#configure_rack_timeoutObject



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

def configure_rack_timeout
  copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb'
end

#configure_simple_formObject



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

def configure_simple_form
  run 'rails g simple_form:install'
  copy_file 'simple_form_purecss.rb', 'config/simple_form_purecss.rb'
end

#configure_smtpObject



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/tirantes/app_builder.rb', line 83

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

  prepend_file 'config/environments/production.rb',
    "require Rails.root.join('config/initializers/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_time_formatsObject



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

def configure_time_formats
  remove_file 'config/locales/en.yml'
  copy_file 'config_locales_en.yml', 'config/locales/en.yml'
end

#configure_time_zoneObject



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

def configure_time_zone
  config = <<-RUBY
config.active_record.default_timezone = :utc

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

#copy_miscellaneous_filesObject



281
282
283
# File 'lib/tirantes/app_builder.rb', line 281

def copy_miscellaneous_files
  copy_file 'errors.rb', 'config/initializers/errors.rb'
end

#create_application_layoutObject



122
123
124
125
126
# File 'lib/tirantes/app_builder.rb', line 122

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

#create_common_javascriptsObject



134
135
136
# File 'lib/tirantes/app_builder.rb', line 134

def create_common_javascripts
  directory 'javascripts', 'app/assets/javascripts'
end

#create_databaseObject



143
144
145
# File 'lib/tirantes/app_builder.rb', line 143

def create_database
  bundle_command 'exec rake db:create'
end

#create_github_repo(repo_name) ⇒ Object



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

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

#create_heroku_appsObject



258
259
260
261
262
263
# File 'lib/tirantes/app_builder.rb', line 258

def create_heroku_apps
  path_addition = override_path_for_tests
  run "#{path_addition} heroku create #{app_name}-production --remote=production"
  run "#{path_addition} heroku create #{app_name}-staging --remote=staging"
  run "#{path_addition} heroku config:add RACK_ENV=staging RAILS_ENV=staging --remote=staging"
end

#create_partials_directoryObject



110
111
112
# File 'lib/tirantes/app_builder.rb', line 110

def create_partials_directory
  empty_directory 'app/views/application'
end

#create_shared_flashesObject



114
115
116
# File 'lib/tirantes/app_builder.rb', line 114

def create_shared_flashes
  copy_file '_flashes.html.erb', 'app/views/application/_flashes.html.erb'
end

#create_shared_javascriptsObject



118
119
120
# File 'lib/tirantes/app_builder.rb', line 118

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

#customize_error_pagesObject



285
286
287
288
289
290
291
292
293
294
295
# File 'lib/tirantes/app_builder.rb', line 285

def customize_error_pages
  meta_tags =<<-EOS
  <meta charset='utf-8' />
  <meta name='ROBOTS' content='NOODP' />
  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

#disable_xml_paramsObject



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

def disable_xml_params
  copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
end

#enable_database_cleanerObject



157
158
159
# File 'lib/tirantes/app_builder.rb', line 157

def enable_database_cleaner
  copy_file 'database_cleaner_minitest.rb', 'test/support/database_cleaner.rb'
end

#generate_minitestObject



208
209
210
# File 'lib/tirantes/app_builder.rb', line 208

def generate_minitest
  generate 'rails g mini_test:install'
end

#gitignore_filesObject



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/tirantes/app_builder.rb', line 235

def gitignore_files
  remove_file '.gitignore'
  copy_file 'tirantes_gitignore', '.gitignore'
  [
    'app/views/pages',
    'test/lib',
    'test/controllers',
    'test/models',
    'test/integration',
    'test/helpers',
    'test/support/matchers',
    'test/support/mixins',
    'test/support/shared_examples'
  ].each do |dir|
    run "mkdir #{dir}"
    run "touch #{dir}/.keep"
  end
end

#init_gitObject



254
255
256
# File 'lib/tirantes/app_builder.rb', line 254

def init_git
  run 'git init'
end

#provide_setup_scriptObject



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/tirantes/app_builder.rb', line 36

def provide_setup_script
  foreman = <<-RUBY
  # Set up Rails app. Run this script immediately after cloning the codebase.
  # https://github.com/thoughtbot/guides/tree/master/protocol

  # Set up configurable environment variables
  if [ ! -f .env ]; then
    cp .sample.env .env
  fi

  # Pick a port for Foreman
  echo "port: 7000" > .foreman

  # Set up DNS via Pow
  if [ -d ~/.pow ]
  then
    echo 7000 > ~/.pow/`basename $PWD`
  else
    echo "Pow not set up but the team uses it for this project. Setup: http://goo.gl/RaDPO"
  fi
  RUBY

  append_file 'bin/setup', foreman
  run 'chmod a+x bin/setup'
end

#raise_on_delivery_errorsObject



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

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

#raise_on_unpermitted_parametersObject



22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/tirantes/app_builder.rb', line 22

def raise_on_unpermitted_parameters
  action_on_unpermitted_parameters = <<-RUBY

  # Raise an ActionController::UnpermittedParameters exception when
  # a parameter is not explcitly permitted but is passed anyway.
  config.action_controller.action_on_unpermitted_parameters = :raise
  RUBY
  inject_into_file(
    "config/environments/development.rb",
    action_on_unpermitted_parameters,
    before: "\nend"
  )
end

#readmeObject



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

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

#remove_public_indexObject



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

def remove_public_index
  remove_file 'public/index.html'
end

#remove_rails_logo_imageObject



13
14
15
# File 'lib/tirantes/app_builder.rb', line 13

def remove_rails_logo_image
  remove_file 'app/assets/images/rails.png'
end

#remove_routes_comment_linesObject



297
298
299
300
301
# File 'lib/tirantes/app_builder.rb', line 297

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


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

def remove_turbolinks
  replace_in_file 'app/assets/javascripts/application.js',
    /\/\/= require turbolinks\n/,
    ''
end

#replace_gemfileObject



147
148
149
150
# File 'lib/tirantes/app_builder.rb', line 147

def replace_gemfile
  remove_file 'Gemfile'
  copy_file 'Gemfile_clean', 'Gemfile'
end

#set_heroku_remotesObject



265
266
267
268
269
270
271
272
273
274
# File 'lib/tirantes/app_builder.rb', line 265

def set_heroku_remotes
  remotes = <<-RUBY

# Set up staging and production git remotes
git remote add staging [email protected]:#{app_name}-staging.git
git remote add production [email protected]:#{app_name}-production.git
  RUBY

  append_file 'bin/setup', remotes
end

#set_ruby_to_version_being_usedObject



152
153
154
155
# File 'lib/tirantes/app_builder.rb', line 152

def set_ruby_to_version_being_used
  inject_into_file 'Gemfile', "\n\nruby '#{RUBY_VERSION}'",
    after: /source 'https:\/\/rubygems.org'/
end

#setup_default_rake_taskObject



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

def setup_default_rake_task
  append_file 'Rakefile' do
    "task(:default).clear\ntask :default => ['test:all']\n"
  end
end

#setup_foremanObject



216
217
218
219
# File 'lib/tirantes/app_builder.rb', line 216

def setup_foreman
  copy_file 'sample.env', '.sample.env'
  copy_file 'Procfile', 'Procfile'
end

#setup_secret_tokenObject



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

def setup_secret_token
  template 'secret_token.rb.erb', 'config/initializers/secret_token.rb', :force => true
end

#setup_staging_environmentObject



99
100
101
102
103
104
# File 'lib/tirantes/app_builder.rb', line 99

def setup_staging_environment
  run 'cp config/environments/production.rb config/environments/staging.rb'

  prepend_file 'config/environments/staging.rb',
    "Mail.register_interceptor RecipientInterceptor.new(ENV['EMAIL_RECIPIENTS'])\n"
end

#setup_stylesheetsObject



221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/tirantes/app_builder.rb', line 221

def setup_stylesheets
  remove_file 'app/assets/stylesheets/application.css'
  copy_file 'application.css.scss',
    'app/assets/stylesheets/application.css.scss'
  [
    'app/assets/stylesheets/base',
    'app/assets/stylesheets/layout',
    'app/assets/stylesheets/modules'
  ].each do |dir|
    run "mkdir #{dir}"
    run "touch #{dir}/.keep"
  end
end

#use_postgres_config_templateObject



138
139
140
141
# File 'lib/tirantes/app_builder.rb', line 138

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