potassium 6.0.0 → 6.4.0

data/CHANGELOG.md

@@ -2,6 +2,63 @@
 
 ## Unreleased
 
+## 6.4.0
+
+Features
+  - Include `run_test` as a valid example group [#379](https://github.com/platanus/potassium/pull/379)
+  - Updates ActiveAdmin installation to use webpacker [#350](https://github.com/platanus/potassium/pull/350)
+  - Replaces Active Skin with Arctic Admin [#350](https://github.com/platanus/potassium/pull/350)
+
+Fixes
+  - Forces `vue-loader` version to 15, as 16 requires `@vue/compiler-sfc`, which is a part of Vue 3 [#375](https://github.com/platanus/potassium/pull/375)
+  - Changes Content Security Policy added by GTM recipe to: [#375](https://github.com/platanus/potassium/pull/375)
+    - Include the same config regardless of environment
+    - Include `unsafe_eval` in `script_src`, as it is required for Vue's compiler build
+  - Changes the front-end test to avoid using the deprecated method `isVueInstance` [#376](https://github.com/platanus/potassium/pull/376)
+
+## 6.3.0
+
+Features:
+  - Add `monitoring` recipe with scout gem [#353](https://github.com/platanus/potassium/pull/353)
+  - Change CircleCI config to use cache in tests, and remove old cibuild flow [#366](https://github.com/platanus/potassium/pull/366)
+
+Fixes:
+  - Explicitly install project specified node version in CircleCI build [#352](https://github.com/platanus/potassium/pull/352)
+  - Fixes `tailwindCSS@^2` incompatibility with `postcss@^7` [#356](https://github.com/platanus/potassium/pull/356)
+  - Update marcel gem (shrine's mime type analyzer) to avoid mimemagic dependency [#357](https://github.com/platanus/potassium/pull/357)
+  - Explicitly set the frontend test environment to `jsdom` [#367](https://github.com/platanus/potassium/pull/367)
+
+## 6.2.0
+
+Features:
+  - Add Google Tag Manager [#326](https://github.com/platanus/potassium/pull/326)
+  - Update rubocop and rubocop-rspec for potassium and generated projects [#337](https://github.com/platanus/potassium/pull/337)
+  - Adds `mailers` queue to `sidekiq.yml` when installing or creating mailer recipe [#341](https://github.com/platanus/potassium/pull/341)
+
+Fixes:
+  - Change `backgroud_processor` cli option to a switch. As of [#137](https://github.com/platanus/potassium/pull/137) we no longer have `delayed_jobs` as an option, it's only `sidekiq` now [#340](https://github.com/platanus/potassium/pull/340)
+  - Fixes mailer recipe install when background_processor wasn't installed [#341](https://github.com/platanus/potassium/pull/341)
+  - Update `heroku` recipe to check if an app or pipeline name is valid before creating it on Heroku [#344](https://github.com/platanus/potassium/pull/344)
+
+## 6.1.0
+
+Features:
+  - Check node version before project creation [#305](https://github.com/platanus/potassium/pull/305)
+  - Disable observers in test environment [#319](https://github.com/platanus/potassium/pull/319)
+  - Allow user to select custom Github repository [#318](https://github.com/platanus/potassium/pull/318)
+  - Add pull request template to github enabled projects [#320](https://github.com/platanus/potassium/pull/320)
+  - Use a Ruby gem instead of hub to create Github repositories [#323](https://github.com/platanus/potassium/pull/323)
+  - Add dockerized redis configuration when using background processor [#329](https://github.com/platanus/potassium/pull/329)
+  - Add beta support for GraphQL. [#330](https://github.com/platanus/potassium/pull/330)
+  - Add power_api [#301](https://github.com/platanus/potassium/pull/301)
+
+
+Fix:
+  - Fix shrine issues related to configuration and uploader validation [#302](https://github.com/platanus/potassium/pull/302)
+  - Fix database recipe not running recommended generator for strong_migrations gem [#310](https://github.com/platanus/potassium/pull/310)
+  - Fix puma config that was causing it to crash on server start while on development [#313](https://github.com/platanus/potassium/pull/313)
+  - Fix purge css being enabled in development [#327](https://github.com/platanus/potassium/pull/327)
+
 ## 6.0.0
 
 Features:

data/README.md

@@ -16,7 +16,10 @@ Use the `potassium create` command to create a new project:
 
     $ potassium create <project-name>
 
-> It's important to note that it will perform a version check before running to ensure that you're using the latest potassium. Also, if you feel that it's too slow, you may need to update rubygems: `gem update --system`.
+> Please note:
+> 1. Potassium will perform a version check before running to ensure that you are using the latest potassium.
+> 2. If you feel that it's too slow, you may need to update rubygems: `gem update --system`.
+> 3. Potassium uses node under the hood, so a check will also be performed to ensure you are running the supported version.
 
 ### Adding recipes to an existing project
 
@@ -36,41 +39,41 @@ You can run the command on its own to view all the available recipes and select
 
 Potassium Rails apps includes the following gems and technologies:
 
-- [Ruby](https://www.ruby-lang.org) Set the project ruby version based on http://ruby.platan.us/latest
-- [dotenv](https://github.com/bkeepers/dotenv) load environmental variables in development
-- [Yarn](https://yarnpkg.com) for frontend assets packages.
-- [EditorConfig](http://editorconfig.org) for keeping all our editor configurations the same.
-- [pry](http://pryrepl.org) and [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) for a less painful debugging experience.
-- [RSpec](http://rspec.info) for unit and integration testing.
-- [FactoryBot](https://github.com/thoughtbot/factory_bot) for test factories.
-- [Guard](http://guardgem.org) for continuous testing and other watch-related tasks.
-- [AWS-SDK](https://github.com/aws/aws-sdk-ruby) for file uploads, sdks, etc and because we use AWS.
+- [dotenv](https://github.com/bkeepers/dotenv) for loading environmental variables in development
+- [Yarn](https://yarnpkg.com) for frontend assets packages
+- [EditorConfig](http://editorconfig.org) for keeping all our editor configurations the same
+- [pry](http://pryrepl.org) and [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) for a less painful debugging experience
+- [RSpec](http://rspec.info) for unit and integration testing
+- [FactoryBot](https://github.com/thoughtbot/factory_bot) for test factories
+- [Guard](http://guardgem.org) for continuous testing and other watch-related tasks
+- [AWS-SDK](https://github.com/aws/aws-sdk-ruby) for file uploads, sdks, etc and because we use AWS
 - [Puma](https://github.com/puma/puma) to serve HTTP requests
 - [Rack Timeout](https://github.com/heroku/rack-timeout) to abort requests that are
   taking too long
-- [Tzinfo-Data](https://github.com/tzinfo/tzinfo-data) for update timezone information
-- [Faker](https://github.com/stympy/faker) for create development data
-
-The following optional integrations are added too:
-
-- [PostgreSQL](http://www.postgresql.org) or [MySQL](https://www.mysql.com) for the database.
-- [Devise](https://github.com/plataformatec/devise) for authentication.
-- [ActiveAdmin](http://activeadmin.info) for admin interfaces.
-- [ActiveAdminAddons](https://github.com/platanus/activeadmin_addons) for some help with ActiveAdmin.
-- [Pundit](https://github.com/elabs/pundit) for role-based authorization.
-- [DelayedJob](https://github.com/collectiveidea/delayed_job) to execute longer tasks in the background.]
-- [Sidekiq](https://github.com/mperham/sidekiq) a simple, efficient background processing for Ruby.
+- [Tzinfo-Data](https://github.com/tzinfo/tzinfo-data) for updating timezone information
+- [Faker](https://github.com/stympy/faker) for creating development data
+- [Scout](https://github.com/scoutapp/scout_apm_ruby) for monitoring performance
+
+The following optional integrations are also added:
+
+- [PostgreSQL](http://www.postgresql.org) or [MySQL](https://www.mysql.com) for the database
+- [Devise](https://github.com/plataformatec/devise) for authentication
+- [ActiveAdmin](http://activeadmin.info) for admin interfaces
+- [ActiveAdminAddons](https://github.com/platanus/activeadmin_addons) for some help with ActiveAdmin
+- [Pundit](https://github.com/elabs/pundit) for role-based authorization
+- [Sidekiq](https://github.com/mperham/sidekiq) a simple, efficient background processing for Ruby
 - [Sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler) to run scheduled processes
 - Mailing configuration for [AWS SES](https://github.com/aws/aws-sdk-rails)
   and [Sendgrid](https://github.com/platanus/send_grid_mailer) with recipient interceptor support
 - [Sentry](https://sentry.io) to monitor exceptions and errors
 - [Vue.js](https://vuejs.org) or [Angular 2](https://angular.io/) for frontend development
+- [Google Tag Manager](https://tagmanager.google.com/) for analytics
+- Creates the Github repository of your choice for the project. A local git repository will always be created.
 
 A few more things are added to the project:
 
 - A [low database connection pool limit][pool]
-- Setup continuous integration in [CircleCI](circle-ci) to run tests.
-- Create the github repository for the project (it used `hub` under the hood)
+- Setup continuous integration in [CircleCI](circle-ci) to run tests
 - A `bin/setup` script to setup things on a newly cloned project
 - A `bin/cibuild` script to run continuous integration build on CI
 - A `db:fake_data:load` rake task to load fake data for development
@@ -81,24 +84,20 @@ A few more things are added to the project:
 
 The optional API support includes:
 
-- [Responders](https://github.com/plataformatec/responders) for dry-ing our api controllers.
-- [Versionist](https://github.com/bploetz/versionist) for some flexible api versioning.
-- [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) for record serialization.
-- [Simple Token Authentication](https://github.com/gonzalo-bulnes/simple_token_authentication) for stateless API authentication.
+- [Responders](https://github.com/plataformatec/responders) for dry-ing our api controllers
+- [Versionist](https://github.com/bploetz/versionist) for some flexible api versioning
+- [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) for record serialization
+- [Simple Token Authentication](https://github.com/gonzalo-bulnes/simple_token_authentication) for stateless API authentication
 
 ### Heroku
 
 When you choose to deploy to heroku a few extra things are added for the project.
 
-  - Adds the [Rails Stdout Logging][logging-gem] gem
-    to configure the app to log to standard out,
-    which is how [Heroku's logging][heroku-logging] works.
+  - Adds the [Rails Stdout Logging][logging-gem] gem to configure the app to log to standard out, which is how [Heroku's logging][heroku-logging] works
   - Adds a [Procfile][procfile] to define the processes to run in heroku
-  - Setup continuous integration using docker and herokuish to maintain better
-    parity between testing and production environments
-  - Adds a `.buildpacks` file with the default buildpacks to use. It use the
-    following buildpacks:
-  - Adds a `bin/release` file with the release phase script to run specific tasks before the app is deployed completely, for example `rails db:migrate:with_data`.
+  - Setup continuous integration using docker and herokuish to maintain better parity between testing and production environments
+  - Adds a `bin/release` file with the release phase script to run specific tasks before the app is deployed completely, for example `rails db:migrate:with_data`
+  - Adds a `.buildpacks` file with the default buildpacks to use. It use the following buildpacks:
 
 | index | buildpack | description |
 |-------|-----------|-------------|
@@ -110,7 +109,7 @@ Also the heroku applications are created
 
   - Creates a `staging` and `production` applications
   - Creates a pipeline and assign the above application to the `staging`
-    and `production` stages.
+    and `production` stages
   - Setup initial configuration variables
   - Set the application buildpack to the [multi-buildpack][heroku-buildpack-multi]
 
@@ -126,11 +125,9 @@ In order to CicleCI start building the project on each push you need tell circle
 Go to https://circleci.com/add-projects, choose the repository from the list and hit
 **Build Project**
 
-### Hound CI
+#### ReviewDog
 
-In order to Hound start checking your project's PRs you need enable that repository.
-Go to https://monkeyci.platan.us, choose the repository from the list and hit
-**Activate**
+In order to enable code linting via CircleCI and ReviewDog, you need to activate the **Only build pull requests** option under the `Advanced settings` section for your project.
 
 [logging-gem]: https://github.com/heroku/rails_stdout_logging
 [heroku-logging]: https://devcenter.heroku.com/articles/logging#writing-to-your-log
@@ -149,15 +146,24 @@ This is useful when you are adding new recipes to Potassium, and you want to use
 To achieve this you need to run, **In the Potassium's root path**, the `bin/potassium_test create` instead of `potassium create` command.
 This command, will do the same as `potassium create` but first:
 
-- Will drop any existent database of the test app.
-- Will remove the directory containing a previous version of the test app.
+- Will drop any existent database of the test app
+- Will remove the directory containing a previous version of the test app
 
 It's important to remember that `bin/potassium_test create`:
 
 - Does not receive an `app_path` param. It always creates the test project inside `/tmp/dummy_app`
-- Can receive the same options as `potassium create`.
+- Can receive the same options as `potassium create`
 - Runs with options with a default value. This is to avoid the "asking part" of the creation process. You need to enable what you want to test like this: `$ bin/potassium_test create --clockwork`
 
+## Publishing
+On master branch.
+
+1. Change `VERSION` in `lib/potassium/version.rb`
+2. Change `Unreleased` title to current version in `CHANGELOG.md`
+3. Commit new release. For example: `Releasing v6.3.0`
+4. Create tag. For example: `git tag v6.3.0`
+5. Push tag: `git push origin v6.3.0`
+
 ## Contributing
 
 If you want to add functionality please go to
@@ -173,4 +179,4 @@ potassium is maintained by [platanus](http://platan.us).
 
 ## License
 
-Potassium is © 2014 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.
+Potassium is © 2014 Platanus, SPA. It is free software and may be redistributed under the terms specified in the LICENSE file.

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

@@ -1,34 +1,37 @@
-version: 2
-jobs:
-  test:
-    working_directory: ~/app
-
+version: 2.1
+
+ruby-image: &ruby-image circleci/ruby:<%= ruby_version %>
+<%- if selected?(:database, :postgresql) -%>
+postgres-image: &postgres-image postgres:<%= Potassium::POSTGRES_VERSION %>
+<%- end -%>
+<%- if selected?(:background_processor) -%>
+redis-image: &redis-image redis
+<%- end -%>
+env-vars: &env-vars
+  BUNDLE_JOBS: 4
+  BUNDLE_PATH: vendor/bundle
+  RAILS_ENV: test
+
+executors:
+  test-executor:
     docker:
-    - image: platanus/compose:1.22.0
-
-    steps:
-    - checkout
-    - setup_remote_docker
-
-    - run: docker info
-    - run: docker-compose -f docker-compose.ci.yml pull
-    - run: docker-compose -f docker-compose.ci.yml build test
-    - run: bin/cibuild services
-    - run: bin/cibuild deps
-
-    - run: bin/cibuild db
-    - run: bin/cibuild tests
-    <% if selected?(:front_end, :vue) %>
-    - run: bin/cibuild js_tests
-    <% end %>
-
-  lint:
+      - image: *ruby-image
+        environment: *env-vars
+      <%- if selected?(:database, :postgresql) -%>
+      - image: *postgres-image
+      <%- end -%>
+      <%- if selected?(:background_processor) -%>
+      - image: *redis-image
+      <%- end -%>
+
+  lint-executor:
     docker:
-      - image: circleci/ruby:2.7-node
-        environment:
-          BUNDLE_JOBS: 4
-          BUNDLE_RETRY: 3
-          BUNDLE_PATH: vendor/bundle
+      - image: *ruby-image
+        environment: *env-vars
+
+commands:
+  setup:
+    description: checkout code, restore cache, install dependencies, save cache
     steps:
       - checkout
 
@@ -49,20 +52,67 @@ jobs:
             gem install bundler:$BUNDLER_VERSION
             bundle _$(echo $BUNDLER_VERSION)_ install
 
+      - run:
+          name: Install yarn dependencies
+          command: |
+            curl -sL https://deb.nodesource.com/setup_$(cat .node-version).x | sudo -E bash -
+            sudo apt-get install -y nodejs
+            curl -o- -sL https://yarnpkg.com/install.sh | bash
+            sudo ln -s $HOME/.yarn/bin/yarn /usr/local/bin/yarn
+            yarn install --frozen-lockfile
+
       - save_cache:
           key: bundle-dependencies-{{ checksum "Gemfile.lock" }}
           paths:
             - vendor/bundle
 
-      - run:
-          name: Install yarn dependencies
-          command: yarn install --frozen-lockfile
-
       - save_cache:
           key: yarn-dependencies-{{ checksum "yarn.lock" }}
           paths:
             - node_modules
 
+jobs:
+  test:
+    executor: test-executor
+    steps:
+      - setup
+
+      <%- if selected?(:background_processor) -%>
+      - run:
+          name: Wait for redis service
+          command: dockerize -wait tcp://localhost:6379 -timeout 1m
+      <%- end -%>
+      <%- if selected?(:database, :postgresql) -%>
+      - run:
+          name: Wait for postgres service
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+
+      - run:
+          name: Setup database
+          command: bundle exec rails db:create db:schema:load
+      <%- end -%>
+
+      - run:
+          name: Run rspec
+          command: |
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec.xml"
+            RSPEC_FORMAT_ARGS="-f progress --no-color -p 10"
+            bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+
+      <%- if selected?(:front_end, :vue) -%>
+      - run:
+          name: Run jest
+          command: yarn run test
+      <%- end -%>
+
+      - store_test_results:
+          path: test_results
+
+  lint:
+    executor: lint-executor
+    steps:
+      - setup
+
       - run:
           name: Install reviewdog
           command: |
@@ -94,7 +144,6 @@ jobs:
             | ./bin/reviewdog -reporter=github-pr-review -f=stylelint
 
 workflows:
-  version: 2
   test_and_lint:
     jobs:
       - test

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

@@ -22,7 +22,7 @@
     "array-callback-return": 2,
     "block-scoped-var": 2,
     "complexity": [1, {
-      "max": 20
+      "max": 6
     }],
     "consistent-return": 2,
     "curly": [2, "multi-line"],
@@ -100,8 +100,8 @@
     "yoda": 2,
     "comma-dangle": [2, "always-multiline"],
     "no-cond-assign": [2, "always"],
-    "no-console": 0,
-    "no-debugger": 0,
+    "no-console": 1,
+    "no-debugger": 1,
     "no-constant-condition": 2,
     "no-control-regex": 2,
     "no-dupe-args": 2,
@@ -339,5 +339,14 @@
       "code": 120,
       "ignoreHTMLAttributeValues": true
   }]
-  }
+  },
+  "overrides": [
+    {
+      "files": ["**/*.js"],
+      "excludedFiles": "app/**/*.js",
+      "env": {
+        "node": true
+      }
+    }
+  ]
 }

data/lib/potassium/assets/.github/pull_request_template.md

@@ -0,0 +1,9 @@
+### Contexto
+​
+### Qué se esta haciendo
+​
+#### En particular hay que revisar
+​
+
+-----------
+#### Info Adicional (pantallazos, links, fuentes, etc.)

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

@@ -502,6 +502,19 @@ Performance/RedundantBlockCall:
   Description: Use `yield` instead of `block.call`.
   Reference: https://github.com/JuanitoFatas/fast-ruby#proccall-vs-yield-code
   Enabled: false
+Style/OptionalBooleanParameter:
+  Description: 'Use keyword arguments when defining method with boolean argument.'
+  Enabled: false
+Lint/MissingSuper:
+  Description: >-
+                  This cop checks for the presence of constructors and lifecycle callbacks
+                  without calls to `super`'.
+  Enabled: false
+Style/RedundantFileExtensionInRequire:
+  Description: >-
+                  Checks for the presence of superfluous `.rb` extension in
+                  the filename provided to `require` and `require_relative`.
+  Enabled: false
 RSpec/MultipleExpectations:
   Max: 5
 RSpec/NestedGroups:

data/lib/potassium/assets/README.yml

@@ -42,10 +42,7 @@ readme:
         The project is setup to run tests
         in [CircleCI](https://circleci.com/gh/platanus/<%= get(:dasherized_app_name) %>/tree/master)
 
-        You can also run the test locally simulating the production environment using docker.
-        Just make sure you have docker installed and run:
-
-            bin/cibuild
+        You can also run the test locally simulating the production environment using [CircleCI's method](https://circleci.com/docs/2.0/local-cli/).
     deployment:
       title: "Deployment"
       body: |
@@ -112,9 +109,6 @@ readme:
         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/)."
-        delayed_job:
-          title: "Queue System"
-          body: "For managing tasks in the background, this project uses [DelayedJob](https://github.com/collectiveidea/delayed_job)"
         sidekiq:
           title: "Queue System"
           body: "For managing tasks in the background, this project uses [Sidekiq](https://github.com/mperham/sidekiq)"
@@ -130,6 +124,12 @@ 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."
+        power_api:
+          title: "API Support"
+          body: "This projects uses [Power API](https://github.com/platanus/power_api). It's a Rails engine that gathers a set of gems and configurations designed to build incredible REST APIs."
+        graphql:
+          title: "API Support"
+          body: "This projects uses [graphql-ruby](https://graphql-ruby.org/) to generate a GraphQL API."
         active_admin:
           title: "Administration"
           body: |