potassium 6.7.0 → 7.1.0

data/lib/potassium/recipes/front_end_vite.rb

@@ -0,0 +1,155 @@
+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
+  JSDOM_VERSION = Potassium::JSDOM_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: [
+      "@tsconfig/node14",
+      "@vitejs/plugin-vue",
+      "@vue/tsconfig",
+      "vue-tsc"
+    ],
+    vitest_dev: [
+      "vitest",
+      "@vue/test-utils@#{VUE_TEST_UTILS_VERSION}",
+      "jsdom@#{JSDOM_VERSION}"
+    ],
+    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/mailer.rb

@@ -74,7 +74,7 @@ class Recipes::Mailer < Rails::AppBuilder
     RUBY
     application asset_host_prod, env: "production"
     mailer_config = <<~RUBY
-      require Rails.root.join("config", "mailer")
+      require Rails.root.join("config/mailer")
     RUBY
 
     prepend_file "config/environments/production.rb", mailer_config

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/rails.rb

@@ -1,6 +1,8 @@
 class Recipes::Rails < Rails::AppBuilder
   def create
     gather_gem("bootsnap", require: false)
+    gather_gem("sassc", github: "sass/sassc-ruby", ref: 'refs/pull/233/head')
+    gather_gem("sassc-embedded")
     environment 'config.force_ssl = true', env: 'production'
     disable_automatic_nonce_generation
   end

data/lib/potassium/recipes/redis.rb

@@ -0,0 +1,57 @@
+class Recipes::Redis < Rails::AppBuilder
+  def create
+    add_redis
+    add_docker_compose_redis_config
+    set_redis_dot_env
+    add_session_store_config
+  end
+
+  def install
+    create
+  end
+
+  def installed?
+    gem_exists?(/redis-actionpack/)
+  end
+
+  def add_redis
+    run_action(:install_redis) do
+      gather_gem("redis-actionpack")
+      copy_file("../assets/redis.yml", "config/redis.yml", force: true)
+    end
+  end
+
+  private
+
+  def add_docker_compose_redis_config
+    compose = DockerHelpers.new('docker-compose.yml')
+
+    service_definition =
+      <<~YAML
+        image: redis:6.2.12
+        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=COMMAND_EXPAND(make services-port SERVICE=redis PORT=6379)
+        REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1
+      TEXT
+    )
+  end
+
+  def add_session_store_config
+    copy_file("../assets/config/initializers/session_store.rb",
+              "config/initializers/session_store.rb", force: true)
+  end
+end

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
+        "@typescript-eslint/eslint-plugin @typescript-eslint/parser "\
+        "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,8 +135,18 @@ class Recipes::VueAdmin < Rails::AppBuilder
               }));
             },
           });
-          app.component('AdminComponent', AdminComponent);
-          app.mount('#wrapper');
+          app.component('admin_component', AdminComponent);
+
+          // Avoid using '#wrapper' as the mount point, as that includes the entire admin page,
+          // which could be used for Client-Side Template Injection (CSTI) attacks. Limit the
+          // mount point to specific areas where you need Vue components.
+
+          // DO NOT mount Vue in elements that contain user input rendered by
+          // ActiveAdmin.
+          // By default ActiveAdmin doesn't escape {{ }} in user input, so it's
+          // possible to inject arbitrary JavaScript code into the page.
+
+          // app.mount('#wrapper');
         }
 
         return null;

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

@@ -4,24 +4,15 @@ set :titleized_app_name, get(:app_name).titleize
 set :underscorized_app_name, get(:app_name).underscore
 set :dasherized_app_name, get(:app_name).dasherize
 
-run_action(:after_create_rails) do
-  rubocop_revision
-end
-
 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
@@ -41,7 +32,6 @@ run_action(:recipe_loading) do
   create :spring
   create :readme
   create :heroku
-  create :ci
   create :style
   create :puma
   create :env
@@ -55,6 +45,7 @@ run_action(:recipe_loading) do
   create :yarn
   create :editorconfig
   create :mailer
+  create :redis
   create :background_processor
   create :schedule
   create :i18n
@@ -76,12 +67,15 @@ run_action(:recipe_loading) do
   create :tzinfo
   create :script
   create :github
+  create :ci
   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
+  create :environment_variables
 end
 
 info "Gathered enough information. Applying the template. Wait a minute."
@@ -95,3 +89,7 @@ run_action(:database_creation) do
   run "bundle exec rails db:create db:migrate"
   run "RACK_ENV=test bundle exec rails db:create db:migrate"
 end
+
+run_action(:rubocop_revision) do
+  run_rubocop
+end

data/lib/potassium/version.rb

@@ -1,17 +1,18 @@
 module Potassium
-  VERSION = "6.7.0"
+  VERSION = "7.1.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"
+  NODE_VERSION = "20"
+  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"
+  JSDOM_VERSION = "^21.1.2"
 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

data/spec/features/background_processor_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe "BackgroundProcessor" do
 
     it "adds sidekiq gem to Gemfile" do
       gemfile_content = IO.read("#{project_path}/Gemfile")
-      expect(gemfile_content).to include("gem 'sidekiq'")
+      expect(gemfile_content).to include("sidekiq")
     end
 
     it "adds queue_adapter to application.rb" do
@@ -43,7 +43,7 @@ RSpec.describe "BackgroundProcessor" 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_PORT=COMMAND_EXPAND(make services-port SERVICE=redis PORT=6379)')
       expect(content).to include('REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}/1')
     end
 

data/spec/features/bullet_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe "Bullet" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project
+  end
+
+  context "with all the bullet config" do
+    let(:dev_config) { IO.read("#{project_path}/config/environments/development.rb") }
+
+    it { expect(dev_config).to include("config.after_initialize do") }
+    it { expect(dev_config).to include("Bullet.enable = true") }
+    it { expect(dev_config).to include("Bullet.alert = true") }
+    it { expect(dev_config).to include("Bullet.bullet_logger = true") }
+    it { expect(dev_config).to include("Bullet.console = true") }
+    it { expect(dev_config).to include("Bullet.rails_logger = true") }
+    it { expect(dev_config).to include("Bullet.add_footer = true") }
+  end
+
+  context "with bullet application job config" do
+    let(:application_job) { IO.read("#{project_path}/app/jobs/application_job.rb") }
+
+    it 'adds bullet configuration to application_job.rb' do
+      expect(application_job).to include("  include Bullet::ActiveJob if Rails.env.development?\n")
+    end
+  end
+end

data/spec/features/ci_spec.rb

@@ -2,16 +2,29 @@ require "spec_helper"
 require "rubocop"
 
 RSpec.describe 'CI' do
+  let(:ci_config) do
+    yml_path = "#{project_path}/.circleci/config.yml"
+    IO.read(yml_path)
+  end
+
   before(:all) do
     drop_dummy_database
     remove_project_directory
     create_dummy_project
   end
 
+  it "adds brakeman to Gemfile" do
+    content = IO.read("#{project_path}/Gemfile")
+    expect(content).to include("brakeman")
+  end
+
   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('cimg/ruby', 'cache', 'rspec', 'reviewdog')
+    expect(ci_config).to include('cimg/ruby', 'cache', 'rspec', 'reviewdog', 'brakeman')
+  end
+
+  it "uses dasherized app name for repo analyzer" do
+    expect(ci_config).to include(
+      "repo_analyzer:analyze[platanus/#{PotassiumTestHelpers::APP_NAME.dasherize}]"
+    )
   end
 end

data/spec/features/coverage_spec.rb

@@ -9,9 +9,9 @@ RSpec.describe "Coverage" do
 
   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'")
+    expect(content).to include("simplecov")
+    expect(content).to include("simplecov_linter_formatter")
+    expect(content).to include("simplecov_text_formatter")
   end
 
   it "requires simplecov config file before rails" do
@@ -26,18 +26,15 @@ RSpec.describe "Coverage" do
 
   context "with vue" do
     let(:node_modules_file) { IO.read("#{project_path}/package.json") }
+    let(:vite_config) { IO.read("#{project_path}/vite.config.ts") }
 
     before(:all) do
       remove_project_directory
-      create_dummy_project("front_end" => "vue")
+      create_dummy_project("front_end_vite" => true)
     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')
+    it "adds vitest coverage configuration" do
+      expect(vite_config).to include("provider: 'c8',")
     end
   end
 end

data/spec/features/database_container_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe "DatabaseContainer" do
         db_port = compose_content[:services][service_name][:ports].first
 
         expect(env_file)
-          .to include("DB_PORT=$(make services-port SERVICE=#{service_name} PORT=#{db_port})")
+          .to include("DB_PORT=COMMAND_EXPAND(make services-port SERVICE=#{service_name} PORT=#{db_port})")
         expect(env_file).to include("DB_HOST=127.0.0.1")
         expect(File.exist?("#{project_path}/Makefile")).to be true
         expect(setup_file).to include("docker-compose up -d")

data/spec/features/database_spec.rb

@@ -9,6 +9,6 @@ RSpec.describe "Database" do
 
   it "adds the Strong Migrations gem to Gemfile" do
     gemfile_content = IO.read("#{project_path}/Gemfile")
-    expect(gemfile_content).to include("gem 'strong_migrations'")
+    expect(gemfile_content).to include("strong_migrations")
   end
 end

data/spec/features/draper_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe "Draper" do
 
   it "adds the Draper gem to Gemfile" do
     gemfile_content = IO.read("#{project_path}/Gemfile")
-    expect(gemfile_content).to include("gem 'draper'")
+    expect(gemfile_content).to include("draper")
   end
 
   it "adds the Draper brief to README file" do