voyage 1.0

data/README.md

@@ -0,0 +1,233 @@
+# Suspenders [![Build Status](https://secure.travis-ci.org/thoughtbot/suspenders.svg?branch=master)](http://travis-ci.org/thoughtbot/suspenders)
+
+Suspenders is the base Rails application used at
+[thoughtbot](https://thoughtbot.com/).
+
+  ![Suspenders boy](http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png)
+
+## Installation
+
+First install the suspenders gem:
+
+    gem install suspenders
+
+Then run:
+
+    suspenders projectname
+
+This will create a Rails app in `projectname` using the latest version of Rails.
+
+### Associated services
+
+* Enable [Circle CI](https://circleci.com/) Continuous Integration
+* Enable [GitHub auto deploys to Heroku staging and review
+    apps](https://dashboard.heroku.com/apps/app-name-staging/deploy/github).
+
+## Gemfile
+
+To see the latest and greatest gems, look at Suspenders'
+[Gemfile](templates/Gemfile.erb), which will be appended to the default
+generated projectname/Gemfile.
+
+It includes application gems like:
+
+* [Autoprefixer Rails](https://github.com/ai/autoprefixer-rails) for CSS vendor prefixes
+* [Bourbon](https://github.com/thoughtbot/bourbon) for Sass mixins
+* [Bitters](https://github.com/thoughtbot/bitters) for scaffold application styles
+* [Delayed Job](https://github.com/collectiveidea/delayed_job) for background
+  processing
+* [Flutie](https://github.com/thoughtbot/flutie) for `page_title` and `body_class` view
+  helpers
+* [High Voltage](https://github.com/thoughtbot/high_voltage) for static pages
+* [Honeybadger](https://honeybadger.io) for exception notification
+* [jQuery Rails](https://github.com/rails/jquery-rails) for jQuery
+* [Neat](https://github.com/thoughtbot/neat) for semantic grids
+* [Normalize](https://necolas.github.io/normalize.css/) for resetting browser styles
+* [Postgres](https://github.com/ged/ruby-pg) for access to the Postgres database
+* [Rack Canonical Host](https://github.com/tylerhunt/rack-canonical-host) to
+  ensure all requests are served from the same domain
+* [Rack Timeout](https://github.com/heroku/rack-timeout) to abort requests that are
+  taking too long
+* [Recipient Interceptor](https://github.com/croaky/recipient_interceptor) to
+  avoid accidentally sending emails to real people from staging
+* [Refills](https://github.com/thoughtbot/refills) for “copy-paste” components
+  and patterns based on Bourbon, Neat and Bitters
+* [Simple Form](https://github.com/plataformatec/simple_form) for form markup
+  and style
+* [Skylight](https://www.skylight.io/) for monitoring performance
+* [Title](https://github.com/calebthompson/title) for storing titles in
+  translations
+* [Puma](https://github.com/puma/puma) to serve HTTP requests
+
+And development gems like:
+
+* [Dotenv](https://github.com/bkeepers/dotenv) for loading environment variables
+* [Pry Rails](https://github.com/rweng/pry-rails) for interactively exploring
+  objects
+* [ByeBug](https://github.com/deivid-rodriguez/byebug) for interactively
+  debugging behavior
+* [Bullet](https://github.com/flyerhzm/bullet) for help to kill N+1 queries and
+  unused eager loading
+* [Bundler Audit](https://github.com/rubysec/bundler-audit) for scanning the
+  Gemfile for insecure dependencies based on published CVEs
+* [Spring](https://github.com/rails/spring) for fast Rails actions via
+  pre-loading
+* [Web Console](https://github.com/rails/web-console) for better debugging via
+  in-browser IRB consoles.
+* [Quiet Assets](https://github.com/evrone/quiet_assets) for muting assets
+  pipeline log messages
+
+And testing gems like:
+
+* [Capybara](https://github.com/jnicklas/capybara) and
+  [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for
+  integration testing
+* [Factory Girl](https://github.com/thoughtbot/factory_girl) for test data
+* [Formulaic](https://github.com/thoughtbot/formulaic) for integration testing
+  HTML forms
+* [RSpec](https://github.com/rspec/rspec) for unit testing
+* [RSpec Mocks](https://github.com/rspec/rspec-mocks) for stubbing and spying
+* [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) for common
+  RSpec matchers
+* [Timecop](https://github.com/ferndopolis/timecop-console) for testing time
+
+## Other goodies
+
+Suspenders also comes with:
+
+* The [`./bin/setup`][setup] convention for new developer setup
+* The `./bin/deploy` convention for deploying to Heroku
+* Rails' flashes set up and in application layout
+* A few nice time formats set up for localization
+* `Rack::Deflater` to [compress responses with Gzip][compress]
+* A [low database connection pool limit][pool]
+* [Safe binstubs][binstub]
+* [t() and l() in specs without prefixing with I18n][i18n]
+* An automatically-created `SECRET_KEY_BASE` environment variable in all
+  environments
+* Configuration for [CircleCI][circle] Continuous Integration (tests)
+* Configuration for [Hound][hound] Continuous Integration (style)
+* The analytics adapter [Segment][segment] (and therefore config for Google
+  Analytics, Intercom, Facebook Ads, Twitter Ads, etc.)
+
+[setup]: https://robots.thoughtbot.com/bin-setup
+[compress]: https://robots.thoughtbot.com/content-compression-with-rack-deflater
+[pool]: https://devcenter.heroku.com/articles/concurrency-and-database-connections
+[binstub]: https://github.com/thoughtbot/suspenders/pull/282
+[i18n]: https://github.com/thoughtbot/suspenders/pull/304
+[circle]: https://circleci.com/docs
+[hound]: https://houndci.com
+[segment]: https://segment.com
+
+## Heroku
+
+You can optionally create Heroku staging and production apps:
+
+    suspenders app --heroku true
+
+This:
+
+* Creates a staging and production Heroku app
+* Sets them as `staging` and `production` Git remotes
+* Configures staging with `RACK_ENV` environment variable set
+  to `staging`
+* Adds the [Rails Stdout Logging][logging-gem] gem
+  to configure the app to log to standard out,
+  which is how [Heroku's logging][heroku-logging] works.
+* Creates a [Heroku Pipeline] for review apps
+
+[logging-gem]: https://github.com/heroku/rails_stdout_logging
+[heroku-logging]: https://devcenter.heroku.com/articles/logging#writing-to-your-log
+[Heroku Pipeline]: https://devcenter.heroku.com/articles/pipelines
+
+You can optionally specify alternate Heroku flags:
+
+    suspenders app \
+      --heroku true \
+      --heroku-flags "--region eu --addons sendgrid,ssl"
+
+See all possible Heroku flags:
+
+    heroku help create
+
+## Git
+
+This will initialize a new git repository for your Rails app. You can
+bypass this with the `--skip-git` option:
+
+    suspenders app --skip-git true
+
+## GitHub
+
+You can optionally create a GitHub repository for the suspended Rails app. It
+requires that you have [Hub](https://github.com/github/hub) on your system:
+
+    curl http://hub.github.com/standalone -sLo ~/bin/hub && chmod +x ~/bin/hub
+    suspenders app --github organization/project
+
+This has the same effect as running:
+
+    hub create organization/project
+
+## Spring
+
+Suspenders uses [spring](https://github.com/rails/spring) by default.
+It makes Rails applications load faster, but it might introduce confusing issues
+around stale code not being refreshed.
+If you think your application is running old code, run `spring stop`.
+And if you'd rather not use spring, add `DISABLE_SPRING=1` to your login file.
+
+## Dependencies
+
+Suspenders requires the latest version of Ruby.
+
+Some gems included in Suspenders have native extensions. You should have GCC
+installed on your machine before generating an app with Suspenders.
+
+Use [OS X GCC Installer](https://github.com/kennethreitz/osx-gcc-installer/) for
+Snow Leopard (OS X 10.6).
+
+Use [Command Line Tools for XCode](https://developer.apple.com/downloads/index.action)
+for Lion (OS X 10.7) or Mountain Lion (OS X 10.8).
+
+We use [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for
+full-stack JavaScript integration testing. It requires QT. Instructions for
+installing QT are
+[here](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit).
+
+PostgreSQL needs to be installed and running for the `db:create` rake task.
+
+## Issues
+
+If you have problems, please create a
+[GitHub Issue](https://github.com/thoughtbot/suspenders/issues).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+Thank you, [contributors]!
+
+[contributors]: https://github.com/thoughtbot/suspenders/graphs/contributors
+
+## License
+
+Suspenders is Copyright © 2008-2016 thoughtbot.
+It is free software,
+and may be redistributed under the terms specified in the [LICENSE] file.
+
+[LICENSE]: LICENSE
+
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/logo.png)
+
+Suspenders is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com?utm_source=github

data/RELEASING.md

@@ -0,0 +1,19 @@
+# Releasing
+
+1. Update `lib/suspenders/version.rb` file accordingly.
+2. Update `NEWS.md` to reflect the changes since last release.
+3. Commit changes. There shouldn't be code changes, and thus CI doesn't need to
+   run, you can then add `[ci skip]` to the commit message.
+4. Tag the release: `git tag vVERSION -a`. The tag message should contain the
+   appropriate `NEWS.md` subsection.
+5. Push changes: `git push --tags`
+6. Build and publish to rubygems:
+   ```bash
+   gem build suspenders.gemspec
+   gem push suspenders-*.gem
+   ```
+
+7. Add a new GitHub release:
+   https://github.com/thoughtbot/suspenders/releases/new?tag=vVERSION
+8. Announce the new release, making sure to say "thank you" to the contributors
+   who helped shape this version!

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+desc 'Run the test suite'
+task :default => :rspec

data/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Suspenders is a Rails template with thoughtbot standard
+    defaults, ready to deploy to Heroku.
+
+    For full details on the changes we've made compared to
+    a vanilla Rails app, check our GitHub project:
+        https://github.com/thoughtbot/suspenders
+
+Example:
+    suspenders ~/Code/weblog
+
+    This generates a Rails installation in ~/Code/weblog configured
+    with our preferred defaults.

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# Run this script immediately after cloning the codebase.
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Add binstubs to PATH in ~/.zshenv like this:
+#   export PATH=".git/safe/../../bin:$PATH"
+mkdir -p .git/safe

data/bin/suspenders

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'suspenders'
+
+if ARGV.empty?
+  puts "Please provide a path for the new application"
+  puts
+  puts "See --help for more info"
+  exit 0
+elsif ['-v', '--version'].include? ARGV[0]
+  puts Suspenders::VERSION
+  exit 0
+end
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Suspenders::AppGenerator.source_root templates_root
+Suspenders::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Suspenders::AppGenerator.start

data/bin/voyage

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'suspenders'
+require 'voyage'
+
+if ['-v', '--version'].include? ARGV[0]
+  puts Voyage::VERSION
+  exit 0
+end
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+template_additions = File.expand_path(File.join("..", "lib/voyage/templates"), File.dirname(__FILE__))
+Suspenders::AppGenerator.source_root templates_root
+Suspenders::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << template_additions << templates_root
+
+Suspenders::AppGenerator.start

data/lib/suspenders.rb

@@ -0,0 +1,6 @@
+require 'suspenders/version'
+require 'suspenders/generators/app_generator'
+require 'suspenders/generators/static_generator'
+require 'suspenders/actions'
+require "suspenders/adapters/heroku"
+require 'suspenders/app_builder'

data/lib/suspenders/actions.rb

@@ -0,0 +1,33 @@
+module Suspenders
+  module Actions
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      unless contents.gsub!(find, replace)
+        raise "#{find.inspect} not found in #{relative_path}"
+      end
+      File.open(path, "w") { |file| file.write(contents) }
+    end
+
+    def action_mailer_host(rails_env, host)
+      config = "config.action_mailer.default_url_options = { host: #{host} }"
+      configure_environment(rails_env, config)
+    end
+
+    def configure_application_file(config)
+      inject_into_file(
+        "config/application.rb",
+        "\n\n    #{config}",
+        before: "\n  end"
+      )
+    end
+
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  #{config}",
+        before: "\nend"
+      )
+    end
+  end
+end

data/lib/suspenders/adapters/heroku.rb

@@ -0,0 +1,127 @@
+module Suspenders
+  module Adapters
+    class Heroku
+      def initialize(app_builder)
+        @app_builder = app_builder
+      end
+
+      def set_heroku_remotes
+        remotes = <<-SHELL.strip_heredoc
+          #{command_to_join_heroku_app('staging')}
+          #{command_to_join_heroku_app('production')}
+
+          git config heroku.remote staging
+        SHELL
+
+        app_builder.append_file "bin/setup", remotes
+      end
+
+      def create_staging_heroku_app(flags)
+        app_name = heroku_app_name_for("staging")
+
+        run_toolbelt_command "create #{app_name} #{flags}", "staging"
+      end
+
+      def create_production_heroku_app(flags)
+        app_name = heroku_app_name_for("production")
+
+        run_toolbelt_command "create #{app_name} #{flags}", "production"
+      end
+
+      def set_heroku_rails_secrets
+        %w(staging production).each do |environment|
+          run_toolbelt_command(
+            "config:add SECRET_KEY_BASE=#{generate_secret}",
+            environment,
+          )
+        end
+      end
+
+      def create_review_apps_setup_script
+        app_builder.template(
+          "bin_setup_review_app.erb",
+          "bin/setup_review_app",
+          force: true,
+        )
+        app_builder.run "chmod a+x bin/setup_review_app"
+      end
+
+      def create_heroku_application_manifest_file
+        app_builder.template "app.json.erb", "app.json"
+      end
+
+      def create_heroku_pipeline
+        pipelines_plugin = `heroku plugins | grep pipelines`
+        if pipelines_plugin.empty?
+          puts "You need heroku pipelines plugin. Run: heroku plugins:install heroku-pipelines"
+          exit 1
+        end
+
+        run_toolbelt_command(
+          "pipelines:create #{heroku_app_name} \
+            -a #{heroku_app_name}-staging --stage staging",
+          "staging",
+        )
+
+        run_toolbelt_command(
+          "pipelines:add #{heroku_app_name} \
+            -a #{heroku_app_name}-production --stage production",
+          "production",
+        )
+      end
+
+      def set_heroku_serve_static_files
+        %w(staging production).each do |environment|
+          run_toolbelt_command(
+            "config:add RAILS_SERVE_STATIC_FILES=true",
+            environment,
+          )
+        end
+      end
+
+      def set_heroku_application_host
+        %w(staging production).each do |environment|
+          run_toolbelt_command(
+            "config:add APPLICATION_HOST=#{heroku_app_name}-#{environment}.herokuapp.com",
+            environment,
+          )
+        end
+      end
+
+      private
+
+      attr_reader :app_builder
+
+      def command_to_join_heroku_app(environment)
+        heroku_app_name = heroku_app_name_for(environment)
+        <<-SHELL
+
+if heroku join --app #{heroku_app_name} &> /dev/null; then
+  git remote add #{environment} git@heroku.com:#{heroku_app_name}.git || true
+  printf 'You are a collaborator on the "#{heroku_app_name}" Heroku app\n'
+else
+  printf 'Ask for access to the "#{heroku_app_name}" Heroku app\n'
+fi
+        SHELL
+      end
+
+      def heroku_app_name
+        app_builder.app_name.dasherize
+      end
+
+      def heroku_app_name_for(environment)
+        "#{heroku_app_name}-#{environment}"
+      end
+
+      def generate_secret
+        SecureRandom.hex(64)
+      end
+
+      def run_toolbelt_command(command, environment)
+        app_builder.run(
+          "heroku #{command} --remote #{environment}",
+        )
+      end
+    end
+  end
+end