railslove-suspenders 0.1.0

data/lib/railslove-suspenders/app_builder.rb

@@ -0,0 +1,335 @@
+module RailsloveSuspenders
+  class AppBuilder < Rails::AppBuilder
+    include RailsloveSuspenders::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def remove_public_index
+      remove_file 'public/index.html'
+    end
+
+    def remove_rails_logo_image
+      remove_file 'app/assets/images/rails.png'
+    end
+
+    def raise_on_delivery_errors
+      replace_in_file 'config/environments/development.rb',
+        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+    end
+
+    def raise_on_unpermitted_parameters
+      configure_environment 'development',
+        'config.action_controller.action_on_unpermitted_parameters = :raise'
+    end
+
+    def provide_setup_script
+      copy_file 'bin_setup', 'bin/setup'
+      run 'chmod a+x bin/setup'
+    end
+
+    def enable_factory_girl_syntax
+      copy_file 'factory_girl_syntax_rspec.rb', 'spec/support/factory_girl.rb'
+    end
+
+    def test_factories_first
+      copy_file 'factories_spec.rb', 'spec/models/factories_spec.rb'
+      append_file 'Rakefile', factories_spec_rake_task
+    end
+
+    def configure_smtp
+      copy_file 'smtp.rb', 'config/initializers/smtp.rb'
+
+      prepend_file 'config/environments/production.rb',
+        "require Rails.root.join('config/initializers/smtp')\n"
+
+      config = <<-RUBY
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        :after => 'config.action_mailer.raise_delivery_errors = false'
+    end
+
+    def setup_staging_environment
+      run 'cp config/environments/production.rb config/environments/staging.rb'
+
+      prepend_file 'config/environments/staging.rb',
+        "Mail.register_interceptor RecipientInterceptor.new(ENV['EMAIL_RECIPIENTS'])\n"
+    end
+
+    def initialize_on_precompile
+      inject_into_file 'config/application.rb',
+        "\n    config.assets.initialize_on_precompile = false",
+        :after => 'config.assets.enabled = true'
+    end
+
+    def create_partials_directory
+      empty_directory 'app/assets/stylesheets/base'
+      empty_directory 'app/assets/stylesheets/modules'
+      empty_directory 'app/assets/stylesheets/layout'
+      empty_directory 'app/assets/stylesheets/controllers'
+    end
+
+    def add_default_stylesheets
+      copy_file 'stylesheets/application.css.sass', 'app/assets/stylesheets/application.css.sass'
+      copy_file 'stylesheets/_shame.css.sass', 'app/assets/stylesheets/_shame.css.sass'
+      copy_file 'stylesheets/base/_colors.css.sass', 'app/assets/stylesheets/base/_colors.css.sass'
+      copy_file 'stylesheets/base/_dimension.css.sass', 'app/assets/stylesheets/base/_dimensions.css.sass'
+      copy_file 'stylesheets/base/_element_defaults.css.sass', 'app/assets/stylesheets/base/_element_defaults.css.sass'
+      copy_file 'stylesheets/base/_icon_font.css.sass', 'app/assets/stylesheets/base/_icon_font.css.sass'
+      copy_file 'stylesheets/base/_sprites.css.sass', 'app/assets/stylesheets/base/_sprites.css.sass'
+      copy_file 'stylesheets/base/_typography.css.sass', 'app/assets/stylesheets/base/_typography.css.sass'
+      copy_file 'stylesheets/base/_global_mixins.css.sass', 'app/assets/stylesheets/base/_global_mixins.css.sass'
+
+    end
+
+    def create_shared_flashes
+      copy_file '_flashes.html.haml', 'app/views/layouts/_flashes.html.haml'
+    end
+
+    def create_shared_javascripts
+      copy_file '_javascript.html.haml', 'app/views/layouts/_javascript.html.haml'
+    end
+
+    def create_application_layout
+      remove_file 'app/views/layouts/application.html.erb'
+      template 'suspenders_layout.html.haml',
+        'app/views/layouts/application.html.haml',
+        :force => true
+    end
+
+    def create_common_javascripts
+      directory 'javascripts', 'app/assets/javascripts'
+    end
+
+    def add_jquery_ui
+      inject_into_file 'app/assets/javascripts/application.js',
+        "//= require jquery-ui\n", :before => '//= require_tree .'
+    end
+
+    def use_postgres_config_template
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        :force => true
+    end
+
+    def create_database
+      bundle_command 'exec rake db:create'
+    end
+
+    def replace_gemfile
+      remove_file 'Gemfile'
+      copy_file 'Gemfile_clean', 'Gemfile'
+    end
+
+    def set_ruby_to_version_being_used
+      inject_into_file 'Gemfile', "\n\nruby '#{RUBY_VERSION}'",
+        after: /source 'https:\/\/rubygems.org'/
+    end
+
+    def enable_database_cleaner
+      replace_in_file 'spec/spec_helper.rb',
+        'config.use_transactional_fixtures = true',
+        'config.use_transactional_fixtures = false'
+
+      copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
+    end
+
+    def configure_rspec
+      remove_file '.rspec'
+      copy_file 'rspec', '.rspec'
+      prepend_file 'spec/spec_helper.rb', simplecov_init
+
+      replace_in_file 'spec/spec_helper.rb',
+        '# config.mock_with :mocha',
+        'config.mock_with :mocha'
+
+      rspec_expect_syntax = <<-RUBY
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+      RUBY
+
+      config = <<-RUBY
+    config.generators do |generate|
+      generate.test_framework :rspec
+      generate.helper false
+      generate.stylesheets false
+      generate.javascript_engine false
+      generate.view_specs false
+    end
+
+      RUBY
+
+      inject_into_file 'spec/spec_helper.rb', rspec_expect_syntax,
+        :after => 'RSpec.configure do |config|'
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_background_jobs_for_rspec
+      copy_file 'background_jobs_rspec.rb', 'spec/support/background_jobs.rb'
+      run 'rails g delayed_job:active_record'
+    end
+
+    def blacklist_active_record_attributes
+      replace_in_file 'config/application.rb',
+        'config.active_record.whitelist_attributes = true',
+        'config.active_record.whitelist_attributes = false'
+    end
+
+    def configure_strong_parameters
+      copy_file 'strong_parameters.rb', 'config/initializers/strong_parameters.rb'
+    end
+
+    def configure_time_zone
+      config = <<-RUBY
+    config.active_record.default_timezone = :utc
+
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_time_formats
+      remove_file 'config/locales/en.yml'
+      copy_file 'config_locales_en.yml', 'config/locales/en.yml'
+    end
+
+    def configure_rack_timeout
+      copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb'
+    end
+
+    def configure_action_mailer
+      action_mailer_host 'development', "#{app_name}.local"
+      action_mailer_host 'test', 'www.example.com'
+      action_mailer_host 'staging', "staging.#{app_name}.com"
+      action_mailer_host 'production', "#{app_name}.com"
+    end
+
+    def generate_rspec
+      generate 'rspec:install'
+    end
+
+    def configure_capybara_webkit
+      append_file 'spec/spec_helper.rb' do
+        "\nCapybara.javascript_driver = :webkit"
+      end
+    end
+
+    def generate_clearance
+      generate 'clearance:install'
+    end
+
+    def configure_unicorn
+      copy_file 'unicorn.rb', 'config/unicorn.rb'
+    end
+
+    def setup_foreman
+      copy_file 'sample.env', '.sample.env'
+      copy_file 'Procfile', 'Procfile'
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      # concat_file 'import_scss_styles', 'app/assets/stylesheets/application.css.scss'
+      # create_file 'app/assets/stylesheets/_screen.scss'
+    end
+
+    def gitignore_files
+      concat_file 'suspenders_gitignore', '.gitignore'
+      [
+        'app/models',
+        'app/assets/images',
+        'db/migrate',
+        'log',
+        'spec/support',
+        'spec/lib',
+        'spec/models',
+        'spec/views',
+        'spec/controllers',
+        'spec/helpers',
+        'spec/support/matchers',
+        'spec/support/mixins',
+        'spec/support/shared_examples'
+      ].each do |dir|
+        empty_directory_with_gitkeep dir
+      end
+    end
+
+    def init_git
+      run 'git init'
+    end
+
+    def create_heroku_apps
+      path_addition = override_path_for_tests
+      run "#{path_addition} heroku create #{app_name}-production --remote=production"
+      run "#{path_addition} heroku create #{app_name}-staging --remote=staging"
+      run "#{path_addition} heroku config:add RACK_ENV=staging RAILS_ENV=staging --remote=staging"
+    end
+
+    def create_github_repo(repo_name)
+      path_addition = override_path_for_tests
+      run "#{path_addition} hub create #{repo_name}"
+    end
+
+    def copy_miscellaneous_files
+      copy_file 'errors.rb', 'config/initializers/errors.rb'
+    end
+
+    def customize_error_pages
+      meta_tags =<<-EOS
+  <meta charset='utf-8' />
+  <meta name='ROBOTS' content='NOODP' />
+      EOS
+      style_tags =<<-EOS
+<link href='/assets/application.css' media='all' rel='stylesheet' type='text/css' />
+      EOS
+
+      %w(500 404 422).each do |page|
+        inject_into_file "public/#{page}.html", meta_tags, :after => "<head>\n"
+        replace_in_file "public/#{page}.html", /<style.+>.+<\/style>/mi, style_tags.strip
+        replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
+      end
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb',
+        /Application\.routes\.draw do.*end/m,
+        "Application.routes.draw do\nend"
+    end
+
+    def add_email_validator
+      copy_file 'email_validator.rb', 'app/validators/email_validator.rb'
+    end
+
+    def disable_xml_params
+      copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
+    end
+
+    def setup_default_rake_task
+      append_file 'Rakefile' do
+        "task(:default).clear\ntask :default => [:spec]"
+      end
+    end
+
+    private
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', '..', 'features', 'support', 'bin'))
+        "PATH=#{support_bin}:$PATH"
+      end
+    end
+
+    def factories_spec_rake_task
+      IO.read find_in_source_paths('factories_spec_rake_task.rb')
+    end
+
+    def simplecov_init
+      IO.read find_in_source_paths('simplecov_init.rb')
+    end
+  end
+end

data/lib/railslove-suspenders/generators/app_generator.rb

@@ -0,0 +1,202 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module RailsloveSuspenders
+  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 => false,
+      :desc => 'Create staging and production Heroku apps'
+
+    class_option :github, :type => :string, :aliases => '-G', :default => nil,
+      :desc => 'Create Github repository and add remote origin pointed to repo'
+
+    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 :remove_files_we_dont_need
+      invoke :customize_gemfile
+      invoke :setup_database
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :create_suspenders_views
+      invoke :create_common_javascripts
+      # invoke :add_jquery_ui
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_git
+      # invoke :create_heroku_apps
+      # invoke :create_github_repo
+      invoke :outro
+    end
+
+    def remove_files_we_dont_need
+      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'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      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
+    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 :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_capybara_webkit
+      # build :setup_guard_spork
+    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
+      build :initialize_on_precompile
+    end
+
+    def create_suspenders_views
+      say 'Creating suspenders views'
+      build :create_partials_directory
+      say 'Add default stylesheets'
+      build :add_default_stylesheets
+      build :create_shared_flashes
+      build :create_shared_javascripts
+      build :create_application_layout
+    end
+
+    def create_common_javascripts
+      say 'Pulling in some common javascripts'
+      build :create_common_javascripts
+    end
+
+    def add_jquery_ui
+      say 'Add jQuery ui to the standard application.js'
+      build :add_jquery_ui
+    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 :add_email_validator
+      build :setup_default_rake_task
+      # build :configure_unicorn
+      # build :setup_foreman
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    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
+      end
+    end
+
+    def create_github_repo
+      if options[:github]
+        say 'Creating Github repo'
+        build :create_github_repo, options[:github]
+      end
+    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 outro
+      say 'Congratulations! You just pulled our suspenders.'
+      say "Remember to run 'rails generate airbrake' with your API key."
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    protected
+
+    def get_builder_class
+      RailsloveSuspenders::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/railslove-suspenders/version.rb

@@ -0,0 +1,4 @@
+module RailsloveSuspenders
+  VERSION = '0.1.0'
+  # suspenders 1.3.0
+end

data/railslove-suspenders.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'railslove-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 'hub', '~> 1.10'
+  s.add_dependency 'rails', '3.2.13'
+  # s.add_development_dependency 'aruba', '~> 0.5'
+  # s.add_development_dependency 'cucumber', '~> 1.2'
+  s.authors = ['stephanpavlovic']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+Suspenders is a base Rails project that you can upgrade. It is used by
+thoughtbot to get a jump start on a working app. Use Suspenders if you're in a
+rush to build something amazing; don't use it if you like missing deadlines.
+  HERE
+
+  s.email = 'stephan@railslove.com'
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |file| File.basename(file) }
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/railslove/railslove-suspenders'
+  s.name = 'railslove-suspenders'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using thoughtbot's best practices."
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = RailsloveSuspenders::VERSION
+end

data/templates/Gemfile_clean

@@ -0,0 +1,42 @@
+source 'https://rubygems.org'
+
+gem 'airbrake'
+gem 'compass'
+gem 'jquery-rails'
+gem 'pg'
+gem 'rails', '>= 3.2.13'
+gem 'quiet_assets'
+gem 'newrelic_rpm'
+
+
+group :assets do
+  gem 'coffee-rails'
+  gem 'sass-rails'
+  gem 'haml-rails'
+  gem 'uglifier'
+end
+
+group :development do
+  gem 'better_errors'
+  gem 'binding_of_caller'
+  gem 'smurfville'
+  gem 'i18n_viz'
+end
+
+group :development, :test do
+  gem 'factory_girl_rails'
+  gem 'rspec-rails'
+end
+
+group :test do
+  gem 'capybara-webkit', '>= 0.14.1'
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'shoulda-matchers'
+  gem 'timecop'
+end
+
+group :deploy do
+  gem "capistrano"
+  gem "capistrano-ext"
+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,9 @@
+You look great in Suspenders
+============================
+
+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)

data/templates/_flashes.html.haml

@@ -0,0 +1,3 @@
+.m-flash
+  - flash.each do |key, value|
+    %div{:id => "flash_#{key}"}= value

data/templates/_javascript.html.haml

@@ -0,0 +1,3 @@
+= javascript_include_tag :application
+= yield :javascript
+

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,11 @@
+#!/usr/bin/env sh
+
+# Set up Rails app. Run this script immediately after cloning the codebase.
+# https://github.com/thoughtbot/guides/tree/master/protocol
+
+bundle install
+bundle exec rake db:setup
+
+if [ ! -f .env ]; then
+  cp .sample.env .env
+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'