welaika-suspenders 2.28.0 → 2.29.0.alpha.1

data/lib/suspenders/generators/production/force_tls_generator.rb

@@ -0,0 +1,14 @@
+require "rails/generators"
+require_relative "../../actions"
+
+module Suspenders
+  module Production
+    class ForceTlsGenerator < Rails::Generators::Base
+      include Suspenders::Actions
+
+      def config_enforce_ssl
+        configure_environment "production", "config.force_ssl = true"
+      end
+    end
+  end
+end

data/lib/suspenders/generators/production/timeout_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+
+module Suspenders
+  module Production
+    class TimeoutGenerator < Rails::Generators::Base
+      def add_gem
+        gem "rack-timeout", group: :production
+      end
+
+      def configure_rack_timeout
+        append_file ".env", rack_timeout_config
+      end
+
+      private
+
+      def rack_timeout_config
+        %{RACK_TIMEOUT_SERVICE_TIMEOUT=10}
+      end
+    end
+  end
+end

data/lib/suspenders/generators/security_generator.rb

@@ -0,0 +1,29 @@
+require "rails/generators"
+
+module Suspenders
+  class SecurityGenerator < Rails::Generators::Base
+    source_root File.expand_path(
+      File.join("..", "..", "..", "templates"),
+      File.dirname(__FILE__),
+    )
+
+    def add_checkers_gems
+      gem 'brakeman', require: false, group: :development
+      gem 'bundler-audit', '>= 0.5.0', require: false, group: :development
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+
+    def setup_brakeman
+      copy_file "brakeman.rake", "lib/tasks/brakeman.rake"
+    end
+
+    def setup_bundler_audit
+      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
+    end
+
+    def create_binstubs
+      Bundler.with_clean_env { run "bundle binstubs brakeman" }
+    end
+  end
+end

data/lib/suspenders/generators/testing_generator.rb

@@ -0,0 +1,72 @@
+require "rails/generators"
+
+module Suspenders
+  class TestingGenerator < Rails::Generators::Base
+    source_root File.expand_path(
+      File.join("..", "..", "..", "templates"),
+      File.dirname(__FILE__),
+    )
+
+    def add_testing_gems
+      gem "spring-commands-rspec", group: :development
+      gem "rspec-rails", "~> 3.8", group: %i(development test)
+      gem "shoulda-matchers", group: :test
+
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def generate_rspec
+      generate "rspec:install"
+    end
+
+    def configure_rspec
+      remove_file "spec/rails_helper.rb"
+      remove_file "spec/spec_helper.rb"
+      copy_file "rails_helper.rb", "spec/rails_helper.rb"
+      copy_file "spec_helper.rb", "spec/spec_helper.rb"
+    end
+
+    def provide_shoulda_matchers_config
+      copy_file(
+        "shoulda_matchers_config_rspec.rb",
+        "spec/support/shoulda_matchers.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_i18n_for_test_environment
+      copy_file "i18n.rb", "spec/support/i18n.rb"
+    end
+
+    def configure_action_mailer_in_specs
+      copy_file "action_mailer.rb", "spec/support/action_mailer.rb"
+    end
+
+    def create_binstubs
+      Bundler.with_clean_env { run "bundle binstubs rspec-core" }
+    end
+
+    def add_helpers_for_rspec
+      copy_file 'queries_helper_rspec.rb', 'spec/support/queries_helper.rb'
+    end
+
+    def add_capybara_helper
+      copy_file 'capybara_helpers.rb', 'spec/support/capybara_helpers.rb'
+    end
+
+    private
+
+    def empty_directory_with_keep_file(destination)
+      empty_directory(destination, {})
+      keep_file(destination)
+    end
+
+    def keep_file(destination)
+      create_file(File.join(destination, ".keep"))
+    end
+  end
+end

data/lib/suspenders/generators/views_generator.rb

@@ -0,0 +1,44 @@
+require "rails/generators"
+
+module Suspenders
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path(
+      File.join("..", "..", "..", "templates"),
+      File.dirname(__FILE__),
+    )
+
+    def add_slim_gem
+      gem "slim-rails"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_slim
+      copy_file 'slim.rb', 'config/initializers/slim.rb'
+    end
+
+    def create_partials_directory
+      empty_directory "app/views/application"
+    end
+
+    def create_shared_flashes
+      copy_file "_flashes.html.slim", "app/views/application/_flashes.html.slim"
+      copy_file "flashes_helper.rb", "app/helpers/flashes_helper.rb"
+    end
+
+    def create_shared_javascripts
+      copy_file "_javascript.html.slim",
+        "app/views/application/_javascript.html.slim"
+    end
+
+    def create_shared_css_overrides
+      copy_file "_css_overrides.html.slim",
+        "app/views/application/_css_overrides.html.slim"
+    end
+
+    def create_application_layout
+      template "suspenders_layout.html.slim",
+        "app/views/layouts/application.html.slim",
+        force: true
+    end
+  end
+end

data/lib/suspenders/version.rb

@@ -1,8 +1,8 @@
 module Suspenders
-  RAILS_VERSION = "~> 5.1.4".freeze
+  RAILS_VERSION = "~> 5.2.0".freeze
   RUBY_VERSION = IO.
     read("#{File.dirname(__FILE__)}/../../.ruby-version").
     strip.
     freeze
-  VERSION = "2.28.0".freeze
+  VERSION = "2.29.0.alpha.1".freeze
 end

data/spec/features/api_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+RSpec.describe "Suspend a new project with --api flag" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+  end
+
+  it "ensures project specs pass" do
+    run_suspenders("--api")
+
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rspec spec/`).to include("0 failures")
+      end
+    end
+  end
+end

data/spec/features/new_project_spec.rb

@@ -74,18 +74,14 @@ RSpec.describe "Suspend a new project with default configuration" do
     expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
   end
 
-  it "configures capybara" do
-    expect(File).to exist("#{project_path}/spec/support/capybara.rb")
+  it "configures capybara-chromedriver" do
+    expect(File).to exist("#{project_path}/spec/support/chromedriver.rb")
   end
 
   it "adds support file for i18n" do
     expect(File).to exist("#{project_path}/spec/support/i18n.rb")
   end
 
-  it "adds support file for factory girl" do
-    expect(File).to exist("#{project_path}/spec/support/factory_girl.rb")
-  end
-
   it "adds rspec helper for fixtures" do
     expect(File).to exist("#{project_path}/spec/support/fixtures_helper.rb")
   end
@@ -192,21 +188,12 @@ RSpec.describe "Suspend a new project with default configuration" do
     expect(production_config).not_to match(/"HOST"/)
   end
 
-  it "configures email interceptor in smtp config" do
-    smtp_file = IO.read("#{project_path}/config/smtp.rb")
-    expect(smtp_file).
-      to match(/RecipientInterceptor.new\(ENV\["EMAIL_RECIPIENTS"\]\)/)
-  end
-
-  it "configs active job queue adapter" do
-    application_config = IO.read("#{project_path}/config/application.rb")
+  it "configures email interceptor" do
+    email_file = File.join(project_path, "config", "initializers", "email.rb")
+    email_config = IO.read(email_file)
 
-    expect(application_config).to match(
-      /^ +config.active_job.queue_adapter = :delayed_job$/
-    )
-    expect(test_config).to match(
-      /^ +config.active_job.queue_adapter = :inline$/
-    )
+    expect(email_config).
+      to include(%{RecipientInterceptor.new(ENV["EMAIL_RECIPIENTS"])})
   end
 
   it "configs bullet gem in development" do
@@ -242,6 +229,7 @@ RSpec.describe "Suspend a new project with default configuration" do
   it "creates binstubs" do
     expect(File).to exist("#{project_path}/bin/brakeman")
     expect(File).to exist("#{project_path}/bin/rubocop")
+    expect(File).to exist("#{project_path}/bin/rspec")
   end
 
   it "removes comments and extra newlines from config files" do
@@ -284,7 +272,7 @@ RSpec.describe "Suspend a new project with default configuration" do
   it "creates heroku application manifest file with application name in it" do
     app_json_file = IO.read("#{project_path}/app.json")
 
-    expect(app_json_file).to match(/"name":"#{app_name.dasherize}"/)
+    expect(app_json_file).to match(/"name":\s*"#{app_name.dasherize}"/)
   end
 
   def app_name

data/spec/features/production/email_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:production:email" do
+  it "generates the configuration for a production email deployment" do
+    with_app { generate("suspenders:production:email") }
+
+    expect("config/smtp.rb").to match_contents(%r{SMTP_SETTINGS\s*=})
+
+    expect("config/environments/production.rb").to \
+      match_contents(%r{require.+config/smtp})
+    expect("config/environments/production.rb").to \
+      match_contents(%r{action_mailer.delivery_method\s*=\s*:smtp})
+    expect("config/environments/production.rb").to \
+      match_contents(%r{action_mailer.smtp_settings\s*=\s*SMTP_SETTINGS})
+
+    expect("app.json").to contain_json(
+      env: {
+        SMTP_ADDRESS: { required: true },
+        SMTP_DOMAIN: { required: true },
+        SMTP_PASSWORD: { required: true },
+        SMTP_USERNAME: { required: true },
+      },
+    )
+  end
+
+  it "destroys the configuration for a production email deployment" do
+    with_app { destroy("suspenders:production:email") }
+
+    expect("config/smtp.rb").not_to exist_as_a_file
+
+    expect("config/environments/production.rb").not_to \
+      match_contents(%r{require.+config/smtp})
+    expect("config/environments/production.rb").not_to \
+      match_contents(%r{action_mailer.delivery_method\s*=\s*:smtp})
+    expect("config/environments/production.rb").not_to \
+      match_contents(%r{action_mailer.smtp_settings\s*=\s*SMTP_SETTINGS})
+
+    expect("app.json").not_to contain_json(
+      env: {
+        SMTP_ADDRESS: { required: true },
+        SMTP_DOMAIN: { required: true },
+        SMTP_PASSWORD: { required: true },
+        SMTP_USERNAME: { required: true },
+      },
+    )
+  end
+end

data/spec/support/contain_json_matcher.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "json"
+
+RSpec::Matchers.define :contain_json do
+  match do
+    sub_json = expected
+    filename = actual
+
+    filepath = File.join(project_path, filename)
+    json = JSON.parse(IO.read(filepath), symbolize_names: true)
+    sub_json <= json
+  end
+
+  failure_message do
+    sub_json = expected
+    filename = actual
+
+    filepath = File.join(project_path, filename)
+    json = JSON.parse(IO.read(filepath), symbolize_names: true)
+
+    "in #{filename}, expected to find\n#{sub_json.inspect}\nin\n#{json.inspect}"
+  end
+end

data/spec/support/exist_as_a_file_matcher.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :exist_as_a_file do
+  match do |filename|
+    File.exist?(File.join(project_path, filename))
+  end
+end

data/spec/support/match_contents_matcher.rb

@@ -0,0 +1,6 @@
+RSpec::Matchers.define :match_contents do |regexp|
+  match do |filename|
+    contents = IO.read(File.join(project_path, filename))
+    contents =~ regexp
+  end
+end

data/spec/support/suspenders.rb

@@ -11,52 +11,92 @@ module SuspendersTestHelpers
 
   def run_suspenders(arguments = nil)
     arguments = "--path=#{root_path} #{arguments}"
-    Dir.chdir(tmp_path) do
-      Bundler.with_clean_env do
-        add_fakes_to_path
-        `
-          #{suspenders_bin} #{APP_NAME} #{arguments}
-        `
-        Dir.chdir(APP_NAME) do
-          with_env("HOME", tmp_path) do
-            `git add .`
-            `git commit -m 'Initial commit'`
-          end
+    run_in_tmp do
+      add_fakes_to_path
+
+      with_revision_for_honeybadger do
+        debug `#{suspenders_bin} #{APP_NAME} #{arguments}`
+      end
+
+      Dir.chdir(APP_NAME) do
+        with_env("HOME", tmp_path) do
+          debug `git add .`
+          debug `git commit -m 'Initial commit'`
         end
       end
     end
   end
 
-  def suspenders_help_command
-    Dir.chdir(tmp_path) do
-      Bundler.with_clean_env do
-        `
-          #{suspenders_bin} -h
-        `
+  def with_app
+    drop_dummy_database
+    remove_project_directory
+    rails_new
+    setup_app_dependencies
+
+    yield
+  end
+
+  def rails_new
+    run_in_tmp do
+      add_fakes_to_path
+
+      with_revision_for_honeybadger do
+        debug `#{system_rails_bin} new #{APP_NAME}`
+      end
+
+      Dir.chdir(APP_NAME) do
+        File.open("Gemfile", "a") do |file|
+          file.puts %{gem "suspenders", path: #{root_path.inspect}}
+        end
+
+        with_env("HOME", tmp_path) do
+          debug `git add .`
+          debug `git commit -m 'Initial commit'`
+        end
       end
     end
   end
 
-  def setup_app_dependencies
-    if File.exist?(project_path)
-      Dir.chdir(project_path) do
-        Bundler.with_clean_env do
-          `bundle check || bundle install`
-        end
+  def generate(generator)
+    run_in_project do
+      with_revision_for_honeybadger do
+        debug `bin/spring stop`
+        debug `#{project_rails_bin} generate #{generator}`
       end
     end
   end
 
-  def drop_dummy_database
-    if File.exist?(project_path)
-      Dir.chdir(project_path) do
-        Bundler.with_clean_env do
-          `rails db:drop`
-        end
+  def destroy(generator)
+    run_in_project do
+      with_revision_for_honeybadger do
+        `bin/spring stop`
+        `#{project_rails_bin} destroy #{generator}`
       end
     end
   end
 
+  def suspenders_help_command
+    run_in_tmp do
+      debug `#{suspenders_bin} -h`
+    end
+  end
+
+  def setup_app_dependencies
+    run_in_project do
+      debug `bundle check || bundle install`
+    end
+  rescue Errno::ENOENT
+    # The project_path might not exist, in which case we can skip this.
+  end
+
+  def drop_dummy_database
+    run_in_project do
+      debug `#{project_rails_bin} db:drop 2>&1`
+    end
+  rescue Errno::ENOENT
+    # The project_path might not exist, in which case we can skip this.
+  end
+
   def add_fakes_to_path
     ENV["PATH"] = "#{support_bin}:#{ENV['PATH']}"
   end
@@ -79,6 +119,14 @@ module SuspendersTestHelpers
     File.join(root_path, 'bin', 'welaika-suspenders')
   end
 
+  def system_rails_bin
+    "rails"
+  end
+
+  def project_rails_bin
+    "bin/rails"
+  end
+
   def support_bin
     File.join(root_path, "spec", "fakes", "bin")
   end
@@ -88,12 +136,47 @@ module SuspendersTestHelpers
   end
 
   def with_env(name, new_value)
+    had_key = ENV.has_key?(name)
     prior = ENV[name]
     ENV[name] = new_value.to_s
 
     yield
 
   ensure
-    ENV[name] = prior
+    ENV.delete(name)
+
+    if had_key
+      ENV[name] = prior
+    end
+  end
+
+  def with_revision_for_honeybadger
+    with_env("HEROKU_SLUG_COMMIT", 1) do
+      yield
+    end
+  end
+
+  def run_in_tmp
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        yield
+      end
+    end
+  end
+
+  def run_in_project
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        yield
+      end
+    end
+  end
+
+  def debug(output)
+    if ENV["DEBUG"]
+      warn output
+    end
+
+    output
   end
 end