class Suspenders::AppBuilder

Public Instance Methods

add_bullet_gem_configuration() click to toggle source
# File lib/suspenders/app_builder.rb, line 59
    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() click to toggle source
# File lib/suspenders/app_builder.rb, line 336
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() click to toggle source
# File lib/suspenders/app_builder.rb, line 311
def configure_action_mailer_in_specs
  copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb'
end
configure_active_job() click to toggle source
# File lib/suspenders/app_builder.rb, line 342
def configure_active_job
  configure_environment "test", "config.active_job.queue_adapter = :inline"
end
configure_automatic_deployment() click to toggle source
# File lib/suspenders/app_builder.rb, line 415
    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() click to toggle source
# File lib/suspenders/app_builder.rb, line 315
def configure_capybara_webkit
  copy_file "capybara_webkit.rb", "spec/support/capybara_webkit.rb"
end
configure_ci() click to toggle source
# File lib/suspenders/app_builder.rb, line 298
def configure_ci
  template "circle.yml.erb", "circle.yml"
end
configure_generators() click to toggle source
# File lib/suspenders/app_builder.rb, line 101
    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() click to toggle source
# File lib/suspenders/app_builder.rb, line 306
def configure_i18n_for_missing_translations
  raise_on_missing_translations_in("development")
  raise_on_missing_translations_in("test")
end
configure_i18n_for_test_environment() click to toggle source
# File lib/suspenders/app_builder.rb, line 302
def configure_i18n_for_test_environment
  copy_file "i18n.rb", "spec/support/i18n.rb"
end
configure_newrelic() click to toggle source
# File lib/suspenders/app_builder.rb, line 127
def configure_newrelic
  template 'newrelic.yml.erb', 'config/newrelic.yml'
end
configure_puma() click to toggle source
# File lib/suspenders/app_builder.rb, line 350
def configure_puma
  copy_file "puma.rb", "config/puma.rb"
end
configure_quiet_assets() click to toggle source
# File lib/suspenders/app_builder.rb, line 84
    def configure_quiet_assets
      config = <<-RUBY
    config.quiet_assets = true
      RUBY

      inject_into_class "config/application.rb", "Application", config
    end
configure_rack_timeout() click to toggle source
# File lib/suspenders/app_builder.rb, line 324
    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() click to toggle source
# File lib/suspenders/app_builder.rb, line 291
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_simple_form() click to toggle source
# File lib/suspenders/app_builder.rb, line 332
def configure_simple_form
  bundle_command "exec rails generate simple_form:install"
end
configure_smtp() click to toggle source
# File lib/suspenders/app_builder.rb, line 131
    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() click to toggle source
# File lib/suspenders/app_builder.rb, line 286
def configure_spec_support_features
  empty_directory_with_keep_file 'spec/features'
  empty_directory_with_keep_file 'spec/support/features'
end
configure_time_formats() click to toggle source
# File lib/suspenders/app_builder.rb, line 319
def configure_time_formats
  remove_file "config/locales/en.yml"
  template "config_locales_en.yml.erb", "config/locales/en.yml"
end
copy_dotfiles() click to toggle source
# File lib/suspenders/app_builder.rb, line 384
def copy_dotfiles
  directory("dotfiles", ".")
end
copy_miscellaneous_files() click to toggle source
# File lib/suspenders/app_builder.rb, line 440
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() click to toggle source
# File lib/suspenders/app_builder.rb, line 254
def create_application_layout
  remove_file "app/views/layouts/application.html.erb"

  template "suspenders_layout.tt",
    "app/views/layouts/application.slim",
    force: true
end
create_database() click to toggle source
# File lib/suspenders/app_builder.rb, line 267
def create_database
  bundle_command 'exec rake db:create db:migrate'
end
create_github_repo(repo_name) click to toggle source
# File lib/suspenders/app_builder.rb, line 427
def create_github_repo(repo_name)
  run "hub create #{repo_name}"
end
create_heroku_apps(flags) click to toggle source
# File lib/suspenders/app_builder.rb, line 392
def create_heroku_apps(flags)
  create_staging_heroku_app(flags)
  create_production_heroku_app(flags)
end
create_partials_directory() click to toggle source
# File lib/suspenders/app_builder.rb, line 234
def create_partials_directory
  empty_directory 'app/views/application'
end
create_shared_css_overrides() click to toggle source
# File lib/suspenders/app_builder.rb, line 247
def create_shared_css_overrides
  copy_file(
    "_css_overrides.slim",
    "app/views/application/_css_overrides.slim",
  )
end
create_shared_flashes() click to toggle source
# File lib/suspenders/app_builder.rb, line 238
def create_shared_flashes
  copy_file "_flashes.slim", "app/views/application/_flashes.slim"
  copy_file "flashes_helper.rb", "app/helpers/flashes_helper.rb"
end
create_shared_javascripts() click to toggle source
# File lib/suspenders/app_builder.rb, line 243
def create_shared_javascripts
  copy_file '_javascript.slim', 'app/views/application/_javascript.slim'
end
customize_error_pages() click to toggle source
# File lib/suspenders/app_builder.rb, line 446
    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
disable_xml_params() click to toggle source
# File lib/suspenders/app_builder.rb, line 487
def disable_xml_params
  copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
end
disallow_wrapping_parameters() click to toggle source
# File lib/suspenders/app_builder.rb, line 230
def disallow_wrapping_parameters
  remove_file "config/initializers/wrap_parameters.rb"
end
enable_database_cleaner() click to toggle source
# File lib/suspenders/app_builder.rb, line 275
def enable_database_cleaner
  copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
end
enable_rack_canonical_host() click to toggle source
# File lib/suspenders/app_builder.rb, line 147
    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

  # Ensure requests are only served from one, canonical host name
  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() click to toggle source
# File lib/suspenders/app_builder.rb, line 165
    def enable_rack_deflater
      config = <<-RUBY

  # Enable deflate / gzip compression of controller-generated responses
  config.middleware.use Rack::Deflater
      RUBY

      inject_into_file(
        "config/environments/production.rb",
        config,
        after: serve_static_files_line
      )
    end
enable_rack_tracker() click to toggle source
# File lib/suspenders/app_builder.rb, line 179
    def enable_rack_tracker
      config = <<-RUBY

  config.middleware.use(Rack::Tracker) do
    if ENV["GOOGLE_ANALYTICS_KEY"]
      handler :google_analytics, { tracker: ENV["GOOGLE_ANALYTICS_KEY"] }
    end
  end
      RUBY

      inject_into_file(
        "config/environments/production.rb",
        config,
        after: "Rails.application.configure do",
      )
    end
gemfile() click to toggle source
# File lib/suspenders/app_builder.rb, line 27
def gemfile
  template "Gemfile.erb", "Gemfile"
end
generate_factories_file() click to toggle source
# File lib/suspenders/app_builder.rb, line 123
def generate_factories_file
  copy_file "factories.rb", "spec/factories.rb"
end
generate_rspec() click to toggle source
# File lib/suspenders/app_builder.rb, line 346
def generate_rspec
  generate 'rspec:install'
end
gitignore() click to toggle source
# File lib/suspenders/app_builder.rb, line 23
def gitignore
  copy_file "suspenders_gitignore", ".gitignore"
end
init_git() click to toggle source
# File lib/suspenders/app_builder.rb, line 388
def init_git
  run 'git init'
end
provide_deploy_script() click to toggle source
# File lib/suspenders/app_builder.rb, line 397
    def provide_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
provide_dev_prime_task() click to toggle source
# File lib/suspenders/app_builder.rb, line 97
def provide_dev_prime_task
  copy_file 'dev.rake', 'lib/tasks/dev.rake'
end
provide_setup_script() click to toggle source
# File lib/suspenders/app_builder.rb, line 92
def provide_setup_script
  template "bin_setup", "bin/setup", force: true
  run "chmod a+x bin/setup"
end
provide_shoulda_matchers_config() click to toggle source
# File lib/suspenders/app_builder.rb, line 279
def provide_shoulda_matchers_config
  copy_file(
    "shoulda_matchers_config_rspec.rb",
    "spec/support/shoulda_matchers.rb"
  )
end
raise_on_delivery_errors() click to toggle source
# File lib/suspenders/app_builder.rb, line 46
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() click to toggle source
# File lib/suspenders/app_builder.rb, line 38
def raise_on_missing_assets_in_test
  inject_into_file(
    "config/environments/test.rb",
    "\n  config.assets.raise_runtime_errors = true",
    after: "Rails.application.configure do",
  )
end
raise_on_unpermitted_parameters() click to toggle source
# File lib/suspenders/app_builder.rb, line 76
    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() click to toggle source
# File lib/suspenders/app_builder.rb, line 19
def readme
  template 'README.md.erb', 'README.md'
end
remove_config_comment_lines() click to toggle source
# File lib/suspenders/app_builder.rb, line 459
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() click to toggle source
# File lib/suspenders/app_builder.rb, line 481
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
set_ruby_to_version_being_used() click to toggle source
# File lib/suspenders/app_builder.rb, line 271
def set_ruby_to_version_being_used
  create_file '.ruby-version', "#{Suspenders::RUBY_VERSION}\n"
end
set_test_delivery_method() click to toggle source
# File lib/suspenders/app_builder.rb, line 51
def set_test_delivery_method
  inject_into_file(
    "config/environments/development.rb",
    "\n  config.action_mailer.delivery_method = :letter_opener",
    after: "config.action_mailer.raise_delivery_errors = true",
  )
end
set_up_factory_girl_for_rspec() click to toggle source
# File lib/suspenders/app_builder.rb, line 119
def set_up_factory_girl_for_rspec
  copy_file 'factory_girl_rspec.rb', 'spec/support/factory_girl.rb'
end
set_up_forego() click to toggle source
# File lib/suspenders/app_builder.rb, line 354
def set_up_forego
  copy_file "Procfile", "Procfile"
end
setup_asset_host() click to toggle source
# File lib/suspenders/app_builder.rb, line 196
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")'

  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() click to toggle source
# File lib/suspenders/app_builder.rb, line 431
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() click to toggle source
# File lib/suspenders/app_builder.rb, line 370
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() click to toggle source
# File lib/suspenders/app_builder.rb, line 491
    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_javascript() click to toggle source
# File lib/suspenders/app_builder.rb, line 358
def setup_javascript
  remove_file "app/assets/stylesheets/application.js"
  copy_file "application.js",
            "app/assets/javascripts/application.js"
end
setup_rack_mini_profiler() click to toggle source
# File lib/suspenders/app_builder.rb, line 31
def setup_rack_mini_profiler
  copy_file(
    "rack_mini_profiler.rb",
    "config/initializers/rack_mini_profiler.rb",
  )
end
setup_secret_token() click to toggle source
# File lib/suspenders/app_builder.rb, line 226
def setup_secret_token
  template 'secrets.yml', 'config/secrets.yml', force: true
end
setup_spring() click to toggle source
# File lib/suspenders/app_builder.rb, line 436
def setup_spring
  bundle_command "exec spring binstub --all"
end
setup_staging_environment() click to toggle source
# File lib/suspenders/app_builder.rb, line 212
    def setup_staging_environment
      staging_file = 'config/environments/staging.rb'
      copy_file 'staging.rb', staging_file

      config = <<-RUBY

Rails.application.configure do
  # ...
end
      RUBY

      append_file staging_file, config
    end
setup_stylesheets() click to toggle source
# File lib/suspenders/app_builder.rb, line 364
def setup_stylesheets
  remove_file "app/assets/stylesheets/application.css"
  copy_file "application.scss",
            "app/assets/stylesheets/application.scss"
end
use_postgres_config_template() click to toggle source
# File lib/suspenders/app_builder.rb, line 262
def use_postgres_config_template
  template 'postgresql_database.yml.erb', 'config/database.yml',
    force: true
end

Private Instance Methods

heroku_adapter() click to toggle source
# File lib/suspenders/app_builder.rb, line 515
def heroku_adapter
  @heroku_adapter ||= Adapters::Heroku.new(self)
end
raise_on_missing_translations_in(environment) click to toggle source
# File lib/suspenders/app_builder.rb, line 509
def raise_on_missing_translations_in(environment)
  config = 'config.action_view.raise_on_missing_translations = true'

  uncomment_lines("config/environments/#{environment}.rb", config)
end
serve_static_files_line() click to toggle source
# File lib/suspenders/app_builder.rb, line 519
def serve_static_files_line
  "config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?\n"
end