cosmit-suspenders 1.36.0

data/lib/suspenders/generators/app_generator.rb

@@ -0,0 +1,254 @@
+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: "Configure for selected database (options: #{DATABASES.join("/")})"
+
+    class_option :heroku, type: :boolean, aliases: "-H", default: false,
+      desc: "Create staging and production Heroku apps"
+
+    class_option :heroku_flags, type: :string, default: "",
+      desc: "Set extra Heroku flags"
+
+    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"
+
+    class_option :skip_turbolinks, type: :boolean, default: true,
+      desc: "Skip turbolinks gem"
+
+    class_option :skip_bundle, type: :boolean, aliases: "-B", default: true,
+      desc: "Don't run bundle install"
+
+    def finish_template
+      invoke :suspenders_customization
+      super
+    end
+
+    def suspenders_customization
+      invoke :customize_gemfile
+      invoke :setup_simple_form
+      invoke :setup_devise
+      invoke :setup_initjs
+      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 :configure_app
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_config_comment_lines
+      invoke :remove_routes_comment_lines
+      invoke :setup_dotfiles
+      invoke :setup_git
+      invoke :setup_database
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :setup_bundler_audit
+      invoke :setup_spring
+      invoke :setup_active_admin
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :set_ruby_to_version_being_used
+
+      if options[:heroku]
+        build :set_up_heroku_specific_gems
+      end
+
+      bundle_command 'install'
+    end
+
+    def setup_simple_form
+      build :configure_simple_form
+    end
+
+    def setup_devise
+      build :configure_devise
+    end
+
+    def setup_initjs
+      build :configure_initjs
+    end
+
+    def setup_active_admin
+      build :configure_active_admin
+    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_missing_assets_in_test
+      build :raise_on_delivery_errors
+      build :set_test_delivery_method
+      build :add_bullet_gem_configuration
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_dev_prime_task
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+      build :configure_quiet_assets
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :set_up_factory_girl_for_rspec
+      build :generate_factories_file
+      build :set_up_hound
+      build :generate_rspec
+      build :configure_rspec
+      build :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :provide_shoulda_matchers_config
+      build :configure_spec_support_features
+      build :configure_ci
+      build :configure_i18n_for_test_environment
+      build :configure_action_mailer_in_specs
+      build :configure_capybara_webkit
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+      build :configure_rack_timeout
+      build :enable_rack_canonical_host
+      build :enable_rack_deflater
+      build :setup_asset_host
+    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 configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_active_job
+      build :configure_time_formats
+      build :disable_xml_params
+      build :setup_default_rake_task
+      build :set_up_forego
+      build :setup_rack_mini_profiler
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say "Initializing git"
+        invoke :setup_default_directories
+        invoke :init_git
+      end
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say "Creating Heroku apps"
+        build :create_heroku_apps, options[:heroku_flags]
+        build :provide_review_apps_setup_script
+        build :set_heroku_serve_static_files
+        build :set_heroku_remotes
+        build :set_heroku_rails_secrets
+        build :create_heroku_pipelines_config_file
+        build :create_heroku_pipeline
+        build :provide_deploy_script
+        build :configure_automatic_deployment
+      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_dotfiles
+      build :copy_dotfiles
+    end
+
+    def setup_default_directories
+      build :setup_default_directories
+    end
+
+    def setup_bundler_audit
+      say "Setting up bundler-audit"
+      build :setup_bundler_audit
+    end
+
+    def setup_spring
+      say "Springifying binstubs"
+      build :setup_spring
+    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_config_comment_lines
+      build :remove_config_comment_lines
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def outro
+      say 'Congratulations! You just pulled our suspenders.'
+    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,5 @@
+module Suspenders
+  RAILS_VERSION = "~> 4.2.0"
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = "1.36.0"
+end

data/lib/suspenders.rb

@@ -0,0 +1,5 @@
+require 'suspenders/version'
+require 'suspenders/generators/app_generator'
+require 'suspenders/actions'
+require "suspenders/adapters/heroku"
+require 'suspenders/app_builder'

data/spec/adapters/heroku_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+module Suspenders
+  module Adapters
+    RSpec.describe Heroku do
+      it "sets the heroku remotes" do
+        setup_file = "bin/setup"
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:append_file)
+
+        Heroku.new(app_builder).set_heroku_remotes
+
+        expect(app_builder).to have_received(:append_file).
+          with(setup_file, /heroku join --app #{app_name.dasherize}-production/)
+        expect(app_builder).to have_received(:append_file).
+          with(setup_file, /heroku join --app #{app_name.dasherize}-staging/)
+      end
+
+      it "sets up the heroku specific gems" do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:inject_into_file)
+
+        Heroku.new(app_builder).set_up_heroku_specific_gems
+
+        expect(app_builder).to have_received(:inject_into_file).
+          with("Gemfile", /rails_stdout_logging/, anything)
+      end
+
+      it "sets the heroku rails secrets" do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+
+        Heroku.new(app_builder).set_heroku_rails_secrets
+
+        expect(app_builder).to(
+          have_configured_var("staging", "SECRET_KEY_BASE"),
+        )
+        expect(app_builder).to(
+          have_configured_var("production", "SECRET_KEY_BASE"),
+        )
+      end
+
+      def app_name
+        SuspendersTestHelpers::APP_NAME
+      end
+
+      def have_configured_var(remote_name, var)
+        have_received(:run).with(/config:add #{var}=.+ --remote #{remote_name}/)
+      end
+    end
+  end
+end

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,15 @@
+require "spec_helper"
+
+RSpec.describe "GitHub" do
+  before do
+    drop_dummy_database
+    remove_project_directory
+  end
+
+  it "suspends 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,93 @@
+require "spec_helper"
+
+RSpec.describe "Heroku" do
+  context "--heroku" do
+    before(:all) do
+      clean_up
+      run_suspenders("--heroku=true")
+    end
+
+    it "suspends a project for Heroku" do
+      app_name = SuspendersTestHelpers::APP_NAME.dasherize
+
+      expect(FakeHeroku).to(
+        have_gem_included(project_path, "rails_stdout_logging"),
+      )
+      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",
+      )
+      expect(FakeHeroku).to have_setup_pipeline_for(app_name)
+
+      bin_setup_path = "#{project_path}/bin/setup"
+      bin_setup = IO.read(bin_setup_path)
+
+      expect(bin_setup).to include("heroku join --app #{app_name}-production")
+      expect(bin_setup).to include("heroku join --app #{app_name}-staging")
+      expect(bin_setup).to include("git config heroku.remote staging")
+      expect(File.stat(bin_setup_path)).to be_executable
+
+      bin_setup_path = "#{project_path}/bin/setup_review_app"
+      bin_setup = IO.read(bin_setup_path)
+
+      expect(bin_setup).to include("heroku run rake db:migrate --app #{app_name}-staging-pr-$1")
+      expect(bin_setup).to include("heroku ps:scale worker=1 --app #{app_name}-staging-pr-$1")
+      expect(bin_setup).to include("heroku restart --app #{app_name}-staging-pr-$1")
+      expect(File.stat(bin_setup_path)).to be_executable
+
+      bin_deploy_path = "#{project_path}/bin/deploy"
+      bin_deploy = IO.read(bin_deploy_path)
+
+      expect(bin_deploy).to include("heroku run rake db:migrate")
+      expect(File.stat(bin_deploy_path)).to be_executable
+
+      readme = IO.read("#{project_path}/README.md")
+
+      expect(readme).to include("./bin/deploy staging")
+      expect(readme).to include("./bin/deploy production")
+
+      circle_yml_path = "#{project_path}/circle.yml"
+      circle_yml = IO.read(circle_yml_path)
+
+      expect(circle_yml).to include <<-YML.strip_heredoc
+      deployment:
+        staging:
+          branch: master
+          commands:
+            - bin/deploy staging
+      YML
+    end
+
+    it "adds app.json file" do
+      expect(File).to exist("#{project_path}/app.json")
+    end
+
+    it "includes application name in app.json file" do
+      app_json_file = IO.read("#{project_path}/app.json")
+      app_name = SuspendersTestHelpers::APP_NAME.dasherize
+
+      expect(app_json_file).to match(/"name":"#{app_name}"/)
+    end
+  end
+
+  context "--heroku with region flag" do
+    before(:all) do
+      clean_up
+      run_suspenders(%{--heroku=true --heroku-flags="--region eu"})
+    end
+
+    it "suspends a project with extra Heroku flags" do
+      expect(FakeHeroku).to have_created_app_for("staging", "--region eu")
+      expect(FakeHeroku).to have_created_app_for("production", "--region eu")
+    end
+  end
+
+  def clean_up
+    drop_dummy_database
+    remove_project_directory
+    FakeHeroku.clear!
+  end
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,215 @@
+require "spec_helper"
+
+RSpec.describe "Suspend a new project with default configuration" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    run_suspenders
+  end
+
+  it "uses custom Gemfile" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+    expect(gemfile_file).to match(
+      /^ruby "#{Suspenders::RUBY_VERSION}"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "autoprefixer-rails"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "rails", "#{Suspenders::RAILS_VERSION}"$/,
+    )
+  end
+
+  it "ensures project specs pass" do
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake`).to include('0 failures')
+      end
+    end
+  end
+
+  it "inherits staging config from production" do
+    staging_file = IO.read("#{project_path}/config/environments/staging.rb")
+    config_stub = "Rails.application.configure do"
+
+    expect(staging_file).to match(/^require_relative "production"/)
+    expect(staging_file).to match(/#{config_stub}/), staging_file
+  end
+
+  it "creates .ruby-version from Suspenders .ruby-version" do
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  it "copies dotfiles" do
+    %w[.ctags .env].each do |dotfile|
+      expect(File).to exist("#{project_path}/#{dotfile}")
+    end
+  end
+
+  it "loads secret_key_base from env" do
+    secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
+    expect(secrets_file).to match(/secret_key_base: <%= ENV\["SECRET_KEY_BASE"\] %>/)
+  end
+
+  it "adds bin/setup file" do
+    expect(File).to exist("#{project_path}/bin/setup")
+  end
+
+  it "makes bin/setup executable" do
+    bin_setup_path = "#{project_path}/bin/setup"
+
+    expect(File.stat(bin_setup_path)).to be_executable
+  end
+
+  it "adds support file for action mailer" do
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  it "configures capybara-webkit" do
+    expect(File).to exist("#{project_path}/spec/support/capybara_webkit.rb")
+  end
+
+  it "adds support file for i18n" do
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  it "creates good default .hound.yml" do
+    hound_config_file = IO.read("#{project_path}/.hound.yml")
+
+    expect(hound_config_file).to include "enabled: true"
+  end
+
+  it "ensures Gemfile contains `rack-mini-profiler`" do
+    gemfile = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile).to include %{gem "rack-mini-profiler", require: false}
+  end
+
+  it "ensures .sample.env defaults to RACK_MINI_PROFILER=0" do
+    env = IO.read("#{project_path}/.env")
+
+    expect(env).to include "RACK_MINI_PROFILER=0"
+  end
+
+  it "creates a rack-mini-profiler initializer" do
+    expect(File).
+      to exist("#{project_path}/config/initializers/rack_mini_profiler.rb")
+  end
+
+  it "raises on unpermitted parameters in all environments" do
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.action_controller.action_on_unpermitted_parameters = :raise$/
+    )
+  end
+
+  it "adds explicit quiet_assets configuration" do
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.quiet_assets = true$/
+    )
+  end
+
+  it "raises on missing translations in development and test" do
+    %w[development test].each do |environment|
+      environment_file =
+        IO.read("#{project_path}/config/environments/#{environment}.rb")
+      expect(environment_file).to match(
+        /^ +config.action_view.raise_on_missing_translations = true$/
+      )
+    end
+  end
+
+  it "evaluates en.yml.erb" do
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  it "configs simple_form" do
+    expect(File).to exist("#{project_path}/config/initializers/simple_form.rb")
+  end
+
+  it "configs :test email delivery method for development" do
+    dev_env_file = IO.read("#{project_path}/config/environments/development.rb")
+    expect(dev_env_file).
+      to match(/^ +config.action_mailer.delivery_method = :test$/)
+  end
+
+  it "uses APPLICATION_HOST, not HOST in the production config" do
+    prod_env_file = IO.read("#{project_path}/config/environments/production.rb")
+    expect(prod_env_file).to match(/"APPLICATION_HOST"/)
+    expect(prod_env_file).not_to match(/"HOST"/)
+  end
+
+  it "configures language in html element" do
+    layout_path = "/app/views/layouts/application.html.erb"
+    layout_file = IO.read("#{project_path}#{layout_path}")
+    expect(layout_file).to match(/<html lang="en">/)
+  end
+
+  it "configs active job queue adapter" do
+    application_config = IO.read("#{project_path}/config/application.rb")
+    test_config = IO.read("#{project_path}/config/environments/test.rb")
+
+    expect(application_config).to match(
+      /^ +config.active_job.queue_adapter = :delayed_job$/
+    )
+    expect(test_config).to match(
+      /^ +config.active_job.queue_adapter = :inline$/
+    )
+  end
+
+  it "configs bullet gem in development" do
+    test_config = IO.read("#{project_path}/config/environments/development.rb")
+
+    expect(test_config).to match /^ +Bullet.enable = true$/
+    expect(test_config).to match /^ +Bullet.bullet_logger = true$/
+    expect(test_config).to match /^ +Bullet.rails_logger = true$/
+  end
+
+  it "configs missing assets to raise in test" do
+    test_config = IO.read("#{project_path}/config/environments/test.rb")
+
+    expect(test_config).to match(
+      /^ +config.assets.raise_runtime_errors = true$/,
+    )
+  end
+
+  it "adds spring to binstubs" do
+    expect(File).to exist("#{project_path}/bin/spring")
+
+    bin_stubs = %w(rake rails rspec)
+    bin_stubs.each do |bin_stub|
+      expect(IO.read("#{project_path}/bin/#{bin_stub}")).to match(/spring/)
+    end
+  end
+
+  it "removes comments and extra newlines from config files" do
+    config_files = [
+      IO.read("#{project_path}/config/application.rb"),
+      IO.read("#{project_path}/config/environment.rb"),
+      IO.read("#{project_path}/config/environments/development.rb"),
+      IO.read("#{project_path}/config/environments/production.rb"),
+      IO.read("#{project_path}/config/environments/test.rb"),
+    ]
+
+    config_files.each do |file|
+      expect(file).not_to match(/.*#.*/)
+      expect(file).not_to match(/^$\n/)
+    end
+  end
+
+  it "copies factories.rb" do
+    expect(File).to exist("#{project_path}/spec/factories.rb")
+  end
+
+  def app_name
+    SuspendersTestHelpers::APP_NAME
+  end
+end