philosophies-suspenders 2.0.0

data/lib/suspenders/generators/app_generator.rb

@@ -0,0 +1,249 @@
+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 :skip_heroku, type: :boolean, aliases: "-H", default: false,
+      desc: "Don't 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 :origin, type: :string, default: nil,
+      desc: "Add and push to git remote for origin"
+
+    class_option :skip_git, type: :boolean, default: false,
+      desc: "Don't create and commit to git repository"
+
+    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 :configure_app
+      invoke :setup_stylesheets
+      invoke :setup_javascripts
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_git
+      invoke :setup_database
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :setup_segment
+      invoke :setup_bundler_audit
+      invoke :setup_spring
+      invoke :run_stairs
+      invoke :initial_commit_and_branching
+      invoke :push_to_origin
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      unless options[:skip_heroku]
+        build :setup_heroku_specific_gems
+      end
+
+      bundle_command 'install'
+
+      build :version_gems_in_gemfile
+    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 :set_test_delivery_method
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+      build :configure_rubocop
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :set_up_factory_girl_for_rspec
+      build :generate_rspec
+      build :configure_rspec
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+      build :configure_i18n_for_test_environment
+      build :configure_i18n_tasks
+      build :configure_action_mailer_in_specs
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_newrelic
+      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 :configure_simple_form
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :setup_default_rake_task
+      build :configure_unicorn
+      build :setup_foreman
+      build :configure_airbrake
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_javascripts
+      say 'Set up javascripts'
+      build :setup_javascripts
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def initial_commit_and_branching
+      if !options[:skip_git]
+        say 'Creating initial commit and branches'
+        build :create_initial_commit
+        build :setup_deployment_environment_branches
+      end
+    end
+
+    def push_to_origin
+      if !options[:skip_git] && options[:origin]
+        say 'Pushing to origin remote'
+        build :setup_and_push_to_origin_remote, options[:origin]
+      end
+    end
+
+    def create_heroku_apps
+      unless options[:skip_heroku]
+        say "Creating Heroku apps"
+        build :create_heroku_apps, options[:heroku_flags]
+        build :set_heroku_serve_static_files
+        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_segment
+      say 'Setting up Segment'
+      build :setup_segment
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    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_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def run_stairs
+      build :run_stairs
+    end
+
+    def outro
+      say 'Congratulations! You just pulled our suspenders.'
+      say 'Remember to update the README with specifics for your project.'
+    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.3"
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = "2.0.0"
+end

data/lib/suspenders.rb

@@ -0,0 +1,4 @@
+require 'suspenders/version'
+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"
+
+RSpec.describe "GitHub" do
+  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,20 @@
+require "spec_helper"
+
+RSpec.describe "Heroku" do
+  it "suspends a project for Heroku" do
+    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")
+  end
+
+  it "suspends a project with extra Heroku flags" do
+    run_suspenders(%{--heroku-flags="--region eu"})
+
+    expect(FakeHeroku).to have_created_app_for("staging", "--region eu")
+    expect(FakeHeroku).to have_created_app_for("production", "--region eu")
+  end
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,157 @@
+require "spec_helper"
+
+RSpec.describe "Suspend a new project with default configuration" do
+  it "ensures project specs pass" do
+    run_suspenders
+
+    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
+    run_suspenders
+
+    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
+    run_suspenders
+
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  it "loads secret_key_base from env" do
+    run_suspenders
+
+    secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
+    expect(secrets_file).to match(/secret_key_base: <%= ENV\["SECRET_KEY_BASE"\] %>/)
+  end
+
+  it "adds support file for action mailer" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  it "adds support file for i18n" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  it "ensures newrelic.yml reads NewRelic license from env" do
+    run_suspenders
+
+    newrelic_file = IO.read("#{project_path}/config/newrelic.yml")
+
+    expect(newrelic_file).to match(
+      /license_key: "<%= ENV\["NEW_RELIC_LICENSE_KEY"\] %>"/
+    )
+  end
+
+  it "records pageviews through Segment if ENV variable set" do
+    run_suspenders
+
+    expect(analytics_partial).
+      to include(%{<% if ENV["SEGMENT_KEY"] %>})
+    expect(analytics_partial).
+      to include(%{window.analytics.load("<%= ENV["SEGMENT_KEY"] %>");})
+  end
+
+  it "raises on unpermitted parameters in all environments" do
+    run_suspenders
+
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.action_controller.action_on_unpermitted_parameters = :raise$/
+    )
+  end
+
+  it "raises on missing translations in development and test" do
+    run_suspenders
+
+    %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 "adds specs for missing or unused translations" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/i18n_spec.rb")
+  end
+
+  it "configs i18n-tasks" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/config/i18n-tasks.yml")
+  end
+
+  it "evaluates en.yml.erb" do
+    run_suspenders
+
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+    app_name = SuspendersTestHelpers::APP_NAME
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  it "configs simple_form" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/config/initializers/simple_form.rb")
+  end
+
+  it "configs :test email delivery method for development" do
+    run_suspenders
+
+    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 "configs active job queue adapter" do
+    run_suspenders
+
+    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 = :sidekiq$/
+    )
+    expect(test_config).to match(
+      /^ +config.active_job.queue_adapter = :inline$/
+    )
+  end
+
+  it "adds spring to binstubs" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/bin/spring")
+
+    spring_line = /^ +load File.expand_path\("\.\.\/spring", __FILE__\)$/
+    bin_stubs = %w(rake rails rspec)
+    bin_stubs.each do |bin_stub|
+      expect(IO.read("#{project_path}/bin/#{bin_stub}")).to match(spring_line)
+    end
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.erb")
+  end
+end