potassium 6.6.0 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc57ea8c0f92d1ce3dd15feef9164f7bef381ce322051bd810a3303c8ca257c
-  data.tar.gz: f31b33309764331c194d97380a37ccd0afdfa50ccd38eeba7931e330262179c3
+  metadata.gz: 81ec8c6408ed21f78421ecb48565bcd42e6478fc0a08a7ca0881035eb8d0c444
+  data.tar.gz: 0b925fa5a1344c3f284d91f8fdb092d984d47f8434b4beed51678e4a909e2ada
 SHA512:
-  metadata.gz: c88f8cd6cb7f6814233c608c05aabb77369ab11887a64256efbba4e813c8cf1d2ee9c4fffc3ca9c45e24618b70e8e652318969cd38f50d7741888e06bdde1333
-  data.tar.gz: 788dbd755914cae98ca2bbd6c4f3566deacdf8eccba0a0b50eaff92facbc95b31bd23ec31a9a4026e0643dfe9fa0a8a888b3c962dd3cc557c184b3d69f245a54
+  metadata.gz: 8a07cf43e021c0350e84eb0213f5ac513fa2446c16cfd492a0b7947acdd45776b817004d5f4cf42962947137dc988ccaa1e61020f23b89a63040b85d04e61a2e
+  data.tar.gz: af4598c990bede9a8be8cbf47dd324f9f13b584b5b0982ab277806f71318b4d97da289e9cad725d45398e66cc7454578bd89fc086b550ebc586286d46d217f98

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 
-## Unreleased
+## 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

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

@@ -116,6 +116,12 @@ jobs:
             RSPEC_FORMAT_ARGS="-f progress --no-color -p 10"
             bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
 
+      - run:
+          name: Run simplecov
+          shell: /bin/bash
+          command: |
+            cat coverage/coverage.txt | ./bin/reviewdog -reporter=github-pr-review -efm="%f:%l:%c: %m"
+
       - run:
           name: Run RSpec system tests
           command: |
@@ -123,12 +129,6 @@ jobs:
             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 simplecov
-          shell: /bin/bash
-          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
@@ -164,6 +164,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 +186,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,

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

@@ -0,0 +1,55 @@
+import axios, { type AxiosRequestTransformer, type AxiosResponseTransformer } from 'axios';
+import convertKeys from '../utils/case-converter';
+
+const api = axios.create({
+  transformRequest: [
+    (data: any) => convertKeys(data, 'decamelize'),
+    ...(axios.defaults.transformRequest as AxiosRequestTransformer[]),
+  ],
+  transformResponse: [
+    ...(axios.defaults.transformResponse as AxiosResponseTransformer[]),
+    (data: any) => convertKeys(data, 'camelize'),
+  ],
+});
+
+export default api;
+
+/*
+// Example to use the api object in the path ´app/javascript/api/users.ts´
+
+import api from './index';
+
+export default {
+  index() {
+    const path = '/api/internal/users';
+
+    return api({
+      method: 'get',
+      url: path,
+    });
+  },
+  create(data: Partial<User>) {
+    const path = '/api/internal/users';
+
+    return api({
+      method: 'post',
+      url: path,
+      data: {
+        user: data,
+      },
+    });
+  },
+  update(data: Partial<User>) {
+    const path = `/api/internal/users/${data.id}`;
+
+    return api({
+      method: 'put',
+      url: path,
+      data: {
+        user: data,
+      },
+    });
+  },
+};
+
+*/

data/lib/potassium/assets/app/javascript/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';
+
+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 default convertKeys;

data/lib/potassium/assets/tsconfig.json

@@ -26,6 +26,7 @@
     "app/javascript/**/*.vue"
   ],
   "exclude": [
-    "node_modules"
+    "node_modules",
+    "**/*.spec.ts"
   ]
 }

data/lib/potassium/recipes/admin.rb

@@ -66,7 +66,45 @@ class Recipes::Admin < Rails::AppBuilder
         aa_style,
         "@import \"~@activeadmin/activeadmin/src/scss/mixins\";\n" +
         "@import \"~@activeadmin/activeadmin/src/scss/base\";",
-        "@import '~arctic_admin/src/scss/main'; \n"
+        <<~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"

data/lib/potassium/recipes/file_storage.rb

@@ -86,7 +86,7 @@ class Recipes::FileStorage < Rails::AppBuilder
   end
 
   def add_image_handling_heroku_setup
-    append_to_file(
+    prepend_file(
       '.buildpacks',
       <<~HERE
         https://github.com/heroku/heroku-buildpack-apt

data/lib/potassium/recipes/front_end.rb

@@ -5,7 +5,7 @@ class Recipes::FrontEnd < Rails::AppBuilder
   POSTCSS_VERSION = Potassium::POSTCSS_VERSION
   TAILWINDCSS_VERSION = Potassium::TAILWINDCSS_VERSION
   AUTOPREFIXER_VERSION = Potassium::AUTOPREFIXER_VERSION
-  VUE_JEST_VERSION = Potassium::VUE_JEST_VERSION
+  JEST_VERSION = Potassium::JEST_VERSION
 
   def ask
     frameworks = {
@@ -35,6 +35,7 @@ class Recipes::FrontEnd < Rails::AppBuilder
       recipe.setup_vue if value == :vue
       recipe.add_responsive_meta_tag
       recipe.setup_tailwind
+      recipe.setup_api_client
       add_readme_header :webpack
     end
   end
@@ -107,8 +108,10 @@ class Recipes::FrontEnd < Rails::AppBuilder
   end
 
   def setup_jest
-    run "bin/yarn add jest @vue/vue3-jest@#{VUE_JEST_VERSION} babel-jest "\
-    "@vue/test-utils@#{VUE_TEST_UTILS_VERSION} ts-jest"
+    run "bin/yarn add jest@#{JEST_VERSION} @vue/vue3-jest@#{JEST_VERSION} "\
+    "babel-jest@#{JEST_VERSION} @vue/test-utils@#{VUE_TEST_UTILS_VERSION} ts-jest@#{JEST_VERSION} "\
+    "jest-environment-jsdom@#{JEST_VERSION} --dev"
+    run "bin/yarn add @types/jest@#{JEST_VERSION}"
     json_file = File.read(Pathname.new("package.json"))
     js_package = JSON.parse(json_file)
     js_package = js_package.merge(jest_config)
@@ -121,7 +124,8 @@ class Recipes::FrontEnd < Rails::AppBuilder
 
   def setup_vue
     run "bin/yarn add vue@#{VUE_VERSION} vue-loader@#{VUE_LOADER_VERSION} "\
-        "babel-preset-typescript-vue3"
+        "babel-preset-typescript-vue3 @types/humps"
+    run "bin/yarn add vue-tsc --dev"
     gsub_file(
       'config/webpack/webpack.config.js',
       ' merge(typescriptConfig, cssConfig, jQueryConfig, webpackConfig);',
@@ -136,6 +140,13 @@ class Recipes::FrontEnd < Rails::AppBuilder
     end
   end
 
+  def setup_api_client
+    run "bin/yarn add axios humps"
+    copy_file '../assets/app/javascript/api/index.ts', 'app/javascript/api/index.ts'
+    copy_file '../assets/app/javascript/utils/case-converter.ts',
+              'app/javascript/utils/case-converter.ts'
+  end
+
   private
 
   def frameworks(framework)
@@ -239,6 +250,9 @@ class Recipes::FrontEnd < Rails::AppBuilder
         "moduleNameMapper": {
           "^@/(.*)$": "app/javascript/$1"
         },
+        "testEnvironmentOptions": {
+          "customExportConditions": ["node", "node-addons"]
+        },
         "moduleFileExtensions": [
           "js",
           "ts",

data/lib/potassium/recipes/style.rb

@@ -22,7 +22,8 @@ class Recipes::Style < Rails::AppBuilder
 
     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"
+        "@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

data/lib/potassium/version.rb

@@ -1,5 +1,5 @@
 module Potassium
-  VERSION = "6.6.0"
+  VERSION = "6.7.0"
   RUBY_VERSION = "2.7.0"
   RAILS_VERSION = "~> 6.1.4.4"
   RUBOCOP_VERSION = "~> 1.9"
@@ -10,8 +10,8 @@ module Potassium
   TAILWINDCSS_VERSION = "^3"
   POSTCSS_VERSION = "^8"
   AUTOPREFIXER_VERSION = "^10"
-  VUE_VERSION = "^3"
-  VUE_LOADER_VERSION = "^16"
-  VUE_TEST_UTILS_VERSION = "^2.0.0-rc.18"
-  VUE_JEST_VERSION = "^27.0.0-alpha.1"
+  VUE_VERSION = "^3.2.33"
+  VUE_LOADER_VERSION = "^16.8.3"
+  VUE_TEST_UTILS_VERSION = "^2.0.2"
+  JEST_VERSION = "^28.0.1"
 end

data/spec/features/front_end_spec.rb

@@ -67,5 +67,10 @@ RSpec.describe "Front end" do
     it 'includes correct version of vue-loader in package' do
       expect(node_modules_file).to include("\"vue-loader\": \"#{Potassium::VUE_LOADER_VERSION}\"")
     end
+
+    it 'includes correct packages for basic api client' do
+      expect(node_modules_file).to include("\"axios\"")
+      expect(node_modules_file).to include("\"humps\"")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potassium
 version: !ruby/object:Gem::Version
-  version: 6.6.0
+  version: 6.7.0
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -281,9 +281,11 @@ files:
 - lib/potassium/assets/active_admin/policies/comment_policy.rb
 - lib/potassium/assets/active_admin/policies/default_policy.rb
 - lib/potassium/assets/active_admin/policies/page_policy.rb
+- lib/potassium/assets/app/javascript/api/index.ts
 - lib/potassium/assets/app/javascript/components/app.spec.ts
 - lib/potassium/assets/app/javascript/components/app.vue
 - lib/potassium/assets/app/javascript/types/vue.d.ts
+- lib/potassium/assets/app/javascript/utils/case-converter.ts
 - lib/potassium/assets/app/jobs/shrine_promote_job.rb
 - lib/potassium/assets/app/mailers/application_mailer.rb
 - lib/potassium/assets/app/mailers/example_mailer.rb