os_suspenders 0.0.1

data/lib/suspenders/app_builder.rb

@@ -0,0 +1,352 @@
+module Suspenders
+  class AppBuilder < Rails::AppBuilder
+    include Suspenders::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    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
+      action_on_unpermitted_parameters = <<-RUBY
+
+  # Raise an ActionController::UnpermittedParameters exception when
+  # a parameter is not explcitly permitted but is passed anyway.
+  config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+      inject_into_file(
+        "config/environments/development.rb",
+        action_on_unpermitted_parameters,
+        before: "\nend"
+      )
+    end
+
+    def provide_setup_script
+      copy_file 'bin_setup', 'bin/setup'
+      run 'chmod a+x bin/setup'
+    end
+
+    def provide_dev_prime_task
+      copy_file 'development_seeds.rb', 'lib/tasks/development_seeds.rake'
+    end
+
+    def configure_generators
+      config = <<-RUBY
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    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 enable_rack_deflater
+      config = <<-RUBY
+
+  # Enable deflate / gzip compression of controller-generated responses
+  config.middleware.use Rack::Deflater
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        :after => "config.serve_static_assets = false\n"
+    end
+
+    def setup_staging_environment
+      staging_file = 'config/environments/staging.rb'
+      copy_file 'staging.rb', staging_file
+
+      config = <<-RUBY
+
+#{app_name.classify}::Application.configure do
+  # ...
+end
+      RUBY
+
+      append_file staging_file, config
+    end
+
+    def setup_secret_token
+      template 'secret_token.rb',
+        'config/initializers/secret_token.rb',
+        :force => true
+    end
+
+    def create_partials_directory
+      empty_directory 'app/views/application'
+    end
+
+    def create_shared_flashes
+      copy_file '_flashes.html.erb', 'app/views/application/_flashes.html.erb'
+    end
+
+    def create_shared_javascripts
+      copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
+    end
+
+    def create_application_layout
+      template 'suspenders_layout.html.erb.erb',
+        'app/views/layouts/application.html.erb',
+        force: true
+    end
+
+    def remove_turbolinks
+      replace_in_file 'app/assets/javascripts/application.js',
+        /\/\/= require turbolinks\n/,
+        ''
+    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 db:migrate'
+    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'/
+      create_file '.ruby-version', "#{RUBY_VERSION}#{patchlevel}\n"
+    end
+
+    def setup_heroku_specific_gems
+      inject_into_file 'Gemfile', "\n\s\sgem 'rails_12factor'",
+        after: /group :staging, :production do/
+    end
+
+    def enable_database_cleaner
+      copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
+    end
+
+    def configure_spec_support_features
+      empty_directory_with_keep_file 'spec/features'
+      empty_directory_with_keep_file 'spec/support/features'
+    end
+
+    def configure_rspec
+      remove_file 'spec/spec_helper.rb'
+      copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+    end
+
+    def use_spring_binstubs
+      run 'bundle exec spring binstub --all'
+    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 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 fix_i18n_deprecation_warning
+      config = <<-RUBY
+    config.i18n.enforce_available_locales = true
+
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def generate_rspec
+      generate 'rspec: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'
+      copy_file 'application.css.scss',
+        'app/assets/stylesheets/application.css.scss'
+    end
+
+    def gitignore_files
+      remove_file '.gitignore'
+      copy_file 'suspenders_gitignore', '.gitignore'
+      [
+        'app/views/pages',
+        'spec/lib',
+        'spec/controllers',
+        'spec/helpers',
+        'spec/support/matchers',
+        'spec/support/mixins',
+        'spec/support/shared_examples'
+      ].each do |dir|
+        run "mkdir #{dir}"
+        run "touch #{dir}/.keep"
+      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 set_heroku_remotes
+      remotes = <<-RUBY
+
+# Set up staging and production git remotes
+git remote add staging git@heroku.com:#{app_name}-staging.git
+git remote add production git@heroku.com:#{app_name}-production.git
+      RUBY
+
+      append_file 'bin/setup', remotes
+    end
+
+    def set_heroku_rails_secrets
+      path_addition = override_path_for_tests
+      run "#{path_addition} heroku config:add SECRET_KEY_BASE=#{generate_secret} --remote=staging"
+      run "#{path_addition} heroku config:add SECRET_KEY_BASE=#{generate_secret} --remote=production"
+    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
+
+      %w(500 404 422).each do |page|
+        inject_into_file "public/#{page}.html", meta_tags, :after => "<head>\n"
+        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 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]\n"
+      end
+    end
+
+    def generate_devise
+      generate 'devise:install'
+    end
+
+    def generate_devise_user
+      generate 'devise User'
+    end
+
+    def devise_migrate
+      bundle_command 'exec rake db:migrate db:test:prepare'
+    end
+
+    private
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', 'spec', 'fakes', '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 generate_secret
+      SecureRandom.hex(64)
+    end
+
+    def patchlevel
+      if RUBY_PATCHLEVEL == 0 && RUBY_VERSION >= '2.1.0'
+        ''
+      else
+        "-p#{RUBY_PATCHLEVEL}"
+      end
+    end
+  end
+end

data/lib/suspenders/generators/app_generator.rb

@@ -0,0 +1,207 @@
+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 => '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 :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
+      invoke :setup_devise
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      if options[:heroku]
+        build :setup_heroku_specific_gems
+      end
+
+      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_devise
+      say 'Setting up devise'
+
+      build :generate_devise
+      build :generate_user
+      build :devise_migrate
+    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 :provide_dev_prime_task
+      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_spring_binstubs
+      # build :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+      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 :configure_rack_timeout
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      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
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say 'Creating Heroku apps'
+        build :create_heroku_apps
+        build :set_heroku_remotes
+        build :set_heroku_rails_secrets
+      end
+    end
+
+    def create_github_repo
+      if !options[:skip_git] && 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_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
+      Suspenders::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    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/spec/fakes/bin/heroku

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', '..', 'support', 'fake_heroku'), File.dirname(__FILE__))
+
+FakeHeroku.new(ARGV).run!

data/spec/fakes/bin/hub

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', '..', 'support', 'fake_github'), File.dirname(__FILE__))
+
+FakeGithub.new(ARGV).run!

data/spec/features/github_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+feature 'GitHub' do
+  scenario 'Suspend a project with --github option' do
+    repo_name = 'test'
+    run_suspenders("--github=#{repo_name}")
+
+    expect(FakeGithub).to have_created_repo(repo_name)
+  end
+end

data/spec/features/heroku_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+feature 'Heroku' do
+  scenario 'Suspend a project with --heroku=true' do
+    run_suspenders('--heroku=true')
+
+    expect(FakeHeroku).to have_gem_included(project_path, 'rails_12factor')
+    expect(FakeHeroku).to have_created_app_for('staging')
+    expect(FakeHeroku).to have_created_app_for('production')
+    expect(FakeHeroku).to have_configured_vars('staging', 'SECRET_KEY_BASE')
+    expect(FakeHeroku).to have_configured_vars('production', 'SECRET_KEY_BASE')
+  end
+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,24 @@
+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
+
+    FakeHeroku.clear!
+    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