potassium 6.7.0 → 7.0.0

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|
@@ -58,77 +57,48 @@ class Recipes::Admin < Rails::AppBuilder
 
       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

@@ -89,7 +89,7 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
       '.env.development',
       <<~TEXT
         REDIS_HOST=127.0.0.1
-        REDIS_PORT=$(make services-port SERVICE=redis PORT=6379)
+        REDIS_PORT=COMMAND_EXPAND(make services-port SERVICE=redis PORT=6379)
         REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1
       TEXT
     )

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,6 +1,7 @@
 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'

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 jest-text-formatter@1.0.2 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/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

data/lib/potassium/recipes/front_end_vite.rb

@@ -0,0 +1,153 @@
+class Recipes::FrontEndVite < Rails::AppBuilder
+  VUE_VERSION = Potassium::VUE_VERSION
+  POSTCSS_VERSION = Potassium::POSTCSS_VERSION
+  TAILWINDCSS_VERSION = Potassium::TAILWINDCSS_VERSION
+  AUTOPREFIXER_VERSION = Potassium::AUTOPREFIXER_VERSION
+  VUE_TEST_UTILS_VERSION = Potassium::VUE_TEST_UTILS_VERSION
+
+  DEPENDENCIES = {
+    tailwind: [
+      "postcss@#{POSTCSS_VERSION}",
+      "tailwindcss@#{TAILWINDCSS_VERSION}",
+      "autoprefixer@#{AUTOPREFIXER_VERSION}",
+      "sass"
+    ],
+    typescript: [
+      "typescript"
+    ],
+    typescript_dev: [
+      "@types/node"
+    ],
+    vue: [
+      "vue@#{VUE_VERSION}"
+    ],
+    vue_dev: [
+      "@vitejs/plugin-vue",
+      "@vue/tsconfig",
+      "vue-tsc"
+    ],
+    vitest_dev: [
+      "vitest",
+      "@vue/test-utils@#{VUE_TEST_UTILS_VERSION}",
+      "jsdom"
+    ],
+    api: [
+      "axios",
+      "humps"
+    ],
+    api_dev: [
+      "@types/humps"
+    ]
+  }
+
+  def installed?
+    gem_exists?(/vite_rails/)
+  end
+
+  def create
+    add_vite
+  end
+
+  def install
+    add_vite
+  end
+
+  def add_vite
+    gather_gem("vite_rails")
+    recipe = self
+    after(:gem_install, wrap_in_action: :vite_install) do
+      run "yarn install"
+      run "bundle exec vite install"
+      recipe.install_packages
+      recipe.setup_tailwind
+      recipe.copy_config_files
+      recipe.setup_vite
+      recipe.copy_default_assets
+      recipe.insert_vue_into_layout
+      recipe.setup_api_client
+      add_readme_header :vite
+    end
+  end
+
+  def install_packages
+    packages, dev_packages = DEPENDENCIES.partition { |k, _| !k.to_s.end_with?('_dev') }.map(&:to_h)
+
+    run "yarn add #{packages.values.flatten.join(' ')}"
+    run "yarn add --dev #{dev_packages.values.flatten.join(' ')}"
+  end
+
+  def setup_tailwind
+    run "npx tailwindcss init -p"
+  end
+
+  def copy_config_files
+    copy_file '../assets/vite.config.ts', 'vite.config.ts', force: true
+    copy_file '../assets/tailwind.config.js', 'tailwind.config.js', force: true
+    copy_file '../assets/tsconfig.json', 'tsconfig.json', force: true
+    copy_file '../assets/tsconfig.config.json', 'tsconfig.config.json', force: true
+  end
+
+  def setup_vite
+    add_vite_dev_ws_content_security_policy
+    copy_dotenv_monkeypatch
+  end
+
+  def copy_default_assets
+    copy_file '../assets/app/frontend/entrypoints/application.js',
+              'app/frontend/entrypoints/application.js', force: true
+    copy_file '../assets/app/frontend/css/application.css', 'app/frontend/css/application.css',
+              force: true
+    copy_file '../assets/app/frontend/components/app.vue', 'app/frontend/components/app.vue',
+              force: true
+    copy_file '../assets/app/frontend/types/vue.d.ts', 'app/frontend/types/vue.d.ts'
+    copy_file '../assets/app/frontend/components/app.spec.ts',
+              'app/frontend/components/app.spec.ts'
+  end
+
+  def insert_vue_into_layout
+    layout_file = "app/views/layouts/application.html.erb"
+    insert_into_file(
+      layout_file,
+      "<div id=\"vue-app\">\n      <app></app>\n      ",
+      before: "<%= yield %>"
+    )
+    insert_into_file layout_file, "\n    </div>", after: "<%= yield %>"
+  end
+
+  def setup_api_client
+    copy_file '../assets/app/frontend/api/index.ts', 'app/frontend/api/index.ts'
+    copy_file '../assets/app/frontend/api/__mocks__/index.mock.ts',
+              'app/frontend/api/__mocks__/index.mock.ts'
+    copy_file '../assets/app/frontend/utils/case-converter.ts',
+              'app/frontend/utils/case-converter.ts'
+    copy_file '../assets/app/frontend/utils/csrf-token.ts',
+              'app/frontend/utils/csrf-token.ts'
+  end
+
+  def add_vite_dev_ws_content_security_policy
+    initializer = "config/initializers/content_security_policy.rb"
+    line = "#    policy.style_src *policy.style_src, :unsafe_inline if Rails.env.development?"
+    policy = <<~HERE.chomp
+      # if Rails.env.development?
+      #   policy.connect_src *policy.connect_src,
+      #                     "ws://\#{ViteRuby.config.host_with_port}"
+      # end
+    HERE
+    # check if policy already exists
+    return if File.read(initializer).include?("policy.connect_src *policy.connect_src")
+
+    inject_into_file initializer, after: line do
+      policy
+    end
+  end
+
+  def copy_dotenv_monkeypatch
+    copy_file '../assets/lib/dotenv_monkeypatch.rb',
+              'lib/dotenv_monkeypatch.rb', force: true
+    insert_into_file(
+      "config/application.rb",
+      "\nrequire_relative '../lib/dotenv_monkeypatch'\n",
+      after: "Bundler.require(*Rails.groups)"
+    )
+  end
+end

data/lib/potassium/recipes/google_tag_manager.rb

@@ -25,7 +25,8 @@ class Recipes::GoogleTagManager < Rails::AppBuilder
   def add_content_security_policy
     inject_into_file(
       'config/initializers/content_security_policy.rb',
-      content_security_policy_code
+      content_security_policy_code,
+      before: '# Report violations without enforcing the policy.'
     )
   end
 
@@ -67,28 +68,23 @@ class Recipes::GoogleTagManager < Rails::AppBuilder
 
   def content_security_policy_code
     <<~HERE
-      Rails.application.config.content_security_policy do |policy|
-        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
+      # policy.connect_src(
+      #   *policy.connect_src,
+      #   'https://www.google-analytics.com'
+      # )
+      # google tag manager requires to enable unsafe inline:
+      # https://developers.google.com/tag-manager/web/csp
+      # policy.script_src(
+      #   *policy.script_src,
+      #   'https://www.googletagmanager.com',
+      #   'https://www.google-analytics.com',
+      #   'https://ssl.google-analytics.com'
+      # )
+      # policy.img_src(
+      #   *policy.img_src,
+      #   'https://www.googletagmanager.com',
+      #   'https://www.google-analytics.com'
+      # )
     HERE
   end
 end

data/lib/potassium/recipes/mjml.rb

@@ -4,7 +4,7 @@ class Recipes::Mjml < Rails::AppBuilder
 
     gather_gem 'mjml-rails'
     after(:gem_install) do
-      run 'bin/yarn add mjml'
+      run 'yarn add mjml'
       mjml_config
     end
   end

data/lib/potassium/recipes/node.rb

@@ -8,7 +8,7 @@ class Recipes::Node < Rails::AppBuilder
   def create
     info "Using node version LTS #{NODE_VERSION}"
     create_file '.node-version', NODE_VERSION, force: true
-    after(:webpacker_install) do
+    after(:vite_install) do
       json_file = File.read(Pathname.new("package.json"))
       js_package = JSON.parse(json_file)
       js_package["engines"] = { "node" => "#{NODE_VERSION}.x" }

data/lib/potassium/recipes/style.rb

@@ -20,13 +20,11 @@ class Recipes::Style < Rails::AppBuilder
       gather_gem 'rubocop-platanus'
     end
 
-    after(:webpacker_install) do
+    after(:vite_install) do
       run "yarn add --dev stylelint eslint eslint-plugin-import "\
         "@typescript-eslint/eslint-plugin  @types/jest @typescript-eslint/parser "\
-        "eslint-plugin-jest eslint-plugin-platanus"
-      if selected?(:front_end, :vue)
-        run 'yarn add --dev eslint-plugin-vue @vue/eslint-config-typescript'
-      end
+        "eslint-plugin-jest eslint-plugin-platanus eslint-plugin-vue "\
+        "@vue/eslint-config-typescript eslint-plugin-tailwindcss"
     end
   end
 

data/lib/potassium/recipes/vue_admin.rb

@@ -5,7 +5,6 @@ class Recipes::VueAdmin < Rails::AppBuilder
         Ask.confirm "Do you want Vue support for ActiveAdmin?"
       end
       set(:vue_admin, vue_admin)
-      set(:front_end, :vue) if vue_admin
     end
   end
 
@@ -29,23 +28,18 @@ class Recipes::VueAdmin < Rails::AppBuilder
   end
 
   def installed?
-    dir_exist?("app/assets/javascripts/admin")
+    file_exist?("lib/vue_component.rb")
   end
 
   def add_vue_admin
     add_vue_component_library
     add_component_integration
-    js_line = 'import "activeadmin_addons"'
-    gsub_file(
-      'app/javascript/active_admin.js',
-      js_line,
-      <<~HERE
-        #{js_line}
-        #{active_admin_js}
-      HERE
+    insert_into_file(
+      'app/frontend/entrypoints/active_admin.js',
+      active_admin_js
     )
     copy_file '../assets/active_admin/admin-component.vue',
-              'app/javascript/components/admin-component.vue',
+              'app/frontend/components/admin-component.vue',
               force: true
   end
 
@@ -128,7 +122,7 @@ class Recipes::VueAdmin < Rails::AppBuilder
   def active_admin_js
     <<~HERE
       import { createApp } from 'vue';
-      import AdminComponent from './components/admin-component.vue';
+      import AdminComponent from '../components/admin-component.vue';
 
       function onLoad() {
         if (document.getElementById('wrapper') !== null) {
@@ -141,7 +135,7 @@ class Recipes::VueAdmin < Rails::AppBuilder
               }));
             },
           });
-          app.component('AdminComponent', AdminComponent);
+          app.component('admin_component', AdminComponent);
           app.mount('#wrapper');
         }
 

data/lib/potassium/recipes/yarn.rb

@@ -1,6 +1,6 @@
 class Recipes::Yarn < Rails::AppBuilder
   def create
-    template '../assets/package.json', 'package.json' unless get(:front_end)
+    template '../assets/package.json', 'package.json'
     template '../assets/bin/update.erb', 'bin/update', force: true
     application "config.assets.paths << Rails.root.join('node_modules')"
     append_to_file ".gitignore", "node_modules/\n"

data/lib/potassium/templates/application.rb

@@ -12,16 +12,11 @@ run_action(:cleaning) do
   clean_gemfile
 end
 
-run_action(:add_utils) do
-  gather_gem("enumerize")
-end
-
 run_action(:asking) do
   ask :database
   ask :devise
   ask :admin
   ask :google_tag_manager
-  ask :front_end
   ask :vue_admin
   ask :mailer
   ask :background_processor
@@ -77,11 +72,12 @@ run_action(:recipe_loading) do
   create :script
   create :github
   create :cleanup
-  create :front_end
-  create :admin
-  create :vue_admin
   create :google_tag_manager
   create :mjml
+  create :bullet
+  create :front_end_vite
+  create :admin
+  create :vue_admin
 end
 
 info "Gathered enough information. Applying the template. Wait a minute."

data/lib/potassium/version.rb

@@ -1,17 +1,17 @@
 module Potassium
-  VERSION = "6.7.0"
+  VERSION = "7.0.0"
   RUBY_VERSION = "2.7.0"
-  RAILS_VERSION = "~> 6.1.4.4"
+  RAILS_VERSION = "~> 7.0.4.2"
   RUBOCOP_VERSION = "~> 1.9"
   RUBOCOP_RSPEC_VERSION = "~> 2.2"
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
   NODE_VERSION = "14"
-  TAILWINDCSS_VERSION = "^3"
-  POSTCSS_VERSION = "^8"
-  AUTOPREFIXER_VERSION = "^10"
+  TAILWINDCSS_VERSION = "^3.2.7"
+  POSTCSS_VERSION = "^8.4.21"
+  AUTOPREFIXER_VERSION = "^10.4.13"
   VUE_VERSION = "^3.2.33"
   VUE_LOADER_VERSION = "^16.8.3"
   VUE_TEST_UTILS_VERSION = "^2.0.2"
-  JEST_VERSION = "^28.0.1"
+  JEST_VERSION = "^29.0.0"
 end

data/spec/features/api_spec.rb

@@ -9,8 +9,8 @@ RSpec.describe "Api" do
 
   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'")
+    expect(gemfile_content).to include("power_api")
+    expect(gemfile_content).to include("rswag-specs")
   end
 
   it "adds the power_api brief to README file" do