potassium 6.7.0 → 7.1.0

data/lib/potassium/assets/lib/dotenv_monkeypatch.rb

@@ -0,0 +1,19 @@
+module Dotenv
+  module Substitutions
+    module Command
+      class << self
+        INTERPOLATED_SHELL_COMMAND = /
+          (?<backslash>\\)?   # is it escaped with a backslash?
+          COMMAND_EXPAND                  # literal $
+          (?<cmd>             # collect command content for eval
+            \(                # require opening paren
+            (?:[^()]|\g<cmd>)+  # allow any number of non-parens, or balanced
+                              # parens (by nesting the <cmd> expression
+                              # recursively)
+            \)                # require closing paren
+          )
+        /x
+      end
+    end
+  end
+end

data/lib/potassium/assets/lib/environment_variables.rb

@@ -0,0 +1,9 @@
+module EnvironmentVariables
+  extend self
+
+  APPLICATION_HOST = ENV.fetch('APPLICATION_HOST')
+
+  def application_host
+    APPLICATION_HOST
+  end
+end

data/lib/potassium/assets/package.json

@@ -1,5 +1,12 @@
 {
   "name": "<%= @app_name.camelcase %>",
+  "private": true,
+  "version": "0.0.1",
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:changes": "vitest --changed master"
+  },
   "engines": {
     "node": "<%= get(:node_version) %>"
   }

data/lib/potassium/assets/tailwind.config.js

@@ -0,0 +1,14 @@
+/* eslint-disable no-undef */
+module.exports = {
+  theme: {
+    extend: {},
+  },
+  variants: {},
+  plugins: [],
+  content: [
+    './app/**/*.html',
+    './app/**/*.vue',
+    './app/**/*.js',
+    './app/**/*.erb',
+  ],
+};

data/lib/potassium/assets/testing/simplecov_config.rb

@@ -1,6 +1,7 @@
 require 'simplecov'
 require 'simplecov_text_formatter'
 require 'simplecov_linter_formatter'
+require 'simplecov_json_formatter'
 
 SimpleCovLinterFormatter.setup do |config|
   config.scope = ENV.fetch(
@@ -48,9 +49,17 @@ SimpleCov.start 'rails' do
   add_filter 'app/responders'
   add_filter 'lib/fake_data_loader.rb'
   add_filter 'lib/vue_component.rb'
+  add_filter 'lib/environment_variables.rb'
 
   if ENV["CIRCLECI"]
-    formatter(SimpleCov::Formatter::TextFormatter)
+    formatter(
+      SimpleCov::Formatter::MultiFormatter.new(
+        [
+          SimpleCov::Formatter::TextFormatter,
+          SimpleCov::Formatter::JSONFormatter
+        ]
+      )
+    )
   else
     formatter(
       SimpleCov::Formatter::MultiFormatter.new(

data/lib/potassium/assets/tsconfig.config.json

@@ -0,0 +1,18 @@
+{
+  "extends": [
+    "@tsconfig/node14/tsconfig.json",
+    "@vue/tsconfig/tsconfig.json"
+  ],
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "playwright.config.*"
+  ],
+  "compilerOptions": {
+    "composite": true,
+    "types": [
+      "node"
+    ]
+  }
+}

data/lib/potassium/assets/tsconfig.json

@@ -1,32 +1,22 @@
 {
-  "compilerOptions": {
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "useDefineForClassFields": true,
-    "jsx": "preserve",
-    "noImplicitThis": true,
-    "strict": true,
-    "isolatedModules": true,
-    "preserveValueImports": true,
-    "importsNotUsedAsValues": "error",
-    "target": "esnext",
-    "allowJs": true,
-
-    // Recommended
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    // See <https://github.com/vuejs/vue-cli/pull/5688>
-    "skipLibCheck": true,
-    "baseUrl": "app/javascript/",
-    "types": ["@types/jest", "@types/node"],
-  },
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
   "include": [
-    "app/javascript/**/*.ts",
-    "app/javascript/**/*.vue"
+    "env.d.ts",
+    "app/**/*",
+    "app/**/*.vue"
   ],
-  "exclude": [
-    "node_modules",
-    "**/*.spec.ts"
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": [
+        "./app/frontend/*"
+      ]
+    },
+    "types": ["vitest/globals", "vite/client"]
+  },
+  "references": [
+    {
+      "path": "./tsconfig.config.json"
+    }
   ]
 }

data/lib/potassium/assets/vite.config.ts

@@ -0,0 +1,46 @@
+import { fileURLToPath, URL } from 'node:url';
+import { defineConfig } from 'vitest/config'
+import RubyPlugin from 'vite-plugin-ruby';
+import vue from '@vitejs/plugin-vue';
+
+export default defineConfig({
+  plugins: [
+    RubyPlugin(),
+    vue()
+  ],
+  resolve: {
+    alias: {
+      vue: 'vue/dist/vue.esm-bundler.js',
+      '@': fileURLToPath(new URL('./app/frontend', import.meta.url)),
+    },
+  },
+  test: {
+    globals: true,
+    environment: 'jsdom',
+    coverage: {
+      provider: 'c8',
+      all: true,
+      include: ['app/frontend/**/*.{js,ts,vue}'],
+      exclude: [
+        /* default excludes */
+        'coverage/**',
+        'dist/**',
+        'packages/*/test{,s}/**',
+        '**/*.d.ts',
+        'cypress/**',
+        'test{,s}/**',
+        'test{,-*}.{js,cjs,mjs,ts,tsx,jsx}',
+        '**/*{.,-}test.{js,cjs,mjs,ts,tsx,jsx}',
+        '**/*{.,-}spec.{js,cjs,mjs,ts,tsx,jsx}',
+        '**/__tests__/**',
+        '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build}.config.*',
+        '**/.{eslint,mocha,prettier}rc.{js,cjs,yml}',
+        /* custom excludes */
+        'app/frontend/**/*.spec.{js,ts,vue}',
+        'app/frontend/**/*.mock.{js,ts,vue}',
+        'app/frontend/active_admin/jquery.js',
+        'app/frontend/entrypoints',
+      ]
+    }
+  },
+})

data/lib/potassium/cli_options.rb

@@ -172,10 +172,12 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       default_test_value: false
     },
     {
-      type: :flag,
-      name: :front_end,
-      desc: "Decides which front-end framework to use. Available: Vue, Angular 2, None",
-      default_test_value: "None"
+      type: :switch,
+      name: :front_end_vite,
+      desc: "Whether to use Vite as frontend bundler",
+      negatable: true,
+      default_value: true,
+      default_test_value: true
     },
     {
       type: :switch,

data/lib/potassium/helpers/rubocop-helpers.rb

@@ -1,15 +1,9 @@
-module RubocopHelpers
-  def rubocop_revision
-    fix_environments
-  end
+require "rubocop"
 
-  private
-
-  def fix_environments
-    # Style problem in Rails 5 production environments
-    file_name = "config/environments/production.rb"
-    production = File.read(file_name)
-    production.gsub!("config.log_tags = [ :request_id ]", "config.log_tags = [:request_id]")
-    File.open(file_name, "w") { |file| file.write(production) }
+module RubocopHelpers
+  def run_rubocop
+    options, paths = RuboCop::Options.new.parse(["-A"])
+    runner = RuboCop::Runner.new(options, RuboCop::ConfigStore.new)
+    runner.run(paths)
   end
 end

data/lib/potassium/platanus_config.rb

@@ -10,7 +10,7 @@ module Potassium
         'db': 'postgresql', 'locale': 'es-CL', 'email_service': 'sendgrid', 'devise': true,
         'devise-user-model': true, 'admin': true, 'vue_admin': true, 'pundit': true,
         'api': true, 'storage': 'shrine', 'heroku': true, 'background_processor': true,
-        'draper': true, 'schedule': true, 'sentry': true, 'front_end': 'vue',
+        'draper': true, 'schedule': true, 'sentry': true, 'front_end_vite': true,
         'google_tag_manager': true, 'test': true, 'spring': true
       }
       default_options = default_options.filter { |key, _| @option_key_names.include?(key) }

data/lib/potassium/recipes/admin.rb

@@ -29,15 +29,14 @@ class Recipes::Admin < Rails::AppBuilder
     gem_exists?(/activeadmin/)
   end
 
-  private
-
   def add_active_admin
+    recipe = self
     gather_gem 'activeadmin', '~> 2.9'
-    gather_gem 'activeadmin_addons'
+    gather_gem 'activeadmin_addons', '~> 2.0.0.beta.0'
     add_readme_section :internal_dependencies, :active_admin
     after(:gem_install, wrap_in_action: :admin_install) do
       generate "active_admin:install --use_webpacker"
-      run 'bin/yarn add @activeadmin/activeadmin'
+      run 'yarn add @activeadmin/activeadmin'
       line = "ActiveAdmin.setup do |config|"
       initializer = "config/initializers/active_admin.rb"
       gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
@@ -53,82 +52,54 @@ class Recipes::Admin < Rails::AppBuilder
             meta_tags_options = { viewport: 'width=device-width, initial-scale=1' }
             config.meta_tags = meta_tags_options
             config.meta_tags_for_logged_out_pages = meta_tags_options
+            config.comments = false
         HERE
       end
 
       generate "activeadmin_addons:install"
 
-      run "bin/yarn add arctic_admin @fortawesome/fontawesome-free"
-
-      aa_style = "app/javascript/stylesheets/active_admin.scss"
-
-      gsub_file(
-        aa_style,
-        "@import \"~@activeadmin/activeadmin/src/scss/mixins\";\n" +
-        "@import \"~@activeadmin/activeadmin/src/scss/base\";",
-        <<~HERE
-          @import '~arctic_admin/src/scss/main';
-
-          // Fix for sidebar when there are too many filters
-          #sidebar {
-            height: 100vh;
-            top: 0;
-            z-index: 10;
-          }
-
-          #sidebar::before {
-            top: 200px !important;
-          }
-
-          #filters_sidebar_section {
-            height: 100vh;
-            overflow: auto;
-          }
-
-          // Fix for invisible datepicker calendar
-          #ui-datepicker-div {
-            z-index: 11 !important;
-          }
-
-          // Fix for backwards date range input
-          #sidebar .sidebar_section .filter_date_range input:nth-child(2) {
-            float: none;
-          }
-
-          #sidebar .sidebar_section .filter_date_range {
-            display: flex;
-            flex-flow: row wrap;
-            justify-content: space-between
-          }
-
-          #sidebar .sidebar_section .filter_date_range label {
-            width: 100%;
-          }
-        HERE
-      )
-
-      aa_js = "app/javascript/packs/active_admin.js"
-      js_line = "import \"@activeadmin/activeadmin\";\n"
-
-      gsub_file(
-        aa_js,
-        js_line,
-        <<~HERE
-          #{js_line}
-          import '@fortawesome/fontawesome-free/css/all.css';
-          import 'arctic_admin';
-        HERE
-      )
-
-      run "mv app/javascript/packs/active_admin.js app/javascript/active_admin.js"
-      gsub_file(
-        "app/javascript/active_admin.js",
-        'import "../stylesheets/active_admin";',
-        'import "./stylesheets/active_admin.scss";'
-      )
+      run "yarn add arctic_admin @fortawesome/fontawesome-free"
 
       run 'rm -rf config/webpack/plugins'
+      run 'rm app/javascript/packs/active_admin.js'
       run 'rm -rf app/javascript/packs/active_admin'
+      run 'rm app/javascript/stylesheets/active_admin.scss'
+      run 'rmdir app/javascript/packs'
+      run 'rmdir app/javascript/stylesheets'
+      run 'rmdir app/javascript'
+
+      recipe.copy_frontend_files
+      recipe.insert_vite_monkeypatch
     end
   end
+
+  def copy_frontend_files
+    copy_file '../assets/app/frontend/entrypoints/active_admin.js',
+              'app/frontend/entrypoints/active_admin.js'
+    copy_file '../assets/app/frontend/entrypoints/active_admin.scss',
+              'app/frontend/entrypoints/active_admin.scss'
+    copy_file '../assets/app/frontend/active_admin/jquery.js', 'app/frontend/active_admin/jquery.js'
+  end
+
+  def insert_vite_monkeypatch
+    monkeypatch =
+      <<~HERE
+        module ActiveAdminViteJS
+          def stylesheet_pack_tag(style, **options)
+            style = 'active_admin.scss' if style == 'active_admin.css'
+            vite_stylesheet_tag(style, **options)
+          end
+
+          def javascript_pack_tag(script, **options)
+            vite_javascript_tag(script, **options)
+          end
+        end
+
+        ActiveAdmin::Views::Pages::Base.include ActiveAdminViteJS
+        ActiveSupport.on_load(:action_view) { include ActiveAdminViteJS }
+
+      HERE
+    insert_into_file "config/initializers/active_admin.rb", monkeypatch,
+                     before: "ActiveAdmin.setup do |config|"
+  end
 end

data/lib/potassium/recipes/background_processor.rb

@@ -14,8 +14,6 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
   def create
     if get(:background_processor)
       add_sidekiq
-      add_docker_compose_redis_config
-      set_redis_dot_env
     end
   end
 
@@ -40,7 +38,6 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
       append_to_file(".env.development", "DB_POOL=25\n")
       template("../assets/sidekiq.rb.erb", "config/initializers/sidekiq.rb", force: true)
       copy_file("../assets/sidekiq.yml", "config/sidekiq.yml", force: true)
-      copy_file("../assets/redis.yml", "config/redis.yml", force: true)
       recipe.mount_sidekiq_routes
     end
   end
@@ -68,33 +65,6 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
 
   private
 
-  def add_docker_compose_redis_config
-    compose = DockerHelpers.new('docker-compose.yml')
-
-    service_definition =
-      <<~YAML
-        image: redis
-        ports:
-          - 6379
-        volumes:
-          - redis_data:/data
-      YAML
-
-    compose.add_service('redis', service_definition)
-    compose.add_volume('redis_data')
-  end
-
-  def set_redis_dot_env
-    append_to_file(
-      '.env.development',
-      <<~TEXT
-        REDIS_HOST=127.0.0.1
-        REDIS_PORT=$(make services-port SERVICE=redis PORT=6379)
-        REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1
-      TEXT
-    )
-  end
-
   def enabled_mailer?
     mailer_answer = get(:email_service)
     mailer_answer && ![:none, :None].include?(mailer_answer.to_sym)

data/lib/potassium/recipes/bullet.rb

@@ -0,0 +1,41 @@
+class Recipes::Bullet < Rails::AppBuilder
+  def create
+    gather_gem 'bullet'
+    recipe = self
+    after(:gem_install) do
+      recipe.bullet_config
+    end
+  end
+
+  def installed?
+    gem_exists?(/bullet/)
+  end
+
+  def install
+    create
+  end
+
+  def bullet_config
+    application bullet_after_initialize, env: "development"
+    insert_into_file "app/jobs/application_job.rb", bullet_application_job_config, before: "end"
+  end
+
+  private
+
+  def bullet_after_initialize
+    <<~RUBY
+      config.after_initialize do
+        Bullet.enable = true
+        Bullet.alert = true
+        Bullet.bullet_logger = true
+        Bullet.console = true
+        Bullet.rails_logger = true
+        Bullet.add_footer = true
+      end
+    RUBY
+  end
+
+  def bullet_application_job_config
+    "  include Bullet::ActiveJob if Rails.env.development?\n"
+  end
+end

data/lib/potassium/recipes/ci.rb

@@ -1,11 +1,16 @@
 class Recipes::Ci < Rails::AppBuilder
   def create
     template '../assets/.circleci/config.yml.erb', '.circleci/config.yml'
+    gather_gem 'repo_analyzer'
 
     gather_gems(:test) do
       gather_gem 'rspec_junit_formatter', '~> 0.4'
     end
 
+    gather_gems(:development, :test) do
+      gather_gem('brakeman')
+    end
+
     add_readme_header :ci
     application 'config.assets.js_compressor = :uglifier', env: 'test'
   end

data/lib/potassium/recipes/cleanup.rb

@@ -4,6 +4,5 @@ class Recipes::Cleanup < Rails::AppBuilder
     erase_comments "config/environments/production.rb"
     erase_comments "config/environments/test.rb"
     erase_comments "config/environments/development.rb"
-    cut_comments "config/initializers/backtrace_silencers.rb", limit: 100
   end
 end

data/lib/potassium/recipes/coverage.rb

@@ -4,9 +4,8 @@ class Recipes::Coverage < Rails::AppBuilder
     configure_rails_helper
     append_to_file('.gitignore', "/coverage/*\n")
     recipe = self
-    after(:setup_jest) do
-      recipe.configure_jest_coverage
-      recipe.setup_jest_text_formatter
+    after(:vite_install) do
+      recipe.setup_coverage_dependencies
     end
   end
 
@@ -18,16 +17,8 @@ class Recipes::Coverage < Rails::AppBuilder
     create
   end
 
-  def configure_jest_coverage
-    json_file = File.read(Pathname.new("package.json"))
-    js_package = JSON.parse(json_file)
-    js_package = add_coverage_config(js_package)
-    json_string = JSON.pretty_generate(js_package)
-    create_file 'package.json', json_string, force: true
-  end
-
-  def setup_jest_text_formatter
-    run "bin/yarn add jest-text-formatter@1.0.2 --dev"
+  def setup_coverage_dependencies
+    run "yarn add c8 --dev"
   end
 
   private
@@ -49,18 +40,4 @@ class Recipes::Coverage < Rails::AppBuilder
       end
     end
   end
-
-  def add_coverage_config(js_package)
-    js_package['scripts']['test:changes'] = 'jest --changedSince=master'
-    js_package['jest'] = js_package['jest'].merge(coverage_defaults)
-    js_package
-  end
-
-  def coverage_defaults
-    {
-      collectCoverage: true,
-      collectCoverageFrom: ['**/*.{js,ts,vue}', '!**/node_modules/**'],
-      coverageReporters: ['text']
-    }
-  end
 end

data/lib/potassium/recipes/database_container.rb

@@ -81,7 +81,7 @@ class Recipes::DatabaseContainer < Rails::AppBuilder
 
         # Database
         DB_HOST=127.0.0.1
-        DB_PORT=$(make services-port SERVICE=#{_service_name} PORT=#{_port})
+        DB_PORT=COMMAND_EXPAND(make services-port SERVICE=#{_service_name} PORT=#{_port})
         DB_USER=#{_user}
 
       TEXT

data/lib/potassium/recipes/environment_variables.rb

@@ -0,0 +1,18 @@
+class Recipes::EnvironmentVariables < Rails::AppBuilder
+  def create
+    template '../assets/.env.test.erb', '.env.test'
+    copy_file '../assets/lib/environment_variables.rb', 'lib/environment_variables.rb'
+
+    application(before_configuration_require)
+  end
+
+  private
+
+  def before_configuration_require
+    <<~RUBY
+      config.before_configuration do
+        require Rails.root.join('lib/environment_variables.rb')
+      end
+    RUBY
+  end
+end

data/lib/potassium/recipes/error_reporting.rb

@@ -8,7 +8,7 @@ class Recipes::ErrorReporting < Rails::AppBuilder
 
   def create
     if selected?(:report_error)
-      gather_gem 'sentry-raven'
+      gather_gem 'sentry-rails'
       template '../assets/config/sentry.rb.erb', 'config/initializers/sentry.rb'
       append_to_file '.env.development', "SENTRY_DSN=\n"
       add_readme_section :internal_dependencies, :sentry
@@ -21,6 +21,6 @@ class Recipes::ErrorReporting < Rails::AppBuilder
   end
 
   def installed?
-    gem_exists?(/sentry-raven/) && file_exist?('config/initializers/sentry.rb')
+    gem_exists?(/sentry-rails/) && file_exist?('config/initializers/sentry.rb')
   end
 end