welaika-suspenders 2.33 → 2.34

data/lib/suspenders/generators/staging/pull_requests_generator.rb

@@ -6,9 +6,9 @@ module Suspenders
       def configure_heroku_staging_pr_pipeline_host
         config = <<-RUBY
 
-  if ENV.fetch("HEROKU_APP_NAME", "").include?("staging-pr-")
-    ENV["APPLICATION_HOST"] = ENV["HEROKU_APP_NAME"] + ".herokuapp.com"
-    ENV["ASSET_HOST"] = ENV["HEROKU_APP_NAME"] + ".herokuapp.com"
+  if ENV.fetch('HEROKU_APP_NAME', '').include?('staging-pr-')
+    ENV['APPLICATION_HOST'] = ENV['HEROKU_APP_NAME'] + '.herokuapp.com'
+    ENV['ASSET_HOST'] = ENV['HEROKU_APP_NAME'] + '.herokuapp.com'
   end
         RUBY
 

data/lib/suspenders/generators/stylelint_generator.rb

@@ -3,11 +3,13 @@ require_relative "base"
 module Suspenders
   class StylelintGenerator < Generators::Base
     def install_stylelint
-      dependencies = ["stylelint",
-                      "stylelint-config-recommended",
-                      "stylelint-order",
-                      "stylelint-declaration-block-no-ignored-properties",
-                      "stylelint-scss"]
+      dependencies = [
+        { name: "stylelint", version: '10' }, # FIXME: config-recommened is not ready for stylelint 11 yet
+        { name: "stylelint-config-recommended" },
+        { name: "stylelint-order" },
+        { name: "stylelint-declaration-block-no-ignored-properties" },
+        { name: "stylelint-scss" }
+      ]
       action YarnInstall.new(self, dependencies, "--dev")
     end
 
@@ -18,17 +20,18 @@ module Suspenders
     class YarnInstall
       def initialize(base, dependencies, flags)
         @base = base
-        @dependencies = dependencies.join(" ")
+        @dependencies = dependencies
         @flags = flags
       end
 
       def invoke!
-        @base.run "bin/yarn add #{@dependencies} #{@flags}"
+        dependencies_with_versions = @dependencies.map { |d| d[:version] ? "#{d[:name]}@#{d[:version]}" : d[:name] }.join(' ')
+        @base.run "bin/yarn add #{dependencies_with_versions} #{@flags}"
       end
 
       def revoke!
         @base.behavior = :invoke
-        @base.run "bin/yarn remove #{@dependencies}"
+        @base.run "bin/yarn remove #{@dependencies.map { |d| d[:name] }.join(' ')}"
       ensure
         @base.behavior = :revoke
       end

data/lib/suspenders/version.rb

@@ -1,9 +1,9 @@
 module Suspenders
   RAILS_VERSION = "~> 5.2.3".freeze
-  POSTGRES_VERSION = "10.6".freeze # Used in CI
+  POSTGRES_VERSION = "11".freeze # Used in CI
   RUBY_VERSION = IO.
     read("#{File.dirname(__FILE__)}/../../.ruby-version").
     strip.
     freeze
-  VERSION = "2.33".freeze
+  VERSION = "2.34".freeze
 end

data/spec/expand_json_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+RSpec.describe Suspenders::Actions::ExpandJson do
+  let(:destination_root) { File.join(root_path, "tmp") }
+  let(:destination_file_name) { "app.json" }
+  let(:destination_path) { File.join(destination_root, destination_file_name) }
+
+  before do
+    FileUtils.rm destination_path if File.exist?(destination_path)
+  end
+
+  describe "#invoke!" do
+    context "when calling multiple times with the same root key" do
+      before do
+        described_class.new(
+          destination_root,
+          destination_file_name,
+          env: {
+            SMTP_ADDRESS: { required: true },
+          },
+        ).invoke!
+      end
+
+      it "deep merges the hash" do
+        described_class.new(
+          destination_root,
+          destination_file_name,
+          env: {
+            HEROKU_APP_NAME: { required: true },
+          },
+        ).invoke!
+
+        expected = <<~JSON
+          {
+            "env": {
+              "SMTP_ADDRESS": {
+                "required": true
+              },
+              "HEROKU_APP_NAME": {
+                "required": true
+              }
+            }
+          }
+        JSON
+        expect(existing_json).to eq(expected.chomp)
+      end
+    end
+  end
+
+  describe "#revoke!" do
+    before do
+      described_class.new(
+        destination_root,
+        destination_file_name,
+        env: {
+          foo: { required: true },
+          bar: { required: true },
+        },
+      ).invoke!
+    end
+
+    it "removes data from the JSON" do
+      described_class.new(
+        destination_root,
+        destination_file_name,
+        env: {
+          foo: { required: true },
+        },
+      ).revoke!
+
+      expected = <<~JSON
+        {
+          "env": {
+            "bar": {
+              "required": true
+            }
+          }
+        }
+      JSON
+      expect(existing_json).to eq(expected.chomp)
+    end
+  end
+
+  private
+
+  def existing_json
+    IO.read(destination_path)
+  end
+end

data/spec/features/inline_svg_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:inline_svg", type: :generator do
+  it "generates the configuration for inline_svg" do
+    with_app { generate("suspenders:inline_svg") }
+
+    expect("config/initializers/inline_svg.rb").to match_contents(/InlineSvg/)
+    expect("Gemfile").to match_contents(/inline_svg/)
+  end
+end

data/spec/features/new_project_spec.rb

@@ -13,9 +13,6 @@ RSpec.describe "Suspend a new project with default configuration" do
     expect(gemfile_file).to match(
       /^ruby '#{Suspenders::RUBY_VERSION}'$/,
     )
-    expect(gemfile_file).to match(
-      /^gem 'active_interaction'/,
-    )
     expect(gemfile_file).to match(
       /^gem 'rails', '#{Suspenders::RAILS_VERSION}'$/,
     )
@@ -96,7 +93,7 @@ RSpec.describe "Suspend a new project with default configuration" do
   it "configs locale and timezone" do
     result = IO.read("#{project_path}/config/application.rb")
 
-    expect(result).to match(/^ +config.i18n.available_locales = \[:en, :it\]$/)
+    expect(result).to match(/^ +config.i18n.available_locales = %i\[en it\]$/)
     expect(result).to match(/^ +config.i18n.default_locale = :it$/)
 
     expect(result).to match(/^ +config.time_zone = 'Rome'$/)
@@ -118,7 +115,7 @@ RSpec.describe "Suspend a new project with default configuration" do
 
   it "configures public_file_server.headers in production" do
     expect(production_config).to match(
-      /^ +config.public_file_server.headers = {\n +"Cache-Control" => "public,/,
+      /^ +config.public_file_server.headers = {\n +'Cache-Control' => 'public,/,
     )
   end
 
@@ -156,13 +153,13 @@ RSpec.describe "Suspend a new project with default configuration" do
   it "sets action mailer default host and asset host" do
     config_key = 'config\.action_mailer\.asset_host'
     config_value =
-      %q{ENV\.fetch\("ASSET_HOST", ENV\.fetch\("APPLICATION_HOST"\)\)}
+      %q{ENV\.fetch\('ASSET_HOST', ENV\.fetch\('APPLICATION_HOST'\)\)}
     expect(production_config).to match(/#{config_key} = #{config_value}/)
   end
 
   it "uses APPLICATION_HOST, not HOST in the production config" do
-    expect(production_config).to match(/"APPLICATION_HOST"/)
-    expect(production_config).not_to match(/"HOST"/)
+    expect(production_config).to match(/'APPLICATION_HOST'/)
+    expect(production_config).not_to match(/'HOST'/)
   end
 
   it "configures email interceptor" do
@@ -170,7 +167,7 @@ RSpec.describe "Suspend a new project with default configuration" do
     email_config = IO.read(email_file)
 
     expect(email_config).
-      to include(%{RecipientInterceptor.new(ENV["EMAIL_RECIPIENTS"], subject_prefix: '[STAGING]'})
+      to include(%{RecipientInterceptor.new(ENV['EMAIL_RECIPIENTS'], subject_prefix: '[STAGING]'})
   end
 
   it "configs bullet gem in development" do
@@ -201,30 +198,12 @@ RSpec.describe "Suspend a new project with default configuration" do
     expect(File).to exist("#{project_path}/bin/overcommit")
   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"),
-      development_config,
-      test_config,
-      production_config,
-    ]
-
-    config_files.each do |file|
-      expect(file).not_to match(%r{.*#.*})
-      expect(file).not_to eq(file.strip)
-      expect(file).not_to match(%r{^$\n\n})
-    end
-  end
-
   it "creates review apps setup script" do
     bin_setup_path = "#{project_path}/bin/setup_review_app"
     bin_setup = IO.read(bin_setup_path)
 
     expect(bin_setup).to include("PARENT_APP_NAME=#{app_name.dasherize}-staging")
     expect(bin_setup).to include("APP_NAME=#{app_name.dasherize}-staging-pr-$1")
-    expect(bin_setup).
-      to include("heroku run rails db:migrate --exit-code --app $APP_NAME")
     expect(bin_setup).to include("heroku ps:scale worker=1 --app $APP_NAME")
     expect(bin_setup).to include("heroku restart --app $APP_NAME")
 
@@ -235,7 +214,7 @@ RSpec.describe "Suspend a new project with default configuration" do
     bin_deploy_path = "#{project_path}/bin/deploy"
     bin_deploy = IO.read(bin_deploy_path)
 
-    expect(bin_deploy).to include("heroku run rails db:migrate --exit-code")
+    expect(bin_deploy).to include('git push $force "$target" "$branch:master"')
     expect("bin/deploy").to be_executable
   end
 

data/spec/features/production/email_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe "suspenders:production:email", type: :generator do
     expect("config/smtp.rb").to match_contents(%r{SMTP_SETTINGS\s*=})
 
     expect("config/environments/production.rb").to \
-      match_contents(%r{require.+config/smtp})
+      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 \

data/spec/features/production/manifest_spec.rb

@@ -8,6 +8,7 @@ RSpec.describe "suspenders:production:manifest", type: :generator do
       name: SuspendersTestHelpers::APP_NAME.dasherize,
       env: {
         APPLICATION_HOST: { required: true },
+        AUTO_MIGRATE_DB: { value: "true" },
         EMAIL_RECIPIENTS: { required: true },
         HEROKU_APP_NAME: { required: true },
         HEROKU_PARENT_APP_NAME: { required: true },
@@ -24,6 +25,7 @@ RSpec.describe "suspenders:production:manifest", type: :generator do
       name: SuspendersTestHelpers::APP_NAME.dasherize,
       env: {
         APPLICATION_HOST: { required: true },
+        AUTO_MIGRATE_DB: { value: "true" },
         EMAIL_RECIPIENTS: { required: true },
         HEROKU_APP_NAME: { required: true },
         HEROKU_PARENT_APP_NAME: { required: true },

data/suspenders.gemspec

@@ -18,6 +18,10 @@ weLaika's fork of the famous thoughbot suspenders gem.
   s.extra_rdoc_files = %w[README.md LICENSE]
   s.files = `git ls-files`.split("\n")
   s.homepage = 'http://github.com/welaika/welaika-suspenders'
+  s.metadata = {
+    'changelog_uri' => 'https://github.com/welaika/welaika-suspenders/blob/master/CHANGELOG_WELAIKA.md',
+    'source_code_uri' => 'https://github.com/welaika/welaika-suspenders'
+  }
   s.license = 'MIT'
   s.name = 'welaika-suspenders'
   s.rdoc_options = ['--charset=UTF-8']
@@ -27,6 +31,7 @@ weLaika's fork of the famous thoughbot suspenders gem.
   s.version = Suspenders::VERSION
 
   s.add_dependency 'rails', Suspenders::RAILS_VERSION
+  s.add_dependency 'bundler', '>= 2'
 
   s.add_development_dependency 'rspec', '~> 3.8'
   s.add_development_dependency 'pry-byebug', '~> 3.6'

data/templates/Dockerfile.gitlab.erb

@@ -48,7 +48,7 @@ RUN curl -sS -O https://dl.google.com/linux/direct/google-chrome-stable_current_
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-RUN gem install bundler --version '< 2' \
+RUN gem install bundler --version '>= 2' \
     && bundle config git.allow_insecure true \
     && bundle config silence_root_warning true \
     && bundle config jobs "$(nproc)"

data/templates/Gemfile.erb

@@ -9,13 +9,13 @@ end
 
 ruby '<%= Suspenders::RUBY_VERSION %>'
 
-gem 'active_interaction', '~> 3.7'
 <% unless options[:api] %>
 gem 'autoprefixer-rails'
 <% end %>
 gem 'bootsnap', '>= 1.1.0', require: false
 gem 'coffee-rails', '~> 4.2'
 gem 'email_validator'
+gem 'interactor'
 gem 'pg', '>= 0.18', '< 2.0'
 gem 'puma', '~> 3.11'
 gem 'rack-canonical-host'
@@ -23,6 +23,7 @@ gem 'rails', '<%= Suspenders::RAILS_VERSION %>'
 gem 'rails-i18n'
 gem 'recipient_interceptor'
 gem 'sassc-rails'
+gem 'sprockets', '< 4'
 gem 'title'
 gem 'uglifier', '>= 1.3.0'
 <% if options[:webpack] %>
@@ -41,6 +42,7 @@ group :development, :test do
   gem 'dotenv-rails'
   gem 'pry-byebug'
   gem 'pry-rails'
+  gem 'welaika-suspenders', '< 3'
 end
 
 group :test do
@@ -50,4 +52,3 @@ group :test do
   gem 'webmock'
 end
 
-gem 'welaika-suspenders', group: %i[development test]

data/templates/Procfile

@@ -1,2 +1 @@
 web: bundle exec puma -p $PORT -C ./config/puma.rb
-# worker:

data/templates/README.md.erb

@@ -4,9 +4,15 @@
 
 To install Ruby, read the [rbenv guide](https://github.com/rbenv/rbenv#installation)
 
-To install Postgres:
+To install Postgres 11:
 
-    $ brew install postgresql@10
+    $ brew install postgresql@<%= Suspenders::POSTGRES_VERSION %>
+
+or
+
+    $ brew install postgresql
+
+if `postgresql@<%= Suspenders::POSTGRES_VERSION %>` does not exist yet.
 
 To install Node:
 
@@ -44,10 +50,10 @@ Run the quality checks and the tests suite:
 
 https://elements.heroku.com/addons/heroku-postgresql
 
-Choose the PostgreSQL version you want to use (e.g. 10):
+Choose the PostgreSQL version you want to use:
 
-    $ heroku addons:create heroku-postgresql:hobby-dev --version=10 --remote=staging
-    $ heroku addons:create heroku-postgresql:hobby-dev --version=10 --remote=production
+    $ heroku addons:create heroku-postgresql:hobby-dev --version=<%= Suspenders::POSTGRES_VERSION %> --remote=staging
+    $ heroku addons:create heroku-postgresql:hobby-dev --version=<%= Suspenders::POSTGRES_VERSION %> --remote=production
 
 Further reading:
 
@@ -88,7 +94,7 @@ Since our `Dockerfile` is called `Dockerfile.gitlab`, the commands are slightly
 
 
 ```bash
-$ docker build -f Dockerfile.gitlab -t registry.gitlab.com/welaika/<%= app_name %> .
+$ docker build --no-cache -f Dockerfile.gitlab -t registry.gitlab.com/welaika/<%= app_name %> .
 $ docker push registry.gitlab.com/welaika/<%= app_name %>
 ```
 

data/templates/bin_auto_migrate

@@ -0,0 +1,5 @@
+ set -e
+
+ if [ -n "$AUTO_MIGRATE_DB" ]; then
+   bundle exec rake db:migrate
+ fi

data/templates/bin_deploy

@@ -20,5 +20,3 @@ branch="$(git symbolic-ref HEAD --short)"
 target="${1:-staging}"
 
 git push $force "$target" "$branch:master"
-heroku run rails db:migrate --exit-code --remote "$target"
-heroku restart --remote "$target"

data/templates/bin_setup_review_app.erb

@@ -17,6 +17,5 @@ heroku pg:backups:capture --app $PARENT_APP_NAME
 URL=`heroku pg:backups public-url --app $PARENT_APP_NAME`
 
 heroku pg:backups restore $URL DATABASE_URL --confirm $APP_NAME --app $APP_NAME
-heroku run rails db:migrate --exit-code --app $APP_NAME
 heroku ps:scale worker=1 --app $APP_NAME
 heroku restart --app $APP_NAME

data/templates/config_sidekiq.yml

@@ -0,0 +1,14 @@
+---
+:concurrency: 5
+
+# Keep in mind that Heroku puts a hard limit of 30 seconds on a process restart,
+# The -t 25 tells Sidekiq to give the jobs 25 seconds to finish before starting
+# the "force shutdown" procedure.
+:timeout: 25
+
+# Sidekiq will run this file through ERB when reading it so you can
+# even put in dynamic logic, like a host-specific queue.
+# http://www.mikeperham.com/2013/11/13/advanced-sidekiq-host-specific-queues/
+:queues:
+  - default
+  - mailers  # for ActionMailer

data/templates/dotfiles/.env

@@ -5,7 +5,6 @@ PORT=3000
 RACK_ENV=development
 RACK_MINI_PROFILER=0
 SECRET_KEY_BASE=development_secret
-EXECJS_RUNTIME=Node
 SMTP_ADDRESS=smtp.example.com
 SMTP_DOMAIN=example.com
 SMTP_PASSWORD=password