potassium 6.3.0 → 6.6.0

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/recipes/vue_admin.rb

@@ -35,15 +35,18 @@ class Recipes::VueAdmin < Rails::AppBuilder
   def add_vue_admin
     add_vue_component_library
     add_component_integration
-    copy_file '../assets/active_admin/init_activeadmin_vue.rb',
-      'config/initializers/init_activeadmin_vue.rb'
-    copy_file '../assets/active_admin/admin_application.js',
-      'app/javascript/packs/admin_application.js',
-      force: true
-    empty_directory 'app/javascript/components'
+    js_line = 'import "activeadmin_addons"'
+    gsub_file(
+      'app/javascript/active_admin.js',
+      js_line,
+      <<~HERE
+        #{js_line}
+        #{active_admin_js}
+      HERE
+    )
     copy_file '../assets/active_admin/admin-component.vue',
-      'app/javascript/components/admin-component.vue',
-      force: true
+              'app/javascript/components/admin-component.vue',
+              force: true
   end
 
   def add_component_integration
@@ -121,4 +124,31 @@ class Recipes::VueAdmin < Rails::AppBuilder
       end
     HERE
   end
+
+  def active_admin_js
+    <<~HERE
+      import { createApp } from 'vue';
+      import AdminComponent from './components/admin-component.vue';
+
+      function onLoad() {
+        if (document.getElementById('wrapper') !== null) {
+          const app = createApp({
+            mounted() {
+              // We need to re-trigger DOMContentLoaded for ArcticAdmin after Vue replaces DOM elements
+              window.document.dispatchEvent(new Event('DOMContentLoaded', {
+                bubbles: true,
+                cancelable: true,
+              }));
+            },
+          });
+          app.component('AdminComponent', AdminComponent);
+          app.mount('#wrapper');
+        }
+
+        return null;
+      }
+
+      document.addEventListener('DOMContentLoaded', onLoad, { once: true });
+    HERE
+  end
 end

data/lib/potassium/templates/application.rb

@@ -38,6 +38,7 @@ end
 
 run_action(:recipe_loading) do
   create :rails
+  create :spring
   create :readme
   create :heroku
   create :ci
@@ -61,12 +62,11 @@ run_action(:recipe_loading) do
   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
@@ -78,7 +78,10 @@ run_action(:recipe_loading) do
   create :github
   create :cleanup
   create :front_end
+  create :admin
+  create :vue_admin
   create :google_tag_manager
+  create :mjml
 end
 
 info "Gathered enough information. Applying the template. Wait a minute."

data/lib/potassium/version.rb

@@ -1,11 +1,17 @@
 module Potassium
-  VERSION = "6.3.0"
+  VERSION = "6.6.0"
   RUBY_VERSION = "2.7.0"
-  RAILS_VERSION = "~> 6.0.2"
+  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"
-  TAILWINDCSS = "npm:@tailwindcss/postcss7-compat"
+  NODE_VERSION = "14"
+  TAILWINDCSS_VERSION = "^3"
+  POSTCSS_VERSION = "^8"
+  AUTOPREFIXER_VERSION = "^10"
+  VUE_VERSION = "^3"
+  VUE_LOADER_VERSION = "^16"
+  VUE_TEST_UTILS_VERSION = "^2.0.0-rc.18"
+  VUE_JEST_VERSION = "^27.0.0-alpha.1"
 end

data/spec/features/api_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "Api" do
   before :all do
     drop_dummy_database
     remove_project_directory
-    create_dummy_project("api" => :rest)
+    create_dummy_project("api" => true)
   end
 
   it "adds power_api related gems to Gemfile" do
@@ -22,4 +22,9 @@ RSpec.describe "Api" do
     content = IO.read("#{project_path}/app/controllers/api/base_controller.rb")
     expect(content).to include("Api::BaseController < PowerApi::BaseController")
   end
+
+  it "installs internal API mode" do
+    content = IO.read("#{project_path}/app/controllers/api/internal/base_controller.rb")
+    expect(content).to include("Api::Internal::BaseController < Api::BaseController")
+  end
 end

data/spec/features/ci_spec.rb

@@ -12,6 +12,6 @@ RSpec.describe 'CI' 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')
+    expect(content).to include('cimg/ruby', 'cache', 'rspec', 'reviewdog')
   end
 end

data/spec/features/coverage_spec.rb

@@ -0,0 +1,43 @@
+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
+
+  context "with vue" do
+    let(:node_modules_file) { IO.read("#{project_path}/package.json") }
+
+    before(:all) do
+      remove_project_directory
+      create_dummy_project("front_end" => "vue")
+    end
+
+    it "adds jest coverage configuration" do
+      expect(node_modules_file).to include('"collectCoverage": true')
+    end
+
+    it "adds jest text formatter package" do
+      expect(node_modules_file).to include('jest-text-formatter')
+    end
+  end
+end

data/spec/features/file_storage_spec.rb

@@ -32,44 +32,120 @@ RSpec.describe "File Storage" do
       content = IO.read("#{project_path}/.env.development")
       expect(content).to include("S3_BUCKET=")
     end
+
+    it "does not add vips install step to ci config" do
+      content = IO.read("#{project_path}/.circleci/config.yml")
+      expect(content).not_to include("Install apt and vips buildpack dependencies")
+    end
   end
 
   context "when selecting shrine" do
-    before :all do
-      drop_dummy_database
-      remove_project_directory
-      create_dummy_project(storage: :shrine)
-    end
+    shared_examples 'common shrine setup' do
+      it "adds the aws-sdk-s3, shrine and marcel gems to Gemfile" do
+        gemfile_content = IO.read("#{project_path}/Gemfile")
+        expect(gemfile_content).to include("gem 'aws-sdk-s3'")
+        expect(gemfile_content).to include("gem 'shrine'")
+        expect(gemfile_content).to include("gem 'marcel'")
+      end
 
-    it "adds the aws-sdk-s3, shrine and marcel gems to Gemfile" do
-      gemfile_content = IO.read("#{project_path}/Gemfile")
-      expect(gemfile_content).to include("gem 'aws-sdk-s3'")
-      expect(gemfile_content).to include("gem 'shrine'")
-      expect(gemfile_content).to include("gem 'marcel'")
-    end
+      it "adds brief to README file" do
+        content = IO.read("#{project_path}/README.md")
+        expect(content).to include("Shrine")
+      end
 
-    it "adds brief to README file" do
-      content = IO.read("#{project_path}/README.md")
-      expect(content).to include("Shrine")
-    end
+      it "adds shrine initializer" do
+        expect(File.exist?("#{project_path}/config/initializers/shrine.rb")).to be true
+      end
+
+      it "adds base_uploader and image_uploader" do
+        expect(File.exist?("#{project_path}/app/uploaders/base_uploader.rb")).to be true
+        expect(File.exist?("#{project_path}/app/uploaders/image_uploader.rb")).to be true
+      end
+
+      it "adds S3 bucket ENV vars" 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
 
-    it "adds shrine initializer" do
-      expect(File.exist?("#{project_path}/config/initializers/shrine.rb")).to be true
+      it "adds vips install step to ci config" do
+        content = IO.read("#{project_path}/.circleci/config.yml")
+        expect(content).to include("Install apt and vips buildpack dependencies")
+      end
     end
 
-    it "adds base_uploader and image_uploader" do
-      expect(File.exist?("#{project_path}/app/uploaders/base_uploader.rb")).to be true
-      expect(File.exist?("#{project_path}/app/uploaders/image_uploader.rb")).to be true
+    context 'with no heroku or api' do
+      before :all do
+        drop_dummy_database
+        remove_project_directory
+        create_dummy_project(storage: :shrine)
+      end
+
+      it_behaves_like 'common shrine setup'
+
+      it 'does not add buildpacks to missing .buildpacks' do
+        expect { IO.read("#{project_path}/.buildpacks") }.to raise_error(Errno::ENOENT)
+      end
+
+      it 'does not add Aptfile' do
+        expect { IO.read("#{project_path}/Aptfile") }.to raise_error(Errno::ENOENT)
+      end
+
+      it 'does not image_handling_attributes serializer concern' do
+        expect do
+          IO.read("#{project_path}/app/serializers/concerns/image_handling_attributes.rb")
+        end.to raise_error(Errno::ENOENT)
+      end
+
+      it 'does not add base serializer' do
+        expect do
+          IO.read("#{project_path}/app/serializers/base_serializer.rb")
+        end.to raise_error(Errno::ENOENT)
+      end
     end
 
-    it "adds S3 bucket ENV vars" do
-      content = IO.read("#{project_path}/.env.development")
-      expect(content).to include("S3_BUCKET=")
+    context 'with heroku' do
+      before :all do
+        drop_dummy_database
+        remove_project_directory
+        create_dummy_project(storage: :shrine, heroku: true)
+      end
+
+      it_behaves_like 'common shrine setup'
+
+      it 'adds buildpacks .buildpacks' do
+        content = IO.read("#{project_path}/.buildpacks")
+        expect(content).to include("heroku-buildpack-apt")
+        expect(content).to include("heroku-buildpack-vips")
+      end
+
+      it 'adds Aptfile' do
+        expect(File.exist?("#{project_path}/Aptfile")).to be(true)
+      end
     end
 
-    it "adds filestorage path to gitignore" do
-      content = IO.read("#{project_path}/.gitignore")
-      expect(content).to include("/public/uploads")
+    context 'with api' do
+      before :all do
+        drop_dummy_database
+        remove_project_directory
+        create_dummy_project(storage: :shrine, api: true)
+      end
+
+      it_behaves_like 'common shrine setup'
+
+      it 'adds image_handling_attributes serializer concern' do
+        expect(
+          File.exist?("#{project_path}/app/serializers/concerns/image_handling_attributes.rb")
+        ).to be(true)
+      end
+
+      it 'adds base serializer' do
+        expect(File.exist?("#{project_path}/app/serializers/base_serializer.rb")).to be(true)
+      end
     end
   end
 end

data/spec/features/front_end_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe "Front end" do
   let(:application_css_path) { "#{project_path}/app/javascript/css/application.css" }
   let(:gemfile) { IO.read("#{project_path}/Gemfile") }
   let(:node_modules_file) { IO.read("#{project_path}/package.json") }
-  let(:application_js_file) { IO.read("#{project_path}/app/javascript/packs/application.js") }
+  let(:application_js_file) { IO.read("#{project_path}/app/javascript/application.js") }
   let(:layout_file) { IO.read("#{project_path}/app/views/layouts/application.html.erb") }
   let(:application_css_file) { IO.read(application_css_path) }
   let(:tailwind_config_file) { IO.read("#{project_path}/tailwind.config.js") }
@@ -18,14 +18,13 @@ RSpec.describe "Front end" do
   it "creates a project without a front end framework" do
     remove_project_directory
     create_dummy_project("front_end" => "None")
-    expect(gemfile).to include('webpacker')
-    expect(File).not_to exist(application_css_path)
+    expect(gemfile).to include('shakapacker')
   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\"")
+  def expect_to_have_tailwind_package_versions
+    expect(node_modules_file).to include("\"tailwindcss\": \"^3\"")
+    expect(node_modules_file).to include("\"autoprefixer\": \"^10\"")
+    expect(node_modules_file).to include("\"postcss\": \"^8\"")
   end
 
   context "with vue" do
@@ -34,11 +33,11 @@ RSpec.describe "Front end" do
       create_dummy_project("front_end" => "vue")
     end
 
-    it "creates a project with vue in compiler mode as frontend framework" do
-      expect(gemfile).to include('webpacker')
+    it "creates a project with vue as frontend framework" do
+      expect(gemfile).to include('shakapacker')
       expect(node_modules_file).to include("\"vue\"")
-      expect(application_js_file).to include('vue/dist/vue.esm')
-      expect(application_js_file).to include("el: '#vue-app'")
+      expect(application_js_file).to include('vue')
+      expect(application_js_file).to include("app.mount('#vue-app')")
       expect(layout_file).to include('id="vue-app"')
     end
 
@@ -47,7 +46,7 @@ RSpec.describe "Front end" do
     end
 
     it "creates a vue project with client css" do
-      expect(application_js_file).to include("import '../css/application.css';")
+      expect(application_js_file).to include("import './css/application.css';")
       expect(layout_file).to include("<%= stylesheet_pack_tag 'application' %>")
       expect(rails_css_file).not_to include('*= require_tree', '*= require_self')
     end
@@ -55,48 +54,18 @@ RSpec.describe "Front end" do
     it "creates a vue project with tailwindcss" do
       expect(node_modules_file).to include("\"tailwindcss\"")
       expect(application_css_file).to include(
-        "@import 'tailwindcss/base';",
-        "@import 'tailwindcss/components';"
+        "@tailwind base;",
+        "@tailwind components;"
       )
       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
+      expect_to_have_tailwind_package_versions
     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
-    before(:all) do
-      remove_project_directory
-      create_dummy_project("front_end" => "angular")
-    end
-
-    it "creates a project without vue as front end framework" do
-      expect(gemfile).to include('webpacker')
-      expect(node_modules_file).to include("\"@angular/core\"")
-    end
-
-    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
+    it 'includes correct version of vue-loader in package' do
+      expect(node_modules_file).to include("\"vue-loader\": \"#{Potassium::VUE_LOADER_VERSION}\"")
     end
   end
 end

data/spec/features/google_tag_manager_spec.rb

@@ -31,29 +31,6 @@ RSpec.describe "Google Tag Manager" do
 
   it 'add content security policy' do
     expect(content_security_policy_file)
-      .to include(content_security_policy_code)
-  end
-
-  def content_security_policy_code
-    <<~HERE
-      Rails.application.config.content_security_policy do |policy|
-        if Rails.env.development?
-          policy.connect_src :self, :https, 'http://localhost:3035', 'ws://localhost:3035'
-          policy.script_src :self, :https, :unsafe_eval
-        else
-          policy.script_src :self, :https
-          # google tag manager requires to enable unsafe inline:
-          # https://developers.google.com/tag-manager/web/csp
-          policy.connect_src :self, :https, 'https://www.google-analytics.com'
-          policy.script_src :self,
-            :https,
-            :unsafe_inline,
-            'https://www.googletagmanager.com',
-            'https://www.google-analytics.com',
-            'https://ssl.google-analytics.com'
-          policy.img_src :self, :https, 'https://www.googletagmanager.com', 'https://www.google-analytics.com'
-        end
-      end
-    HERE
+      .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)