potassium 6.1.0 → 6.5.0

data/lib/potassium/recipes/heroku.rb

@@ -1,13 +1,7 @@
 class Recipes::Heroku < Rails::AppBuilder
   NAME_PREFIX = 'pl'
-
-  attr_accessor :app_name_staging
-
-  def initialize(args)
-    super(args)
-    set(:heroku_app_name_staging, app_name_for('staging'))
-    set(:heroku_app_name_production, app_name_for('production'))
-  end
+  ENVIRONMENTS = ['staging', 'production']
+  HEROKU_NAMES_MAX_CHARS = 30
 
   def ask
     heroku = answer(:heroku) do
@@ -16,6 +10,8 @@ class Recipes::Heroku < Rails::AppBuilder
 
     if heroku
       set(:heroku, heroku)
+
+      ENVIRONMENTS.each { |environment| set_app_name_for(environment) }
     end
   end
 
@@ -28,14 +24,13 @@ class Recipes::Heroku < Rails::AppBuilder
   end
 
   def installed?
-    gem_exists?(/rails_stdout_logging/)
+    gem_exists?(/heroku-stage/)
   end
 
   private
 
   def add_heroku
     gather_gems(:production) do
-      gather_gem('rails_stdout_logging')
       gather_gem('heroku-stage')
     end
 
@@ -47,31 +42,34 @@ class Recipes::Heroku < Rails::AppBuilder
     template "../assets/bin/setup_heroku.erb", "bin/setup_heroku", force: true
     run "chmod a+x bin/setup_heroku"
 
-    if logged_in?
-      %w(staging production).each do |environment|
-        create_app_on_heroku(environment)
-      end
-      puts "Remember to connect the github repository to the new pipeline"
-      open_pipeline_command = "\e[33mheroku pipelines:open #{heroku_pipeline_name}\e[0m"
-      puts "run #{open_pipeline_command} to open the dashboard"
-    else
-      puts "You are not logged in into heroku"
-      login_command = "\e[33mheroku login\e[0m"
-      puts "Run #{login_command} and enter your credentials"
-      puts "You can install the heroku recipe again create the app in heroku"
-      install_command = "\e[33mpostassium install heroku --force\e[0m"
-      puts "Just run #{install_command}"
-    end
+    logged_in? ? create_apps : puts_not_logged_in_msg
 
     add_readme_header :deployment
   end
 
+  def create_apps
+    ENVIRONMENTS.each { |environment| create_app_on_heroku(environment) }
+    puts "Remember to connect the github repository to the new pipeline"
+    open_pipeline_command = "\e[33mheroku pipelines:open #{heroku_pipeline_name}\e[0m"
+    puts "run #{open_pipeline_command} to open the dashboard"
+  end
+
+  def puts_not_logged_in_msg
+    puts "You are not logged in into heroku"
+    login_command = "\e[33mheroku login\e[0m"
+    puts "Run #{login_command} and enter your credentials"
+    puts "You can install the heroku recipe again to create the app in heroku"
+    install_command = "\e[33mpostassium install heroku --force\e[0m"
+    puts "Just run #{install_command}"
+  end
+
   def heroku_pipeline_name
-    app_name.dasherize
+    @heroku_pipeline_name ||= valid_heroku_name(app_name.dasherize, 'pipeline', false)
   end
 
-  def app_name_for(environment)
-    "#{NAME_PREFIX}-#{app_name.dasherize}-#{environment}"
+  def set_app_name_for(environment)
+    default_name = "#{NAME_PREFIX}-#{app_name.dasherize}-#{environment}"
+    set("heroku_app_name_#{environment}".to_sym, valid_heroku_name(default_name, environment))
   end
 
   def logged_in?
@@ -84,7 +82,7 @@ class Recipes::Heroku < Rails::AppBuilder
 
   def create_app_on_heroku(environment)
     rack_env = "RACK_ENV=production"
-    staged_app_name = app_name_for(environment)
+    staged_app_name = get("heroku_app_name_#{environment}".to_sym)
 
     run_toolbelt_command "create #{staged_app_name} --remote #{environment}"
     run_toolbelt_command "labs:enable runtime-dyno-metadata", staged_app_name
@@ -99,14 +97,14 @@ class Recipes::Heroku < Rails::AppBuilder
   def set_rails_secrets(environment)
     run_toolbelt_command(
       "config:add SECRET_KEY_BASE=#{generate_secret}",
-      app_name_for(environment)
+      get("heroku_app_name_#{environment}".to_sym)
     )
   end
 
   def set_app_multi_buildpack(environment)
     run_toolbelt_command(
       "buildpacks:set https://github.com/heroku/heroku-buildpack-multi.git",
-      app_name_for(environment)
+      get("heroku_app_name_#{environment}".to_sym)
     )
   end
 
@@ -133,4 +131,18 @@ class Recipes::Heroku < Rails::AppBuilder
       `heroku #{command} --app #{app_env_name}`
     end
   end
+
+  def valid_heroku_name(name, element, force_suffix = true)
+    suffix = "-#{element}"
+    while name.length > HEROKU_NAMES_MAX_CHARS
+      puts "Heroku names must be shorter than #{HEROKU_NAMES_MAX_CHARS} chars."
+      if force_suffix
+        puts "Potassium uses the heroku-stage gem, because of that '#{suffix}' will be "\
+             "added to your app name. The suffix, #{suffix}, counts towards the app name length."
+      end
+      name = Ask.input("Please enter a valid name for #{element}:")
+      name += suffix if force_suffix && !name.end_with?(suffix)
+    end
+    name
+  end
 end

data/lib/potassium/recipes/mailer.rb

@@ -24,11 +24,7 @@ class Recipes::Mailer < Rails::AppBuilder
     dependencies(email_service)
     config(email_service)
 
-    background_processor_recipe = load_recipe(:background_processor)
-    background_processor_answer = get(:background_processor)
-
-    background_processor_recipe.add_sidekiq unless background_processor_recipe.installed? ||
-      background_processor_answer
+    ensure_sidekiq_install_and_add_mailers_queue
   end
 
   def install
@@ -36,6 +32,10 @@ class Recipes::Mailer < Rails::AppBuilder
     create
   end
 
+  def add_mailer_queue
+    insert_into_file "config/sidekiq.yml", "  - mailers", after: "- default\n"
+  end
+
   private
 
   def email_services(service_name)
@@ -102,4 +102,17 @@ class Recipes::Mailer < Rails::AppBuilder
     gather_gems(:development) { gather_gem("letter_opener") }
     application "config.action_mailer.delivery_method = :letter_opener", env: "development"
   end
+
+  def ensure_sidekiq_install_and_add_mailers_queue
+    background_processor_recipe = load_recipe(:background_processor)
+    background_processor_answer = get(:background_processor)
+
+    if background_processor_recipe.installed?
+      add_mailer_queue
+    else
+      recipe = self
+      after(:install_sidekiq) { recipe.add_mailer_queue }
+      background_processor_recipe.add_sidekiq unless background_processor_answer
+    end
+  end
 end

data/lib/potassium/recipes/monitoring.rb

@@ -0,0 +1,5 @@
+class Recipes::Monitoring < Rails::AppBuilder
+  def create
+    gather_gem('scout_apm')
+  end
+end

data/lib/potassium/recipes/pundit.rb

@@ -31,20 +31,39 @@ class Recipes::Pundit < Rails::AppBuilder
   end
 
   def install_admin_pundit
+    configure_active_admin_initializer
+    copy_policies
+  end
+
+  private
+
+  def configure_active_admin_initializer
+    config_active_admin_option("authorization_adapter", "ActiveAdmin::PunditAdapter")
+    config_active_admin_option("pundit_default_policy", "'BackOffice::DefaultPolicy'")
+    config_active_admin_option("pundit_policy_namespace", ":back_office")
+  end
+
+  def copy_policies
+    copy_policy("default_policy")
+    copy_policy("admin_user_policy")
+    copy_policy("page_policy", "active_admin")
+    copy_policy("comment_policy", "active_admin")
+  end
+
+  def config_active_admin_option(option, value)
     initializer = "config/initializers/active_admin.rb"
-    gsub_file initializer, /# config\.authorization_adapter =[^\n]+\n/ do
-      "config.authorization_adapter = ActiveAdmin::PunditAdapter\n"
+    gsub_file initializer, /# config\.#{option} =[^\n]+\n/ do
+      "config.#{option} = #{value}\n"
     end
-
-    template "../assets/active_admin/pundit_page_policy.rb",
-      "app/policies/active_admin/page_policy.rb"
-    template "../assets/active_admin/comment_policy.rb",
-      "app/policies/active_admin/comment_policy.rb"
-    template "../assets/active_admin/admin_user_policy.rb",
-      "app/policies/admin_user_policy.rb"
   end
 
-  private
+  def copy_policy(policy_name, model_namespace = nil)
+    destination_path = [model_namespace, policy_name].compact.join("/")
+    template(
+      "../assets/active_admin/policies/#{policy_name}.rb",
+      "app/policies/back_office/#{destination_path}.rb"
+    )
+  end
 
   def run_pundit_installer
     gather_gem 'pundit'

data/lib/potassium/recipes/rails.rb

@@ -1,10 +1,6 @@
 class Recipes::Rails < Rails::AppBuilder
   def create
     gather_gem("bootsnap", require: false)
-    gather_gems(:development) do
-      gather_gem("spring")
-    end
-
     environment 'config.force_ssl = true', env: 'production'
     disable_automatic_nonce_generation
   end

data/lib/potassium/recipes/schedule.rb

@@ -10,8 +10,8 @@ class Recipes::Schedule < Rails::AppBuilder
     if selected?(:schedule)
       gather_gem 'sidekiq-scheduler', '>= 3.0.1'
       add_readme_section :internal_dependencies, :sidekiq_scheduler
+      append_schedule_section_to_yml
     end
-    template '../assets/sidekiq_scheduler.yml', 'config/sidekiq.yml', force: true
   end
 
   def install
@@ -22,4 +22,19 @@ class Recipes::Schedule < Rails::AppBuilder
   def installed?
     gem_exists?(/sidekiq-scheduler/) && file_exist?('config/sidekiq.yml')
   end
+
+  private
+
+  def append_schedule_section_to_yml
+    append_to_file(
+      'config/sidekiq.yml',
+      <<-HERE.gsub(/^ {8}/, '')
+        # :schedule:
+          #  an_scheduled_task:
+          #    cron: '0 * * * * *'  # Runs once per minute
+          #    class: ExampleJob
+          #    args: ['a', 'b']
+      HERE
+    )
+  end
 end

data/lib/potassium/recipes/spring.rb

@@ -0,0 +1,9 @@
+class Recipes::Spring < Rails::AppBuilder
+  def create
+    if answer(:spring)
+      gather_gems(:development) do
+        gather_gem("spring")
+      end
+    end
+  end
+end

data/lib/potassium/recipes/style.rb

@@ -13,10 +13,10 @@ class Recipes::Style < Rails::AppBuilder
 
   def add_linters
     gather_gems(:development, :test) do
-      gather_gem 'rubocop', '~> 0.82.0'
+      gather_gem 'rubocop', Potassium::RUBOCOP_VERSION
       gather_gem 'rubocop-performance'
       gather_gem 'rubocop-rails'
-      gather_gem 'rubocop-rspec'
+      gather_gem 'rubocop-rspec', Potassium::RUBOCOP_RSPEC_VERSION
     end
     run 'bin/yarn add --dev stylelint eslint eslint-plugin-import'
     run 'bin/yarn add --dev eslint-plugin-vue' if selected?(:front_end, :vue)

data/lib/potassium/recipes/testing.rb

@@ -1,5 +1,76 @@
 class Recipes::Testing < Rails::AppBuilder
   def create
+    add_gems
+    add_readme_header(:testing)
+    recipe = self
+
+    after(:gem_install) do
+      recipe.install_rspec
+      recipe.install_guard
+      recipe.create_rspec_binary
+    end
+
+    config_raise_delivery_errors_option
+  end
+
+  def install_rspec
+    remove_dir 'test'
+    generate "rspec:install"
+    remove_file 'spec/rails_helper.rb'
+    copy_file '../assets/testing/rails_helper.rb', 'spec/rails_helper.rb'
+    remove_file '.rspec'
+    copy_file '../assets/testing/.rspec', '.rspec'
+    create_file 'spec/system/.keep'
+    create_support_directories
+  end
+
+  def create_support_directories
+    %w{
+      custom_matchers
+      shared_examples
+      configurations
+      helpers
+      helpers/system
+    }.each do |directory|
+      path = "spec/support/#{directory}"
+      empty_directory(path)
+      create_file("#{path}/.keep")
+    end
+
+    add_support_configuration_modules
+  end
+
+  def add_support_configuration_modules
+    files = %w{
+      faker_config
+      factory_bot_config
+      power_types_config
+      shoulda_matchers_config
+      system_tests_config
+    }
+    files << "devise_config" if selected?(:authentication)
+    files.each do |config_module|
+      copy_file(
+        "../assets/testing/#{config_module}.rb",
+        "spec/support/configurations/#{config_module}.rb"
+      )
+    end
+  end
+
+  def install_guard
+    run "bundle exec guard init"
+    run "bundle binstub guard"
+    line = /guard :rspec, cmd: "bundle exec rspec" do\n/
+    gsub_file 'Guardfile', line do
+      "guard :rspec, cmd: \"bin/rspec\" do\n"
+    end
+  end
+
+  def create_rspec_binary
+    run "bundle binstubs rspec-core"
+  end
+
+  def add_gems
     gather_gems(:development, :test) do
       gather_gem('rspec-rails')
       gather_gem('factory_bot_rails')
@@ -10,26 +81,12 @@ class Recipes::Testing < Rails::AppBuilder
 
     gather_gems(:test) do
       gather_gem('shoulda-matchers', require: false)
+      gather_gem('capybara')
+      gather_gem('webdrivers')
     end
+  end
 
-    after(:gem_install) do
-      remove_dir 'test'
-
-      generate "rspec:install"
-
-      remove_file 'spec/rails_helper.rb'
-      copy_file '../assets/testing/rails_helper.rb', 'spec/rails_helper.rb'
-
-      remove_file '.rspec'
-      copy_file '../assets/testing/.rspec', '.rspec'
-
-      empty_directory 'spec/support'
-      create_file 'spec/support/.keep'
-
-      run "bundle exec guard init"
-      run "bundle binstubs rspec-core"
-    end
-
+  def config_raise_delivery_errors_option
     raise_delivery_errors_regexp = /config.action_mailer.raise_delivery_errors = false\n/
     gsub_file 'config/environments/development.rb', raise_delivery_errors_regexp do
       "config.action_mailer.raise_delivery_errors = true"

data/lib/potassium/templates/application.rb

@@ -20,6 +20,7 @@ run_action(:asking) do
   ask :database
   ask :devise
   ask :admin
+  ask :google_tag_manager
   ask :front_end
   ask :vue_admin
   ask :mailer
@@ -37,6 +38,7 @@ end
 
 run_action(:recipe_loading) do
   create :rails
+  create :spring
   create :readme
   create :heroku
   create :ci
@@ -58,13 +60,13 @@ run_action(:recipe_loading) do
   create :i18n
   create :pry
   create :better_errors
+  create :monitoring
   create :devise
-  create :admin
-  create :vue_admin
   create :seeds
   create :error_reporting
   create :pundit
   create :testing
+  create :coverage
   create :secrets
   create :api
   create :draper
@@ -76,6 +78,9 @@ run_action(:recipe_loading) do
   create :github
   create :cleanup
   create :front_end
+  create :admin
+  create :vue_admin
+  create :google_tag_manager
 end
 
 info "Gathered enough information. Applying the template. Wait a minute."

data/lib/potassium/version.rb

@@ -1,9 +1,12 @@
 module Potassium
-  VERSION = "6.1.0"
+  VERSION = "6.5.0"
   RUBY_VERSION = "2.7.0"
-  RAILS_VERSION = "~> 6.0.2"
-  RUBOCOP_VERSION = "~> 0.65.0"
+  RAILS_VERSION = "~> 6.1.4.4"
+  RUBOCOP_VERSION = "~> 1.9"
+  RUBOCOP_RSPEC_VERSION = "~> 2.2"
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
-  NODE_VERSION = "12"
+  NODE_VERSION = "14"
+  TAILWINDCSS = "npm:@tailwindcss/postcss7-compat"
+  VUE_LOADER_VERSION = "^15.9.7"
 end

data/potassium.gemspec

@@ -24,7 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.4.0"
   spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rubocop", Potassium::RUBOCOP_VERSION
-  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rspec", Potassium::RUBOCOP_RSPEC_VERSION
   spec.add_runtime_dependency "gems", "~> 0.8"
   spec.add_runtime_dependency "gli", "~> 2.12.2"
   spec.add_runtime_dependency "inquirer", "~> 0.2"

data/spec/features/background_processor_spec.rb

@@ -2,11 +2,11 @@ require "spec_helper"
 require 'yaml'
 
 RSpec.describe "BackgroundProcessor" do
-  context "working with sidekiq" do
+  context "when working with sidekiq and no mailer" do
     before :all do
       drop_dummy_database
       remove_project_directory
-      create_dummy_project("background_processor" => "sidekiq", "heroku" => true)
+      create_dummy_project("background_processor" => true, "heroku" => true)
     end
 
     it "adds sidekiq gem to Gemfile" do
@@ -52,9 +52,11 @@ RSpec.describe "BackgroundProcessor" do
       expect(content).to include("require 'sidekiq'")
     end
 
-    it "adds sidekiq.yml file" do
-      content = IO.read("#{project_path}/config/sidekiq.yml")
-      expect(content).to include("concurrency: 5")
+    it "adds sidekiq.yml file with no mailer queue" do
+      yml_path = "#{project_path}/config/sidekiq.yml"
+      content = IO.read(yml_path)
+      expect(File.exist?(yml_path)).to be true
+      expect(content).not_to include("- mailers")
     end
 
     it "adds redis.yml file" do

data/spec/features/ci_spec.rb

@@ -1,14 +1,17 @@
 require "spec_helper"
 require "rubocop"
 
-RSpec.describe "A new project" do
+RSpec.describe 'CI' do
   before(:all) do
     drop_dummy_database
     remove_project_directory
-    create_dummy_project("heroku" => true)
+    create_dummy_project
   end
 
-  it "correctly runs continous integration" do
-    expect { on_project { `bin/cibuild` } }.to_not output.to_stderr
+  it "correctly bundles the config file" do
+    yml_path = "#{project_path}/.circleci/config.yml"
+    content = IO.read(yml_path)
+    expect(File.exist?(yml_path)).to be true
+    expect(content).to include('cimg/ruby', 'cache', 'rspec', 'reviewdog')
   end
 end

data/spec/features/coverage_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+RSpec.describe "Coverage" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project
+  end
+
+  it "adds simplecov related gems to Gemfile" do
+    content = IO.read("#{project_path}/Gemfile")
+    expect(content).to include("gem 'simplecov'")
+    expect(content).to include("gem 'simplecov_linter_formatter'")
+    expect(content).to include("gem 'simplecov_text_formatter'")
+  end
+
+  it "requires simplecov config file before rails" do
+    content = IO.read("#{project_path}/spec/rails_helper.rb")
+    expect(content).to include("ENV['RACK_ENV'] ||= 'test'\nrequire 'simplecov_config'")
+  end
+
+  it "adds simplecov config file" do
+    content = IO.read("#{project_path}/spec/simplecov_config.rb")
+    expect(content).to include("SimpleCov.start 'rails'")
+  end
+end

data/spec/features/front_end_spec.rb

@@ -19,7 +19,12 @@ RSpec.describe "Front end" do
     remove_project_directory
     create_dummy_project("front_end" => "None")
     expect(gemfile).to include('webpacker')
-    expect(File).not_to exist(application_css_path)
+  end
+
+  def expect_to_have_tailwind_compatibility_build
+    expect(node_modules_file).to include("\"tailwindcss\": \"npm:@tailwindcss/postcss7-compat\"")
+    expect(node_modules_file).to include("\"autoprefixer\": \"^9\"")
+    expect(node_modules_file).to include("\"postcss\": \"^7\"")
   end
 
   context "with vue" do
@@ -55,6 +60,14 @@ RSpec.describe "Front end" do
       expect(tailwind_config_file).to include('module.exports')
     end
 
+    it 'includes correct packages for tailwind, postcss and autoprefixer compatibility build' do
+      expect_to_have_tailwind_compatibility_build
+    end
+
+    it 'includes correct version of vue-loader in package' do
+      expect(node_modules_file).to include("\"vue-loader\": \"#{Potassium::VUE_LOADER_VERSION}\"")
+    end
+
     context "with graphql" do
       before(:all) do
         remove_project_directory
@@ -84,5 +97,9 @@ RSpec.describe "Front end" do
     it "creates application_js_file for tailwind without vue" do
       expect(application_js_file).to include("import '../css/application.css';")
     end
+
+    it 'includes correct packages for tailwind, postcss and autoprefixer compatibility build' do
+      expect_to_have_tailwind_compatibility_build
+    end
   end
 end

data/spec/features/google_tag_manager_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+RSpec.describe "Google Tag Manager" do
+  before :all do
+    remove_project_directory
+    create_dummy_project('google_tag_manager' => true)
+  end
+
+  let(:gtm_head_file_path) do
+    "#{project_path}/app/views/shared/_gtm_head.html.erb"
+  end
+  let(:gtm_body_file_path) do
+    "#{project_path}/app/views/shared/_gtm_body.html.erb"
+  end
+  let(:content_security_policy_file_path) do
+    "#{project_path}/config/initializers/content_security_policy.rb"
+  end
+  let(:application_layout_file) do
+    IO.read("#{project_path}/app/views/layouts/application.html.erb")
+  end
+  let(:content_security_policy_file) do
+    IO.read(content_security_policy_file_path)
+  end
+
+  it 'adds google tag manager script' do
+    expect(File).to be_file(gtm_head_file_path)
+    expect(File).to be_file(gtm_body_file_path)
+    expect(application_layout_file).to include('shared/gtm_head')
+    expect(application_layout_file).to include('shared/gtm_body')
+  end
+
+  it 'add content security policy' do
+    expect(content_security_policy_file)
+      .to include("\nRails.application.config.content_security_policy do |policy|")
+  end
+end

data/spec/features/heroku_spec.rb

@@ -10,10 +10,6 @@ RSpec.describe "Heroku" do
     create_dummy_project("heroku" => true)
     app_name = PotassiumTestHelpers::APP_NAME.dasherize
 
-    expect(FakeHeroku).to(
-      have_gem_included(project_path, "rails_stdout_logging")
-    )
-
     procfile_path = "#{project_path}/Procfile"
     procfile = IO.read(procfile_path)