mj-suspenders 0.0.1

data/lib/suspenders/generators/app_generator.rb

@@ -0,0 +1,165 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Suspenders
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, :type => :string, :aliases => '-d', :default => 'mysql',
+      :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :skip_test_unit, :type => :boolean, :aliases => '-T', :default => true,
+      :desc => 'Skip Test::Unit files'
+
+    def finish_template
+      invoke :suspenders_customization
+      super
+    end
+
+    def suspenders_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :setup_secret_token
+      invoke :create_suspenders_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_git
+      invoke :setup_database
+    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 :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :raise_on_unpermitted_parameters
+      build :configure_generators
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :generate_rspec
+      build :configure_rspec
+      build :use_spring_binstubs
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+      build :configure_travis
+      build :configure_i18n_in_specs
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :enable_rack_deflater
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def create_suspenders_views
+      say 'Creating suspenders 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
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_time_zone
+      build :configure_time_formats
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :setup_default_rake_task
+      build :configure_unicorn
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    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 run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    def ruby_version_with_patch_level
+      "#{RUBY_VERSION}#{patch_level}"
+    end
+
+    protected
+
+    def get_builder_class
+      Suspenders::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+
+    def patch_level
+      if RUBY_PATCHLEVEL == 0 && RUBY_VERSION >= '2.1.0'
+        ''
+      else
+        "-p#{RUBY_PATCHLEVEL}"
+      end
+    end
+  end
+end

data/lib/suspenders/version.rb

@@ -0,0 +1,3 @@
+module Suspenders
+  VERSION = '0.0.1'
+end

data/lib/suspenders.rb

@@ -0,0 +1,3 @@
+require 'suspenders/generators/app_generator'
+require 'suspenders/actions'
+require 'suspenders/app_builder'

data/mj-suspenders.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'suspenders/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 1.9.2'
+  s.add_dependency 'bundler', '~> 1.3'
+  s.add_dependency 'rails', '4.0.3'
+  s.add_development_dependency 'aruba', '~> 0.5.2'
+  s.add_development_dependency 'cucumber', '~> 1.2'
+  s.authors = ['thoughtbot', 'Marcelo Jacobus']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+MJ-Suspenders is a base Rails project used by the author of this gem.
+  HERE
+
+  s.email = 'marcelo.jacobus@gmail.com'
+  s.executables = ['mj-suspenders']
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/mjacobus/mg-suspenders'
+  s.license = 'MIT'
+  s.name = 'mj-suspenders'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using thoughtbot's best practices. Plus Marcelo Jacobus favorites"
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Suspenders::VERSION
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov', '~> 0.7.1'
+  s.add_development_dependency 'capybara'
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,38 @@
+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 = "Dummy::Application.configure do"
+    expect(staging_file).to match(/^require_relative 'production'/)
+    expect(staging_file).to match(/#{config_stub}/), staging_file
+  end
+
+  if RUBY_PATCHLEVEL == 0 && RUBY_VERSION >= '2.1.0'
+    scenario '.ruby-version does not include patchlevel for Ruby 2.1.0+' do
+      run_suspenders
+
+      ruby_version_file = IO.read("#{project_path}/.ruby-version")
+      expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+    end
+  else
+    scenario '.ruby-version includes patchlevel for all pre-Ruby 2.1.0 versions' do
+      run_suspenders
+
+      ruby_version_file = IO.read("#{project_path}/.ruby-version")
+      expect(ruby_version_file).to eq "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}\n"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'capybara/rspec'
+require 'bundler/setup'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'bin'
+  add_filter 'spec'
+end
+
+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
+  end
+end

data/spec/support/suspenders.rb

@@ -0,0 +1,50 @@
+module SuspendersTestHelpers
+  APP_NAME = 'dummy'
+
+  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'
+        ENV['DISABLE_SPRING'] = '1'
+
+        %x(#{suspenders_bin} #{APP_NAME} #{arguments})
+      end
+    end
+  end
+
+  def drop_dummy_database
+    if File.exists?(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', 'mj-suspenders')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/templates/Gemfile.erb

@@ -0,0 +1,43 @@
+source 'https://rubygems.org'
+
+ruby '<%= RUBY_VERSION %>'
+
+gem 'coffee-rails'
+gem 'email_validator'
+gem 'high_voltage'
+gem 'jquery-rails'
+gem 'mysql2'
+gem 'rack-timeout'
+gem 'rails', '>= 4.0.3'
+gem 'recipient_interceptor'
+gem 'sass-rails'
+gem 'simple_form'
+gem 'title'
+gem 'uglifier'
+gem 'unicorn'
+
+group :development do
+  gem 'spring'
+  gem 'spring-commands-rspec'
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  # gem 'dotenv-rails'
+  gem 'pry-rails'
+  gem 'rspec-rails', '>= 2.14'
+end
+
+group :test do
+  # gem 'capybara-webkit', '>= 1.0.0'
+  gem 'database_cleaner'
+  # gem 'launchy'
+  gem 'shoulda-matchers'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :staging, :production do
+  # gem 'newrelic_rpm', '>= 3.7.3'
+end

data/templates/README.md.erb

@@ -0,0 +1,36 @@
+<%= app_name.humanize %>
+<%= '=' * app_name.humanize.length %>
+
+[![Build Status](https://travis-ci.org/mjacobus/<%= app_name %>.png?branch=master)](https://travis-ci.org/mjacobus/<%= app_name %>)
+[![Coverage Status](https://coveralls.io/repos/mjacobus/<%= app_name %>/badge.png)](https://coveralls.io/r/mjacobus/<%= app_name %>)
+[![Code Climate](https://codeclimate.com/github/mjacobus/<%= app_name %>.png)](https://codeclimate.com/github/mjacobus/<%= app_name %>)
+
+Getting Started
+---------------
+
+TODO:
+
+Guidelines
+----------
+
+Use the following 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)
+
+Authors
+-------
+
+- [Marcelo Jacobus](https://github.com/mjacobus)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+** Do not forget to write tests**

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,10 @@
+<%= javascript_include_tag :application %>
+
+<%= yield :javascript %>
+
+<% if Rails.env.test? %>
+  <%= javascript_tag do %>
+    $.fx.off = true;
+    $.ajaxSetup({ async: false });
+  <% end %>
+<% end %>

data/templates/application.css.scss

@@ -0,0 +1,4 @@
+/**
+ *= require_self
+ *= require_tree .
+ */

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

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

data/templates/ruby-version.erb

@@ -0,0 +1 @@
+<%= ruby_version_with_patch_level %>

data/templates/secret_token.rb

@@ -0,0 +1,10 @@
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+<%= app_const %>.config.secret_key_base = ENV['SECRET_KEY_BASE']

data/templates/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+SimpleCov.start 'rails'
+
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../../config/environment', __FILE__)
+
+require 'rspec/rails'
+require 'webmock/rspec'
+
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |file| require file }
+
+module Features
+  # Extend this module in spec/support/features/*.rb
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include Features, type: :feature
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = 'random'
+  config.use_transactional_fixtures = false
+end
+
+# Capybara.javascript_driver = :webkit
+WebMock.disable_net_connect!(allow_localhost: true)

data/templates/staging.rb

@@ -0,0 +1,6 @@
+require_relative 'production'
+
+Mail.register_interceptor RecipientInterceptor.new(
+  ENV['EMAIL_RECIPIENTS'] || ['marcelo.jacobus@gmail.com'],
+  subject_prefix: '[staging]'
+)

data/templates/suspenders_gitignore

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

data/templates/suspenders_layout.html.erb.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <title><%%= 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/travis.yml.erb

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+env:
+  - DB=sqlite
+  - DB=mysql
+  - DB=postgresql
+script:
+  - RAILS_ENV=test bundle exec rake db:migrate --trace
+  - bundle exec rake db:test:prepare
+  - bundle exec rspec spec/
+before_script:
+  - mysql -e 'create database <%= app_name %>_test'
+  - psql -c 'create database  <%= app_name %>_test' -U postgres
+branches:
+  only: master
+notifications:
+  email:
+    on_failure: change
+    on_failure: always

data/templates/unicorn.rb

@@ -0,0 +1,29 @@
+# https://devcenter.heroku.com/articles/rails-unicorn
+
+worker_processes (ENV['WEB_CONCURRENCY'] || 3).to_i
+timeout (ENV['WEB_TIMEOUT'] || 5).to_i
+preload_app true
+
+before_fork do |server, worker|
+  Signal.trap 'TERM' do
+    puts 'Unicorn master intercepting TERM and sending myself QUIT instead'
+    Process.kill 'QUIT', Process.pid
+  end
+
+  if defined? ActiveRecord::Base
+    ActiveRecord::Base.connection.disconnect!
+  end
+end
+
+after_fork do |server, worker|
+  Signal.trap 'TERM' do
+    puts 'Unicorn worker intercepting TERM and doing nothing. Wait for master to sent QUIT'
+  end
+
+  if defined? ActiveRecord::Base
+    config = Rails.application.config.database_configuration[Rails.env]
+    config['reaping_frequency'] = (ENV['DB_REAPING_FREQUENCY'] || 10).to_i
+    config['pool'] = (ENV['DB_POOL'] || 2).to_i
+    ActiveRecord::Base.establish_connection(config)
+  end
+end