potassium 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11bd2c43f5af6d71fc6b3b148ba69cd8189d4b22a144c0b9f83f1b051115e214
-  data.tar.gz: dd6d6bd437bb406738f9f76e0e7b5742a305d1948001eaa1c79056bc8b30b91a
+  metadata.gz: f6e930d3ad3b2989b3fd4e3675da60f6dec57089d0eba9eabe4d1bccbcae68de
+  data.tar.gz: 50ca1761257ba7f22d0724a3f1996a703d39dfefab842d4198cc99f7392741d0
 SHA512:
-  metadata.gz: 436ed38de1d2189cab51d2f2be5f59190ff2a1a6729554ce28374b373ee440ffac606dddb368bcff5dfc31dfb29d5c467465ec2676cbe13d2d08928f5629ef35
-  data.tar.gz: 17eb691dcad577143b4218d78da12bbe5f66256a0213d5d1f70d05b5ef53343e83e0ac87e511df05197b7e90668eddb0fc2feea260a77b01590e6d2b36715a9c
+  metadata.gz: 7044e4cfce08ab3cca65a7dbc30ec8be951ab478f368067955a8435bac40fe4c769f0a8b2b38828ab93614c0eeac8fe67d68c1f59ae3d8317b424c848e639c33
+  data.tar.gz: c699ee1eedb6b15512acbbdb6b53bab2e98b65e7aab413d398d47042e58e1c16ee8b786394674d6b07ba93f248a51f4da7bf366eaf184d0a13e4527d99647fe5

data/.circleci/config.yml

@@ -76,9 +76,32 @@ jobs:
             cat tmp/files_to_lint | grep -E '.+\.(rb)$' | xargs bundle exec rubocop --force-exclusion \
             | ./bin/reviewdog -reporter=github-pr-review -f=rubocop
 
+  deploy:
+    executor: ruby-executor
+    steps:
+      - setup
+
+      - run:
+          name: Setup rubygems
+          command: bash .circleci/setup-rubygems.sh
+
+      - run:
+          name: Publish to rubygems
+          command: |
+            gem build potassium.gemspec
+            version_tag=$(git describe --tags)
+            gem push potassium-${version_tag#v}.gem
+
 workflows:
   test_and_lint:
     jobs:
       - test
       - lint:
           context: org-global
+      - deploy:
+          context: org-global
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## 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:

data/README.md

@@ -52,6 +52,7 @@ Potassium Rails apps includes the following gems and technologies:
   taking too long
 - [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:
 
@@ -154,6 +155,15 @@ It's important to remember that `bin/potassium_test 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

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/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: |

data/lib/potassium/helpers/template-helpers.rb

@@ -7,6 +7,10 @@ module TemplateHelpers
     "#{Potassium::NODE_VERSION}.x"
   end
 
+  def ruby_version
+    Semantic::Version.new(Potassium::RUBY_VERSION).instance_eval { "#{major}.#{minor}" }
+  end
+
   def load_recipe(recipe_name)
     @recipes ||= {}
     @recipes[recipe_name] ||= get_recipe_class(recipe_name.to_sym).new(self)

data/lib/potassium/recipes/ci.rb

@@ -1,50 +1,20 @@
 class Recipes::Ci < Rails::AppBuilder
   def create
-    copy_file '../assets/Dockerfile.ci', 'Dockerfile.ci'
     template '../assets/.circleci/config.yml.erb', '.circleci/config.yml'
 
-    template '../assets/bin/cibuild.erb', 'bin/cibuild'
-    run "chmod a+x bin/cibuild"
-
-    copy_file '../assets/docker-compose.ci.yml', 'docker-compose.ci.yml'
-
     gather_gems(:test) do
-      gather_gem 'rspec_junit_formatter', '0.2.2'
-    end
-
-    compose = DockerHelpers.new('docker-compose.ci.yml')
-
-    if selected?(:database, :mysql)
-      srv =
-        <<~YAML
-          image: mysql:#{Potassium::MYSQL_VERSION}
-          environment:
-            MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
-        YAML
-      compose.add_service("mysql", srv)
-      compose.add_link('test', 'mysql')
-      compose.add_env('test', 'MYSQL_HOST', 'mysql')
-      compose.add_env('test', 'MYSQL_PORT', '3306')
-
-    elsif selected?(:database, :postgresql)
-      srv =
-        <<~YAML
-          image: "postgres:#{Potassium::POSTGRES_VERSION}"
-          environment:
-            POSTGRES_USER: postgres
-            POSTGRES_PASSWORD: ''
-        YAML
-      compose.add_service("postgresql", srv)
-      compose.add_link('test', 'postgresql')
-      compose.add_env('test', 'DB_USER', 'postgres')
-      compose.add_env('test', 'DB_HOST', 'postgresql')
-      compose.add_env('test', 'DB_PORT', '5432')
+      gather_gem 'rspec_junit_formatter', '~> 0.4'
     end
 
-    compose.add_volume('test_data')
-
     add_readme_header :ci
-
     application 'config.assets.js_compressor = :uglifier', env: 'test'
   end
+
+  def install
+    create
+  end
+
+  def installed?
+    file_exist?('.circleci/config.yml')
+  end
 end

data/lib/potassium/recipes/file_storage.rb

@@ -39,7 +39,7 @@ class Recipes::FileStorage < Rails::AppBuilder
 
   def add_shrine
     gather_gem('shrine', '~> 3.0')
-    gather_gem('marcel', '~> 0.3.3')
+    gather_gem('marcel', '~> 1.0')
     copy_file('../assets/config/shrine.rb', 'config/initializers/shrine.rb', force: true)
     copy_file('../assets/app/uploaders/image_uploader.rb', 'app/uploaders/image_uploader.rb')
     copy_file('../assets/app/uploaders/base_uploader.rb', 'app/uploaders/base_uploader.rb')

data/lib/potassium/recipes/front_end.rb

@@ -69,7 +69,8 @@ class Recipes::FrontEnd < Rails::AppBuilder
   end
 
   def setup_tailwind
-    run 'bin/yarn add tailwindcss'
+    run "bin/yarn add tailwindcss@#{Potassium::TAILWINDCSS}"
+    specify_autoprefixer_postcss_compatibility_versions
     setup_client_css
     remove_server_css_requires
     setup_tailwind_requirements
@@ -147,6 +148,10 @@ class Recipes::FrontEnd < Rails::AppBuilder
     JS
   end
 
+  def specify_autoprefixer_postcss_compatibility_versions
+    run 'bin/yarn -D add postcss@^7 autoprefixer@^9'
+  end
+
   def setup_client_css
     application_css = 'app/javascript/css/application.css'
     create_file application_css, "", force: true
@@ -264,7 +269,8 @@ class Recipes::FrontEnd < Rails::AppBuilder
         },
         "snapshotSerializers": [
           "<rootDir>/node_modules/jest-serializer-vue"
-        ]
+        ],
+        "testEnvironment": "jsdom"
       }
     }
   end

data/lib/potassium/recipes/monitoring.rb

@@ -0,0 +1,5 @@
+class Recipes::Monitoring < Rails::AppBuilder
+  def create
+    gather_gem('scout_apm')
+  end
+end

data/lib/potassium/templates/application.rb

@@ -59,6 +59,7 @@ run_action(:recipe_loading) do
   create :i18n
   create :pry
   create :better_errors
+  create :monitoring
   create :devise
   create :admin
   create :vue_admin

data/lib/potassium/version.rb

@@ -1,5 +1,5 @@
 module Potassium
-  VERSION = "6.2.0"
+  VERSION = "6.3.0"
   RUBY_VERSION = "2.7.0"
   RAILS_VERSION = "~> 6.0.2"
   RUBOCOP_VERSION = "~> 1.9"
@@ -7,4 +7,5 @@ module Potassium
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
   NODE_VERSION = "12"
+  TAILWINDCSS = "npm:@tailwindcss/postcss7-compat"
 end

data/spec/features/ci_spec.rb

@@ -1,14 +1,17 @@
 require "spec_helper"
 require "rubocop"
 
-RSpec.describe "A new project" do
+RSpec.describe 'CI' do
   before(:all) do
     drop_dummy_database
     remove_project_directory
-    create_dummy_project("heroku" => true)
+    create_dummy_project
   end
 
-  it "correctly runs continous integration" do
-    expect { on_project { `bin/cibuild` } }.to_not output.to_stderr
+  it "correctly bundles the config file" do
+    yml_path = "#{project_path}/.circleci/config.yml"
+    content = IO.read(yml_path)
+    expect(File.exist?(yml_path)).to be true
+    expect(content).to include('circleci/ruby', 'cache', 'rspec', 'reviewdog')
   end
 end

data/spec/features/front_end_spec.rb

@@ -22,6 +22,12 @@ RSpec.describe "Front end" do
     expect(File).not_to exist(application_css_path)
   end
 
+  def expect_to_have_tailwind_compatibility_build
+    expect(node_modules_file).to include("\"tailwindcss\": \"npm:@tailwindcss/postcss7-compat\"")
+    expect(node_modules_file).to include("\"autoprefixer\": \"^9\"")
+    expect(node_modules_file).to include("\"postcss\": \"^7\"")
+  end
+
   context "with vue" do
     before(:all) do
       remove_project_directory
@@ -55,6 +61,10 @@ RSpec.describe "Front end" do
       expect(tailwind_config_file).to include('module.exports')
     end
 
+    it 'includes correct packages for tailwind, postcss and autoprefixer compatibility build' do
+      expect_to_have_tailwind_compatibility_build
+    end
+
     context "with graphql" do
       before(:all) do
         remove_project_directory
@@ -84,5 +94,9 @@ RSpec.describe "Front end" do
     it "creates application_js_file for tailwind without vue" do
       expect(application_js_file).to include("import '../css/application.css';")
     end
+
+    it 'includes correct packages for tailwind, postcss and autoprefixer compatibility build' do
+      expect_to_have_tailwind_compatibility_build
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potassium
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - juliogarciag
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -244,6 +244,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
 - ".editorconfig"
 - ".gitignore"
 - ".node-version"
@@ -270,7 +271,6 @@ files:
 - lib/potassium/assets/.pryrc
 - lib/potassium/assets/.rubocop.yml
 - lib/potassium/assets/.stylelintrc.json
-- lib/potassium/assets/Dockerfile.ci
 - lib/potassium/assets/Makefile.erb
 - lib/potassium/assets/Procfile
 - lib/potassium/assets/README.md.erb
@@ -300,7 +300,6 @@ files:
 - lib/potassium/assets/app/uploaders/image_uploader.rb
 - lib/potassium/assets/app/views/shared/_gtm_body.html.erb
 - lib/potassium/assets/app/views/shared/_gtm_head.html.erb
-- lib/potassium/assets/bin/cibuild.erb
 - lib/potassium/assets/bin/release
 - lib/potassium/assets/bin/setup.erb
 - lib/potassium/assets/bin/setup_heroku.erb
@@ -314,7 +313,6 @@ files:
 - lib/potassium/assets/config/sentry.rb.erb
 - lib/potassium/assets/config/shrine.rb
 - lib/potassium/assets/config/storage.yml
-- lib/potassium/assets/docker-compose.ci.yml
 - lib/potassium/assets/docker-compose.yml
 - lib/potassium/assets/es-CL.yml
 - lib/potassium/assets/lib/tasks/auto_annotate_models.rake
@@ -372,6 +370,7 @@ files:
 - lib/potassium/recipes/i18n.rb
 - lib/potassium/recipes/listen.rb
 - lib/potassium/recipes/mailer.rb
+- lib/potassium/recipes/monitoring.rb
 - lib/potassium/recipes/node.rb
 - lib/potassium/recipes/power_types.rb
 - lib/potassium/recipes/pry.rb
@@ -430,7 +429,7 @@ homepage: https://github.com/platanus/potassium
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -446,7 +445,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: An application generator from Platanus
 test_files:

data/lib/potassium/assets/Dockerfile.ci

@@ -1,6 +0,0 @@
-FROM platanus/ruby:2.7
-
-RUN mkdir /app
-WORKDIR /app
-
-ADD . /app

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

@@ -1,117 +0,0 @@
-#!/usr/bin/env bash
-trap "exit" SIGINT SIGTERM
-
-command -v docker >/dev/null 2>&1 && docker info >/dev/null || {
-  printf >&2 "\e[31mI require docker but it's not installed. Aborting.\e[0m\n"; exit 1;
-}
-
-DOCKER_COMPOSE_ARGS="-f docker-compose.ci.yml"
-
-# Build Image
-build(){
-  docker-compose $DOCKER_COMPOSE_ARGS build test
-}
-
-# Wait services to be ready
-wait_services(){
-  function test_service {
-    docker-compose $DOCKER_COMPOSE_ARGS run --rm test sh -c "nc -z $1 $2"
-  }
-
-  count=0
-  # Chain tests together by using &&
-  until (
-  <% if(selected?(:database, :mysql) || selected?(:database, :postgresql))-%>
-  test_service '$DB_HOST' '$DB_PORT' && \
-  <% end-%>
-  echo "Services ready"
-  )
-  do
-    ((count++))
-    if [ $count -gt 50 ]
-    then
-      echo "Services didn't become ready in time"
-      exit 1
-    else
-      echo "Waiting for services to become ready..."
-    fi
-    sleep 0.5
-  done
-}
-
-# Prepare dependencies
-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"
-}
-
-# Prepare database
-database(){
-  docker-compose $DOCKER_COMPOSE_ARGS run --rm test bundle exec rake db:create db:schema:load
-}
-
-# Run the specs
-tests(){
-  [ -n "$CI" ] && {
-    RSPEC_JUNIT_ARGS="-r rspec_junit_formatter --format RspecJunitFormatter -o $HOME/.rspec_reports/junit.xml"
-    RSPEC_FORMAT_ARGS="--format progress --no-color"
-  }
-  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
-  wait_services
-  dependencies
-  assets
-  database
-  tests
-}
-
-case "$1" in
-  "")
-    no_ci
-    ;;
-  "services")
-    wait_services
-    ;;
-  "deps"|"dependencies")
-    dependencies <% if selected?(:front_end, :vue) %>&& yarn_dependencies<% end %>
-    ;;
-  "assets")
-    assets
-    ;;
-  "db"|"database")
-    database
-    ;;
-<% if selected?(:front_end, :vue) %>
-  "js_tests")
-    js_tests
-    ;;
-<% end %>
-  "specs"|"tests")
-    tests
-    ;;
-  "build")
-    build
-    ;;
-  *)
-    echo "Usage: cibuild [services|deps|assets|db|specs|build]"
-    ;;
-esac

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

@@ -1,12 +0,0 @@
-version: '3.4'
-
-services:
-  test:
-    build:
-      context: "."
-      dockerfile: Dockerfile.ci
-    volumes:
-    - "test_data:/usr/local/bundle"
-    - "./node_modules:/app/node_modules"
-    environment:
-      RACK_ENV: test