bulldozer 1.6.0

data/README.md

@@ -0,0 +1,225 @@
+# Bulldozer [![Build Status](https://secure.travis-ci.org/SeasonedSoftware/bulldozer.svg?branch=master)](http://travis-ci.org/SeasonedSoftware/bulldozer) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+
+Bulldozer is the base Rails application used at
+[seasoned](https://seasoned.cc/).
+
+  ![Bulldozer](https://banner2.kisspng.com/20180509/epe/kisspng-excavator-architectural-engineering-bulldozer-logo-5af28c67e988a6.8792375915258450959566.jpg)
+
+## Installation
+
+First install the bulldozer gem:
+
+    gem install bulldozer
+
+Then run:
+
+    bulldozer 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 Bulldozer'
+[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/SeasonedSoftware/bourbon) for Sass mixins
+* [Bitters](https://github.com/SeasonedSoftware/bitters) for scaffold application styles
+* [Delayed Job](https://github.com/collectiveidea/delayed_job) for background
+  processing
+* [High Voltage](https://github.com/SeasonedSoftware/high_voltage) for static pages
+* [Honeybadger](https://honeybadger.io) for exception notification
+* [Neat](https://github.com/SeasonedSoftware/neat) for semantic grids
+* [Normalize](https://necolas.github.io/normalize.css/) for resetting browser styles
+* [Oj](http://www.ohler.com/oj/)
+* [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
+* [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.
+
+And testing gems like:
+
+* [Capybara](https://github.com/jnicklas/capybara) and
+  [Google Chromedriver]
+  integration testing
+* [Factory Bot](https://github.com/SeasonedSoftware/factory_bot) for test data
+* [Formulaic](https://github.com/SeasonedSoftware/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/SeasonedSoftware/shoulda-matchers) for common
+  RSpec matchers
+* [Timecop](https://github.com/travisjeffery/timecop) for testing time
+
+## Other goodies
+
+Bulldozer 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.seasoned.cc/bin-setup
+[compress]: https://robots.seasoned.cc/content-compression-with-rack-deflater
+[pool]: https://devcenter.heroku.com/articles/concurrency-and-database-connections
+[binstub]: https://github.com/SeasonedSoftware/bulldozer/pull/282
+[i18n]: https://github.com/SeasonedSoftware/bulldozer/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:
+
+    bulldozer app --heroku true
+
+This:
+
+* Creates a staging and production Heroku app
+* Sets them as `staging` and `production` Git remotes
+* Configures staging with `HONEYBADGER_ENV` environment variable set
+  to `staging`
+* Creates a [Heroku Pipeline] for review apps
+* Schedules automated backups for 10AM UTC for both `staging` and `production`
+
+[Heroku Pipeline]: https://devcenter.heroku.com/articles/pipelines
+
+You can optionally specify alternate Heroku flags:
+
+    bulldozer 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:
+
+    bulldozer 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 https://hub.github.com/standalone -sLo ~/bin/hub && chmod +x ~/bin/hub
+    bulldozer app --github organization/project
+
+This has the same effect as running:
+
+    hub create organization/project
+
+## Spring
+
+Bulldozer 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
+
+Bulldozer requires the latest version of Ruby.
+
+Some gems included in Bulldozer have native extensions. You should have GCC
+installed on your machine before generating an app with Bulldozer.
+
+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 [Google Chromedriver] for full-stack JavaScript integration testing. It
+requires Google Chrome or Chromium.
+
+[Google Chromedriver]: https://sites.google.com/a/chromium.org/chromedriver/home
+
+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/SeasonedSoftware/bulldozer/issues).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+Thank you, [contributors]!
+
+[contributors]: https://github.com/SeasonedSoftware/bulldozer/graphs/contributors
+
+## License
+
+Bulldozer is Copyright © 2008-2017 seasoned.
+It is free software,
+and may be redistributed under the terms specified in the [LICENSE] file.
+
+[LICENSE]: LICENSE
+
+## About seasoned
+
+[![seasoned][seasoned-logo]][seasoned]
+
+Bulldozer is maintained and funded by seasoned, inc.
+The names and logos for seasoned are trademarks of seasoned, inc.
+
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
+
+[seasoned]: https://seasoned.cc?utm_source=github
+[seasoned-logo]: http://presskit.seasoned.cc/images/seasoned-logo-for-readmes.svg
+[community]: https://seasoned.cc/community?utm_source=github
+[hire]: https://seasoned.cc?utm_source=github

data/RELEASING.md

@@ -0,0 +1,18 @@
+# Releasing
+
+1. Update `NEWS.md` to reflect the changes since last release.
+2. Update `lib/bulldozer/version.rb` file accordingly.
+3. Commit changes. There shouldn't be code changes, and thus CI doesn't need to
+   run; you can add `[ci skip]` to the commit message.
+4. Tag the release: `git tag vVERSION -a -s`. The tag message should contain the
+   appropriate `NEWS.md` subsection.
+5. Push changes: `git push --tags`
+6. Build and publish to rubygems:
+   ```sh
+   gem build bulldozer.gemspec
+   gem push bulldozer-*.gem
+   ```
+7. Add a new GitHub release:
+   https://github.com/SeasonedSoftware/bulldozer/releases/new?tag=vVERSION
+8. Announce the new release, making sure to thank 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:
+    Bulldozer is a Rails template with seasoned 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/SeasonedSoftware/bulldozer
+
+Example:
+    bulldozer ~/Code/weblog
+
+    This generates a Rails installation in ~/Code/weblog configured
+    with our preferred defaults.

data/bin/bulldozer

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'bulldozer'
+
+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 Bulldozer::VERSION
+  exit 0
+end
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Bulldozer::AppGenerator.source_root templates_root
+Bulldozer::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Bulldozer::AppGenerator.start

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/bulldozer.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'bulldozer/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= #{Bulldozer::RUBY_VERSION}"
+  s.required_rubygems_version = ">= 2.7.4"
+  s.authors = ['mpatrick']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+Bulldozer is a base Rails project that you can upgrade. It is used by
+seasoned to get a jump start on a working app. Use Bulldozer if you're in a
+rush to build something amazing; don't use it if you like missing deadlines.
+  HERE
+
+  s.email = 'support@seasoned.cc'
+  s.executables = ['bulldozer']
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/SeasonedSoftware/bulldozer'
+  s.license = 'MIT'
+  s.name = 'bulldozer'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using seasoned's best practices."
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Bulldozer::VERSION
+
+  s.add_dependency 'bitters', '~> 1.7'
+  s.add_dependency 'rails', Bulldozer::RAILS_VERSION
+
+  s.add_development_dependency 'rspec', '~> 3.2'
+end

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+
+services:
+  ruby:
+    build: .
+    command: bash
+    volumes:
+      - .:/app

data/dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:2.5.3
+# Install VIM to edit credentials.yml.enc file
+RUN apt-get update && apt-get install -y vim
+ENV EDITOR="vim"
+# Install container dependencies
+RUN apt-get update && apt-get install -y libc-ares2 libv8-3.14.5 --no-install-recommends && rm -rf /var/lib/apt/lists/*
+# Set the work directory inside container
+RUN mkdir /app
+WORKDIR /app
+# Copy all the rest inside work directory
+COPY . /app

data/lib/bulldozer.rb

@@ -0,0 +1,24 @@
+require "bulldozer/version"
+require "bulldozer/generators/app_generator"
+require "bulldozer/generators/static_generator"
+require "bulldozer/generators/stylesheet_base_generator"
+require "bulldozer/generators/forms_generator"
+require "bulldozer/generators/ci_generator"
+require "bulldozer/generators/db_optimizations_generator"
+require "bulldozer/generators/factories_generator"
+require "bulldozer/generators/lint_generator"
+require "bulldozer/generators/jobs_generator"
+require "bulldozer/generators/analytics_generator"
+require "bulldozer/generators/views_generator"
+require "bulldozer/generators/js_driver_generator"
+require "bulldozer/generators/json_generator"
+require "bulldozer/generators/testing_generator"
+require "bulldozer/generators/production/force_tls_generator"
+require "bulldozer/generators/production/email_generator"
+require "bulldozer/generators/production/timeout_generator"
+require "bulldozer/generators/production/deployment_generator"
+require "bulldozer/generators/production/manifest_generator"
+require "bulldozer/generators/staging/pull_requests_generator"
+require "bulldozer/actions"
+require "bulldozer/adapters/heroku"
+require "bulldozer/app_builder"

data/lib/bulldozer/actions.rb

@@ -0,0 +1,85 @@
+module Bulldozer
+  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 action_mailer_asset_host(rails_env, host)
+      config = "config.action_mailer.asset_host = #{host}"
+      configure_environment(rails_env, config)
+    end
+
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n  #{config}",
+        before: "\nend"
+      )
+    end
+
+    def expand_json(file, data)
+      action ExpandJson.new(destination_root, file, data)
+    end
+
+    class ExpandJson
+      def initialize(destination_root, file, data)
+        @destination_root = destination_root
+        @file = file
+        @data = data
+      end
+
+      def invoke!
+        write_out { |existing_json| existing_json.merge(data) }
+      end
+
+      def revoke!
+        write_out { |existing_json| hash_unmerge(existing_json, data) }
+      end
+
+      private
+
+      attr_reader :destination_root, :file, :data
+
+      def write_out
+        new_json = yield(existing_json)
+        IO.write(destination_file, JSON.pretty_generate(new_json))
+      end
+
+      def destination_file
+        File.join(destination_root, file)
+      end
+
+      def existing_json
+        JSON.parse(IO.read(destination_file))
+      rescue Errno::ENOENT
+        {}
+      end
+
+      def hash_unmerge(hash, subhash)
+        subhash.reduce(hash) do |acc, (k, v)|
+          if hash.has_key?(k)
+            if v == hash[k]
+              acc.except(k)
+            elsif v.is_a?(Hash)
+              acc.merge(k => hash_unmerge(hash[k], v))
+            else
+              acc
+            end
+          else
+            acc
+          end
+        end
+      end
+    end
+  end
+end