potassium 6.3.0 → 6.6.0

data/lib/potassium/recipes/front_end.rb

@@ -1,8 +1,15 @@
 class Recipes::FrontEnd < Rails::AppBuilder
+  VUE_LOADER_VERSION = Potassium::VUE_LOADER_VERSION
+  VUE_VERSION = Potassium::VUE_VERSION
+  VUE_TEST_UTILS_VERSION = Potassium::VUE_TEST_UTILS_VERSION
+  POSTCSS_VERSION = Potassium::POSTCSS_VERSION
+  TAILWINDCSS_VERSION = Potassium::TAILWINDCSS_VERSION
+  AUTOPREFIXER_VERSION = Potassium::AUTOPREFIXER_VERSION
+  VUE_JEST_VERSION = Potassium::VUE_JEST_VERSION
+
   def ask
     frameworks = {
       vue: "Vue",
-      angular: "Angular 2",
       none: "None"
     }
 
@@ -15,21 +22,17 @@ class Recipes::FrontEnd < Rails::AppBuilder
   end
 
   def create
-    return if [:none, :None].include? get(:front_end).to_sym
-
+    gather_gem('shakapacker', '~> 6.2.0')
     recipe = self
-    after(:gem_install) do
-      value = get(:front_end)
+    after(:gem_install, wrap_in_action: :webpacker_install) do
       run "rails webpacker:install"
-      run "rails webpacker:install:#{value}" if value
-
-      if value == :vue
-        recipe.setup_vue_with_compiler_build
-        recipe.setup_jest
-        if get(:api) == :graphql
-          recipe.setup_apollo
-        end
-      end
+    end
+    after(:webpacker_install) do
+      value = get(:front_end)
+      recipe.copy_webpack_rules
+      recipe.add_assets_path
+      recipe.setup_typescript
+      recipe.setup_vue if value == :vue
       recipe.add_responsive_meta_tag
       recipe.setup_tailwind
       add_readme_header :webpack
@@ -44,13 +47,37 @@ class Recipes::FrontEnd < Rails::AppBuilder
   def installed?
     package_file = 'package.json'
     return false unless file_exist?(package_file)
+
     package_content = read_file(package_file)
-    package_content.include?("\"@angular/core\"") || package_content.include?("\"vue\"")
+    package_content.include?("\"vue\"")
+  end
+
+  def copy_webpack_rules
+    copy_file '../assets/config/webpack/webpack.config.js',
+              'config/webpack/webpack.config.js',
+              force: true
+    copy_file '../assets/config/webpack/rules/index.js', 'config/webpack/rules/index.js'
+    copy_file '../assets/config/webpack/rules/css.js', 'config/webpack/rules/css.js'
+    copy_file '../assets/config/webpack/rules/vue.js', 'config/webpack/rules/vue.js'
+    copy_file '../assets/config/webpack/rules/jquery.js', 'config/webpack/rules/jquery.js'
+    copy_file '../assets/config/webpack/rules/typescript.js', 'config/webpack/rules/typescript.js'
+  end
+
+  def add_assets_path
+    gsub_file(
+      'config/webpacker.yml',
+      'additional_paths: []',
+      "additional_paths: ['app/assets']"
+    )
+  end
+
+  def setup_typescript
+    run "bin/yarn add typescript fork-ts-checker-webpack-plugin ts-loader @types/node"
+    copy_file '../assets/tsconfig.json', 'tsconfig.json'
   end
 
   def setup_vue_with_compiler_build
-    application_js = 'app/javascript/packs/application.js'
-    remove_file "app/javascript/packs/hello_vue.js"
+    application_js = 'app/javascript/application.js'
     create_file application_js, application_js_content, force: true
 
     layout_file = "app/views/layouts/application.html.erb"
@@ -69,43 +96,44 @@ class Recipes::FrontEnd < Rails::AppBuilder
   end
 
   def setup_tailwind
-    run "bin/yarn add tailwindcss@#{Potassium::TAILWINDCSS}"
-    specify_autoprefixer_postcss_compatibility_versions
+    run "bin/yarn add css-loader style-loader mini-css-extract-plugin @types/tailwindcss "\
+      "css-minimizer-webpack-plugin postcss@#{POSTCSS_VERSION} postcss-loader "\
+      "tailwindcss@#{TAILWINDCSS_VERSION} autoprefixer@#{AUTOPREFIXER_VERSION} sass sass-loader "\
+      "eslint-plugin-tailwindcss"
+    run "npx tailwindcss init -p"
     setup_client_css
     remove_server_css_requires
     setup_tailwind_requirements
   end
 
   def setup_jest
-    run 'bin/yarn add jest vue-jest babel-jest @vue/test-utils jest-serializer-vue babel-core@^7.0.0-bridge.0 --dev'
+    run "bin/yarn add jest @vue/vue3-jest@#{VUE_JEST_VERSION} babel-jest "\
+    "@vue/test-utils@#{VUE_TEST_UTILS_VERSION} ts-jest"
     json_file = File.read(Pathname.new("package.json"))
     js_package = JSON.parse(json_file)
     js_package = js_package.merge(jest_config)
     json_string = JSON.pretty_generate(js_package)
     create_file 'package.json', json_string, force: true
 
-    copy_file '../assets/app/javascript/app.spec.js', 'app/javascript/app.spec.js'
+    copy_file '../assets/app/javascript/components/app.spec.ts',
+              'app/javascript/components/app.spec.ts'
   end
 
-  def setup_apollo
-    run 'bin/yarn add vue-apollo graphql apollo-client apollo-link apollo-link-http apollo-cache-inmemory graphql-tag'
-
-    inject_into_file(
-      'app/javascript/packs/application.js',
-      apollo_imports,
-      after: "import App from '../app.vue';"
-    )
-
-    inject_into_file(
-      'app/javascript/packs/application.js',
-      apollo_loading,
-      after: "import VueApollo from 'vue-apollo';"
-    )
-    inject_into_file(
-      'app/javascript/packs/application.js',
-      "\n    apolloProvider,",
-      after: "components: { App },"
+  def setup_vue
+    run "bin/yarn add vue@#{VUE_VERSION} vue-loader@#{VUE_LOADER_VERSION} "\
+        "babel-preset-typescript-vue3"
+    gsub_file(
+      'config/webpack/webpack.config.js',
+      ' merge(typescriptConfig, cssConfig, jQueryConfig, webpackConfig);',
+      ' merge(vueConfig, typescriptConfig, cssConfig, jQueryConfig, webpackConfig);'
     )
+    copy_file '../assets/app/javascript/components/app.vue', 'app/javascript/components/app.vue'
+    copy_file '../assets/app/javascript/types/vue.d.ts', 'app/javascript/types/vue.d.ts'
+    setup_vue_with_compiler_build
+    recipe = self
+    run_action(:setup_jest) do
+      recipe.setup_jest
+    end
   end
 
   private
@@ -113,45 +141,11 @@ class Recipes::FrontEnd < Rails::AppBuilder
   def frameworks(framework)
     frameworks = {
       vue: "vue",
-      angular: "angular",
       none: nil
     }
     frameworks[framework]
   end
 
-  def apollo_imports
-    <<~JS
-      \n
-      import { ApolloClient } from 'apollo-client';
-      import { createHttpLink } from 'apollo-link-http';
-      import { InMemoryCache } from 'apollo-cache-inmemory';
-      import VueApollo from 'vue-apollo';
-    JS
-  end
-
-  def apollo_loading
-    <<~JS
-      \n
-      const httpLink = createHttpLink({
-        uri: `${window.location.origin}/graphql`,
-      })
-      const cache = new InMemoryCache()
-      const apolloClient = new ApolloClient({
-        link: httpLink,
-        cache,
-      })
-
-      Vue.use(VueApollo)
-      const apolloProvider = new VueApollo({
-        defaultClient: apolloClient,
-      })
-    JS
-  end
-
-  def specify_autoprefixer_postcss_compatibility_versions
-    run 'bin/yarn -D add postcss@^7 autoprefixer@^9'
-  end
-
   def setup_client_css
     application_css = 'app/javascript/css/application.css'
     create_file application_css, "", force: true
@@ -160,14 +154,14 @@ class Recipes::FrontEnd < Rails::AppBuilder
     layout_file = "app/views/layouts/application.html.erb"
     insert_into_file layout_file, stylesheet_pack_tag, before: "</head>"
 
-    application_js = 'app/javascript/packs/application.js'
+    application_js = 'app/javascript/application.js'
     if get(:front_end) != :vue
-      create_file application_js, "import '../css/application.css';\n", force: true
+      create_file application_js, "import './css/application.css';\n", force: true
     else
       insert_into_file(
         application_js,
-        "\nimport '../css/application.css';",
-        after: "import App from '../app.vue';"
+        "\nimport './css/application.css';",
+        after: "import App from './components/app.vue';"
       )
     end
   end
@@ -178,9 +172,6 @@ class Recipes::FrontEnd < Rails::AppBuilder
 
     tailwind_config = 'tailwind.config.js'
     create_file tailwind_config, tailwind_config_content, force: true
-
-    postcss_file = 'postcss.config.js'
-    insert_into_file postcss_file, postcss_require_tailwind, after: "plugins: [\n"
   end
 
   def remove_server_css_requires
@@ -190,14 +181,14 @@ class Recipes::FrontEnd < Rails::AppBuilder
 
   def application_js_content
     <<~JS
-      import Vue from 'vue/dist/vue.esm';
-      import App from '../app.vue';
+      import { createApp } from 'vue';
+      import App from './components/app.vue';
 
       document.addEventListener('DOMContentLoaded', () => {
-        const app = new Vue({
-          el: '#vue-app',
+        const app = createApp({
           components: { App },
         });
+        app.mount('#vue-app');
 
         return app;
       });
@@ -206,9 +197,9 @@ class Recipes::FrontEnd < Rails::AppBuilder
 
   def tailwind_client_css
     <<~CSS
-      @import 'tailwindcss/base';
-      @import 'tailwindcss/components';
-      @import 'tailwindcss/utilities';
+      @tailwind base;
+      @tailwind components;
+      @tailwind utilities;
     CSS
   end
 
@@ -221,26 +212,16 @@ class Recipes::FrontEnd < Rails::AppBuilder
         },
         variants: {},
         plugins: [],
-        purge: {
-          enabled: process.env.NODE_ENV === 'production',
-          content: [
-            './app/**/*.html',
-            './app/**/*.vue',
-            './app/**/*.js',
-            './app/**/*.erb',
-          ],
-        }
+        content: [
+          './app/**/*.html',
+          './app/**/*.vue',
+          './app/**/*.js',
+          './app/**/*.erb',
+        ],
       };
     JS
   end
 
-  def postcss_require_tailwind
-    <<-JS.gsub(/^ {4}/, '  ')
-      require('tailwindcss'),
-      require('autoprefixer'),
-    JS
-  end
-
   def jest_config
     {
       "scripts": {
@@ -260,16 +241,14 @@ class Recipes::FrontEnd < Rails::AppBuilder
         },
         "moduleFileExtensions": [
           "js",
+          "ts",
           "json",
           "vue"
         ],
         "transform": {
-          "^.+\\.js$": "<rootDir>/node_modules/babel-jest",
-          ".*\\.(vue)$": "<rootDir>/node_modules/vue-jest"
+          "^.+\\.ts$": "ts-jest",
+          ".*\\.(vue)$": "@vue/vue3-jest"
         },
-        "snapshotSerializers": [
-          "<rootDir>/node_modules/jest-serializer-vue"
-        ],
         "testEnvironment": "jsdom"
       }
     }

data/lib/potassium/recipes/google_tag_manager.rb

@@ -68,22 +68,26 @@ class Recipes::GoogleTagManager < Rails::AppBuilder
   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
+        policy.connect_src(
+          :self,
+          :https,
+          'http://localhost:3035',
+          'ws://localhost:3035',
+          'https://www.google-analytics.com'
+        )
+        # google tag manager requires to enable unsafe inline and vue unsave eval:
+        # https://developers.google.com/tag-manager/web/csp
+        # https://vuejs.org/v2/guide/installation.html#CSP-environments
+        policy.script_src(
+          :self,
+          :https,
+          :unsafe_inline,
+          :unsafe_eval,
+          'https://www.googletagmanager.com',
+          'https://www.google-analytics.com',
+          'https://ssl.google-analytics.com'
+        )
+        policy.img_src :self, 'data:', :https, 'https://www.googletagmanager.com', 'https://www.google-analytics.com'
       end
     HERE
   end

data/lib/potassium/recipes/heroku.rb

@@ -24,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
 

data/lib/potassium/recipes/mailer.rb

@@ -63,20 +63,32 @@ class Recipes::Mailer < Rails::AppBuilder
     gather_gem 'recipient_interceptor'
   end
 
+  def config_environments
+    gsub_file 'config/environments/production.rb', /$\s*config.action_mailer.*/, ''
+    asset_host_dev = <<~RUBY
+      config.action_mailer.asset_host = "http://\#{ENV.fetch('APPLICATION_HOST')}"
+    RUBY
+    application asset_host_dev, env: "development"
+    asset_host_prod = <<~RUBY
+      config.action_mailer.asset_host = "https://\#{ENV.fetch('APPLICATION_HOST')}"
+    RUBY
+    application asset_host_prod, env: "production"
+    mailer_config = <<~RUBY
+      require Rails.root.join("config", "mailer")
+    RUBY
+
+    prepend_file "config/environments/production.rb", mailer_config
+  end
+
   def config(service)
     template "../assets/config/mailer.rb.erb", 'config/mailer.rb'
-    gsub_file 'config/environments/production.rb', /$\s*config.action_mailer.*/, ''
+
     append_to_file '.env.development', "APPLICATION_HOST=localhost:3000\n"
     append_to_file '.env.development', "EMAIL_RECIPIENTS=\n"
 
-    mailer_config =
-      <<~RUBY
-        require Rails.root.join("config", "mailer")
-      RUBY
-
-    prepend_file "config/environments/production.rb", mailer_config
-    copy_file '../assets/app/mailers/application_mailer.rb', 'app/mailers/application_mailer.rb', force: true
-
+    copy_file '../assets/app/mailers/application_mailer.rb', 'app/mailers/application_mailer.rb',
+              force: true
+    config_environments
     send(service[:name])
   end
 
@@ -88,7 +100,7 @@ class Recipes::Mailer < Rails::AppBuilder
       }
     RUBY
     inject_into_file 'config/mailer.rb', sendgrid_settings,
-      after: "Rails.application.config.action_mailer.delivery_method = :sendgrid\n"
+                     after: "Rails.application.config.action_mailer.delivery_method = :sendgrid\n"
     sendgrid_dev_settings = <<~RUBY
       Rails.application.config.action_mailer.sendgrid_dev_settings = {
         api_key: ENV['SENDGRID_API_KEY']

data/lib/potassium/recipes/mjml.rb

@@ -0,0 +1,31 @@
+class Recipes::Mjml < Rails::AppBuilder
+  def create
+    return if get(:email_service).to_s.downcase.to_sym == :none
+
+    gather_gem 'mjml-rails'
+    after(:gem_install) do
+      run 'bin/yarn add mjml'
+      mjml_config
+    end
+  end
+
+  def installed?
+    gem_exists?(/mjml-rails/)
+  end
+
+  def install
+    create
+  end
+end
+
+private
+
+def mjml_config
+  copy_file '../assets/app/views/layouts/default_mail.html.mjml',
+            'app/views/layouts/default_mail.html.mjml', force: true
+  copy_file '../assets/app/mailers/example_mailer.rb', 'app/mailers/example_mailer.rb', force: true
+  copy_file '../assets/app/views/example_mailer/example_mail.html.mjml',
+            'app/views/example_mailer/example_mail.html.mjml', force: true
+  copy_file '../assets/public/mails/platanus-logo.png',
+            'public/mails/platanus-logo.png', force: true
+end

data/lib/potassium/recipes/node.rb

@@ -3,19 +3,17 @@ require 'semantic'
 require 'json'
 
 class Recipes::Node < Rails::AppBuilder
-  def create
-    info "Using node version LTS #{version}"
-    create_file '.node-version', version, force: true
-    json_file = File.read(Pathname.new("package.json"))
-    js_package = JSON.parse(json_file)
-    js_package["engines"] = { "node" => "#{version}.x" }
-    json_string = JSON.pretty_generate(js_package)
-    create_file 'package.json', json_string, force: true
-  end
+  NODE_VERSION = Potassium::NODE_VERSION
 
-  private
-
-  def version
-    Potassium::NODE_VERSION
+  def create
+    info "Using node version LTS #{NODE_VERSION}"
+    create_file '.node-version', NODE_VERSION, force: true
+    after(:webpacker_install) do
+      json_file = File.read(Pathname.new("package.json"))
+      js_package = JSON.parse(json_file)
+      js_package["engines"] = { "node" => "#{NODE_VERSION}.x" }
+      json_string = JSON.pretty_generate(js_package)
+      create_file 'package.json', json_string, force: true
+    end
   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/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

@@ -17,9 +17,16 @@ class Recipes::Style < Rails::AppBuilder
       gather_gem 'rubocop-performance'
       gather_gem 'rubocop-rails'
       gather_gem 'rubocop-rspec', Potassium::RUBOCOP_RSPEC_VERSION
+      gather_gem 'rubocop-platanus'
+    end
+
+    after(:webpacker_install) do
+      run "yarn add --dev stylelint eslint eslint-plugin-import "\
+        "@typescript-eslint/eslint-plugin  @types/jest @typescript-eslint/parser eslint-plugin-jest"
+      if selected?(:front_end, :vue)
+        run 'yarn add --dev eslint-plugin-vue @vue/eslint-config-typescript'
+      end
     end
-    run 'bin/yarn add --dev stylelint eslint eslint-plugin-import'
-    run 'bin/yarn add --dev eslint-plugin-vue' if selected?(:front_end, :vue)
   end
 
   def add_config_files