class Suspenders::AppBuilder

Public Instance Methods

configure_action_mailer() click to toggle source
# File lib/suspenders/app_builder.rb, line 199
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_generators() click to toggle source
# File lib/suspenders/app_builder.rb, line 37
    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_rack_timeout() click to toggle source
# File lib/suspenders/app_builder.rb, line 195
def configure_rack_timeout
  copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb'
end
configure_rspec() click to toggle source
# File lib/suspenders/app_builder.rb, line 168
def configure_rspec
  remove_file 'spec/spec_helper.rb'
  copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
end
configure_smtp() click to toggle source
# File lib/suspenders/app_builder.rb, line 63
    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_spec_support_features() click to toggle source
# File lib/suspenders/app_builder.rb, line 163
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 190
def configure_time_formats
  remove_file 'config/locales/en.yml'
  copy_file 'config_locales_en.yml', 'config/locales/en.yml'
end
configure_time_zone() click to toggle source

def configure_background_jobs_for_rspec

copy_file 'background_jobs_rspec.rb', 'spec/support/background_jobs.rb'
run 'rails g delayed_job:active_record'

end

# File lib/suspenders/app_builder.rb, line 182
    def configure_time_zone
      config = <<-RUBY
    config.active_record.default_timezone = :utc

      RUBY
      inject_into_class 'config/application.rb', 'Application', config
    end
configure_unicorn() click to toggle source
# File lib/suspenders/app_builder.rb, line 218
def configure_unicorn
  copy_file 'unicorn.rb', 'config/unicorn.rb'
end
copy_miscellaneous_files() click to toggle source
# File lib/suspenders/app_builder.rb, line 283
def copy_miscellaneous_files
  copy_file 'errors.rb', 'config/initializers/errors.rb'
end
create_application_layout() click to toggle source
# File lib/suspenders/app_builder.rb, line 122
def create_application_layout
  template 'suspenders_layout.html.erb.erb',
    'app/views/layouts/application.html.erb',
    force: true
end
create_database() click to toggle source
# File lib/suspenders/app_builder.rb, line 139
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 278
def create_github_repo(repo_name)
  path_addition = override_path_for_tests
  run "#{path_addition} hub create #{repo_name}"
end
create_heroku_apps() click to toggle source
# File lib/suspenders/app_builder.rb, line 254
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_directory() click to toggle source
# File lib/suspenders/app_builder.rb, line 110
def create_partials_directory
  empty_directory 'app/views/application'
end
create_shared_flashes() click to toggle source
# File lib/suspenders/app_builder.rb, line 114
def create_shared_flashes
  copy_file '_flashes.html.erb', 'app/views/application/_flashes.html.erb'
end
create_shared_javascripts() click to toggle source
# File lib/suspenders/app_builder.rb, line 118
def create_shared_javascripts
  copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
end
customize_error_pages() click to toggle source
# File lib/suspenders/app_builder.rb, line 287
    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
devise_migrate() click to toggle source
# File lib/suspenders/app_builder.rb, line 325
def devise_migrate
  bundle_command 'exec rake db:migrate db:test:prepare'
end
devise_token() click to toggle source
# File lib/suspenders/app_builder.rb, line 329
def devise_token
  token = generate_secret
  replace_in_file '.env', 'development_secret', token
end
disable_xml_params() click to toggle source
# File lib/suspenders/app_builder.rb, line 305
def disable_xml_params
  copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
end
enable_database_cleaner() click to toggle source
# File lib/suspenders/app_builder.rb, line 159
def enable_database_cleaner
  copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
end
enable_factory_girl_syntax() click to toggle source
# File lib/suspenders/app_builder.rb, line 54
def enable_factory_girl_syntax
  copy_file 'factory_girl_syntax_rspec.rb', 'spec/support/factory_girl.rb'
end
enable_rack_deflater() click to toggle source
# File lib/suspenders/app_builder.rb, line 79
    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 => "config.serve_static_assets = false\n"
    end
fix_i18n_deprecation_warning() click to toggle source
# File lib/suspenders/app_builder.rb, line 206
    def fix_i18n_deprecation_warning
      config = <<-RUBY
    config.i18n.enforce_available_locales = true

      RUBY
      inject_into_class 'config/application.rb', 'Application', config
    end
generate_devise() click to toggle source
# File lib/suspenders/app_builder.rb, line 315
def generate_devise
  generate 'devise:install'
  inject_into_file 'config/initializers/devise.rb',
    "  config.secret_key = ENV['SECRET_KEY_BASE']\n", after: "Devise.setup do |config|\n"
end
generate_devise_user() click to toggle source
# File lib/suspenders/app_builder.rb, line 321
def generate_devise_user
  generate 'devise User'
end
generate_rspec() click to toggle source
# File lib/suspenders/app_builder.rb, line 214
def generate_rspec
  generate 'rspec:install'
end
gitignore_files() click to toggle source
# File lib/suspenders/app_builder.rb, line 233
def gitignore_files
  remove_file '.gitignore'
  copy_file 'suspenders_gitignore', '.gitignore'
  [
    'app/views/pages',
    'spec/lib',
    'spec/controllers',
    'spec/helpers',
    'spec/support/matchers',
    'spec/support/mixins',
    'spec/support/shared_examples'
  ].each do |dir|
    run "mkdir #{dir}"
    run "touch #{dir}/.keep"
  end
end
init_git() click to toggle source
# File lib/suspenders/app_builder.rb, line 250
def init_git
  run 'git init'
end
provide_dev_prime_task() click to toggle source
# File lib/suspenders/app_builder.rb, line 33
def provide_dev_prime_task
  copy_file 'development_seeds.rb', 'lib/tasks/development_seeds.rake'
end
provide_setup_script() click to toggle source
# File lib/suspenders/app_builder.rb, line 28
def provide_setup_script
  copy_file 'bin_setup', 'bin/setup'
  run 'chmod a+x bin/setup'
end
raise_on_delivery_errors() click to toggle source
# File lib/suspenders/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() click to toggle source
# File lib/suspenders/app_builder.rb, line 14
    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
readme() click to toggle source
# File lib/suspenders/app_builder.rb, line 5
def readme
  template 'README.md.erb', 'README.md'
end
remove_routes_comment_lines() click to toggle source
# File lib/suspenders/app_builder.rb, line 299
def remove_routes_comment_lines
  replace_in_file 'config/routes.rb',
    /Application\.routes\.draw do.*end/m,
    "Application.routes.draw do\nend"
end
replace_gemfile() click to toggle source
# File lib/suspenders/app_builder.rb, line 143
def replace_gemfile
  remove_file 'Gemfile'
  copy_file 'Gemfile_clean', 'Gemfile'
end
set_heroku_rails_secrets() click to toggle source
# File lib/suspenders/app_builder.rb, line 272
def set_heroku_rails_secrets
  path_addition = override_path_for_tests
  run "#{path_addition} heroku config:add SECRET_KEY_BASE=#{generate_secret} --remote=staging"
  run "#{path_addition} heroku config:add SECRET_KEY_BASE=#{generate_secret} --remote=production"
end
set_heroku_remotes() click to toggle source
# File lib/suspenders/app_builder.rb, line 261
    def set_heroku_remotes
      remotes = <<-RUBY

# Set up staging and production git remotes
git remote add staging git@heroku.com:#{app_name}-staging.git
git remote add production git@heroku.com:#{app_name}-production.git
      RUBY

      append_file 'bin/setup', remotes
    end
set_ruby_to_version_being_used() click to toggle source
# File lib/suspenders/app_builder.rb, line 148
def set_ruby_to_version_being_used
  inject_into_file 'Gemfile', "\n\nruby '#{RUBY_VERSION}'",
    after: /source 'https:\/\/rubygems.org'/
  create_file '.ruby-version', "#{RUBY_VERSION}#{patchlevel}\n"
end
setup_default_rake_task() click to toggle source
# File lib/suspenders/app_builder.rb, line 309
def setup_default_rake_task
  append_file 'Rakefile' do
    "task(:default).clear\ntask :default => [:spec]\n"
  end
end
setup_foreman() click to toggle source
# File lib/suspenders/app_builder.rb, line 222
def setup_foreman
  copy_file 'sample.env', '.env'
  copy_file 'Procfile', 'Procfile'
end
setup_heroku_specific_gems() click to toggle source
# File lib/suspenders/app_builder.rb, line 154
def setup_heroku_specific_gems
  inject_into_file 'Gemfile', "\n\s\sgem 'rails_12factor'",
    after: /group :staging, :production do/
end
setup_secret_token() click to toggle source
# File lib/suspenders/app_builder.rb, line 104
def setup_secret_token
  template 'secret_token.rb',
    'config/initializers/secret_token.rb',
    :force => true
end
setup_staging_environment() click to toggle source
# File lib/suspenders/app_builder.rb, line 90
    def setup_staging_environment
      staging_file = 'config/environments/staging.rb'
      copy_file 'staging.rb', staging_file

      config = <<-RUBY

#{app_name.classify}::Application.configure do
  # ...
end
      RUBY

      append_file staging_file, config
    end
setup_stylesheets() click to toggle source
# File lib/suspenders/app_builder.rb, line 227
def setup_stylesheets
  remove_file 'app/assets/stylesheets/application.css'
  copy_file 'application.css.scss',
    'app/assets/stylesheets/application.css.scss'
end
test_factories_first() click to toggle source
# File lib/suspenders/app_builder.rb, line 58
def test_factories_first
  copy_file 'factories_spec.rb', 'spec/models/factories_spec.rb'
  append_file 'Rakefile', factories_spec_rake_task
end
use_postgres_config_template() click to toggle source
# File lib/suspenders/app_builder.rb, line 134
def use_postgres_config_template
  template 'postgresql_database.yml.erb', 'config/database.yml',
    force: true
end
use_spring_binstubs() click to toggle source
# File lib/suspenders/app_builder.rb, line 173
def use_spring_binstubs
  run 'bundle exec spring binstub --all'
end

Private Instance Methods

factories_spec_rake_task() click to toggle source
# File lib/suspenders/app_builder.rb, line 343
def factories_spec_rake_task
  IO.read find_in_source_paths('factories_spec_rake_task.rb')
end
generate_secret() click to toggle source
# File lib/suspenders/app_builder.rb, line 347
def generate_secret
  SecureRandom.hex(64)
end
override_path_for_tests() click to toggle source
# File lib/suspenders/app_builder.rb, line 336
def override_path_for_tests
  if ENV['TESTING']
    support_bin = File.expand_path(File.join('..', '..', 'spec', 'fakes', 'bin'))
    "PATH=#{support_bin}:$PATH"
  end
end
patchlevel() click to toggle source
# File lib/suspenders/app_builder.rb, line 351
def patchlevel
  if RUBY_PATCHLEVEL == 0 && RUBY_VERSION >= '2.1.0'
    ''
  else
    "-p#{RUBY_PATCHLEVEL}"
  end
end