voyage 1.0

data/lib/voyage/templates/seeder.rb.erb

@@ -0,0 +1,46 @@
+module Seeder
+  extend self
+<% if config[:using_devise] %>
+  def admin_user
+    puts '-----> Creating Admin User'
+
+    # Remove all admins
+    User.admins.destroy_all
+
+    create(:user, :admin)
+  end
+
+  def all_users
+    puts '-----> Resetting to a clean user list with all Users'
+
+    # Remove all users
+    User.destroy_all
+
+    # list user traits from factory_girl here
+    %w(admin another_role).each do |name|
+      create(:user, name.to_sym)
+    end
+  end
+<% else %>
+  # Change 'resource' to something real
+  def seed_resource
+    puts '-----> Creating Resource'
+
+    # Remove all resources
+    Resource.destroy_all
+
+    create(:resource)
+  end
+<% end %>
+end
+
+if Rails.env == 'production'
+  unless ENV['FORCE_SEED']
+    puts
+    puts '================================================================================='
+    puts 'WARNING: You are trying to run db:seed on production. This is a DESTRUCTIVE task.'
+    puts 'If you know what you are doing, you can override by setting environment variable '
+    puts 'FORCE_SEED=1'
+    exit 1
+  end
+end

data/lib/voyage/templates/seeds.rb.erb

@@ -0,0 +1,50 @@
+require 'faker'
+require 'factory_girl_rails'
+include FactoryGirl::Syntax::Methods
+
+# This file should contain all the record creation needed to seed the database
+# with its default values.  The data can then be loaded with the rake db:seed
+# (or created alongside the db with db:setup).
+#
+# For the seeded attribute values, see factories.rb
+
+puts
+puts 'Seeding the database...'
+puts
+
+dev_tables_to_seed =
+  %w(
+    <%= config[:using_devise] ? 'admin_user' : 'factory_name' %>
+  )
+
+production_tables_to_seed =
+  %w(
+    <%= config[:using_devise] ? 'admin_user' : 'factory_name' %>
+  )
+
+test_tables_to_seed = %w()
+
+if ENV['TABLES'].present?
+  # Allow overriding which tables we seed if the TABLES env var is present
+  tables = ENV['TABLES'].to_s.split(',')
+else
+  # Load the tables specified based on the environment
+  tables =
+    case Rails.env
+    when 'production'
+      production_tables_to_seed
+    when 'staging', 'development'
+      dev_tables_to_seed
+    when 'test'
+      test_tables_to_seed
+    else
+      message = 'Error: Rails environment not found. Please check seeds.rb.'
+      fail StandardError.new, message: message
+    end
+end
+
+# raise StandardError.new, message: 'No Tables Specified' if tables.blank?
+
+tables.each do |table_name|
+  eval("Seeder.#{table_name}")
+end

data/lib/voyage/templates/simplecov.rb

@@ -0,0 +1,31 @@
+if ENV['COVERAGE'] =~ /\Atrue\z/i
+  require 'cadre/simplecov'
+
+  SimpleCov.start do
+    add_filter '/.bundle/'
+    add_filter '/spec/'
+    add_filter '/config/'
+    add_group 'Controllers', 'app/controllers'
+    add_group 'Helpers',     'app/helpers'
+    add_group 'Mailers',     'app/mailers'
+    add_group 'Models',      'app/models'
+    add_group 'Serializers', 'app/serializers'
+    add_group 'Services',    'app/services'
+    add_group 'Workers',     'app/workers'
+    add_group 'Libraries',   'lib'
+    add_group 'Long Files' do |src_file|
+      src_file.lines.count > 300
+    end
+    add_group 'Ignored Code' do |src_file|
+      File.readlines(src_file.filename).grep(/:nocov:/).any?
+    end
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    Cadre::SimpleCov::VimFormatter
+  ]
+
+  SimpleCov.minimum_coverage 95
+  SimpleCov.command_name 'Rspec'
+end

data/lib/voyage/templates/users_index.html.slim.erb

@@ -0,0 +1,25 @@
+h1 Listing Users
+
+table
+  thead
+    tr<% if config[:adding_first_and_last_name] %>
+      th First Name
+      th Last Name<% end %>
+      th Email
+      th
+      th
+      th
+
+  tbody
+    - @users.each do |user|
+      tr<% if config[:adding_first_and_last_name] %>
+        td= user.first_name
+        td= user.last_name<% end %>
+        td= user.email
+        td= link_to 'Show', user
+        td= link_to 'Edit', edit_user_path(user)
+        td= link_to 'Destroy', user, data: { confirm: 'Are you sure?' }, method: :delete
+
+br
+
+= link_to 'New User', signup_path

data/lib/voyage/templates/welcome.html.erb

@@ -0,0 +1,11 @@
+<h1>Welcome to Voyage!</h1>
+
+<pre>
+                __
+                \ \___     .__
+              .--""___\..--"/
+          .__.|-"""..... ' /
+  ________\_______________/_________
+</pre>
+
+<%%= Redcarpet::Markdown.new(Redcarpet::Render::HTML.new).render(File.read('README.md')).html_safe %>

data/lib/voyage/version.rb

@@ -0,0 +1,8 @@
+module Voyage
+  RAILS_VERSION = "~> 4.2".freeze
+  RUBY_VERSION = IO.
+    read("#{File.dirname(__FILE__)}/../../.ruby-version").
+    strip.
+    freeze
+  VERSION = '1.0'.freeze
+end

data/spec/adapters/heroku_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+module Suspenders
+  module Adapters
+    RSpec.describe Heroku do
+      it "sets the heroku remotes" do
+        setup_file = "bin/setup"
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:append_file)
+
+        Heroku.new(app_builder).set_heroku_remotes
+
+        expect(app_builder).to have_received(:append_file).
+          with(setup_file, /heroku join --app #{app_name.dasherize}-production/)
+        expect(app_builder).to have_received(:append_file).
+          with(setup_file, /heroku join --app #{app_name.dasherize}-staging/)
+      end
+
+      it "sets the heroku rails secrets" do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+
+        Heroku.new(app_builder).set_heroku_rails_secrets
+
+        expect(app_builder).to(
+          have_configured_var("staging", "SECRET_KEY_BASE"),
+        )
+        expect(app_builder).to(
+          have_configured_var("production", "SECRET_KEY_BASE"),
+        )
+      end
+
+      it "sets the application host" do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+
+        Heroku.new(app_builder).set_heroku_application_host
+
+        expect(app_builder).to(
+          have_configured_var("staging", "APPLICATION_HOST"),
+        )
+
+        expect(app_builder).to(
+          have_configured_var("production", "APPLICATION_HOST"),
+        )
+      end
+
+      def app_name
+        SuspendersTestHelpers::APP_NAME
+      end
+
+      def have_configured_var(remote_name, var)
+        have_received(:run).with(/config:add #{var}=.+ --remote #{remote_name}/)
+      end
+    end
+  end
+end

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/cli_help_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+RSpec.describe "Command line help output" do
+  let(:help_text) { suspenders_help_command }
+
+  it "does not contain the default rails usage statement" do
+    expect(help_text).not_to include("rails new APP_PATH [options]")
+  end
+
+  it "provides the correct usage statement for suspenders" do
+    expect(help_text).to include <<~EOH
+      Usage:
+        suspenders APP_PATH [options]
+    EOH
+  end
+
+  it "does not contain the default rails group" do
+    expect(help_text).not_to include("Rails options:")
+  end
+
+  it "provides help and version usage within the suspenders group" do
+    expect(help_text).to include <<~EOH
+Suspenders options:
+  -h, [--help], [--no-help]        # Show this help message and quit
+  -v, [--version], [--no-version]  # Show Suspenders version number and quit
+EOH
+  end
+
+  it "does not show the default extended rails help section" do
+    expect(help_text).not_to include("Create suspenders files for app generator.")
+  end
+
+  it "contains the usage statement from the suspenders gem" do
+    expect(help_text).to include IO.read(usage_file)
+  end
+end

data/spec/features/github_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+RSpec.describe "GitHub" do
+  before do
+    drop_dummy_database
+    remove_project_directory
+  end
+
+  it "suspends a project with --github option" do
+    repo_name = 'test'
+    run_suspenders("--github=#{repo_name}")
+    setup_app_dependencies
+
+    expect(FakeGithub).to have_created_repo(repo_name)
+  end
+end

data/spec/features/heroku_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+RSpec.describe "Heroku" do
+  context "--heroku" do
+    before(:all) do
+      clean_up
+      run_suspenders("--heroku=true")
+      setup_app_dependencies
+    end
+
+    it "suspends a project for Heroku" do
+      app_name = SuspendersTestHelpers::APP_NAME.dasherize
+
+      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",
+      )
+      expect(FakeHeroku).to have_configured_vars(
+        "staging",
+        "APPLICATION_HOST",
+      )
+      expect(FakeHeroku).to have_configured_vars(
+        "production",
+        "APPLICATION_HOST",
+      )
+      expect(FakeHeroku).to have_setup_pipeline_for(app_name)
+
+      bin_setup_path = "#{project_path}/bin/setup"
+      bin_setup = IO.read(bin_setup_path)
+
+      expect(bin_setup).to include("heroku join --app #{app_name}-production")
+      expect(bin_setup).to include("heroku join --app #{app_name}-staging")
+      expect(bin_setup).to include("git config heroku.remote staging")
+      expect(File.stat(bin_setup_path)).to be_executable
+
+      readme = IO.read("#{project_path}/README.md")
+
+      expect(readme).to include("./bin/deploy staging")
+      expect(readme).to include("./bin/deploy production")
+
+      circle_yml_path = "#{project_path}/circle.yml"
+      circle_yml = IO.read(circle_yml_path)
+
+      expect(circle_yml).to include <<-YML.strip_heredoc
+      deployment:
+        staging:
+          branch: master
+          commands:
+            - bin/deploy staging
+      YML
+    end
+  end
+
+  context "--heroku with region flag" do
+    before(:all) do
+      clean_up
+      run_suspenders(%{--heroku=true --heroku-flags="--region eu"})
+      setup_app_dependencies
+    end
+
+    it "suspends a project with extra Heroku flags" do
+      expect(FakeHeroku).to have_created_app_for("staging", "--region eu")
+      expect(FakeHeroku).to have_created_app_for("production", "--region eu")
+    end
+  end
+
+  def clean_up
+    drop_dummy_database
+    remove_project_directory
+    FakeHeroku.clear!
+  end
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,270 @@
+require "spec_helper"
+
+RSpec.describe "Suspend a new project with default configuration" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    run_suspenders
+    setup_app_dependencies
+  end
+
+  it "uses custom Gemfile" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+    expect(gemfile_file).to match(
+      /^ruby "#{Suspenders::RUBY_VERSION}"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "autoprefixer-rails"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "rails", "#{Suspenders::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 "creates .ruby-version from Suspenders .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[.ctags .env].each do |dotfile|
+      expect(File).to exist("#{project_path}/#{dotfile}")
+    end
+  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-webkit" do
+    expect(File).to exist("#{project_path}/spec/support/capybara_webkit.rb")
+  end
+
+  it "adds support file for i18n" do
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  it "creates good default .hound.yml" do
+    hound_config_file = IO.read("#{project_path}/.hound.yml")
+
+    expect(hound_config_file).to include "enabled: true"
+  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 "ensures .sample.env defaults to RACK_MINI_PROFILER=0" do
+    env = IO.read("#{project_path}/.env")
+
+    expect(env).to include "RACK_MINI_PROFILER=0"
+  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 Segment if ENV variable set" do
+    expect(analytics_partial).
+      to include(%{<% if ENV["SEGMENT_KEY"] %>})
+    expect(analytics_partial).
+      to include(%{window.analytics.load("<%= ENV["SEGMENT_KEY"] %>");})
+  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.quiet_assets = true$/
+    )
+  end
+
+  it "configures static_cache_control in production" do
+    prod_env_file = IO.read("#{project_path}/config/environments/production.rb")
+    expect(prod_env_file).to match(
+      /config.static_cache_control = "public, max-age=.+"/,
+    )
+  end
+
+  it "raises on missing translations in development and test" do
+    %w[development test].each do |environment|
+      environment_file =
+        IO.read("#{project_path}/config/environments/#{environment}.rb")
+      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
+    dev_env_file = IO.read("#{project_path}/config/environments/development.rb")
+    expect(dev_env_file).
+      to match(/^ +config.action_mailer.delivery_method = :file$/)
+  end
+
+  it "uses APPLICATION_HOST, not HOST in the production config" do
+    prod_env_file = IO.read("#{project_path}/config/environments/production.rb")
+    expect(prod_env_file).to match(/"APPLICATION_HOST"/)
+    expect(prod_env_file).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.erb"
+    layout_file = IO.read("#{project_path}#{layout_path}")
+    expect(layout_file).to match(/<html lang="en">/)
+  end
+
+  it "configs active job queue adapter" do
+    application_config = IO.read("#{project_path}/config/application.rb")
+    test_config = IO.read("#{project_path}/config/environments/test.rb")
+
+    expect(application_config).to match(
+      /^ +config.active_job.queue_adapter = :delayed_job$/
+    )
+    expect(test_config).to match(
+      /^ +config.active_job.queue_adapter = :inline$/
+    )
+  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 "configs missing assets to raise in test" do
+    test_config = IO.read("#{project_path}/config/environments/test.rb")
+
+    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"),
+      IO.read("#{project_path}/config/environments/development.rb"),
+      IO.read("#{project_path}/config/environments/production.rb"),
+      IO.read("#{project_path}/config/environments/test.rb"),
+    ]
+
+    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("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 "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
+
+  it "sets up heroku specific gems" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile_file).to include %{gem "rails_stdout_logging"}
+  end
+
+  def app_name
+    SuspendersTestHelpers::APP_NAME
+  end
+
+  it "adds high_voltage" do
+    gemfile = IO.read("#{project_path}/Gemfile")
+    expect(gemfile).to match(/high_voltage/)
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.erb")
+  end
+end