prop_up 0.0.1

data/lib/prop/generators/app_generator.rb

@@ -0,0 +1,212 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Prop
+  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: true,
+      desc: 'Create staging and production Heroku apps'
+
+    class_option :github,
+      type: 'string',
+      aliases: '-G',
+      default: true,
+      desc: 'Create github repo and add remote origin'
+
+    class_option :skip_test_unit,
+      type: :boolean,
+      aliases: '-T',
+      default: true,
+      desc: 'Skip Test::Unit files'
+
+    def finish_template
+      invoke :prop_customizations
+      super
+    end
+
+    def prop_customizations
+      invoke :remove_garbage_files
+      invoke :customize_gemfile
+      invoke :setup_database
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :create_prop_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :create_guard_file
+      invoke :initialize_zeus
+      invoke :setup_git
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :start_zeus
+      invoke :outro
+    end
+
+    def remove_garbage_files
+      build :remove_public_index
+      build :remove_rails_logo_image
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+      build :use_postgres_config_template
+      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 :configure_generators
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :enable_factory_girl_syntax
+      build :test_factories_first
+      build :generate_rspec
+      build :configure_rspec
+      build :use_rspec_binstub
+      build :conifigure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_capybara_webkit
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def create_prop_views
+      say 'Creating prop 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 :create_common_javascripts
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :blacklist_active_record_attributes
+      build :configure_strong_parameters
+      build :configure_time_zone
+      build :configure_time_formats
+      build :configure_rack_timeout
+      build :disable_xml_params
+      build :setup_default_rake_task
+      build :configure_unicorn
+      build :setup_foreman
+    end
+
+    def setup_stylesheets
+      say 'Setting up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def create_guard_file
+      say 'Creating Guardfile'
+      build :setup_guardfile
+    end
+
+    def initialize_zeus
+      build :init_zeus
+    end
+
+    def setup_git
+      say 'Initializing git'
+      invoke :setup_gitignore
+      invoke :init_git
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say 'Creating Heroku apps'
+        build :create_heroku_apps
+        build :set_heroku_remotes
+      end
+    end
+
+    def create_github_repo
+      say 'Creating Github repo'
+      build :create_github_repo, "#{app_name}"
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    end
+
+    def copy_libraries
+      say 'Copying libraries'
+      build :copy_libraries
+    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 start_zeus
+      build :start_zeus
+    end
+
+    def outro
+      say 'Propped up.'
+    end
+
+    protected
+
+    def get_builder_class
+      Prop::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/prop/version.rb

@@ -0,0 +1,3 @@
+module Prop
+  VERSION = "0.0.1"
+end

data/prop.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'prop/version'
+require 'date'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.add_dependency 'bundler', '~> 1.3'
+  spec.add_dependency 'rails', '4.0.0'
+  spec.authors = ['Nathaniel Wroblewski']
+  spec.date = Date.today.strftime('%Y-%m-%d')
+
+  spec.description = <<-HERE
+Prop is a base Rails project that you can upgrade.
+It is used to get a jump start on a working app.
+  HERE
+
+  spec.email         = ["nathanielwroblewski@gmail.com"]
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |file| File.basename(file) }
+  spec.extra_rdoc_files = %w[README.md LICENSE]
+  spec.name          = "prop_up"
+  spec.summary       = 'Generate a Rails app using pre-configured best practices'
+  spec.homepage      = 'https://github.com/NathanielWroblewski/prop'
+  spec.license       = "MIT"
+
+  spec.files            = `git ls-files`.split("\n")
+  spec.rdoc_options     = ['--charset=UTF-8']
+  spec.require_paths    = ['lib']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.version       = Prop::VERSION
+end

data/templates/Gemfile_clean

@@ -0,0 +1,56 @@
+source 'https://rubygems.org'
+
+ruby '2.0.0'
+
+gem 'rails', '>= 4.0.0'
+
+gem 'airbrake'
+gem 'coffee-rails'
+gem 'delayed_job_active_record', '>= 4.0.0'
+gem 'email_validator'
+gem 'haml_coffee_assets'
+gem 'jquery-rails'
+gem 'paperclip'
+gem 'pg'
+gem 'rack-timeout'
+gem 'recipient_interceptor'
+gem 'sass-rails'
+gem 'simple_form'
+gem 'uglifier'
+gem 'unicorn'
+gem 'zurb-foundation'
+
+group :development do
+  gem 'better_errors'
+  gem 'binding_of_caller'
+  gem 'foreman'
+  gem 'guard'
+  gem 'guard-rspec'
+end
+
+group :development, :test do
+  gem 'capybara'
+  gem 'factory_girl_rails'
+  gem 'parallel_tests'
+  gem 'rspec'
+  gem 'rspec-core'
+  gem 'rspec-expectations'
+  gem 'rspec-mocks'
+  gem 'rspec-rails', '>= 2.14'
+  gem 'shoulda-matchers'
+  gem 'zeus', '>= 0.13.4.pre2'
+end
+
+group :test do
+  gem 'capybara-webkit', '>= 1.0.0'
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :staging, :production do
+  gem 'newrelic_rpm', '>= 3.6.7'
+  gem 'rails_12factor'
+end

data/templates/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', zeus: true, cli: '--color --order rand:$RANDOM' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
+  watch(%r{^spec/factories.rb$})                      { 'spec/factories_spec.rb' }
+  watch('app/controllers/application_controller.rb')  { 'spec/controllers' }
+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,6 @@
+You're being propped up
+============================
+
+Consult the following repo for best practices and workflow protocol:
+
+[Prop](https://github.com/NathanielWroblewski/prop)

data/templates/_flashes.html.erb

@@ -0,0 +1,5 @@
+<div id="flash">
+  <% flash.each do |key, value| -%>
+    <div id="flash_<%= key %>"><%= value %></div>
+  <% end -%>
+</div>

data/templates/_javascript.html.erb

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

data/templates/application.css.scss

@@ -0,0 +1,5 @@
+@charset 'utf-8';
+
+///////////////////////////////////////////////////////////////////////////////
+
+///////////////////////////////////////////////////////////////////////////////

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,25 @@
+#!/usr/bin/env sh
+
+# Set up Rails app. Run this script immediately after cloning the codebase.
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Set up the database
+bundle exec rake db:setup
+
+# Set up configurable environment variables
+if [ ! -f .env ]; then
+  cp .sample.env .env
+fi
+
+# 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

data/templates/config_locales_en.yml

@@ -0,0 +1,11 @@
+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'

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/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,28 @@
+require 'net/http'
+require 'net/smtp'
+
+# Example:
+#   begin
+#     some http call
+#   rescue *HTTP_ERRORS => error
+#     notify_hoptoad error
+#   end
+
+HTTP_ERRORS = [Timeout::Error,
+               Errno::EINVAL,
+               Errno::ECONNRESET,
+               EOFError,
+               Net::HTTPBadResponse,
+               Net::HTTPHeaderSyntaxError,
+               Net::ProtocolError]
+
+SMTP_SERVER_ERRORS = [TimeoutError,
+                      IOError,
+                      Net::SMTPUnknownError,
+                      Net::SMTPServerBusy,
+                      Net::SMTPAuthenticationError]
+
+SMTP_CLIENT_ERRORS = [Net::SMTPFatalError,
+                      Net::SMTPSyntaxError]
+
+SMTP_ERRORS = SMTP_SERVER_ERRORS + SMTP_CLIENT_ERRORS

data/templates/factories_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+FactoryGirl.factories.map(&:name).each do |factory_name|
+  describe "factory #{factory_name}" do
+    it 'is valid' do
+      factory = build(factory_name)
+
+      if factory.respond_to?(:valid?)
+        expect(factory).to be_valid, factory.errors.full_messages.join(',')
+      end
+    end
+  end
+end

data/templates/factories_spec_rake_task.rb

@@ -0,0 +1,9 @@
+if defined?(RSpec)
+  desc 'Run factory specs.'
+
+  RSpec::Core::RakeTask.new(:factory_specs) do |t|
+    t.pattern = './spec/models/factories_spec.rb'
+  end
+
+  task spec: :factory_specs
+end

data/templates/factory_girl_syntax_rspec.rb

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

data/templates/javascripts/prefilled_input.js

@@ -0,0 +1,59 @@
+// clear inputs with starter values
+new function($) {
+  $.fn.prefilledInput = function() {
+
+    var focus = function () {
+      $(this).removeClass('prefilled');
+      if (this.value == this.prefilledValue) {
+        this.value = '';
+      }
+    };
+
+    var blur = function () {
+      if (this.value == '') {
+        $(this).addClass('prefilled').val(this.prefilledValue);
+      } else if (this.value != this.prefilledValue) {
+        $(this).removeClass('prefilled');
+      }
+    };
+
+    var extractPrefilledValue = function () {
+      if (this.title) {
+        this.prefilledValue = this.title;
+        this.title = '';
+      } else if (this.id) {
+        this.prefilledValue = $('label[for=' + this.id + ']').hide().text();
+      }
+      if (this.prefilledValue) {
+        this.prefilledValue = this.prefilledValue.replace(/\*$/, '');
+      }
+    };
+
+    var initialize = function (index) {
+      if (!this.prefilledValue) {
+        this.extractPrefilledValue = extractPrefilledValue;
+        this.extractPrefilledValue();
+        $(this).trigger('blur');
+      }
+    };
+
+    return this.filter(":input").
+      focus(focus).
+      blur(blur).
+      each(initialize);
+  };
+
+  var clearPrefilledInputs = function () {
+    var form = this.form || this;
+    $(form).find("input.prefilled, textarea.prefilled").val("");
+  };
+
+  var prefilledSetup = function () {
+    $('input.prefilled, textarea.prefilled').prefilledInput();
+    $('form').submit(clearPrefilledInputs);
+    $('input:submit, button:submit').click(clearPrefilledInputs);
+  };
+
+  $(document).ready(prefilledSetup);
+  $(document).ajaxComplete(prefilledSetup);
+}(jQuery);

data/templates/postgresql_database.yml.erb

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

data/templates/prop_gitignore

@@ -0,0 +1,15 @@
+!.keep
+*.DS_Store
+*.swo
+*.swp
+.bundle
+.sass-cache/
+coverage/*
+db/*.sqlite3
+db/schema.rb
+log/*
+public/system
+rerun.txt
+tags
+tmp/*
+tmp/**/*

data/templates/prop_layout.html.erb.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <title><%%= page_title %></title>
+  <%%= stylesheet_link_tag :application, :media => 'all' %>
+  <%%= csrf_meta_tags %>
+</head>
+<body class="<%%= body_class %>">
+  <%%= render 'flashes' -%>
+  <%%= yield %>
+  <%%= render 'javascript' %>
+</body>
+</html>

data/templates/rack_timeout.rb

@@ -0,0 +1 @@
+Rack::Timeout.timeout = (ENV['TIMEOUT_IN_SECONDS'] || 5).to_i

data/templates/sample.env

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

data/templates/smtp.rb

@@ -0,0 +1,10 @@
+if Rails.env.staging? || Rails.env.production?
+  SMTP_SETTINGS = {
+    address: ENV['SMTP_ADDRESS'], # example: 'smtp.sendgrid.net'
+    authentication: :plain,
+    domain: ENV['SMTP_DOMAIN'], # example: 'this-app.com'
+    password: ENV['SMTP_PASSWORD'],
+    port: '587',
+    user_name: ENV['SMTP_USERNAME']
+  }
+end

data/templates/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'simplecov'
+SimpleCov.start 'rails'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../../config/environment', __FILE__)
+
+require 'rspec/rails'
+require 'webmock/rspec'
+require 'paperclip/matchers'
+
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |file| require file }
+
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.fail_fast = false
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = 'random'
+  config.color = true
+  config.use_transactional_fixtures = false
+  config.include FactoryGirl::Syntax::Default
+  config.include Paperclip::Shoulda::Matchers
+end
+
+Capybara.javascript_driver = :webkit
+WebMock.disable_net_connect!(allow_localhost: true)