hitfox-suspenders 1.0.0

data/spec/features/new_project_spec.rb

@@ -0,0 +1,108 @@
+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 "i18n support file is added" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  scenario "raises on unpermitted parameters in all environments" do
+    run_suspenders
+
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.action_controller.action_on_unpermitted_parameters = :raise$/
+    )
+  end
+
+  scenario "raises on missing translations in development and test" do
+    run_suspenders
+
+    %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
+
+  scenario "specs for missing or unused translations" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/i18n_spec.rb")
+  end
+
+  scenario "config file for i18n tasks" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/config/i18n-tasks.yml")
+  end
+
+  scenario "generated en.yml is evaluated" do
+    run_suspenders
+
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+    app_name = SuspendersTestHelpers::APP_NAME
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  scenario "config simple_form" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/config/initializers/simple_form.rb")
+  end
+
+  scenario "config :test email delivery method for development" do
+    run_suspenders
+
+    dev_env_file = IO.read("#{project_path}/config/environments/development.rb")
+    expect(dev_env_file).
+      to match(/^ +config.action_mailer.delivery_method = :test$/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'capybara/rspec'
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/suspenders').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include SuspendersTestHelpers
+
+  config.before(:all) do
+    create_tmp_directory
+  end
+
+  config.before(:each) do
+    drop_dummy_database
+    remove_project_directory
+
+    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/suspenders.rb

@@ -0,0 +1,49 @@
+module SuspendersTestHelpers
+  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_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.exist?(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', 'hitfox-suspenders')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/suspenders.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'suspenders/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= #{Suspenders::RUBY_VERSION}"
+  s.authors = ['thoughtbot', 'hitfox']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+Suspenders is a base Rails project that includes the gems we like to
+use at Hitfox. This is our fork of the Thoughtbot's original suspenders
+gem.
+  HERE
+
+  s.email = 'demitry.toumilovich@hitfoxgroup.com'
+  s.executables = ['hitfox-suspenders']
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/HitFox/hitfox-suspenders'
+  s.license = 'MIT'
+  s.name = 'hitfox-suspenders'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using Hitfox's best practices."
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Suspenders::VERSION
+
+  s.add_dependency 'bitters', '~> 1.0.0'
+  s.add_dependency 'bundler', '~> 1.3'
+  s.add_dependency 'rails', Suspenders::RAILS_VERSION
+
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'capybara', '~> 2.2', '>= 2.2.0'
+end

data/templates/Gemfile.erb

@@ -0,0 +1,48 @@
+source "https://rubygems.org"
+
+ruby "<%= Suspenders::RUBY_VERSION %>"
+
+gem 'honeybadger', '~> 2.0'
+gem "coffee-rails", "~> 4.1.0"
+gem "email_validator"
+gem "high_voltage"
+gem "i18n-tasks"
+gem "jquery-rails"
+gem "pg"
+gem "rails", "<%= Suspenders::RAILS_VERSION %>"
+gem "sass-rails", "~> 5.0"
+gem "simple_form", "~> 3.0.3"
+gem "title"
+gem "uglifier"
+gem 'mandrill_dm', '1.1.0'
+
+group :development do
+  gem "spring"
+  gem "spring-commands-rspec"
+  gem "web-console"
+end
+
+group :development, :test do
+  gem "awesome_print"
+  gem "bundler-audit", require: false
+  gem "byebug"
+  gem "dotenv-rails"
+  gem "faker"
+  gem "factory_girl_rails"
+  gem "pry-rails"
+  gem "rspec-rails", "~> 3.1.0"
+end
+
+group :test do
+  gem "capybara-webkit", ">= 1.2.0"
+  gem "database_cleaner"
+  gem "launchy"
+  gem "shoulda-matchers", require: false
+  gem "simplecov", require: false
+  gem "timecop"
+  gem "webmock"
+end
+
+group :staging, :production do
+  gem "rack-timeout"
+end

data/templates/README.md.erb

@@ -0,0 +1,42 @@
+# <%= 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. If not, set up
+your machine with [this script].
+
+[this script]: https://github.com/thoughtbot/laptop
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+If you don't have `foreman`, see [Foreman's install instructions][foreman]. It
+is [purposefully excluded from the project's `Gemfile`][exclude].
+
+[foreman]: https://github.com/ddollar/foreman
+[exclude]: https://github.com/ddollar/foreman/pull/437#issuecomment-41110407
+
+## Assumptions
+* [Mandrill](https://mandrill.com/) is used for email delivery on production
+ * MANDRILL_API_KEY must be set as an ENV variable on the server
+* [Honeybadger](https://www.honeybadger.io/) is used for Exception monitoring
+ * Remember to run `bundle exec honeybadger install API_KEY` with your API key on the staging and production servers.
+* [Rspec](https://github.com/rspec/rspec-rails) is used as the testing library
+* Postgres is the database in use
+* [Simple form](https://github.com/plataformatec/simple_form) is used for building forms
+* [High voltage](https://github.com/thoughtbot/high_voltage) gem is used for creating static pages
+
+## Guidelines
+
+Use the following Thoughtbot 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/_flashes.html.erb

@@ -0,0 +1,7 @@
+<% if flash.any? %>
+  <div id="flash">
+    <% user_facing_flashes.each do |key, value| -%>
+      <div class="flash-<%= key %>"><%= value %></div>
+    <% end -%>
+  </div>
+<% 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,8 @@
+@charset "utf-8";
+
+@import "normalize-rails";
+@import "bourbon";
+@import "base/grid-settings";
+@import "neat";
+@import "base/base";
+@import "refills/flashes";

data/templates/bin_setup.erb

@@ -0,0 +1,36 @@
+#!/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
+gem install bundler --conservative
+bundle check || 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 db:setup dev:prime
+
+# Add binstubs to PATH via export PATH=".git/safe/../../bin:$PATH" in ~/.zshenv
+mkdir -p .git/safe
+
+# Pick a port for Foreman
+if ! grep --quiet --no-messages --fixed-strings 'port' .foreman; then
+  printf 'port: <%= config[:port_number] %>\n' >> .foreman
+fi
+
+if ! command -v foreman > /dev/null; then
+  printf 'Foreman is not installed.\n'
+  printf 'See https://github.com/ddollar/foreman for install instructions.\n'
+fi
+
+# Only if this isn't CI
+# if [ -z "$CI" ]; then
+# fi

data/templates/bundler_audit.rake

@@ -0,0 +1,12 @@
+if Rails.env.development? || Rails.env.test?
+  require "bundler/audit/cli"
+
+  namespace :bundler do
+    desc "Updates the ruby-advisory-db and runs audit"
+    task :audit do
+      %w(update check).each do |command|
+        Bundler::Audit::CLI.start [command]
+      end
+    end
+  end
+end

data/templates/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.2.0

data/templates/config_i18n_tasks.yml

@@ -0,0 +1,13 @@
+search:
+  paths:
+    - "app/controllers"
+    - "app/helpers"
+    - "app/presenters"
+    - "app/views"
+
+ignore_unused:
+  - activerecord.*
+  - date.*
+  - simple_form.*
+  - time.*
+  - titles.*

data/templates/config_locales_en.yml.erb

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

data/templates/database_cleaner_rspec.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:deletion)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :deletion
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/templates/development_seeds.rb

@@ -0,0 +1,12 @@
+if Rails.env.development? || Rails.env.test?
+  require "factory_girl"
+
+  namespace :dev do
+    desc "Seed data for development environment"
+    task prime: "db:setup" do
+      include FactoryGirl::Syntax::Methods
+
+      # create(:user, email: "user@example.com", password: "password")
+    end
+  end
+end

data/templates/disable_xml_params.rb

@@ -0,0 +1,3 @@
+# Protect against injection attacks
+# http://www.kb.cert.org/vuls/id/380039
+ActionDispatch::ParamsParser::DEFAULT_PARSERS.delete(Mime::XML)

data/templates/errors.rb

@@ -0,0 +1,34 @@
+require "net/http"
+require "net/smtp"
+
+# Example:
+#   begin
+#     some http call
+#   rescue *HTTP_ERRORS => error
+#     notify_hoptoad error
+#   end
+
+HTTP_ERRORS = [
+  EOFError,
+  Errno::ECONNRESET,
+  Errno::EINVAL,
+  Net::HTTPBadResponse,
+  Net::HTTPHeaderSyntaxError,
+  Net::ProtocolError,
+  Timeout::Error
+]
+
+SMTP_SERVER_ERRORS = [
+  IOError,
+  Net::SMTPAuthenticationError,
+  Net::SMTPServerBusy,
+  Net::SMTPUnknownError,
+  TimeoutError
+]
+
+SMTP_CLIENT_ERRORS = [
+  Net::SMTPFatalError,
+  Net::SMTPSyntaxError
+]
+
+SMTP_ERRORS = SMTP_SERVER_ERRORS + SMTP_CLIENT_ERRORS

data/templates/factory_girl_rspec.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/templates/flashes_helper.rb

@@ -0,0 +1,5 @@
+module FlashesHelper
+  def user_facing_flashes
+    flash.to_hash.slice("alert", "error", "notice", "success")
+  end
+end

data/templates/i18n.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include AbstractController::Translation
+end

data/templates/json_encoding.rb

@@ -0,0 +1 @@
+ActiveSupport::JSON::Encoding.time_precision = 0

data/templates/mandrill.rb

@@ -0,0 +1,3 @@
+MandrillDm.configure do |config|
+  config.api_key = ENV['MANDRILL_API_KEY']
+end

data/templates/postgresql_database.yml.erb

@@ -0,0 +1,11 @@
+development: &default
+  adapter: postgresql
+  database: <%= app_name %>_development
+  encoding: utf8
+  min_messages: warning
+  pool: 2
+  timeout: 5000
+
+test:
+  <<: *default
+  database: <%= app_name %>_test

data/templates/rails_helper.rb

@@ -0,0 +1,23 @@
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../config/environment", __FILE__)
+
+require "rspec/rails"
+require "shoulda/matchers"
+
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |file| require file }
+
+module Features
+  # Extend this module in spec/support/features/*.rb
+  include Formulaic::Dsl
+end
+
+RSpec.configure do |config|
+  config.include Features, type: :feature
+  config.infer_base_class_for_anonymous_controllers = false
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+end
+
+ActiveRecord::Migration.maintain_test_schema!
+Capybara.javascript_driver = :webkit

data/templates/sample.env

@@ -0,0 +1,3 @@
+# http://ddollar.github.com/foreman/
+RACK_ENV=development
+SECRET_KEY_BASE=development_secret

data/templates/secrets.yml

@@ -0,0 +1,14 @@
+default: &default
+  secret_key_base: <%%= ENV["SECRET_KEY_BASE"] %>
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+staging:
+  <<: *default
+
+production:
+  <<: *default

data/templates/spec_helper.rb

@@ -0,0 +1,22 @@
+if ENV.fetch("COVERAGE", false)
+  require "simplecov"
+  SimpleCov.start "rails"
+end
+
+require "webmock/rspec"
+
+# http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+end
+
+WebMock.disable_net_connect!(allow_localhost: true)

data/templates/staging.rb

@@ -0,0 +1,5 @@
+require_relative "production"
+
+Mail.register_interceptor(
+  RecipientInterceptor.new(ENV.fetch("EMAIL_RECIPIENTS"))
+)

data/templates/suspenders_gitignore

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