code42template 2.0.0

data/spec/features/new_project_spec.rb

@@ -0,0 +1,186 @@
+require "spec_helper"
+
+RSpec.describe "Create a new project with default configuration" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    run_code42template
+  end
+
+  it "uses custom Gemfile" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile_file).to match(
+      /^ruby "#{Code42Template::RUBY_VERSION}"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "rails", "#{Code42Template::RAILS_VERSION}"$/,
+    )
+  end
+
+  it "ensures project specs pass" do
+    copy_file 'smoke_test.rb', 'spec/models/smoke_test_spec.rb'
+    copy_file 'feature_smoke_test.rb', 'spec/models/feature_smoke_spec.rb'
+    copy_file 'routes.rb', 'config/routes.rb'
+    copy_file 'home_controller.rb', 'app/controllers/home_controller.rb'
+    copy_file 'index.html.erb', 'app/views/home/index.html.erb'
+
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake health`).to include(
+          '3 examples, 0 failures', # rspec
+          'LOC (100.0%) covered.', # simplecov
+          'no offenses detected', # rubocop
+          'Security Warnings | 0', # brakeman
+          'No vulnerabilities found', # bundler-audit
+          '1 passing', # mocha
+          'TOTAL: 1 SUCCESS' # karma
+        )
+      end
+    end
+  end
+
+  it "creates .ruby-version from template's .ruby-version" do
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  it "copies dotfiles" do
+    %w[.env .rspec .codeclimate.yml].each do |dotfile|
+      expect(File).to exist("#{project_path}/#{dotfile}")
+    end
+  end
+
+  it 'copies rspec configuration' do
+    %w[spec_helper.rb rails_helper.rb].each do |spec_config|
+      expect(File).to exist(file_path("spec/#{spec_config}"))
+    end
+  end
+
+  it 'copies NPM and javascript files' do
+    %w[
+      config/karma.conf.js
+      config/webpack.config.js
+      config/webpack.config.test.js
+      config/webpack.config.test.browser.js
+      spec/javascripts/index.browser.js
+      spec/javascripts/index.integration.js
+      spec/javascripts/unit/smoke.spec.js
+      package.json
+      Procfile
+      mocha-webpack.opts
+    ].each do |file|
+      expect(File).to exist(file_path(file))
+    end
+  end
+
+  it 'copies health task and continuous integration setup' do
+    expect(File).to exist(file_path('lib/tasks/health.rake'))
+    expect(File).to exist(file_path('.travis.yml'))
+  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 'sets action dispatch show exceptions to true in test env' do
+    test_config = read_file('config/environments/test.rb')
+
+    expect(test_config).to match(
+      /config.action_dispatch.show_exceptions.*=.*true/
+    )
+    expect(test_config).not_to match(
+      /config.action_dispatch.show_exceptions.*=.*false/
+    )
+  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 "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 "configs bullet gem in development" do
+    test_config = IO.read("#{project_path}/config/environments/development.rb")
+
+    expect(test_config).to match /^ +Bullet.enable = true$/
+    expect(test_config).to match /^ +Bullet.bullet_logger = true$/
+    expect(test_config).to match /^ +Bullet.rails_logger = true$/
+  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(
+      "heroku run rake db:migrate --exit-code "\
+      "--app #{app_name.dasherize}-staging-pr-$1"
+    )
+    expect(bin_setup).to include(
+      "heroku ps:scale worker=1 "\
+      "--app #{app_name.dasherize}-staging-pr-$1"
+    )
+    expect(bin_setup).to include(
+      "heroku restart "\
+      "--app #{app_name.dasherize}-staging-pr-$1"
+    )
+    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 rake db:migrate --exit-code")
+    expect(File.stat(bin_deploy_path)).to be_executable
+  end
+
+  it "sets up heroku specific gems" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile_file).to include %{gem 'rails_12factor'}
+  end
+
+  def app_name
+    Code42TemplateTestHelpers::APP_NAME
+  end
+
+  def read_file(path)
+    IO.read(file_path(path))
+  end
+
+  def file_path(path)
+    File.join(project_path, path)
+  end
+
+  def copy_file(source_fixture_name, destination_path)
+    source_path = Pathname(__dir__).join('..', 'fixtures', source_fixture_name)
+    destination_path = Pathname(project_path).join(destination_path)
+    destination_dir = destination_path.join('..')
+    FileUtils.mkdir_p(destination_dir) unless destination_dir.exist?
+
+    FileUtils.cp(source_path, destination_path)
+  end
+end

data/spec/fixtures/feature_smoke_test.rb

@@ -0,0 +1,15 @@
+require 'feature_helper'
+
+RSpec.feature 'feature smoke test' do
+  it 'works with js', js: true do
+    visit '/'
+
+    expect(page).to have_content('It works!')
+  end
+
+  it 'works without js' do
+    visit '/'
+
+    expect(page).to have_content('It works!')
+  end
+end

data/spec/fixtures/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/spec/fixtures/index.html.erb

@@ -0,0 +1 @@
+<p>It works!</p>

data/spec/fixtures/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root to: 'home#index'
+end

data/spec/fixtures/smoke_test.rb

@@ -0,0 +1,10 @@
+require 'rails_helper'
+
+RSpec.describe 'rails_helper smoke test' do
+  it 'is configured correctly' do
+    expect(Rails.env).to be_test
+    expect(RSpec.configuration.use_transactional_fixtures).to eq true
+    expect(Capybara.javascript_driver).to eq :poltergeist
+    expect(Capybara.default_driver).to eq :rack_test
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+require (Pathname.new(__FILE__).dirname + '../lib/code42template').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include Code42TemplateTestHelpers
+
+  config.before(:all) do
+    add_fakes_to_path
+    create_tmp_directory
+  end
+end

data/spec/support/code42template.rb

@@ -0,0 +1,83 @@
+module Code42TemplateTestHelpers
+  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_code42template(arguments = nil)
+    arguments = "--path=#{root_path} #{arguments}"
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        add_fakes_to_path
+        `
+          #{code42template_bin} #{APP_NAME} #{arguments}
+        `
+      end
+    end
+  end
+
+  def code42template_help_command
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        `
+          #{code42template_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
+          `rake 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_path ||= File.join(root_path, "USAGE")
+  end
+
+  private
+
+  def tmp_path
+    @tmp_path ||= Pathname.new("#{root_path}/tmp")
+  end
+
+  def code42template_bin
+    File.join(root_path, 'bin', 'code42template')
+  end
+
+  def support_bin
+    File.join(root_path, "spec", "fakes", "bin")
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/spec/support/fake_heroku.rb

@@ -0,0 +1,83 @@
+require 'pathname'
+
+class FakeHeroku
+  RECORDER = Pathname(__dir__).join('..', '..', 'tmp', 'heroku_commands')
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    if @args.first == "plugins"
+      puts "heroku-pipelines@0.29.0"
+    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_configured_buildpacks_sequentially?(environment, buildpack_urls)
+    lines = commands_ran.each_line.grep(
+      /.*buildpacks:(add|clear).*#{environment}.*/
+    )
+    app_name = app_name_for(environment)
+
+    if lines.shift !~ /^buildpacks:clear -a #{app_name} --remote #{environment}/
+      fail "Expected #{environment} to have cleared buildpacks before "\
+           "adding new ones"
+    end
+
+    if lines.count != buildpack_urls.count
+      fail "Expected #{environment} to have #{buildpack_urls.count} "\
+           "buildpacks configured but has #{lines.count}"
+    end
+
+    lines.zip(buildpack_urls).all? do |line, buildpack_url|
+      line =~ /^buildpacks:add #{buildpack_url} -a #{app_name} --remote #{environment}/
+    end
+  end
+
+  def self.has_created_app_for?(environment, flags = nil)
+    app_name = app_name_for(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, value = '.+')
+    commands_ran =~ /^config:add #{var}=#{value} --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
+  private_class_method :commands_ran
+
+  def self.app_name_for(environment)
+    "#{Code42TemplateTestHelpers::APP_NAME.dasherize}-#{environment}"
+  end
+  private_class_method :app_name_for
+end

data/templates/Gemfile.erb

@@ -0,0 +1,42 @@
+source "https://rubygems.org"
+
+ruby "<%= Code42Template::RUBY_VERSION %>"
+
+gem "pg"
+gem "rails", "<%= Code42Template::RAILS_VERSION %>"
+gem 'puma'
+gem 'rack-mini-profiler'
+gem 'rubocop', require: false
+gem 'webpack-rails'
+gem 'foreman'
+gem 'sidekiq'
+
+group :development do
+  gem "spring"
+  gem "spring-commands-rspec"
+  gem "binding_of_caller"
+  gem "better_errors"
+end
+
+group :development, :test do
+  gem 'brakeman', require: false
+  gem "bullet"
+  gem 'listen'
+  gem "bundler-audit", require: false
+  gem "dotenv-rails"
+  gem "pry-byebug"
+  gem "pry-rails"
+  gem "rspec-rails", "~> 3.5.1"
+end
+
+group :test do
+  gem 'database_cleaner'
+  gem 'capybara'
+  gem 'factory_girl_rails'
+  gem 'simplecov', require: false
+  gem 'poltergeist'
+end
+
+group :staging, :production do
+  gem 'rails_12factor'
+end

data/templates/Procfile

@@ -0,0 +1,3 @@
+rails: bundle exec puma -p $PORT -C ./config/puma.rb
+webpack: ./node_modules/.bin/webpack-dev-server --config config/webpack.config.js
+worker: bundle exec sidekiq -C ./config/sidekiq.yml

data/templates/README.md.erb

@@ -0,0 +1,10 @@
+# <%= app_name.humanize %>
+
+## Getting Started
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+    % ./bin/setup
+
+It assumes you have a machine equipped with Ruby, Postgres, etc.

data/templates/active_job.rb

@@ -0,0 +1 @@
+ActiveJob::Base.queue_adapter = :sidekiq

data/templates/application.js

@@ -0,0 +1 @@
+(() => console.log('I am alive!'))()

data/templates/bin_deploy

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# Run this script to deploy the app to Heroku.
+
+set -e
+
+branch="$(git symbolic-ref HEAD --short)"
+target="${1:-staging}"
+
+git push "$target" "$branch:master"
+heroku run rake db:migrate --exit-code --remote "$target"
+heroku restart --remote "$target"

data/templates/bin_setup

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+# Set up Rails app. Run this script immediately after cloning the codebase.
+# https://github.com/thoughtbot/guides/tree/master/protocol
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+gem install bundler --conservative
+bundle check || bundle install
+
+# Set up database and add any development seed data
+bin/rake dev:prime
+
+# Add binstubs to PATH via export PATH=".git/safe/../../bin:$PATH" in ~/.zshenv
+mkdir -p .git/safe
+
+# Only if this isn't CI
+# if [ -z "$CI" ]; then
+# fi

data/templates/bin_setup_review_app.erb

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# Run this script to set up a review app's database and worker dyno
+
+set -e
+
+if [ -z "$1" ]; then
+  printf "You must provide a review app (same as the pull request) id.\n"
+  exit 64
+fi
+
+heroku pg:backups restore \
+  `heroku pg:backups public-url -a <%= app_name.dasherize %>-staging` \
+  DATABASE_URL \
+  --confirm <%= app_name.dasherize %>-staging-pr-$1 \
+  --app <%= app_name.dasherize %>-staging-pr-$1
+heroku run rake db:migrate --exit-code --app <%= app_name.dasherize %>-staging-pr-$1
+heroku ps:scale worker=1 --app <%= app_name.dasherize %>-staging-pr-$1
+heroku restart --app <%= app_name.dasherize %>-staging-pr-$1

data/templates/code42_gitignore

@@ -0,0 +1,16 @@
+!.keep
+*.DS_Store
+*.swo
+*.swp
+/.bundle
+/.env.local
+/coverage/*
+/db/*.sqlite3
+/log/*
+/public/system
+/public/assets
+/tags
+/tmp/*
+coverage
+node_modules
+public/webpack

data/templates/config_locales_pt-BR.yml.erb

@@ -0,0 +1,17 @@
+pt-BR:
+  date:
+    formats:
+      default:
+        "%d/%m/%Y"
+
+  time:
+    formats:
+      default:
+        "%a, %b %-d, %Y at %r"
+      date:
+        "%b %-d, %Y"
+      short:
+        "%B %d"
+
+  titles:
+    application: <%= app_name.humanize %>

data/templates/dotfiles/.babelrc

@@ -0,0 +1,5 @@
+{
+  "presets": [
+    "es2015"
+  ]
+}

data/templates/dotfiles/.codeclimate.yml

@@ -0,0 +1,3 @@
+languages:
+  Ruby: true
+  JavaScript: true

data/templates/dotfiles/.env

@@ -0,0 +1,8 @@
+ASSET_HOST=localhost:3000
+APPLICATION_HOST=localhost:3000
+PORT=3000
+SECRET_KEY_BASE=development_secret
+SMTP_ADDRESS=smtp.example.com
+SMTP_DOMAIN=example.com
+SMTP_PASSWORD=password
+SMTP_USERNAME=username

data/templates/dotfiles/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/templates/dotfiles/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - Rakefile
+    - db/*
+    - bin/*
+    - config/**/*
+FrozenStringLiteralComment:
+  Enabled: false
+AndOr:
+  Enabled: false
+IfUnlessModifier:
+  Enabled: false
+LeadingCommentSpace:
+  Enabled: false
+StringLiterals:
+  Enabled: false
+SignalException:
+  EnforcedStyle: semantic
+Documentation:
+  Enabled: false

data/templates/feature_helper.rb.erb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+require 'rake'
+
+<%= app_name.camelize %>::Application.load_tasks
+Rake::Task['webpack:compile'].invoke

data/templates/health.rake

@@ -0,0 +1,22 @@
+if Rails.env.development? || Rails.env.test?
+  def run_command(command, env = {})
+    description = "Running '#{command}'"
+    separator = '-' * description.length
+
+    puts '', separator, description, separator, ''
+
+    system(env, command) or fail "There was an error while running '#{command}'"
+  end
+
+  desc 'Checks app health: runs tests, security checks and rubocop'
+  task :health do
+    rails_helper = Rails.root / 'spec/rails_helper.rb'
+
+    run_command "bundle exec rspec -r#{rails_helper}", 'COVERAGE' => 'true'
+    run_command 'npm run test'
+    run_command 'bundle exec bundle-audit update'
+    run_command 'bundle exec bundle-audit check'
+    run_command 'bundle exec brakeman -z'
+    run_command 'bundle exec rubocop'
+  end
+end