potassium 6.1.0 → 6.5.0

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

@@ -1,47 +1,58 @@
-version: 2
-jobs:
-  test:
-    working_directory: ~/app
-
+version: 2.1
+
+ruby-image: &ruby-image cimg/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
+
+orbs:
+  browser-tools: circleci/browser-tools@1.1
+
+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
 
       - restore_cache:
           keys:
-          - bundle-dependencies-{{ checksum "Gemfile.lock" }}
+          - bundle-dependencies-{{ .Environment.BUNDLE_CACHE_VERSION }}-{{ checksum "Gemfile.lock" }}
           - bundle-dependencies-
 
       - restore_cache:
           keys:
-          - yarn-dependencies-{{ checksum "yarn.lock" }}
+          - yarn-dependencies-{{ .Environment.YARN_CACHE_VERSION }}-{{ checksum "yarn.lock" }}
           - yarn-dependencies-
 
+      - run:
+          name: Install reviewdog
+          command: |
+            curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b ./bin
+
       - run:
           name: Install bundle dependencies
           command: |
@@ -49,24 +60,81 @@ 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" }}
+          key: bundle-dependencies-{{ .Environment.BUNDLE_CACHE_VERSION }}-{{ checksum "Gemfile.lock" }}
           paths:
             - vendor/bundle
 
-      - run:
-          name: Install yarn dependencies
-          command: yarn install --frozen-lockfile
-
       - save_cache:
-          key: yarn-dependencies-{{ checksum "yarn.lock" }}
+          key: yarn-dependencies-{{ .Environment.YARN_CACHE_VERSION }}-{{ checksum "yarn.lock" }}
           paths:
             - node_modules
 
+jobs:
+  test:
+    executor: test-executor
+    steps:
+      - setup
+      - browser-tools/install-chrome
+      - browser-tools/install-chromedriver
+
+      <%- if selected?(:background_processor) -%>
       - run:
-          name: Install reviewdog
+          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 unit tests
           command: |
-            curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b ./bin
+            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
+
+      - run:
+          name: Run RSpec system tests
+          command: |
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec-system.xml"
+            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
+          command: yarn run test
+      <%- end -%>
+
+      - store_test_results:
+          path: test_results
+
+  lint:
+    executor: lint-executor
+    steps:
+      - setup
 
       - run:
           name: Get files to lint
@@ -94,7 +162,6 @@ jobs:
             | ./bin/reviewdog -reporter=github-pr-review -f=stylelint
 
 workflows:
-  version: 2
   test_and_lint:
     jobs:
       - test

data/lib/potassium/assets/.pryrc

@@ -4,9 +4,3 @@ if defined?(PryByebug)
   Pry.commands.alias_command 'n', 'next'
   Pry.commands.alias_command 'f', 'finish'
 end
-
-if defined?(Rails)
-  require 'rails/console/app'
-  require 'rails/console/helpers'
-  include Rails::ConsoleMethods # rubocop:disable Style/MixinUsage
-end

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)"
@@ -129,7 +123,7 @@ readme:
           body: "This project uses [Draper](https://github.com/drapergem/draper) to add an object-oriented layer of presentation logic"
         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."
+          body: "This project 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."
@@ -159,8 +153,51 @@ readme:
               ```
               - You can also use **any** vue bindings such as `v-for` , `:key` etc.
             <% end %>
+            <% if get(:authorization) %>
+            It uses the [ActiveAdmin's Pundit adapter](https://activeadmin.info/13-authorization-adapter.html).
+            - Policies for admin resources must inherit from `BackOffice::DefaultPolicy` and be placed inside the `app/policies/back_office` directory.
+              - For example:
+
+                `app/admin/clients.rb`:
+
+                ```ruby
+                ActiveAdmin.register Client do
+                  # ...
+                end
+                ```
+
+                `app/policies/back_office/client_policy.rb`:
+
+                ```ruby
+                class BackOffice::ClientPolicy < BackOffice::DefaultPolicy
+                end
+                ```
+            <% end %>
     seeds:
       title: "Seeds"
       body: |
         To populate your database with initial data you can add, inside the `/db/seeds.rb` file, the code to generate **only the necessary data** to run the application.
         If you need to generate data with **development purposes**, you can customize the `lib/fake_data_loader.rb` module and then to run the `rake load_fake_data` task from your terminal.
+    testing:
+      title: "Testing"
+      body: |
+        We use:
+        - [RSpec](https://github.com/rspec/rspec-rails): the testing framework.
+        - [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers): one-liners to test common Rails functionality that, if written by hand, would be much longer, more complex, and error-prone.
+        - [Factory Bot](https://github.com/thoughtbot/factory_bot_rails): a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
+        - [Faker](https://github.com/faker-ruby/faker): a port of Perl's Data::Faker library that generates fake data.
+        - [Guard](https://github.com/guard/guard): automates various tasks by running custom rules whenever file or directories are modified. We use it to run RSpec when files change.
+
+        Place your unit tests inside the `spec` directory.
+
+        To run unit tests: `bin/guard`
+
+        #### System tests
+
+        We use, in addition to the previous gems:
+        - [Capybara](https://github.com/teamcapybara/capybara): helps you test web applications by simulating how a real user would interact with your app. It is agnostic about the driver running your tests and comes with Rack::Test and Selenium support built in. WebKit is supported through an external gem.
+        - [Webdrivers](https://github.com/titusfortner/webdrivers): run Selenium tests more easily with automatic installation and updates for all supported webdrivers.
+
+        Place your system tests inside the `spec/system` directory.
+
+        To run system tests: `bin/rspec --tag type:system`

data/lib/potassium/assets/active_admin/policies/admin_user_policy.rb

@@ -0,0 +1,2 @@
+class BackOffice::AdminUserPolicy < BackOffice::DefaultPolicy
+end

data/lib/potassium/assets/active_admin/policies/comment_policy.rb

@@ -0,0 +1,2 @@
+class BackOffice::ActiveAdmin::CommentPolicy < BackOffice::DefaultPolicy
+end

data/lib/potassium/assets/active_admin/policies/default_policy.rb

@@ -0,0 +1,49 @@
+class BackOffice::DefaultPolicy
+  attr_reader :admin_user, :record
+
+  def initialize(admin_user, record)
+    @admin_user = admin_user
+    @record = record
+  end
+
+  def index?
+    true
+  end
+
+  def show?
+    true
+  end
+
+  def create?
+    true
+  end
+
+  def new?
+    create?
+  end
+
+  def update?
+    true
+  end
+
+  def edit?
+    update?
+  end
+
+  def destroy?
+    true
+  end
+
+  class Scope
+    attr_reader :admin_user, :scope
+
+    def initialize(admin_user, scope)
+      @admin_user = admin_user
+      @scope = scope
+    end
+
+    def resolve
+      scope.all
+    end
+  end
+end

data/lib/potassium/assets/active_admin/policies/page_policy.rb

@@ -0,0 +1,2 @@
+class BackOffice::ActiveAdmin::PagePolicy < BackOffice::DefaultPolicy
+end

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

@@ -4,7 +4,7 @@ import App from 'app';
 describe('App', () => {
   test('is a Vue instance', () => {
     const wrapper = shallowMount(App);
-    expect(wrapper.isVueInstance()).toBeTruthy();
+    expect(wrapper.vm).toBeTruthy();
   });
 
   it('displays message on load', () => {

data/lib/potassium/assets/app/views/shared/_gtm_body.html.erb

@@ -0,0 +1,4 @@
+<!-- Google Tag Manager (noscript) -->
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=<%= ENV['GTM_CONTAINER_ID'] %>"
+                  height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+<!-- End Google Tag Manager (noscript) -->

data/lib/potassium/assets/app/views/shared/_gtm_head.html.erb

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+        new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','<%=ENV['GTM_CONTAINER_ID']%>');</script>
+<!-- End Google Tag Manager -->

data/lib/potassium/assets/testing/.rspec

@@ -2,3 +2,4 @@
 --require rails_helper
 --format=doc
 --format=Nc
+--tag ~type:system

data/lib/potassium/assets/testing/devise_config.rb

@@ -0,0 +1,6 @@
+require 'devise'
+
+RSpec.configure do |config|
+  config.include Devise::Test::ControllerHelpers, type: :controller
+  config.include Devise::Test::IntegrationHelpers, type: :request
+end

data/lib/potassium/assets/testing/factory_bot_config.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/lib/potassium/assets/testing/faker_config.rb

@@ -0,0 +1 @@
+require 'faker'

data/lib/potassium/assets/testing/power_types_config.rb

@@ -0,0 +1 @@
+PowerTypes::Observable.observable_disabled = true

data/lib/potassium/assets/testing/rails_helper.rb

@@ -1,60 +1,141 @@
-# This file is copied to spec/ when you run 'rails generate rspec:install'
 ENV['RACK_ENV'] ||= 'test'
 require File.expand_path('../config/environment', __dir__)
 require 'rspec/rails'
 require 'spec_helper'
-require 'shoulda/matchers'
-require 'faker'
-# Add additional requires below this line. Rails is not loaded until this point!
-
-# Requires supporting ruby files with custom matchers and macros, etc, in
-# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
-# run as spec files by default. This means that files in spec/support that end
-# in _spec.rb will both be required and run as specs, causing the specs to be
-# run twice. It is recommended that you do not name files matching this glob to
-# end with _spec.rb. You can configure this pattern with the --pattern
-# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-#
-# The following line is provided for convenience purposes. It has the downside
-# of increasing the boot-up time by auto-requiring all files in the support
-# directory. Alternatively, in the individual `*_spec.rb` files, manually
-# require only the support files necessary.
-#
-Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
-
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.maintain_test_schema!
 
-PowerTypes::Observable.observable_disabled = true
+=begin
 
-RSpec.configure do |config|
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
+General
+=======
 
-  # RSpec Rails can automatically mix in different behaviours to your tests
-  # based on their file location, for example enabling you to call `get` and
-  # `post` in specs under `spec/controllers`.
-  #
-  # You can disable this behaviour by removing the line below, and instead
-  # explicitly tag your specs with their type, e.g.:
-  #
-  #     RSpec.describe UsersController, :type => :controller do
-  #       # ...
-  #     end
-  #
-  # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/docs
-  config.infer_spec_type_from_file_location!
+1) Place your unit tests inside the "spec" directory.
+2) Run unit tests executing `bin/guard`.
+3) Use support directories to add helpers and settings.
+   You can only put RSpec configuration on this file.
 
-  config.include FactoryBot::Syntax::Methods
-end
+Support
+-------
+
+* spec/support/configurations: put testing related gem settings here.
+
+  For example: spec/support/configurations/shoulda_matchers_config.rb
+
+  ----------------------------------------
+  require 'shoulda/matchers'
+
+  Shoulda::Matchers.configure do |config|
+    config.integrate do |with|
+      with.test_framework :rspec
+      with.library :rails
+    end
+  end
+  ----------------------------------------
+
+* spec/support/helpers: place here helpers created by you to use in your unit tests.
+
+  For example: spec/support/helpers/attachments_helpers.rb
+
+  ----------------------------------------------------------------------------------
+  module AttachmentsHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      def create_attachment_file(filename: "pikachu.png", content_type: "image/png")
+        Rack::Test::UploadedFile.new(file_fixture(filename), content_type)
+      end
+    end
+  end
+
+  RSpec.configure do |config|
+    config.fixture_path = "#{::Rails.root}/spec/assets"
+    config.file_fixture_path = "#{::Rails.root}/spec/assets"
+
+    config.include AttachmentsHelpers
+  end
+  ----------------------------------------------------------------------------------
+
+* spec/support/custom_matchers: place here your custom matchers
+  (https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/custom-matchers)
+
+* spec/support/shared_examples: place here your shared examples
+  (https://relishapp.com/rspec/rspec-core/v/3-10/docs/example-groups/shared-examples)
+
+System Tests
+============
+
+1) Place your system tests inside the "spec/system" directory.
+2) Run system tests executing `bin/rspec --tag type:system`.
+
+Support
+-------
+
+* spec/support/configurations/system_tests_config.rb: on this file you will find the
+  general configuration of the system tests. Keep in mind that this type of test will
+  run with the `selenium_chrome_headless` driver unless you put the `no_js` tag.
 
-Shoulda::Matchers.configure do |config|
-  config.integrate do |with|
-    with.test_framework :rspec
-    with.library :rails
+  For example: spec/system/login_spec.rb
+
+  ----------------------------------------------------------------------------
+  require "rails_helper"
+
+  RSpec.describe "Login" do
+    let!(:user) { create(:user, email: "lean@platan.us") }
+
+    context "without logged user", :no_js do # will use :rack_test driver
+      before { visit("/") }
+
+      it { expect(page).to have_text("Ingresa") }
+    end
+
+    context "with logged user" do # will use :selenium_chrome_headless driver
+      before { sign_in(user) }
+
+      it { expect(page).to have_text("Hola!") }
+    end
+  end
+  ----------------------------------------------------------------------------
+
+* spec/support/helpers/system: place here helpers created by you
+  to use in your system tests.
+
+  For example: spec/support/helpers/login_helpers.rb
+
+  ------------------------------------------------
+  module LoginHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      def sign_in(email, password)
+        visit('/users/sign_in')
+
+        within(:xpath, '//*[@id="new_user"]') do
+          fill_in('Email', with: email)
+          fill_in('Contraseña', with: password)
+        end
+
+        click_button('Ingresar')
+      end
+
+      def logout
+        visit('/users/sign_out')
+      end
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include LoginHelpers, type: :system
   end
+  ------------------------------------------------
+
+  Remember to include the system helpers with the tag `type: :system`
+=end
+
+Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |f| require f }
+
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_run_when_matching :focus unless Rails.env.production?
 end

data/lib/potassium/assets/testing/shoulda_matchers_config.rb

@@ -0,0 +1,8 @@
+require 'shoulda/matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end