potassium 6.6.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc57ea8c0f92d1ce3dd15feef9164f7bef381ce322051bd810a3303c8ca257c
-  data.tar.gz: f31b33309764331c194d97380a37ccd0afdfa50ccd38eeba7931e330262179c3
+  metadata.gz: 3d5e76dc98fd706504cc3247552cef3ca64a0bb7d849d3e5fb22aad2fee7ec9d
+  data.tar.gz: a5957889e338657dabad861765c2febd8c75c20a26eb2cec5603245feb265735
 SHA512:
-  metadata.gz: c88f8cd6cb7f6814233c608c05aabb77369ab11887a64256efbba4e813c8cf1d2ee9c4fffc3ca9c45e24618b70e8e652318969cd38f50d7741888e06bdde1333
-  data.tar.gz: 788dbd755914cae98ca2bbd6c4f3566deacdf8eccba0a0b50eaff92facbc95b31bd23ec31a9a4026e0643dfe9fa0a8a888b3c962dd3cc557c184b3d69f245a54
+  metadata.gz: 0c44956c6e4a6a85b0235f643ba73fd254a54743a2fd5ee9628849416b9718088474db66a80b4c8f1392eb370fe219ce5cee41b2d3d68baa3cbf156836f1d25b
+  data.tar.gz: b6a540e566d9ec3119e40c0d2001564c2d59a785806d6f1c2fa384fccaabf1f6bb6b2ff5dfb603c2f684cfa72c723efffcab1f8562bde7afcd82609b46b360a0

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## Unreleased
 
+## 7.0.0
+
+Features
+  - Updates to ActiveAdmin Addons 2 (beta) [#431](https://github.com/platanus/potassium/pull/431)
+  - Replaces Shakapacker with Vite [#431](https://github.com/platanus/potassium/pull/431)
+  - Update to Rails 7 [#431](https://github.com/platanus/potassium/pull/431)
+  - Install repo analyzer gem to run in CI environment
+  - Removes enumerize in favor of built-in enums [#428](https://github.com/platanus/potassium/pull/428)
+  - Add linter rule to enforce the use of named exports [#427](https://github.com/platanus/potassium/pull/427)
+  - Enable new rubocop rules [#429](https://github.com/platanus/potassium/pull/429)
+    <details>
+      <summary>See rules</summary>
+
+      - [Rails/Delegate](https://docs.rubocop.org/rubocop-rails/2.17/cops_rails.html#railsdelegate)
+      - [Rails/I18nLocaleAssignment](https://docs.rubocop.org/rubocop-rails/2.17/cops_rails.html#railsi18nlocaleassignment)
+      - [Rails/WhereEquals](https://docs.rubocop.org/rubocop-rails/2.17/cops_rails.html#railswhereequals)
+      - [Rails/WhereNot](https://docs.rubocop.org/rubocop-rails/2.17/cops_rails.html#railswherenot)
+      - [Rails/RedundantPresenceValidationOnBelongsTo](https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsredundantpresencevalidationonbelongsto)
+      - [Layout/ClassStructure](https://docs.rubocop.org/rubocop/1.24/cops_layout.html#layoutclassstructure)
+    </details>
+
+## 6.7.0
+
+Features
+  - Add type checking to reviewdog [#411](https://github.com/platanus/potassium/pull/411)
+  - Add initial api files [#412](https://github.com/platanus/potassium/pull/412)
+  - Add eslint-plugin-platanus [#415](https://github.com/platanus/potassium/pull/415)
+
+Fixes
+  - Prepend vips installation [#407](https://github.com/platanus/potassium/pull/407)
+  - Fix jest install [#408](https://github.com/platanus/potassium/pull/408)
+  - Fix circle ci config. Provide global context to test job [#409](https://github.com/platanus/potassium/pull/409)
+  - Fix admin css (arctic_skin) [#413](https://github.com/platanus/potassium/pull/413)
+  - Fix tsc check [#414](https://github.com/platanus/potassium/pull/414)
+  - Fix monkeyci commenting because of uncovered lines when tests do exist [#416](https://github.com/platanus/potassium/pull/416)
+  - Typescript fixes [#417](https://github.com/platanus/potassium/pull/417)
+
 ## 6.6.0
 Features
   - Update power api gem to use v2.0.0. Install "internal" API mode [#394](https://github.com/platanus/potassium/pull/394)

data/README.md

@@ -43,12 +43,18 @@ This will create a project with the following configuration:
   13. `draper`: `true`
   14. `schedule`: `true`
   15. `sentry`: `true`
-  16. `front_end`: `'vue'`
+  16. `front_end_vite`: `true`
   17. `google_tag_manager`: `true`
   18. `test`: `true`
   19. `spring`: `true`
 
 The remaining question will be asked as usual.
+
+### Running from Repository
+
+If you cloned this repository and are running the gem using the bin script (`potassium/bin/potassium create`), take careful note of the gem versions that are used. Sometimes the local Rails version is used instead of the one specified in the gemspec. Remove your local Gemfile.lock after pulling from the repository to help prevent these issues.
+
+
 ### Adding recipes to an existing project
 
 Use the `potassium install` command to add a recipe to a project:
@@ -82,6 +88,7 @@ Potassium Rails apps includes the following gems and technologies:
 - [Faker](https://github.com/stympy/faker) for creating development data
 - [Scout](https://github.com/scoutapp/scout_apm_ruby) for monitoring performance
 - [Mjml](https://github.com/sighmon/mjml-rails) for mails style
+- [Bullet](https://github.com/flyerhzm/bullet) to identify eager loading (N+1 queries)
 
 The following optional integrations are also added:
 

data/lib/potassium/assets/.circleci/config.yml.erb

@@ -117,11 +117,12 @@ jobs:
             bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
 
       - run:
-          name: Run RSpec system tests
-          command: |
-            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec-system.xml"
-            RSPEC_FORMAT_ARGS="--tag type:system -f progress --no-color -p 10"
-            bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+          name: Update repo analyzer gem
+          command: bundle update --conservative repo_analyzer
+
+      - run:
+          name: POST extracted data to nest
+          command: bin/rake "repo_analyzer:analyze[platanus/<%= get(:app_name) %>]"
 
       - run:
           name: Run simplecov
@@ -129,14 +130,19 @@ jobs:
           command: |
             cat coverage/coverage.txt | ./bin/reviewdog -reporter=github-pr-review -efm="%f:%l:%c: %m"
 
-      <%- if selected?(:front_end, :vue) -%>
       - run:
-          name: Run jest
+          name: Run RSpec system tests
           command: |
-            yarn run test > coverage/input_jest.txt
-            ./node_modules/.bin/format-coverage coverage/input_jest.txt coverage/output_jest.txt /home/circleci/project/app/javascript
-            cat coverage/output_jest.txt | ./bin/reviewdog -reporter=github-pr-review -efm="%f:%l:%c: %m"
-      <%- end -%>
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec-system.xml"
+            RSPEC_FORMAT_ARGS="--tag type:system -f progress --no-color -p 10"
+            bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+
+    - run:
+        name: Run vitest
+        command: |
+          yarn run test > coverage/input_vitest.txt
+          ./node_modules/.bin/format-coverage coverage/input_vitest.txt coverage/output_vitest.txt /home/circleci/project/app/frontend
+          cat coverage/output_vitest.txt | ./bin/reviewdog -reporter=github-pr-review -efm="%f:%l:%c: %m"
 
       - store_test_results:
           path: test_results
@@ -164,6 +170,18 @@ jobs:
             cat tmp/files_to_lint | grep -E '.+\.(js|jsx|vue)$' | xargs yarn run eslint \
             | ./bin/reviewdog -reporter=github-pr-review -f=eslint
 
+      - run:
+          name: Run tsc
+          shell: /bin/bash
+          command: |
+            yarn run tsc --noEmit | ./bin/reviewdog -reporter=github-pr-review -f=tsc
+
+      - run:
+          name: Run vue-tsc
+          shell: /bin/bash
+          command: |
+            yarn run vue-tsc --noEmit | ./bin/reviewdog -reporter=github-pr-review -f=tsc
+
       - run:
           name: Run stylelint
           shell: /bin/bash
@@ -174,6 +192,7 @@ jobs:
 workflows:
   test_and_lint:
     jobs:
-      - test
+      - test:
+          context: org-global
       - lint:
           context: org-global

data/lib/potassium/assets/.eslintrc.json

@@ -22,7 +22,8 @@
     "plugin:vue/vue3-recommended",
     "@vue/typescript/recommended",
     "@vue/eslint-config-typescript",
-    "plugin:tailwindcss/recommended"
+    "plugin:tailwindcss/recommended",
+    "plugin:platanus/recommended"
   ],
   "rules": {
     "accessor-pairs": 0,
@@ -208,7 +209,7 @@
       "newlines-between": "never"
     }],
     "import/newline-after-import": 2,
-    "import/prefer-default-export": 2,
+    "import/no-default-export": 2,
     "array-bracket-spacing": [2, "never"],
     "block-spacing": [2, "always"],
     "brace-style": [2, "1tbs", {
@@ -254,7 +255,7 @@
     "lines-around-comment": 0,
     "max-depth": [2, 4],
     "max-len": [2, 120, {
-      "ignorePattern": "^\\s.+class=\""
+      "ignorePattern": "^\\s.+class=|\\s.d=\""
     }],
     "max-nested-callbacks": [2, 4],
     "max-params": [1, 4],
@@ -286,7 +287,7 @@
     "no-new-object": 2,
     "no-plusplus": 0,
     "no-restricted-syntax": [2, "DebuggerStatement", "ForInStatement", "LabeledStatement", "WithStatement"],
-    "no-spaced-func": 2,
+    "no-spaced-func": 0,
     "no-ternary": 0,
     "no-trailing-spaces": 2,
     "no-underscore-dangle": [1],
@@ -345,14 +346,20 @@
     "vue/max-len": ["error", {
       "code": 120,
       "ignoreHTMLAttributeValues": true
+    }],
+    "tailwindcss/no-custom-classname": ["warn", {
+      "cssFiles": ["**/*.css", "!**/node_modules", "!**/.*", "!**/dist", "!**/build", "!**/vendor"]
     }]
   },
   "overrides": [
     {
-      "files": ["*.ts", "*.vue"],
-      "rules": {
-        "no-undef": "off"
-      }
+        "files": ["*.ts", "*.vue"],
+        "rules": {
+          "no-undef": "off",
+          "no-unused-vars": "off",
+          "no-spaced-func": "off",
+          "@typescript-eslint/no-unused-vars": "error"
+        }
     }
   ]
 }

data/lib/potassium/assets/.rubocop.yml

@@ -282,6 +282,59 @@ Style/SymbolArray:
 Layout/ExtraSpacing:
   Description: Do not use unnecessary spacing.
   Enabled: false
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    validation:
+      - validate
+      - validates
+    association:
+      - belongs_to
+      - has_one
+      - has_many
+      - has_and_belongs_to_many
+    attribute_macros:
+      - attribute
+      - attr_accessor
+      - attr_reader
+      - attr_writer
+    callbacks:
+      - before_validation
+      - after_validation
+      - before_save
+      - before_create
+      - after_create
+      - after_save
+      - after_commit
+      - after_create_commit
+    other_macros:
+      - devise
+      - acts_as_token_authenticatable
+      - accepts_nested_attributes_for
+      - humanize
+      - monetize
+    scope:
+      - scope
+      - pg_search_scope
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - public_attribute_macros
+    - association
+    - validation
+    - enum
+    - aasm
+    - scope
+    - public_delegate
+    - other_macros
+    - class_methods
+    - initializer
+    - public_methods
+    - protected_attribute_macros
+    - protected_methods
+    - private_attribute_macros
+    - private_delegate
+    - private_methods
 Naming/AccessorMethodName:
   Description: Check the naming of accessor methods for get_/set_.
   Enabled: false
@@ -498,7 +551,15 @@ Lint/StructNewOverride:
   Enabled: true
 Rails/Delegate:
   Description: Prefer delegate method for delegations.
-  Enabled: false
+  Enabled: true
+Rails/I18nLocaleAssignment:
+  Enabled: true
+Rails/WhereEquals:
+  Enabled: true
+Rails/WhereNot:
+  Enabled: true
+Rails/RedundantPresenceValidationOnBelongsTo:
+  Enabled: true
 Performance/RedundantBlockCall:
   Description: Use `yield` instead of `block.call`.
   Reference: https://github.com/JuanitoFatas/fast-ruby#proccall-vs-yield-code

data/lib/potassium/assets/README.yml

@@ -22,20 +22,14 @@ readme:
             $ heroku local
 
         [Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
-    webpack:
+    vite:
       title: "Development"
       body: |
-        For hot-reloading and fast webpacker compilation you need to run webpack's dev server along with the rails server:
+        For hot-reloading and fast compilation you need to run the vite dev server along with the rails server:
 
-            $ ./bin/webpacker-dev-server
+            $ ./bin/vite dev
 
         Running the dev server will also solve problems with the cache not refreshing between changes and provide better error messages if something fails to compile.
-
-        For even faster in-place component refreshing (with no page reloads), you can enable Hot Module Reloading in `config/webpacker.yml`
-
-            development:
-              dev_server:
-                hmr: true
     ci:
       title: "Continuous Integrations"
       body: |

data/lib/potassium/assets/app/frontend/active_admin/jquery.js

@@ -0,0 +1,2 @@
+import $ from 'jquery'
+window.jQuery = window.$ = $

data/lib/potassium/assets/app/frontend/api/__mocks__/index.mock.ts

@@ -0,0 +1,3 @@
+const api = jest.fn();
+
+export { api };

data/lib/potassium/assets/app/frontend/api/index.ts

@@ -0,0 +1,63 @@
+import axios, { type AxiosRequestTransformer, type AxiosResponseTransformer } from 'axios';
+import { convertKeys, type objectToConvert } from '../utils/case-converter';
+import { csrfToken } from '../utils/csrf-token';
+
+const api = axios.create({
+  transformRequest: [
+    (data: objectToConvert) => convertKeys(data, 'decamelize'),
+    ...(axios.defaults.transformRequest as AxiosRequestTransformer[]),
+  ],
+  transformResponse: [
+    ...(axios.defaults.transformResponse as AxiosResponseTransformer[]),
+    (data: objectToConvert) => convertKeys(data, 'camelize'),
+  ],
+  headers: {
+    'Content-Type': 'application/json',
+    'Accept': 'application/json',
+    'X-CSRF-Token': csrfToken(),
+  },
+});
+
+export { api };
+
+/*
+// Example to use the api object in the path ´app/javascript/api/users.ts´
+
+import { api } from './index';
+
+function index() {
+  const path = '/api/internal/users';
+
+  return api({
+    method: 'get',
+    url: path,
+  });
+}
+
+function create(data: Partial<User>) {
+  const path = '/api/internal/users';
+
+  return api({
+    method: 'post',
+    url: path,
+    data: {
+      user: data,
+    },
+  });
+}
+
+function update(data: Partial<User>) {
+  const path = `/api/internal/users/${data.id}`;
+
+  return api({
+    method: 'put',
+    url: path,
+    data: {
+      user: data,
+    },
+  });
+}
+
+export { index, create, update };
+
+*/

data/lib/potassium/assets/app/frontend/css/application.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

data/lib/potassium/assets/app/frontend/entrypoints/active_admin.js

@@ -0,0 +1,7 @@
+import '../active_admin/jquery'
+import 'jquery-ui'
+import 'jquery-ui/ui/widgets/mouse'
+import '@activeadmin/activeadmin'
+import "activeadmin_addons"
+import "@fortawesome/fontawesome-free/css/all.css";
+import 'arctic_admin'

data/lib/potassium/assets/app/frontend/entrypoints/active_admin.scss

@@ -0,0 +1,38 @@
+@import 'activeadmin_addons/src/stylesheets/all';
+@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%;
+}

data/lib/potassium/assets/app/frontend/entrypoints/application.js

@@ -0,0 +1,12 @@
+import { createApp } from 'vue';
+import App from '../components/app.vue';
+import '../css/application.css';
+
+document.addEventListener('DOMContentLoaded', () => {
+  const app = createApp({
+    components: { App },
+  });
+  app.mount('#vue-app');
+
+  return app;
+});

data/lib/potassium/assets/app/{javascript → frontend}/types/vue.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-default-export */
 declare module '*.vue' {
   import type { DefineComponent } from 'vue'
   const component: DefineComponent<{}, {}, any>

data/lib/potassium/assets/app/frontend/utils/case-converter.ts

@@ -0,0 +1,39 @@
+// From https://github.com/domchristie/humps/issues/51#issuecomment-425113505
+/* eslint-disable complexity */
+/* eslint-disable max-statements */
+import { camelize, decamelize } from 'humps';
+
+export type objectToConvert = File | FormData | Blob | Record<string, unknown> | Array<objectToConvert>;
+
+function convertKeys(
+  object: objectToConvert,
+  conversion: 'camelize' | 'decamelize',
+): objectToConvert {
+  const converter = {
+    camelize,
+    decamelize,
+  };
+  if (object && !(object instanceof File) && !(object instanceof Blob)) {
+    if (object instanceof Array) {
+      return object.map((item: objectToConvert) => convertKeys(item, conversion));
+    }
+    if (object instanceof FormData) {
+      const formData = new FormData();
+      for (const [key, value] of object.entries()) {
+        formData.append(converter[conversion](key), value);
+      }
+
+      return formData;
+    }
+    if (typeof object === 'object') {
+      return Object.keys(object).reduce((acc, next) => ({
+        ...acc,
+        [converter[conversion](next)]: convertKeys(object[next] as objectToConvert, conversion),
+      }), {});
+    }
+  }
+
+  return object;
+}
+
+export { convertKeys };

data/lib/potassium/assets/app/frontend/utils/csrf-token.ts

@@ -0,0 +1,9 @@
+// From: https://github.com/rails/rails/blob/main/actionview/app/javascript/rails-ujs/utils/csrf.js
+function csrfToken() {
+  const meta = document.querySelector('meta[name=csrf-token]');
+  const token = meta && meta.getAttribute('content');
+
+  return token ?? false;
+}
+
+export { csrfToken };

data/lib/potassium/assets/bin/setup.erb

@@ -11,7 +11,7 @@ gem install bundler --conservative
 bundle check || bundle install
 
 # Install javascript dependencies
-bin/yarn install
+yarn install
 
 # Set up required services
 docker-compose up -d

data/lib/potassium/assets/bin/update.erb

@@ -18,7 +18,7 @@ chdir APP_ROOT do
   system! 'gem install bundler --conservative'
 
   puts '== Installing YARN stuff =='
-  system! 'bin/yarn install'
+  system! 'yarn install'
 
   system('bundle check') || system!('bundle install')
   puts "\n== Updating database =="

data/lib/potassium/assets/config/sentry.rb.erb

@@ -1,15 +1,7 @@
 if Rails.env.production?
-  Raven.configure do |config|
-    config.sanitize_fields = Rails.application.config.filter_parameters.map(&:to_s)
+  Sentry.init do |config|
     <% if get(:heroku) %>
-    config.current_environment = Heroku.stage
+      config.environment = Heroku.stage
     <% end %>
   end
-
-  # In case you want to group the events with different ids in the
-  module RackTimeoutExtensions
-    def raven_context
-      { fingerprint: ["{{ default }}", env["REQUEST_PATH"].gsub(/\d/, '')] }
-    end
-  end
 end

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/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(
@@ -50,7 +51,14 @@ SimpleCov.start 'rails' do
   add_filter 'lib/vue_component.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,8 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.node.json",
+  "include": ["vite.config.*", "vitest.config.*", "cypress.config.*", "playwright.config.*"],
+  "compilerOptions": {
+    "composite": true,
+    "types": ["node"]
+  }
+}