potassium 5.2.2 → 6.3.0

data/.ruby-version

@@ -1 +1 @@
-2.5
+2.7

data/CHANGELOG.md

@@ -2,12 +2,103 @@
 
 ## Unreleased
 
+## 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:
+  - Update ActiveAdmin to 2.6 [#246](https://github.com/platanus/potassium/pull/246)
+  - Update bundler to 2.0 [#250](https://github.com/platanus/potassium/pull/250)
+  - Update Rails to 6.0.2 [#251](https://github.com/platanus/potassium/pull/251)
+  - Improve specs performance [#259](https://github.com/platanus/potassium/pull/259)
+  - Dasherize app name in docker compose related files [#261](https://github.com/platanus/potassium/pull/261)
+  - Split specs by timings in CircleCI [#263](https://github.com/platanus/potassium/pull/263)
+  - Update ruby to 2.7.0 [#264](https://github.com/platanus/potassium/pull/264)
+  - Add tailwindcss [#266](https://github.com/platanus/potassium/pull/266)
+  - Update rack-cors to 1.1 [#269](https://github.com/platanus/potassium/pull/269)
+  - Use safer CORS configuration exposing only API and public resources [#271](https://github.com/platanus/potassium/pull/271)
+  - Add option to support Vue in ActiveAdmin [#272](https://github.com/platanus/potassium/pull/272)
+  - Add tests for Vue [#273](https://github.com/platanus/potassium/pull/278)
+  - Remove simple commands and docker-compose args in Makefile [#279](https://github.com/platanus/potassium/pull/279)
+  - Remove Paperclip and add [Shrine](https://github.com/shrinerb/shrine) for file_storage recipe [#291](https://github.com/platanus/potassium/pull/291)
+  - Add linting job to CircleCI builds using [reviewdog](https://github.com/reviewdog/reviewdog) and per-project dependencies/configurations for linters [#292](https://github.com/platanus/potassium/pull/292)
+  - Remove angular_admin recipe [#297](https://github.com/platanus/potassium/pull/297)
+
+Fix:
+  - Correctly use cache for bundle dependencies in CircleCI build [#244](https://github.com/platanus/potassium/pull/244) and [#258](https://github.com/platanus/potassium/pull/258)
+  - Fix model auto annotate [#260](https://github.com/platanus/potassium/pull/260)
+  - Fix sidekiq repeated installation on potassium create if selecting mailer [#262](https://github.com/platanus/potassium/pull/262)
+  - Include ApiErrorConcern in all environments [#270](https://github.com/platanus/potassium/pull/270)
+
+## 5.2.3
+
+Features:
+  - Add restore-from commands for pg_restore in makefile [#237](https://github.com/platanus/potassium/pull/237)
+  - Allow usage of vue components in rails views out of the box [#231](https://github.com/platanus/potassium/pull/231)
+  - Add data migrate [#227](https://github.com/platanus/potassium/pull/227)
+  - Add raven capture in error handler if sentry enabled [#226](https://github.com/platanus/potassium/pull/226)
+  - Remove unnecesary aws-sdk gems in favor of specific ones [#221](https://github.com/platanus/potassium/pull/221)
+  - Unify storage options and deprecate paperclip [#211](https://github.com/platanus/potassium/pull/211)
+
+Fix:
+  - Fix gather_gem issue when multiple versions passed as argument [#242](https://github.com/platanus/potassium/pull/242)
+  - Support "None" passed as CLI flag option in file storage [#240](https://github.com/platanus/potassium/pull/240)
+  - Add sidekiq worker to Procfile if installed after project setup (with heroku) [#234](https://github.com/platanus/potassium/pull/234)
+  - Include test_data volume to CI compose for bundler related data [#229](https://github.com/platanus/potassium/pull/229)
+  - Comment out schedule entry in sidekiq.yml [#225](https://github.com/platanus/potassium/pull/225)
+  - Use ruby image for potassium test build [#224](https://github.com/platanus/potassium/pull/224)
+  - Use webpacker from rubygems instead of repo master [#222](https://github.com/platanus/potassium/pull/222)
+  - Add rubocop-rspec for compatibility with updated linters in spec [#218](https://github.com/platanus/potassium/pull/218)
+  - Remove containers after spec run [#216](https://github.com/platanus/potassium/pull/216)
+  - Fix database container install [#214](https://github.com/platanus/potassium/pull/214)
+
 ## 5.2.2
 
 Features:
   - Implement release phase on heroku
   - Add sendgrid_dev support
-  -
+
 Fix:
   - Fix Circle CI
   - Fix services containers env variables

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`.
+  - 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/docs/DSL.md

@@ -308,7 +308,7 @@ add_readme_header(:style_guide)
 
 ##### | `add_readme_section(header, section, iterpolation_values)`
 
-To add header's sections. Paperclip, for example:
+To add header's sections. Devise, for example:
 
 ```yml
 readme:
@@ -316,11 +316,11 @@ readme:
     internal_dependencies:
       title: "Internal dependencies"
       sections:
-        paperclip:
-          title: "Uploads"
-          body: "For managing uploads, this project uses..."
+        devise:
+          title: "Authentication"
+          body: "We are using the great..."
 ```
 
 ```ruby
-add_readme_section(:internal_dependencies, :paperclip)
+add_readme_section(:internal_dependencies, :devise)
 ```

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

@@ -0,0 +1,151 @@
+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: *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: *ruby-image
+        environment: *env-vars
+
+commands:
+  setup:
+    description: checkout code, restore cache, install dependencies, save cache
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - bundle-dependencies-{{ checksum "Gemfile.lock" }}
+          - bundle-dependencies-
+
+      - restore_cache:
+          keys:
+          - yarn-dependencies-{{ checksum "yarn.lock" }}
+          - yarn-dependencies-
+
+      - run:
+          name: Install bundle dependencies
+          command: |
+            BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")
+            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
+
+      - 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: |
+            curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b ./bin
+
+      - run:
+          name: Get files to lint
+          command: git diff origin/master --name-only --diff-filter=d > tmp/files_to_lint
+
+      - run:
+          name: Run rubocop
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(rb)$' | xargs bundle exec rubocop --force-exclusion \
+            | ./bin/reviewdog -reporter=github-pr-review -f=rubocop
+
+      - run:
+          name: Run eslint
+          shell: /bin/bash
+          command: |
+            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 stylelint
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(scss|css|less)$' | xargs yarn run stylelint \
+            | ./bin/reviewdog -reporter=github-pr-review -f=stylelint
+
+workflows:
+  test_and_lint:
+    jobs:
+      - test
+      - lint:
+          context: org-global