potassium 6.0.0 → 6.4.0

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/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/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/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
@@ -58,9 +59,8 @@ 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
@@ -76,6 +76,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.0.0"
+  VERSION = "6.4.0"
   RUBY_VERSION = "2.7.0"
   RAILS_VERSION = "~> 6.0.2"
-  RUBOCOP_VERSION = "~> 0.65.0"
+  RUBOCOP_VERSION = "~> 1.9"
+  RUBOCOP_RSPEC_VERSION = "~> 2.2"
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
   NODE_VERSION = "12"
+  TAILWINDCSS = "npm:@tailwindcss/postcss7-compat"
+  VUE_LOADER_VERSION = "^15.9.7"
 end

data/potassium.gemspec

@@ -20,15 +20,18 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry", "~> 0.10.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   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"
   spec.add_runtime_dependency "levenshtein", "~> 0.2"
+  spec.add_runtime_dependency "octokit", "~> 4.18"
   spec.add_runtime_dependency "rails", Potassium::RAILS_VERSION
   spec.add_runtime_dependency "semantic", "~> 1.4"
 end

data/spec/features/api_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+RSpec.describe "Api" do
+  before :all do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project("api" => :rest)
+  end
+
+  it "adds power_api related gems to Gemfile" do
+    gemfile_content = IO.read("#{project_path}/Gemfile")
+    expect(gemfile_content).to include("gem 'power_api'")
+    expect(gemfile_content).to include("gem 'rswag-specs'")
+  end
+
+  it "adds the power_api brief to README file" do
+    readme = IO.read("#{project_path}/README.md")
+    expect(readme).to include("Power API")
+  end
+
+  it "installs power_api" do
+    content = IO.read("#{project_path}/app/controllers/api/base_controller.rb")
+    expect(content).to include("Api::BaseController < PowerApi::BaseController")
+  end
+end

data/spec/features/background_processor_spec.rb

@@ -1,11 +1,12 @@
 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
@@ -41,6 +42,9 @@ RSpec.describe "BackgroundProcessor" do
     it "adds ENV vars" do
       content = IO.read("#{project_path}/.env.development")
       expect(content).to include("DB_POOL=25")
+      expect(content).to include('REDIS_HOST=127.0.0.1')
+      expect(content).to include('REDIS_PORT=$(make services-port SERVICE=redis PORT=6379)')
+      expect(content).to include('REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1')
     end
 
     it "adds sidekiq.rb file" do
@@ -48,19 +52,28 @@ 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
       content = IO.read("#{project_path}/config/redis.yml")
-      expect(content).to include("REDIS_HOST")
+      expect(content).to include("REDIS_URL")
     end
 
     it "mounts sidekiq app" do
       content = IO.read("#{project_path}/config/routes.rb")
       expect(content).to include("mount Sidekiq::Web => '/queue'")
     end
+
+    it 'adds redis to docker-compose' do
+      compose_file = IO.read("#{project_path}/docker-compose.yml")
+      compose_content = YAML.safe_load(compose_file, symbolize_names: true)
+
+      expect(compose_content[:services]).to include(:redis)
+    end
   end
 end

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('circleci/ruby', 'cache', 'rspec', 'reviewdog')
   end
 end

data/spec/features/draper_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "Draper" do
   before :all do
     drop_dummy_database
     remove_project_directory
-    create_dummy_project("draper" => true, "api" => true)
+    create_dummy_project("draper" => true)
   end
 
   it "adds the Draper gem to Gemfile" do
@@ -17,11 +17,6 @@ RSpec.describe "Draper" do
     expect(readme).to include("Draper")
   end
 
-  it "adds api responder to work with draper" do
-    responder_content = IO.read("#{project_path}/app/responders/api_responder.rb")
-    expect(responder_content).to include("decorated_resource")
-  end
-
   it "adds decorators directory" do
     content = IO.read("#{project_path}/app/decorators/.keep")
     expect(content).to be_empty

data/spec/features/file_storage_spec.rb

@@ -66,5 +66,10 @@ RSpec.describe "File Storage" do
       content = IO.read("#{project_path}/.env.development")
       expect(content).to include("S3_BUCKET=")
     end
+
+    it "adds filestorage path to gitignore" do
+      content = IO.read("#{project_path}/.gitignore")
+      expect(content).to include("/public/uploads")
+    end
   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
@@ -54,6 +59,28 @@ 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
+        create_dummy_project("front_end" => "vue", "api" => "graphql")
+      end
+
+      it "creates a vue project with apollo" do
+        expect(node_modules_file).to include("\"vue-apollo\"")
+        expect(application_js_file).to include("import { ApolloClient } from 'apollo-client';")
+        expect(application_js_file).to include("Vue.use(VueApollo)")
+        expect(application_js_file).to include("apolloProvider,")
+      end
+    end
   end
 
   context "with angular" do
@@ -70,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/github_spec.rb

@@ -1,22 +1,67 @@
 require "spec_helper"
 
 RSpec.describe "GitHub" do
+  let(:org_name) { "platanus" }
+  let(:repo_name) { PotassiumTestHelpers::APP_NAME.dasherize }
+  let(:access_token) { "1234" }
+  let(:pr_template_file) { IO.read("#{project_path}/.github/pull_request_template.md") }
+
   before do
     drop_dummy_database
     remove_project_directory
   end
 
-  it "create a the github repository" do
-    create_dummy_project("github" => true)
-    app_name = PotassiumTestHelpers::APP_NAME.dasherize
+  it "creates the github repository" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => false,
+      "github_has_org" => false,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
+
+    expect(FakeOctokit).to have_created_repo(repo_name)
+    expect(pr_template_file).to include('Contexto')
+  end
+
+  it "creates the private github repository" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => true,
+      "github_has_org" => false,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
+
+    expect(FakeOctokit).to have_created_private_repo(repo_name)
+    expect(pr_template_file).to include('Contexto')
+  end
+
+  it "creates the github repository for the organization" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => false,
+      "github_has_org" => true,
+      "github_org" => org_name,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
 
-    expect(FakeGithub).to have_created_repo("platanus/#{app_name}")
+    expect(FakeOctokit).to have_created_repo_for_org(repo_name, org_name)
+    expect(pr_template_file).to include('Contexto')
   end
 
-  it "create a the github private repository" do
-    create_dummy_project("github" => true, "github-private" => true)
-    app_name = PotassiumTestHelpers::APP_NAME.dasherize
+  it "creates the private github repository for the organization" do
+    create_dummy_project(
+      "github" => true,
+      "github_private" => true,
+      "github_has_org" => true,
+      "github_org" => org_name,
+      "github_name" => repo_name,
+      "github_access_token" => access_token
+    )
 
-    expect(FakeGithub).to have_created_private_repo("platanus/#{app_name}")
+    expect(FakeOctokit).to have_created_private_repo_for_org(repo_name, org_name)
+    expect(pr_template_file).to include('Contexto')
   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