potassium 5.2.3 → 6.0.0

data/lib/potassium/assets/.stylelintrc.json

@@ -0,0 +1,46 @@
+{
+  "rules": {
+    "declaration-bang-space-before": "always",
+    "declaration-bang-space-after": "never",
+    "declaration-property-value-blacklist": {
+      "/^border/": ["none"]
+    },
+    "color-named": "never",
+    "declaration-block-no-duplicate-properties": true,
+    "rule-empty-line-before": ["always-multi-line", {
+      "except": ["after-single-line-comment", "first-nested"]
+    }],
+    "block-no-empty": true,
+    "no-missing-end-of-source-newline": true,
+    "color-hex-length": "short",
+    "color-hex-case": "lower",
+    "color-no-invalid-hex": true,
+    "selector-max-id": 0,
+    "declaration-no-important": true,
+    "indentation": 2,
+    "number-leading-zero": "never",
+    "no-duplicate-selectors": true,
+    "max-nesting-depth": 3,
+    "selector-pseudo-element-colon-notation": "double",
+    "selector-no-qualifying-type": true,
+    "shorthand-property-no-redundant-values": true,
+    "declaration-block-semicolon-newline-after": "always-multi-line",
+    "selector-list-comma-newline-after": "always",
+    "function-comma-space-after": "always-single-line",
+    "declaration-colon-space-after": "always",
+    "declaration-colon-space-before": "never",
+    "block-opening-brace-space-before": "always",
+    "function-parentheses-space-inside": "never",
+    "string-quotes": "single",
+    "declaration-block-trailing-semicolon": "always",
+    "no-eol-whitespace": true,
+    "number-no-trailing-zeros": true,
+    "function-url-quotes": "always",
+    "property-no-vendor-prefix": true,
+    "selector-no-vendor-prefix": true,
+    "media-feature-name-no-vendor-prefix": true,
+    "at-rule-no-vendor-prefix": true,
+    "value-no-vendor-prefix": true,
+    "length-zero-no-unit": true
+  }
+}

data/lib/potassium/assets/Dockerfile.ci

@@ -1,4 +1,4 @@
-FROM platanus/ruby:2.5
+FROM platanus/ruby:2.7
 
 RUN mkdir /app
 WORKDIR /app

data/lib/potassium/assets/Makefile.erb

@@ -1,7 +1,4 @@
-PROJECT ?= <%= get(:underscorized_app_name) %>
-DOCKER_COMPOSE_FILE ?= docker-compose.yml
-
-DOCKER_COMPOSE_ARGS ?= -p $(PROJECT) -f $(DOCKER_COMPOSE_FILE)
+PROJECT ?= <%= get(:dasherized_app_name) %>
 
 SHELL := /bin/bash
 
@@ -11,39 +8,16 @@ BOLD ?= $(shell tput bold)
 NORMAL ?= $(shell tput sgr0)
 
 help:
-	@echo Install dependencies:
-	@echo "  ${BOLD}make setup${NORMAL}"
-	@echo ""
-	@echo Runing the services like mysql:
-	@echo "  ${BOLD}make services-up${NORMAL}"
+	@echo "Generate a backup in the environment (staging|production) database:"
+	@echo "  ${BOLD}make backup-<environment>${NORMAL}"
 	@echo ""
-	@echo "Reset the environment (rm mysql db):"
-	@echo "  ${BOLD}make services-down${NORMAL}"
+	@echo "Copy latest database backup from the environment (staging|production) to local database:"
+	@echo "  ${BOLD}make restore-from-<environment>${NORMAL}"
 	@echo ""
 
-setup:
-	bin/setup
-
-services: services-up
-
-services-ps:
-	docker-compose $(DOCKER_COMPOSE_ARGS) ps
-
-services-up:
-	docker-compose $(DOCKER_COMPOSE_ARGS) up -d
-
-services-stop:
-	docker-compose $(DOCKER_COMPOSE_ARGS) stop
-
-services-down:
-	docker-compose $(DOCKER_COMPOSE_ARGS) down --volumes
-
-services-logs:
-	docker-compose $(DOCKER_COMPOSE_ARGS) logs -f
-
 services-port:
 	@set -o pipefail; \
-	docker-compose $(DOCKER_COMPOSE_ARGS) port ${SERVICE} ${PORT} 2> /dev/null | cut -d':' -f2 || echo ${PORT}
+	docker-compose port ${SERVICE} ${PORT} 2> /dev/null | cut -d':' -f2 || echo ${PORT}
 
 backup-staging: ROLE=staging
 backup-production: ROLE=production

data/lib/potassium/assets/README.yml

@@ -22,6 +22,20 @@ readme:
             $ heroku local
 
         [Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
+    webpack:
+      title: "Development"
+      body: |
+        For hot-reloading and fast webpacker compilation you need to run webpack's dev server along with the rails server:
+
+            $ ./bin/webpack-dev-server
+
+        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: |
@@ -61,10 +75,17 @@ readme:
     style_guide:
       title: "Style Guides"
       body: |
-        The style guides are enforced through a self hosted version of [Hound CI](http://monkeyci.platan.us). The style configuration can also be used locally
-        in development runing `rubocop` or just using the rubocop integration for your text editor of choice.
+        Style guides are enforced through a CircleCI [job](.circleci/config.yml) with [reviewdog](https://github.com/reviewdog/reviewdog) as a reporter, using per-project dependencies and style configurations.
+        Please note that this reviewdog implementation requires a GitHub user token to comment on pull requests. A token can be generated [here](https://github.com/settings/tokens), and it should have at least the `repo` option checked.
+        The included `config.yml` assumes your CircleCI organization has a context named `org-global` with the required token under the environment variable `REVIEWDOG_GITHUB_API_TOKEN`.
+
+        The project comes bundled with configuration files available in this repository.
+
+        Linting dependencies like `rubocop` or `rubocop-rspec` must be locked in your `Gemfile`. Similarly, packages like `eslint` or `eslint-plugin-vue` must be locked in your `package.json`.
+
+        You can add or modify rules by editing the [`.rubocop.yml`](.rubocop.yml), [`.eslintrc.json`](.eslintrc.json) or [`.stylelintrc.json`](.stylelintrc.json) files.
 
-        You can add custom rules to this project just adding them to the `.ruby-style.yml` file.
+        You can (and should) use linter integrations for your text editor of choice, using the project's configuration.
     mailing:
       title: "Sending Emails"
       body: |
@@ -82,12 +103,12 @@ readme:
         devise:
           title: "Authentication"
           body: "We are using the great [Devise](https://github.com/plataformatec/devise) library by [PlataformaTec](http://plataformatec.com.br/)"
-        paperclip:
-          title: "Uploads"
-          body: "For managing uploads, this project uses [Paperclip](https://github.com/thoughtbot/paperclip), a gem made by the awesome [Thoughbot](https://thoughtbot.com/) team."
         active_storage:
-          title: "Active Storage"
+          title: "File Storage"
           body: "For managing uploads, this project uses [Active Storage](https://github.com/rails/rails/tree/master/activestorage)."
+        shrine:
+          title: "File Storage"
+          body: "For managing uploads, this project uses [Shrine](https://github.com/shrinerb/shrine)."
         pundit:
           title: "Authorization"
           body: "For defining which parts of the system each user has access to, we have chosen to include the [Pundit](https://github.com/elabs/pundit) gem, by [Elabs](http://elabs.se/)."
@@ -109,6 +130,29 @@ readme:
         power_types:
           title: "Rails pattern enforcing types"
           body: "This projects uses [Power-Types](https://github.com/platanus/power-types) to generate Services, Commands, Utils and Values."
+        active_admin:
+          title: "Administration"
+          body: |
+            This project uses [Active Admin](https://github.com/activeadmin/activeadmin) which is a Ruby on Rails framework for creating elegant backends for website administration.
+            <% if get(:vue_admin) %>
+            This project supports Vue inside ActiveAdmin
+            - The main package is located in `app/javascript/packs/admin_application.js`, here you will declare the components you want to include in your ActiveAdmin views as you would in a normal Vue App.
+            - Additionally, to be able to use Vue components as [Arbre](https://github.com/activeadmin/arbre) Nodes the component names are also declared in `config/initializers/active_admin.rb`
+            - The generator includes an example component called `admin_component`, you can use this component inside any ActiveAdmin view by just writing `admin_component` as you would with any `html` tag.
+              - For example:
+                ```
+                admin_component(class:"myCustomClass",id:"myCustomId") do
+                  admin_component(id:"otherCustomId")
+                end
+                ```
+              - (Keep in mind that the example works with ruby blocks because `AdminComponent` has a `<slot>` tag defined, therefore children can be added to the component)
+            - The integration supports passing props to the components and converts them to their corresponing javascript objects.
+              - For example, the following works
+              ```
+              admin_component(testList:[1,2,3,4],testObject:{"name":"Vue component"})
+              ```
+              - You can also use **any** vue bindings such as `v-for` , `:key` etc.
+            <% end %>
     seeds:
       title: "Seeds"
       body: |

data/lib/potassium/assets/active_admin/admin-component.vue

@@ -0,0 +1,35 @@
+<template>
+  <div>
+    I am a Vue Component {{ test }} {{ message }}
+    <slot />
+  </div>
+</template>
+
+<script>
+export default {
+  props: {
+    test: {
+      type: String,
+      default: '',
+    },
+    testNumber: {
+      type: Number,
+      default: 0,
+    },
+    testObject: {
+      type: Object,
+      default: null,
+    },
+    testList: {
+      type: Array,
+      default: null,
+    },
+  },
+
+  data() {
+    return {
+      message: 'Hello World',
+    };
+  },
+};
+</script>

data/lib/potassium/assets/active_admin/admin_application.js

@@ -0,0 +1,14 @@
+import Vue from 'vue/dist/vue.esm';
+import AdminComponent from '../components/admin-component';
+
+Vue.component('admin_component', AdminComponent);
+
+document.addEventListener('DOMContentLoaded', () => {
+  if (document.getElementById('wrapper') !== null) {
+    return new Vue({
+      el: '#wrapper',
+    });
+  }
+
+  return null;
+});

data/lib/potassium/assets/active_admin/init_activeadmin_vue.rb

@@ -0,0 +1,10 @@
+module AdminPageLayoutOverride
+  def build_page(*args)
+    within head do
+      text_node(javascript_packs_with_chunks_tag('admin_application'))
+    end
+    super
+  end
+end
+
+ActiveAdmin::Views::Pages::Base.send :prepend, AdminPageLayoutOverride

data/lib/potassium/assets/api/base_controller.rb

@@ -1,7 +1,5 @@
 class Api::V1::BaseController < ApplicationController
-  if Rails.env.production?
-    include ApiErrorConcern
-  end
+  include ApiErrorConcern
 
   self.responder = ApiResponder
 

data/lib/potassium/assets/app/javascript/app.spec.js

@@ -0,0 +1,14 @@
+import { shallowMount } from '@vue/test-utils';
+import App from 'app';
+
+describe('App', () => {
+  test('is a Vue instance', () => {
+    const wrapper = shallowMount(App);
+    expect(wrapper.isVueInstance()).toBeTruthy();
+  });
+
+  it('displays message on load', () => {
+    const wrapper = shallowMount(App);
+    expect(wrapper.find('p').text()).toEqual('Hello Vue!');
+  });
+});

data/lib/potassium/assets/app/uploaders/base_uploader.rb

@@ -0,0 +1,13 @@
+class BaseUploader < Shrine
+  plugin :validation_helpers
+
+  Attacher.validate do
+    validate_mime_type allowed_types
+  end
+
+  private
+
+  def allowed_types
+    raise NotImplementedError
+  end
+end

data/lib/potassium/assets/app/uploaders/image_uploader.rb

@@ -0,0 +1,5 @@
+class ImageUploader < BaseUploader
+  def allowed_types
+    @allowed_types ||= %w[image/jpeg image/jpg image/png image/svg+xml image/gif].freeze
+  end
+end

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

@@ -44,6 +44,12 @@ dependencies(){
   docker-compose $DOCKER_COMPOSE_ARGS run --rm test bundle install
 }
 
+<% if selected?(:front_end, :vue) %>
+yarn_dependencies(){
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test yarn install
+}
+<% end %>
+
 assets() {
   docker-compose $DOCKER_COMPOSE_ARGS run --rm test /bin/bash -c "bin/setup && bundle exec rake assets:precompile"
 }
@@ -62,6 +68,12 @@ tests(){
   docker-compose $DOCKER_COMPOSE_ARGS run --rm test bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
 }
 
+<% if selected?(:front_end, :vue) %>
+js_tests(){
+  docker-compose $DOCKER_COMPOSE_ARGS run --rm test yarn run test
+}
+<% end %>
+
 # Run the complete ci build
 no_ci(){
   build
@@ -80,7 +92,7 @@ case "$1" in
     wait_services
     ;;
   "deps"|"dependencies")
-    dependencies
+    dependencies <% if selected?(:front_end, :vue) %>&& yarn_dependencies<% end %>
     ;;
   "assets")
     assets
@@ -88,6 +100,11 @@ case "$1" in
   "db"|"database")
     database
     ;;
+<% if selected?(:front_end, :vue) %>
+  "js_tests")
+    js_tests
+    ;;
+<% end %>
   "specs"|"tests")
     tests
     ;;

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

@@ -14,7 +14,7 @@ bundle check || bundle install
 bin/yarn install
 
 # Set up required services
-make services-up
+docker-compose up -d
 
 # Set up database
 bin/rails db:setup

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

@@ -1,6 +1,6 @@
 development: &default
   adapter: mysql2
-  database: <%= get(:underscorized_app_name) %>_development
+  database: <%= get(:dasherized_app_name) %>_development
   encoding: utf8
   host: <%%= ENV["DB_HOST"] || "127.0.0.1" %>
   port: <%%= ENV["DB_PORT"] || 3306 %>
@@ -12,7 +12,7 @@ development: &default
 
 test:
   <<: *default
-  database: <%= get(:underscorized_app_name) %>_test
+  database: <%= get(:dasherized_app_name) %>_test
 
 production: &deploy
   encoding: utf8

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

@@ -1,6 +1,6 @@
 development: &default
   adapter: postgresql
-  database: <%= get(:underscorized_app_name) %>_development
+  database: <%= get(:dasherized_app_name) %>_development
   encoding: utf8
   host: <%%= ENV["DB_HOST"] || "127.0.0.1" %>
   port: <%%= ENV["DB_PORT"] || 5432 %>
@@ -12,7 +12,7 @@ development: &default
 
 test:
   <<: *default
-  database: <%= get(:underscorized_app_name) %>_test
+  database: <%= get(:dasherized_app_name) %>_test
 
 production: &deploy
   encoding: utf8

data/lib/potassium/assets/config/shrine.rb

@@ -0,0 +1,33 @@
+require 'shrine'
+
+if Rails.env.development?
+  require 'shrine/storage/file_system'
+
+  Shrine.storages = {
+    cache: Shrine::Storage::FileSystem.new('public', prefix: 'uploads/cache'),
+    store: Shrine::Storage::FileSystem.new('public', prefix: 'uploads')
+  }
+elsif Rails.env.production?
+  require 'shrine/storage/s3'
+
+  s3_options = {
+    bucket: ENV.fetch('S3_BUCKET'),
+    region: ENV.fetch('AWS_REGION'),
+    access_key_id: ENV.fetch('AWS_ACCESS_KEY_ID'),
+    secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY')
+  }
+
+  Shrine.storages = {
+    cache: Shrine::Storage::S3.new(prefix: 'cache', **s3_options),
+    store: Shrine::Storage::S3.new(**s3_options)
+  }
+else
+  require 'shrine/storage/memory'
+
+  Shrine.storages[:store] = Shrine::Storage::Memory.new
+end
+
+Shrine.plugin :activerecord
+Shrine.plugin :cached_attachment_data
+Shrine.plugin :restore_cached_data
+Shrine.plugin :determine_mime_type, analyzer: :marcel

data/lib/potassium/assets/docker-compose.ci.yml

@@ -7,5 +7,6 @@ services:
       dockerfile: Dockerfile.ci
     volumes:
     - "test_data:/usr/local/bundle"
+    - "./node_modules:/app/node_modules"
     environment:
       RACK_ENV: test

data/lib/potassium/assets/lib/tasks/auto_annotate_models.rake

@@ -36,7 +36,8 @@ if Rails.env.development?
       'force' => 'false',
       'trace' => 'false',
       'wrapper_open' => nil,
-      'wrapper_close' => nil
+      'wrapper_close' => nil,
+      'models' => true
     )
   end