underlay 1.50.1

data/spec/features/new_project_spec.rb

@@ -0,0 +1,308 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Suspend a new project with default configuration' do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    run_underlay
+    setup_app_dependencies
+  end
+
+  it 'uses custom Gemfile' do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+    expect(gemfile_file).to match(
+      /^ruby "#{Underlay::RUBY_VERSION}"$/
+    )
+    expect(gemfile_file).to match(
+      /^gem "autoprefixer-rails"$/
+    )
+    expect(gemfile_file).to match(
+      /^gem "rails", "#{Underlay::RAILS_VERSION}"$/
+    )
+  end
+
+  it 'ensures project specs pass' do
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake`).to include('0 failures')
+      end
+    end
+  end
+
+  it 'includes the bundle:audit task' do
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rails -T`).to include('rails bundle:audit')
+      end
+    end
+  end
+
+  it 'creates .ruby-version from Underlay .ruby-version' do
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  it "doesn't generate test directory" do
+    expect(File).not_to exist("#{project_path}/test")
+  end
+
+  it 'loads secret_key_base from env' do
+    secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
+    expect(secrets_file)
+      .to match(/secret_key_base: <%= ENV\["SECRET_KEY_BASE"\] %>/)
+  end
+
+  it 'adds bin/setup file' do
+    expect(File).to exist("#{project_path}/bin/setup")
+  end
+
+  it 'makes bin/setup executable' do
+    bin_setup_path = "#{project_path}/bin/setup"
+
+    expect(File.stat(bin_setup_path)).to be_executable
+  end
+
+  it 'adds support file for action mailer' do
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  it 'configures capybara' do
+    expect(File).to exist("#{project_path}/spec/support/capybara.rb")
+  end
+
+  it 'adds support file for i18n' do
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  it 'ensures Gemfile contains `rack-mini-profiler`' do
+    gemfile = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile).to include %(gem "rack-mini-profiler", require: false)
+  end
+
+  it 'initializes ActiveJob to avoid memory bloat' do
+    expect(File)
+      .to exist("#{project_path}/config/initializers/active_job.rb")
+  end
+
+  it 'creates a rack-mini-profiler initializer' do
+    expect(File)
+      .to exist("#{project_path}/config/initializers/rack_mini_profiler.rb")
+  end
+
+  it 'records pageviews through Google Tag Manager if ENV variable set' do
+    expect(analytics_partial).to include(%(if ENV['GOOGLE_TAG_ID']))
+    expect(analytics_partial).to include(
+      "https://www.googletagmanager.com/ns.html?id=\#{ENV['GOOGLE_TAG_ID']}"
+    )
+  end
+
+  it 'raises on unpermitted parameters in all environments' do
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.action_controller.action_on_unpermitted_parameters = :raise$/
+    )
+  end
+
+  it 'adds explicit quiet_assets configuration' do
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(/^ +config.assets.quiet = true$/)
+  end
+
+  it 'configures public_file_server.headers in production' do
+    expect(production_config).to match(
+      /^ +config.public_file_server.headers = {\n +"Cache-Control" => "public,/
+    )
+  end
+
+  it 'configures production environment to enforce SSL' do
+    expect(production_config).to match(
+      /^ +config.force_ssl = true/
+    )
+  end
+
+  it 'raises on missing translations in development and test' do
+    [development_config, test_config].each do |environment_file|
+      expect(environment_file).to match(
+        /^ +config.action_view.raise_on_missing_translations = true$/
+      )
+    end
+  end
+
+  it 'evaluates en.yml.erb' do
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  it 'configs simple_form' do
+    expect(File).to exist("#{project_path}/config/initializers/simple_form.rb")
+  end
+
+  it 'configs :test email delivery method for development' do
+    expect(development_config)
+      .to match(/^ +config.action_mailer.delivery_method = :file$/)
+  end
+
+  it 'sets action mailer default host and asset host' do
+    config_key = 'config\.action_mailer\.asset_host'
+    config_value =
+      %q{ENV\.fetch\("ASSET_HOST", ENV\.fetch\("APPLICATION_HOST"\)\)}
+    expect(production_config).to match(/#{config_key} = #{config_value}/)
+  end
+
+  it 'uses APPLICATION_HOST, not HOST in the production config' do
+    expect(production_config).to match(/"APPLICATION_HOST"/)
+    expect(production_config).not_to match(/"HOST"/)
+  end
+
+  it 'configures email interceptor in smtp config' do
+    smtp_file = IO.read("#{project_path}/config/smtp.rb")
+    expect(smtp_file)
+      .to match(/RecipientInterceptor.new\(ENV\["EMAIL_RECIPIENTS"\]\)/)
+  end
+
+  it 'configures language in html element' do
+    layout_path = '/app/views/layouts/application.html.slim'
+    layout_file = IO.read("#{project_path}#{layout_path}")
+    expect(layout_file).to match(/html lang="\#{I18n.locale}\"/)
+  end
+
+  it 'configs active job queue adapter' do
+    application_config = IO.read("#{project_path}/config/application.rb")
+
+    expect(application_config).to match(
+      /^ +config.active_job.queue_adapter = :sidekiq$/
+    )
+    expect(test_config).to match(
+      /^ +config.active_job.queue_adapter = :inline$/
+    )
+    expect(File).to exist("#{project_path}/config/sidekiq.yml")
+  end
+
+  it 'configs bullet gem in development' do
+    expect(development_config).to match(/^ +Bullet.enable = true$/)
+    expect(development_config).to match(/^ +Bullet.bullet_logger = true$/)
+    expect(development_config).to match(/^ +Bullet.rails_logger = true$/)
+  end
+
+  it 'configs missing assets to raise in test' do
+    expect(test_config).to match(
+      /^ +config.assets.raise_runtime_errors = true$/
+    )
+  end
+
+  it 'adds spring to binstubs' do
+    expect(File).to exist("#{project_path}/bin/spring")
+
+    bin_stubs = %w[rake rails rspec]
+    bin_stubs.each do |bin_stub|
+      expect(IO.read("#{project_path}/bin/#{bin_stub}")).to match(/spring/)
+    end
+  end
+
+  it 'removes comments and extra newlines from config files' do
+    config_files = [
+      IO.read("#{project_path}/config/application.rb"),
+      IO.read("#{project_path}/config/environment.rb"),
+      development_config,
+      test_config,
+      production_config
+    ]
+
+    config_files.each do |file|
+      expect(file).not_to match(/.*#.*/)
+      expect(file).not_to match(/^$\n/)
+    end
+  end
+
+  it 'copies factories.rb' do
+    expect(File).to exist("#{project_path}/spec/factories.rb")
+  end
+
+  it 'creates review apps setup script' do
+    bin_setup_path = "#{project_path}/bin/setup_review_app"
+    bin_setup = IO.read(bin_setup_path)
+
+    expect(bin_setup).to include(
+      "PARENT_APP_NAME=#{app_name.dasherize}-staging"
+    )
+    expect(bin_setup).to include("APP_NAME=#{app_name.dasherize}-staging-pr-$1")
+    expect(bin_setup)
+      .to include('heroku run rails db:migrate --exit-code --app $APP_NAME')
+    expect(bin_setup).to include('heroku ps:scale worker=1 --app $APP_NAME')
+    expect(bin_setup).to include('heroku restart --app $APP_NAME')
+
+    expect(File.stat(bin_setup_path)).to be_executable
+  end
+
+  it 'creates deploy script' do
+    bin_deploy_path = "#{project_path}/bin/deploy"
+    bin_deploy = IO.read(bin_deploy_path)
+
+    expect(bin_deploy).to include('heroku run rails db:migrate --exit-code')
+    expect(File.stat(bin_deploy_path)).to be_executable
+  end
+
+  it 'creates heroku application manifest file with application name in it' do
+    app_json_file = IO.read("#{project_path}/app.json")
+
+    expect(app_json_file).to match(/"name":"#{app_name.dasherize}"/)
+  end
+
+  def app_name
+    UnderlayTestHelpers::APP_NAME
+  end
+
+  it 'adds high_voltage' do
+    gemfile = IO.read("#{project_path}/Gemfile")
+    expect(gemfile).to match(/high_voltage/)
+  end
+
+  it 'configures flashes' do
+    flashes_path = %w[app assets stylesheets partials _flashes.scss]
+    expect(read_project_file(flashes_path)).to match(/\.flash-alert/m)
+
+    app_css = read_project_file(%w[app assets stylesheets application.scss])
+    expect(app_css).to match(%r{normalize\.css\/normalize\.css/})
+    expect(app_css).to match(%r{partials\/_flashes.scss/})
+  end
+
+  it "doesn't use turbolinks" do
+    app_js = read_project_file(%w[app assets javascripts application.js])
+    expect(app_js).not_to match(/turbolinks/)
+  end
+
+  it 'configures Timecop safe mode' do
+    spec_helper = read_project_file(%w[spec spec_helper.rb])
+    expect(spec_helper).to match(/Timecop.safe_mode = true/)
+  end
+
+  def development_config
+    @development_config ||=
+      read_project_file %w[config environments development.rb]
+  end
+
+  def test_config
+    @test_config ||= read_project_file %w[config environments test.rb]
+  end
+
+  def production_config
+    @production_config ||=
+      read_project_file %w[config environments production.rb]
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.slim")
+  end
+
+  def read_project_file(path)
+    IO.read(File.join(project_path, *path))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+require(Pathname.new(__FILE__).dirname + '../lib/underlay').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include UnderlayTestHelpers
+
+  config.before(:all) do
+    add_fakes_to_path
+    create_tmp_directory
+  end
+
+  config.before(:each) do
+    FakeGithub.clear!
+  end
+end

data/spec/support/fake_github.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class FakeGithub
+  RECORDER = File.expand_path(
+    File.join('..', '..', 'tmp', 'hub_commands'),
+    File.dirname(__FILE__)
+  )
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    File.open(RECORDER, 'a') do |file|
+      file.write @args.join(' ')
+    end
+  end
+
+  def self.clear!
+    FileUtils.rm_rf RECORDER
+  end
+
+  def self.has_created_repo?(repo_name)
+    File.read(RECORDER) == "create #{repo_name}"
+  end
+end

data/spec/support/fake_heroku.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class FakeHeroku
+  RECORDER = File.expand_path(
+    File.join('..', '..', 'tmp', 'heroku_commands'),
+    File.dirname(__FILE__)
+  )
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    if @args.first == 'help'
+      puts 'pipelines      #  manage collections of apps in pipelines'
+    end
+    File.open(RECORDER, 'a') do |file|
+      file.puts @args.join(' ')
+    end
+  end
+
+  def self.clear!
+    FileUtils.rm_rf RECORDER
+  end
+
+  def self.has_gem_included?(project_path, gem_name)
+    gemfile = File.open(File.join(project_path, 'Gemfile'), 'a')
+
+    File.foreach(gemfile).any? do |line|
+      line.match(/#{Regexp.quote(gem_name)}/)
+    end
+  end
+
+  def self.has_created_app_for?(environment, flags = nil)
+    app_name = "#{UnderlayTestHelpers::APP_NAME.dasherize}-#{environment}"
+
+    command = if flags
+                "create #{app_name} #{flags} --remote #{environment}\n"
+              else
+                "create #{app_name} --remote #{environment}\n"
+              end
+
+    File.foreach(RECORDER).any? { |line| line == command }
+  end
+
+  def self.has_configured_vars?(remote_name, var)
+    commands_ran =~ /^config:add #{var}=.+ --remote #{remote_name}\n/
+  end
+
+  def self.has_setup_pipeline_for?(app_name)
+    commands_ran =~ /^pipelines:create #{app_name} -a #{app_name}-staging --stage staging/ &&
+      commands_ran =~ /^pipelines:add #{app_name} -a #{app_name}-production --stage production/
+  end
+
+  def self.commands_ran
+    @commands_ran ||= File.read(RECORDER)
+  end
+end

data/spec/support/underlay.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module UnderlayTestHelpers
+  APP_NAME = 'dummy_app'
+
+  def remove_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+
+  def create_tmp_directory
+    FileUtils.mkdir_p(tmp_path)
+  end
+
+  def run_underlay(arguments = nil)
+    arguments = "--path=#{root_path} #{arguments}"
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        add_fakes_to_path
+        `
+          #{underlay_bin} #{APP_NAME} #{arguments}
+        `
+        Dir.chdir(APP_NAME) do
+          with_env('HOME', tmp_path) do
+            `git add .`
+            `git commit -m 'Initial commit'`
+          end
+        end
+      end
+    end
+  end
+
+  def underlay_help_command
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        `
+          #{underlay_bin} -h
+        `
+      end
+    end
+  end
+
+  def setup_app_dependencies
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `bundle check || bundle install`
+        end
+      end
+    end
+  end
+
+  def drop_dummy_database
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `rails db:drop`
+        end
+      end
+    end
+  end
+
+  def add_fakes_to_path
+    ENV['PATH'] = "#{support_bin}:#{ENV['PATH']}"
+  end
+
+  def project_path
+    @project_path ||= Pathname.new("#{tmp_path}/#{APP_NAME}")
+  end
+
+  def usage_file
+    @usage_file ||= File.join(root_path, 'USAGE')
+  end
+
+  private
+
+  def tmp_path
+    @tmp_path ||= Pathname.new("#{root_path}/tmp")
+  end
+
+  def underlay_bin
+    File.join(root_path, 'bin', 'underlay')
+  end
+
+  def support_bin
+    File.join(root_path, 'spec', 'fakes', 'bin')
+  end
+
+  def root_path
+    File.expand_path('../..', __dir__)
+  end
+
+  def with_env(name, new_value)
+    prior = ENV[name]
+    ENV[name] = new_value.to_s
+
+    yield
+  ensure
+    ENV[name] = prior
+  end
+end

data/templates/Gemfile.erb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+ruby '<%= Underlay::RUBY_VERSION %>'
+
+<% unless options[:api] -%>
+  gem 'autoprefixer-rails'
+  gem 'flutie'
+  gem 'jquery-rails'
+  gem 'sass-rails', '~> 5.0'
+  gem 'simple_form'
+  gem 'slim'
+  gem 'sprockets', '>= 3.0.0'
+  gem 'uglifier'
+<% end -%>
+gem 'figaro'
+gem 'lograge'
+gem 'pg'
+gem 'puma'
+gem 'rack-canonical-host'
+gem 'rails', '<%= Underlay::RAILS_VERSION %>'
+gem 'recipient_interceptor'
+gem 'sentry-raven'
+gem 'sidekiq'
+gem 'skylight'
+<% if options[:twilio_base] -%>
+  gem 'twilio_base', '~> 0.3.7', git: 'https://github.com/DVELP/twilio_base'
+<% end -%>
+<% if options[:webpack] %>
+  gem 'webpacker'
+<% end -%>
+
+group :development do
+  gem 'listen'
+  gem 'rack-mini-profiler', require: false
+  gem 'spring'
+  gem 'spring-commands-rspec'
+  <% unless options[:api] -%>
+    gem 'web-console'
+  <% end -%>
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'bullet'
+  gem 'bundler-audit', '>= 0.5.0', require: false
+  gem 'factory_bot_rails'
+  gem 'pry-byebug'
+  gem 'pry-rails'
+  gem 'rspec-rails', '~> 3.6'
+  gem 'rubocop', require: false
+  <% unless options[:api] -%>
+    gem 'scss_lint', require: false
+    gem 'slim_lint', require: false
+  <% end -%>
+end
+
+group :test do
+  <% unless options[:api] %>
+    gem 'capybara'
+    gem 'formulaic'
+    gem 'phantomjs'
+    gem 'poltergeist'
+  <% end -%>
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'shoulda-matchers'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :production do
+  gem 'rack-timeout'
+end

data/templates/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec puma -p $PORT -C ./config/puma.rb
+worker: bundle exec sidekiq -v

data/templates/README.md.erb

@@ -0,0 +1,21 @@
+# <%= app_name.humanize %>
+
+## Getting Started
+Run the setup script to install dependencies and get the app running on your machine
+:
+    % ./bin/setup
+
+After setting up, you can run the application using [Heroku Local]:
+
+    % heroku local
+
+Learn more about [Heroku Local](https://devcenter.heroku.com/articles/heroku-local)
+
+## Guidelines
+Use the following guide for programming well, programming in style and getting things done:
+
+* [DVELP Cookbook](https://github.com/DVELP/cookbook)
+
+## Specs & Linting
+CI is setup to run both linting and rspec. To avoid unnecessary delay with code
+reviews ensure you run `bin/rake` before raising a pull request.

data/templates/_analytics.html.slim

@@ -0,0 +1,10 @@
+- if ENV['GOOGLE_TAG_ID']
+  /! Google Tag Manager (noscript)
+  noscript
+    iframe{
+      src="https://www.googletagmanager.com/ns.html?id=#{ENV['GOOGLE_TAG_ID'}"
+      height="0"
+      width="0"
+      style="display:none;visibility:hidden"
+    }
+  /! End Google Tag Manager (noscript)

data/templates/_css_overrides.html.slim

@@ -0,0 +1,5 @@
+- if Rails.env.test?
+  style type="text/css"
+    * {
+      transition-property: none !important;
+    }

data/templates/_flashes.html.slim

@@ -0,0 +1,8 @@
+- if user_facing_flashes.any?
+  .notification-wrap
+    - user_facing_flashes.each do |alert_type, msg|
+      .notification class=(alert_type + ' js-flash-alert')
+        .notification-body
+          = msg
+          = link_to(sprite_tag('cross', class: 'svgIcon'), '#',
+            class: 'notification-close js-flash-alert-close')

data/templates/_flashes.scss

@@ -0,0 +1,21 @@
+.flash-alert {
+  border-radius: 5px;
+  height: 60px;
+  margin: rem-calc(20 0);
+  position: relative;
+  transition: height 0.8s ease, opacity 0.4s ease;
+}
+.flash-alert.is-transparent {
+  height: 0;
+  margin: 0;
+  opacity: 0;
+}
+.flash-alert p {
+  padding: rem-calc(20);
+}
+.flash-alert-close {
+  cursor: pointer;
+  position: absolute;
+  right: rem-calc(35);
+  top: rem-calc(20);
+}

data/templates/_javascript.html.slim

@@ -0,0 +1,10 @@
+= javascript_include_tag :application
+
+= yield :javascript
+
+= render "analytics"
+
+- if Rails.env.test?
+  = javascript_tag do
+    $.fx.off = true;
+    $.ajaxSetup({ async: false });

data/templates/action_mailer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end