jetfuel 1.18.0

data/lib/jetfuel/generators/app_generator.rb

@@ -0,0 +1,227 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Jetfuel
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, :type => :string, :aliases => '-d', :default => 'postgresql',
+      :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :heroku, :type => :boolean, :aliases => '-H', :default => false,
+      :desc => 'Create staging and production Heroku apps'
+
+    class_option :github, :type => :string, :aliases => '-G', :default => nil,
+      :desc => 'Create Github repository and add remote origin pointed to repo'
+
+    class_option :skip_test_unit, :type => :boolean, :aliases => '-T', :default => true,
+      :desc => 'Skip Test::Unit files'
+
+    def finish_template
+      invoke :suspenders_customization
+      super
+    end
+
+    def suspenders_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :setup_secret_token
+      invoke :create_suspenders_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :setup_helpers
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_git
+      invoke :setup_database
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :setup_segment_io
+      invoke :install_leather
+      invoke :setup_devise
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      if options[:heroku]
+        build :setup_heroku_specific_gems
+      end
+
+      bundle_command 'install'
+    end
+
+    def setup_devise
+      say 'Install Devise'
+      build :install_devise
+      build :create_devise_user
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_dev_prime_task
+      build :configure_generators
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :set_up_factory_girl_for_rspec
+      build :generate_rspec
+      build :configure_rspec
+      build :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+      build :configure_travis
+      build :configure_i18n_in_specs
+      build :configure_action_mailer_in_specs
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_newrelic
+      build :configure_smtp
+      build :enable_rack_deflater
+      build :setup_asset_host
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def create_suspenders_views
+      say 'Creating suspenders views'
+      build :create_partials_directory
+      build :create_shared_flashes
+      build :create_shared_javascripts
+      build :create_application_layout
+    end
+
+    def setup_coffeescript
+      say 'Setting up CoffeeScript defaults'
+      build :remove_turbolinks
+      build :add_bootstrap_js
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_time_zone
+      build :configure_time_formats
+      build :configure_rack_timeout
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :setup_default_rake_task
+      build :configure_unicorn
+      build :setup_foreman
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_helpers
+      say 'Set up helpers'
+      build :setup_helpers
+    end
+
+    def install_leather
+      say 'Install Leather'
+      build :install_leather
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say 'Creating Heroku apps'
+        build :create_heroku_apps
+        build :set_heroku_remotes
+        build :set_heroku_rails_secrets
+      end
+    end
+
+    def create_github_repo
+      if !options[:skip_git] && options[:github]
+        say 'Creating Github repo'
+        build :create_github_repo, options[:github]
+      end
+    end
+
+    def setup_segment_io
+      say 'Setting up Segment.io'
+      build :setup_segment_io
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def outro
+      say 'Congratulations! You just pulled our suspenders.'
+      say "Remember to run 'rails generate airbrake' with your API key."
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    protected
+
+    def get_builder_class
+      Suspenders::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/jetfuel/version.rb

@@ -0,0 +1,5 @@
+module Jetfuel
+  RAILS_VERSION = '4.1.1'
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = '1.18.0'
+end

data/lib/jetfuel.rb

@@ -0,0 +1,4 @@
+require 'jetfuel/version'
+require 'jetfuel/generators/app_generator'
+require 'jetfuel/actions'
+require 'jetfuel/app_builder'

data/spec/fakes/bin/heroku

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', '..', 'support', 'fake_heroku'), File.dirname(__FILE__))
+
+FakeHeroku.new(ARGV).run!

data/spec/fakes/bin/hub

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', '..', 'support', 'fake_github'), File.dirname(__FILE__))
+
+FakeGithub.new(ARGV).run!

data/spec/features/github_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+feature 'GitHub' do
+  scenario 'Suspend a project with --github option' do
+    repo_name = 'test'
+    run_suspenders("--github=#{repo_name}")
+
+    expect(FakeGithub).to have_created_repo(repo_name)
+  end
+end

data/spec/features/heroku_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+feature 'Heroku' do
+  scenario 'Suspend a project with --heroku=true' do
+    run_suspenders('--heroku=true')
+
+    expect(FakeHeroku).to have_gem_included(project_path, 'rails_12factor')
+    expect(FakeHeroku).to have_created_app_for('staging')
+    expect(FakeHeroku).to have_created_app_for('production')
+    expect(FakeHeroku).to have_configured_vars('staging', 'SECRET_KEY_BASE')
+    expect(FakeHeroku).to have_configured_vars('production', 'SECRET_KEY_BASE')
+
+    bin_setup = IO.read("#{project_path}/bin/setup")
+    app_name = SuspendersTestHelpers::APP_NAME
+
+    expect(bin_setup).to include("heroku join --app #{app_name}-staging")
+    expect(bin_setup).to include("heroku join --app #{app_name}-production")
+  end
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+feature 'Suspend a new project with default configuration' do
+  scenario 'specs pass' do
+    run_suspenders
+
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake`).to include('0 failures')
+      end
+    end
+  end
+
+  scenario 'staging config is inherited from production' do
+    run_suspenders
+
+    staging_file = IO.read("#{project_path}/config/environments/staging.rb")
+    config_stub = "Rails.application.configure do"
+
+    expect(staging_file).to match(/^require_relative 'production'/)
+    expect(staging_file).to match(/#{config_stub}/), staging_file
+  end
+
+  scenario 'generated .ruby-version is pulled from Suspenders .ruby-version' do
+    run_suspenders
+
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  scenario 'secrets.yml reads secret from env' do
+    run_suspenders
+
+    secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
+    expect(secrets_file).to match(/secret_key_base: <%= ENV\['SECRET_KEY_BASE'\] %>/)
+  end
+
+  scenario 'action mailer support file is added' do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  scenario 'newrelic.yml reads NewRelic license from env' do
+    run_suspenders
+
+    newrelic_file = IO.read("#{project_path}/config/newrelic.yml")
+
+    expect(newrelic_file).to match(
+      /license_key: '<%= ENV\['NEW_RELIC_LICENSE_KEY'\] %>'/
+    )
+  end
+
+  scenario 'records pageviews through Segment.io if ENV variable set' do
+    run_suspenders
+
+    expect(analytics_partial).
+      to include("<% if ENV['SEGMENT_IO_KEY'] %>")
+    expect(analytics_partial).
+      to include("window.analytics.load('<%= ENV['SEGMENT_IO_KEY'] %>');")
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.erb")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'capybara/rspec'
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/jetfuel').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include JetfuelTestHelpers
+
+  config.before(:all) do
+    create_tmp_directory
+  end
+
+  config.before(:each) do
+    drop_dummy_database
+    remove_project_directory
+
+    FakeHeroku.clear!
+    FakeGithub.clear!
+  end
+end

data/spec/support/fake_github.rb

@@ -0,0 +1,21 @@
+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,38 @@
+class FakeHeroku
+  RECORDER = File.expand_path(File.join('..', '..', 'tmp', 'heroku_commands'), File.dirname(__FILE__))
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    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?(remote_name)
+    app_name = "#{SuspendersTestHelpers::APP_NAME}-#{remote_name}"
+    expected_line = "create #{app_name} --remote=#{remote_name}\n"
+
+    File.foreach(RECORDER).any? { |line| line == expected_line }
+  end
+
+  def self.has_configured_vars?(remote_name, var)
+    File.foreach(RECORDER).any? do |line|
+      line =~ /^config:add #{var}=.+ --remote=#{remote_name}\n$/
+    end
+  end
+end

data/spec/support/jetfuel.rb

@@ -0,0 +1,49 @@
+module JetfuelTestHelpers
+  APP_NAME = 'dummy'
+
+  def remove_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+
+  def create_tmp_directory
+    FileUtils.mkdir_p(tmp_path)
+  end
+
+  def run_suspenders(arguments = nil)
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        ENV['TESTING'] = '1'
+
+        %x(#{suspenders_bin} #{APP_NAME} #{arguments})
+      end
+    end
+  end
+
+  def drop_dummy_database
+    if File.exists?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `rake db:drop`
+        end
+      end
+    end
+  end
+
+  def project_path
+    @project_path ||= Pathname.new("#{tmp_path}/#{APP_NAME}")
+  end
+
+  private
+
+  def tmp_path
+    @tmp_path ||= Pathname.new("#{root_path}/tmp")
+  end
+
+  def suspenders_bin
+    File.join(root_path, 'bin', 'suspenders')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/templates/Brewfile

@@ -0,0 +1,2 @@
+install postgres --no-python
+install qt imagemagick

data/templates/Gemfile.erb

@@ -0,0 +1,51 @@
+source 'https://rubygems.org'
+
+ruby '<%= Suspenders::RUBY_VERSION %>'
+
+gem 'airbrake'
+gem 'bourbon', '~> 3.2.1'
+gem 'coffee-rails'
+gem 'delayed_job_active_record'
+gem 'email_validator'
+gem 'flutie'
+gem 'high_voltage'
+gem 'jquery-rails'
+gem 'pg'
+gem 'rack-timeout'
+gem 'rails', '<%= Suspenders::RAILS_VERSION %>'
+gem 'recipient_interceptor'
+gem 'sass-rails', '~> 4.0.3'
+gem 'simple_form'
+gem 'title'
+gem 'uglifier'
+gem 'unicorn'
+gem 'leather'
+gem 'font-awesome-sass'
+
+group :development do
+  gem 'foreman'
+  gem 'spring'
+  gem 'spring-commands-rspec'
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'dotenv-rails'
+  gem 'factory_girl_rails'
+  gem 'pry-rails'
+  gem 'rspec-rails', '~> 2.14.0'
+end
+
+group :test do
+  gem 'capybara-webkit', '>= 1.0.0'
+  gem 'database_cleaner'
+  gem 'formulaic'
+  gem 'launchy'
+  gem 'shoulda-matchers', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :staging, :production do
+  gem 'newrelic_rpm', '>= 3.7.3'
+end

data/templates/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec unicorn -p $PORT -c ./config/unicorn.rb
+worker: bundle exec rake jobs:work

data/templates/README.md.erb

@@ -0,0 +1,25 @@
+<%= app_name.humanize %>
+<%= '=' * app_name.humanize.length %>
+
+Getting Started
+---------------
+
+This repository comes equipped with a self-setup script:
+
+    % ./bin/setup
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+[foreman]: http://ddollar.github.io/foreman/
+
+Guidelines
+----------
+
+Use the following guides for getting things done, programming well, and
+programming in style.
+
+* [Protocol](http://github.com/thoughtbot/guides/blob/master/protocol)
+* [Best Practices](http://github.com/thoughtbot/guides/blob/master/best-practices)
+* [Style](http://github.com/thoughtbot/guides/blob/master/style)

data/templates/_analytics.html.erb

@@ -0,0 +1,7 @@
+<% if ENV['SEGMENT_IO_KEY'] %>
+  <script type="text/javascript">
+    window.analytics=window.analytics||[],window.analytics.methods=["identify","group","track","page","pageview","alias","ready","on","once","off","trackLink","trackForm","trackClick","trackSubmit"],window.analytics.factory=function(t){return function(){var a=Array.prototype.slice.call(arguments);return a.unshift(t),window.analytics.push(a),window.analytics}};for(var i=0;i<window.analytics.methods.length;i++){var key=window.analytics.methods[i];window.analytics[key]=window.analytics.factory(key)}window.analytics.load=function(t){if(!document.getElementById("analytics-js")){var a=document.createElement("script");a.type="text/javascript",a.id="analytics-js",a.async=!0,a.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.io/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n)}},window.analytics.SNIPPET_VERSION="2.0.9",
+    window.analytics.load('<%= ENV['SEGMENT_IO_KEY'] %>');
+    window.analytics.page();
+  </script>
+<% end %>

data/templates/_flashes.html.erb

@@ -0,0 +1,8 @@
+<% [:notice, :error, :alert].each do |level| %>
+  <% unless flash[level].blank? %>
+    <div class="flash alert alert-<%= flash_class(level) %>">
+      <a class="close" href="#" data-dismiss="alert">×</a>
+      <%= content_tag :p, flash[level] %>
+    </div>
+  <% end %>
+<% end %>

data/templates/_javascript.html.erb

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

data/templates/action_mailer.rb

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

data/templates/application.css.scss

@@ -0,0 +1,7 @@
+@charset 'utf-8';
+
+@import 'bourbon';
+@import 'bootstrap_variables';
+@import 'devise';
+@import 'font-awesome';
+@import 'flashes';

data/templates/application_helper.rb

@@ -0,0 +1,9 @@
+module ApplicationHelper
+  def flash_class(level)
+    case level
+    when :notice then "info"
+    when :error then "danger"
+    when :alert then "warning"
+    end
+  end
+end

data/templates/background_jobs_rspec.rb

@@ -0,0 +1,19 @@
+module BackgroundJobs
+  def run_background_jobs_immediately
+    delay_jobs = Delayed::Worker.delay_jobs
+    Delayed::Worker.delay_jobs = false
+    yield
+  ensure
+    Delayed::Worker.delay_jobs = delay_jobs
+  end
+end
+
+RSpec.configure do |config|
+  config.around(:each, type: :feature) do |example|
+    run_background_jobs_immediately do
+      example.run
+    end
+  end
+
+  config.include BackgroundJobs
+end

data/templates/bin_setup

@@ -0,0 +1,32 @@
+#!/usr/bin/env 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
+bundle install
+
+# Set up configurable environment variables
+if [ ! -f .env ]; then
+  cp .sample.env .env
+fi
+
+# Set up database and add any development seed data
+bundle exec rake dev:prime
+
+# Add binstubs to PATH via export PATH=".git/safe/../../bin:$PATH" in ~/.zshenv
+mkdir -p .git/safe
+
+# Pick a port for Foreman
+echo "port: 7000" > .foreman
+
+# Set up DNS via Pow
+if [ -d ~/.pow ]
+then
+  echo 7000 > ~/.pow/`basename $PWD`
+else
+  echo "Pow not set up but the team uses it for this project. Setup: http://goo.gl/RaDPO"
+fi