class Shoelaces::AppBuilder
Public Class Methods
set_port_number(number)
click to toggle source
# File lib/shoelaces/app_builder.rb, line 6 def self.set_port_number(number) @@port_number = number end
Public Instance Methods
add_images()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 134 def add_images copy_file 'noise.png', 'app/assets/images/noise.png' end
add_static_pages()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 138 def add_static_pages template 'home.html.erb.erb', 'app/views/pages/home.html.erb', force: true template 'about.html.erb.erb', 'app/views/pages/about.html.erb', force: true template 'contact.html.erb.erb', 'app/views/pages/contact.html.erb', force: true end
configure_action_mailer()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 259 def configure_action_mailer action_mailer_host 'development', "localhost:#{port_number}" action_mailer_host 'test', 'www.example.com' action_mailer_host 'staging', "staging.#{app_name}.com" action_mailer_host 'production', "#{app_name}.com" end
configure_action_mailer_in_specs()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 238 def configure_action_mailer_in_specs copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb' end
configure_background_jobs_for_rspec()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 233 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
configure_generators()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 42 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_development_environment()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 229 def configure_i18n_for_development_environment raise_on_missing_translations_in("development") end
configure_i18n_for_test_environment()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 224 def configure_i18n_for_test_environment copy_file 'i18n.rb', 'spec/support/i18n.rb' raise_on_missing_translations_in("test") end
configure_newrelic()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 63 def configure_newrelic template 'newrelic.yml.erb', 'config/newrelic.yml' end
configure_rack_timeout()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 255 def configure_rack_timeout copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb' end
configure_rspec()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 215 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/shoelaces/app_builder.rb, line 67 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/shoelaces/app_builder.rb, line 210 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/shoelaces/app_builder.rb, line 250 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
# File lib/shoelaces/app_builder.rb, line 242 def configure_time_zone config = <<-RUBY config.active_record.default_timezone = :utc RUBY inject_into_class 'config/application.rb', 'Application', config end
configure_travis()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 220 def configure_travis template 'travis.yml.erb', '.travis.yml' end
configure_unicorn()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 282 def configure_unicorn copy_file 'unicorn.rb', 'config/unicorn.rb' end
copy_miscellaneous_files()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 373 def copy_miscellaneous_files copy_file 'errors.rb', 'config/initializers/errors.rb' end
create_application_layout()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 150 def create_application_layout template 'shoelaces_layout.html.erb.erb', 'app/views/layouts/application.html.erb', force: true template 'shoelaces_layout_header.html.erb.erb', 'app/views/layouts/_header.html.erb', force: true template 'shoelaces_layout_footer.html.erb.erb', 'app/views/layouts/_footer.html.erb', force: true end
create_database()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 188 def create_database bundle_command 'exec rake db:create db:migrate' end
create_github_repo(repo_name)
click to toggle source
# File lib/shoelaces/app_builder.rb, line 363 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/shoelaces/app_builder.rb, line 324 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/shoelaces/app_builder.rb, line 126 def create_partials_directory empty_directory 'app/views/application' end
customize_error_pages()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 377 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/shoelaces/app_builder.rb, line 396 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/shoelaces/app_builder.rb, line 206 def enable_database_cleaner copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb' end
enable_rack_deflater()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 83 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/shoelaces/app_builder.rb, line 266 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()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 274 def generate_rspec generate 'rspec:install' end
generate_simple_form()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 278 def generate_simple_form generate 'simple_form:install --bootstrap' end
gitignore_files()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 303 def gitignore_files remove_file '.gitignore' copy_file 'shoelaces_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/shoelaces/app_builder.rb, line 320 def init_git run 'git init' end
join_heroku_app(environment)
click to toggle source
# File lib/shoelaces/app_builder.rb, line 346 def join_heroku_app(environment) heroku_app_name = "#{app_name}-#{environment}" <<-SHELL if heroku join --app #{heroku_app_name} &> /dev/null; then echo 'You are a collaborator on the "#{heroku_app_name}" Heroku app' else echo 'Ask for access to the "#{heroku_app_name}" Heroku app' fi SHELL end
provide_dev_prime_task()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 38 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/shoelaces/app_builder.rb, line 33 def provide_setup_script template 'bin_setup.erb', 'bin/setup', port_number: port_number run 'chmod a+x bin/setup' end
raise_on_delivery_errors()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 14 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/shoelaces/app_builder.rb, line 19 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/shoelaces/app_builder.rb, line 10 def readme template 'README.md.erb', 'README.md' end
remove_routes_comment_lines()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 390 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()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 162 def remove_turbolinks replace_in_file 'app/assets/javascripts/application.js', /\/\/= require turbolinks\n/, '' end
replace_gemfile()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 192 def replace_gemfile remove_file 'Gemfile' template 'Gemfile.erb', 'Gemfile' end
set_heroku_rails_secrets()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 357 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/shoelaces/app_builder.rb, line 331 def set_heroku_remotes remotes = <<-SHELL # Set up staging and production git remotes. git remote add staging git@heroku.com:#{app_name}-staging.git || true git remote add production git@heroku.com:#{app_name}-production.git || true # Join the staging and production apps. #{join_heroku_app('staging')} #{join_heroku_app('production')} SHELL append_file 'bin/setup', remotes end
set_ruby_to_version_being_used()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 197 def set_ruby_to_version_being_used create_file '.ruby-version', "#{Shoelaces::RUBY_VERSION}\n" end
set_up_factory_girl_for_rspec()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 59 def set_up_factory_girl_for_rspec copy_file 'factory_girl_rspec.rb', 'spec/support/factory_girl.rb' end
setup_asset_host()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 94 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")' replace_in_file 'config/initializers/assets.rb', "config.assets.version = '1.0'", 'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")' replace_in_file 'config/environments/production.rb', 'config.serve_static_assets = false', 'config.static_cache_control = "public, max-age=#{1.year.to_i}"' end
setup_bootstrap_javascript()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 168 def setup_bootstrap_javascript bootstrap_javascript = <<-RUBY //= require bootstrap RUBY inject_into_file( 'app/assets/javascripts/application.js', bootstrap_javascript, before: "//= require_tree ." ) end
setup_default_rake_task()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 400 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/shoelaces/app_builder.rb, line 286 def setup_foreman copy_file 'sample.env', '.sample.env' copy_file 'Procfile', 'Procfile' end
setup_guard()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 291 def setup_guard copy_file 'Guardfile', 'Guardfile' end
setup_heroku_specific_gems()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 201 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/shoelaces/app_builder.rb, line 122 def setup_secret_token template 'secrets.yml', 'config/secrets.yml', force: true end
setup_segment_io()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 368 def setup_segment_io copy_file '_analytics.html.erb', 'app/views/application/_analytics.html.erb' end
setup_staging_environment()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 108 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/shoelaces/app_builder.rb, line 295 def setup_stylesheets remove_file 'app/assets/stylesheets/application.css' copy_file 'application.css.scss', 'app/assets/stylesheets/application.css.scss' copy_file '_variables.scss', 'app/assets/stylesheets/_variables.scss' end
use_high_voltage_config_template()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 184 def use_high_voltage_config_template copy_file 'high_voltage.rb', 'config/initializers/high_voltage.rb' end
use_postgres_config_template()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 179 def use_postgres_config_template template 'postgresql_database.yml.erb', 'config/database.yml', force: true end
Private Instance Methods
factories_spec_rake_task()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 421 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/shoelaces/app_builder.rb, line 425 def generate_secret SecureRandom.hex(64) end
override_path_for_tests()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 414 def override_path_for_tests if ENV['TESTING'] support_bin = File.expand_path(File.join('..', '..', 'spec', 'fakes', 'bin')) "PATH=#{support_bin}:$PATH" end end
port_number()
click to toggle source
# File lib/shoelaces/app_builder.rb, line 429 def port_number if @@port_number @port_number = @@port_number else @port_number ||= [3000, 5000, 6000, 7000, 8000, 9000].sample end end
raise_on_missing_translations_in(environment)
click to toggle source
# File lib/shoelaces/app_builder.rb, line 408 def raise_on_missing_translations_in(environment) config = 'config.action_view.raise_on_missing_translations = true' uncomment_in_file("config/environments/#{environment}.rb", config) end