potassium 6.4.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14355a0a57fd6a46a1cd70c835959c2bad07eb67ddf46406fab5d6d3b5ad1d7
-  data.tar.gz: 6c9d2885e8723911bfa0084feb4ab3a6697442314400ba4d3fc56c4117125cb8
+  metadata.gz: bf3d3969e70d29a2f2c15992c48f609ad389a486560fd6a16ea3a74871328a19
+  data.tar.gz: c1617bc3cba761408d2cba7419fbe4c68cb265a7438ea07b8c9b637944e3271d
 SHA512:
-  metadata.gz: 136691a7fc128bb7365594deee8187e1c6e72bebb098d59157cfdc7e82134c7d790a67e5ca49edc4c445472a28b57ead05752bf89a127825c0b1c3c68f245706
-  data.tar.gz: 33685ddf7b75156fa20dda246ad7b848a9f4dd247f877445596c347daf58e6b8ac8f61333e1315c526f85c7ed298ed01d1cf9ed4909a218006bd84dac972fc81
+  metadata.gz: 61cbdbbced51469867a32a83a97628f8ea4ccfb3290cc2b2e6e8a34f86e53a6e0478609326264b59324266b8db184cd449d921a9f17cc3f5a58be01eddb00e3b
+  data.tar.gz: '00900211ab3d5dcb75e4f45889778c752cda9f61a7e8d8cd0e264bb1ba678c50f8b9593f8bb98c3afd8b2fa554458cb639bfba202428a978976872cf45d291a5'

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 
-ruby-image: &ruby-image circleci/ruby:2.7.0-node
+ruby-image: &ruby-image cimg/ruby:2.7.4-node
 env-vars: &env-vars
   BUNDLE_JOBS: 4
   RAILS_ENV: test

data/.node-version

@@ -1 +1 @@
-12
+14

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-## Unreleased
+## 6.5.0
+
+Features
+  - Update node to latest LTS version, 14 [#363](https://github.com/platanus/potassium/pull/363)
+  - Update ActiveAdmin to 2.9 to fix CSV streaming issues [#384](https://github.com/platanus/potassium/pull/384)
+  - Separates Pundit's configuration for Active Admin from Application's configuration [#378](https://github.com/platanus/potassium/pull/378)
+  - Add SimpleCov recipe [#387](https://github.com/platanus/potassium/pull/387)
+  - Update Rails to 6.1 [#389](https://github.com/platanus/potassium/pull/389) & [#392](https://github.com/platanus/potassium/pull/392)
+  - Include `run_test` as a valid example group [#379](https://github.com/platanus/potassium/pull/379). This was added incorrectly in this [PR](https://github.com/platanus/potassium/pull/379).
+
+Fixes
+  - Remove rails_stdout_logging gem because it is no longer needed after Rails 5 and it was generating a deprecation warning [#325](https://github.com/platanus/potassium/pull/325)
 
 ## 6.4.0
 

data/README.md

@@ -93,7 +93,6 @@ The optional API support includes:
 
 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 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 `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`
@@ -129,7 +128,6 @@ Go to https://circleci.com/add-projects, choose the repository from the list and
 
 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
 [procfile]: https://devcenter.heroku.com/articles/procfile
 [heroku-buildpack-ruby-version]: http://github.com/platanus/heroku-buildpack-ruby-version

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

@@ -1,6 +1,6 @@
 version: 2.1
 
-ruby-image: &ruby-image circleci/ruby:<%= ruby_version %>
+ruby-image: &ruby-image cimg/ruby:<%= ruby_version %>
 <%- if selected?(:database, :postgresql) -%>
 postgres-image: &postgres-image postgres:<%= Potassium::POSTGRES_VERSION %>
 <%- end -%>
@@ -12,6 +12,9 @@ env-vars: &env-vars
   BUNDLE_PATH: vendor/bundle
   RAILS_ENV: test
 
+orbs:
+  browser-tools: circleci/browser-tools@1.1
+
 executors:
   test-executor:
     docker:
@@ -37,14 +40,19 @@ commands:
 
       - 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: |
@@ -62,12 +70,12 @@ commands:
             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
 
       - save_cache:
-          key: yarn-dependencies-{{ checksum "yarn.lock" }}
+          key: yarn-dependencies-{{ .Environment.YARN_CACHE_VERSION }}-{{ checksum "yarn.lock" }}
           paths:
             - node_modules
 
@@ -76,6 +84,8 @@ jobs:
     executor: test-executor
     steps:
       - setup
+      - browser-tools/install-chrome
+      - browser-tools/install-chromedriver
 
       <%- if selected?(:background_processor) -%>
       - run:
@@ -93,12 +103,25 @@ jobs:
       <%- end -%>
 
       - run:
-          name: Run rspec
+          name: Run RSpec unit tests
           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
 
+      - 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
@@ -113,11 +136,6 @@ jobs:
     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

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/README.yml

@@ -123,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."
@@ -153,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/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

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

@@ -0,0 +1,64 @@
+require 'simplecov'
+require 'simplecov_text_formatter'
+require 'simplecov_linter_formatter'
+
+SimpleCovLinterFormatter.setup do |config|
+  config.scope = ENV.fetch(
+    "SIMPLE_COV_LINTER_SCOPE", :own_changes
+  )
+  config.json_filename = ENV.fetch(
+    "SIMPLE_COV_LINTER_JSON_FILENAME", ".resultset.json"
+  )
+  config.summary_enabled = ENV.fetch(
+    "SIMPLE_COV_LINTER_SUMMARY_ENABLED", true
+  )
+  config.summary_enabled_bg = ENV.fetch(
+    "SIMPLE_COV_LINTER_SUMMARY_BG_ENABLED", true
+  )
+  config.summary_covered_bg_color = ENV.fetch(
+    "SIMPLE_COV_LINTER_SUMMARY_COVERED_BG_COLOR", :darkgreen
+  )
+  config.summary_not_covered_bg_color = ENV.fetch(
+    "SIMPLE_COV_LINTER_SUMMARY_NOT_COVERED_BG_COLOR", :firebrick
+  )
+  config.summary_text_color = ENV.fetch(
+    "SIMPLE_COV_LINTER_SUMMARY_TEXT_COLOR", :white
+  )
+  config.summary_files_sorting = ENV.fetch(
+    "SIMPLE_COV_LINTER_SUMMARY_FILES_SORTING", :coverage
+  )
+end
+
+SimpleCov.start 'rails' do
+  add_group 'Commands', 'app/commands'
+  add_group 'Services', 'app/services'
+  add_group 'Observers', 'app/observers'
+  add_group 'Policies', 'app/policies'
+  add_group 'Utils', 'app/utils'
+  add_group 'Extensions', 'app/extensions'
+
+  add_filter %r{app/controllers/([a-z]|_)*_controller.rb}
+  add_filter 'app/admin'
+  add_filter 'app/channels'
+  add_filter 'app/uploaders'
+  add_filter 'app/serializers'
+  add_filter 'app/clients'
+  add_filter 'app/helpers'
+  add_filter 'app/decorators'
+  add_filter 'app/responders'
+  add_filter 'lib/fake_data_loader.rb'
+  add_filter 'lib/vue_component.rb'
+
+  if ENV["CIRCLECI"]
+    formatter(SimpleCov::Formatter::TextFormatter)
+  else
+    formatter(
+      SimpleCov::Formatter::MultiFormatter.new(
+        [
+          SimpleCov::Formatter::LinterFormatter,
+          SimpleCov::Formatter::HTMLFormatter
+        ]
+      )
+    )
+  end
+end

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

@@ -0,0 +1,6 @@
+RSpec.configure do |config|
+  config.before(:each, type: :system) do |example|
+    driver = example.metadata[:no_js] ? :rack_test : :selenium_chrome_headless
+    driven_by(driver)
+  end
+end

data/lib/potassium/cli_options.rb

@@ -192,6 +192,14 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       negatable: true,
       default_value: false,
       default_test_value: true
+    },
+    {
+      type: :switch,
+      name: "spring",
+      desc: "Whether to use Spring",
+      negatable: true,
+      default_value: true,
+      default_test_value: false
     }
   ]
 

data/lib/potassium/recipes/admin.rb

@@ -32,7 +32,7 @@ class Recipes::Admin < Rails::AppBuilder
   private
 
   def add_active_admin
-    gather_gem 'activeadmin', '~> 2.6'
+    gather_gem 'activeadmin', '~> 2.9'
     gather_gem 'activeadmin_addons'
     add_readme_section :internal_dependencies, :active_admin
     after(:gem_install, wrap_in_action: :admin_install) do

data/lib/potassium/recipes/api.rb

@@ -38,7 +38,8 @@ class Recipes::Api < Rails::AppBuilder
     end
 
     add_readme_section :internal_dependencies, :power_api
-    append_to_file('.rubocop.yml', "RSpec:\n  Includes:\n    Examples:\n      - run_test!")
+    rubocop_example = "RSpec:\n  Language:\n    Includes:\n      Examples:\n        - run_test!"
+    append_to_file('.rubocop.yml', rubocop_example)
 
     after(:gem_install) do
       generate "power_api:install"

data/lib/potassium/recipes/coverage.rb

@@ -0,0 +1,35 @@
+class Recipes::Coverage < Rails::AppBuilder
+  def create
+    load_gems
+    configure_rails_helper
+    append_to_file('.gitignore', "/coverage/*\n")
+  end
+
+  def installed?
+    gem_exists?(/simplecov/)
+  end
+
+  def install
+    create
+  end
+
+  private
+
+  def load_gems
+    gather_gems(:test) do
+      gather_gem 'simplecov'
+      gather_gem 'simplecov_linter_formatter', '~> 0.2'
+      gather_gem 'simplecov_text_formatter'
+    end
+  end
+
+  def configure_rails_helper
+    copy_file '../assets/testing/simplecov_config.rb', 'spec/simplecov_config.rb'
+
+    after(:gem_install) do
+      gsub_file 'spec/rails_helper.rb', "ENV['RACK_ENV'] ||= 'test'" do |match|
+        "#{match}\nrequire 'simplecov_config'"
+      end
+    end
+  end
+end

data/lib/potassium/recipes/heroku.rb

@@ -24,14 +24,13 @@ class Recipes::Heroku < Rails::AppBuilder
   end
 
   def installed?
-    gem_exists?(/rails_stdout_logging/)
+    gem_exists?(/heroku-stage/)
   end
 
   private
 
   def add_heroku
     gather_gems(:production) do
-      gather_gem('rails_stdout_logging')
       gather_gem('heroku-stage')
     end
 

data/lib/potassium/recipes/pundit.rb

@@ -31,20 +31,39 @@ class Recipes::Pundit < Rails::AppBuilder
   end
 
   def install_admin_pundit
+    configure_active_admin_initializer
+    copy_policies
+  end
+
+  private
+
+  def configure_active_admin_initializer
+    config_active_admin_option("authorization_adapter", "ActiveAdmin::PunditAdapter")
+    config_active_admin_option("pundit_default_policy", "'BackOffice::DefaultPolicy'")
+    config_active_admin_option("pundit_policy_namespace", ":back_office")
+  end
+
+  def copy_policies
+    copy_policy("default_policy")
+    copy_policy("admin_user_policy")
+    copy_policy("page_policy", "active_admin")
+    copy_policy("comment_policy", "active_admin")
+  end
+
+  def config_active_admin_option(option, value)
     initializer = "config/initializers/active_admin.rb"
-    gsub_file initializer, /# config\.authorization_adapter =[^\n]+\n/ do
-      "config.authorization_adapter = ActiveAdmin::PunditAdapter\n"
+    gsub_file initializer, /# config\.#{option} =[^\n]+\n/ do
+      "config.#{option} = #{value}\n"
     end
-
-    template "../assets/active_admin/pundit_page_policy.rb",
-      "app/policies/active_admin/page_policy.rb"
-    template "../assets/active_admin/comment_policy.rb",
-      "app/policies/active_admin/comment_policy.rb"
-    template "../assets/active_admin/admin_user_policy.rb",
-      "app/policies/admin_user_policy.rb"
   end
 
-  private
+  def copy_policy(policy_name, model_namespace = nil)
+    destination_path = [model_namespace, policy_name].compact.join("/")
+    template(
+      "../assets/active_admin/policies/#{policy_name}.rb",
+      "app/policies/back_office/#{destination_path}.rb"
+    )
+  end
 
   def run_pundit_installer
     gather_gem 'pundit'

data/lib/potassium/recipes/rails.rb

@@ -1,10 +1,6 @@
 class Recipes::Rails < Rails::AppBuilder
   def create
     gather_gem("bootsnap", require: false)
-    gather_gems(:development) do
-      gather_gem("spring")
-    end
-
     environment 'config.force_ssl = true', env: 'production'
     disable_automatic_nonce_generation
   end

data/lib/potassium/recipes/spring.rb

@@ -0,0 +1,9 @@
+class Recipes::Spring < Rails::AppBuilder
+  def create
+    if answer(:spring)
+      gather_gems(:development) do
+        gather_gem("spring")
+      end
+    end
+  end
+end

data/lib/potassium/recipes/testing.rb

@@ -1,5 +1,76 @@
 class Recipes::Testing < Rails::AppBuilder
   def create
+    add_gems
+    add_readme_header(:testing)
+    recipe = self
+
+    after(:gem_install) do
+      recipe.install_rspec
+      recipe.install_guard
+      recipe.create_rspec_binary
+    end
+
+    config_raise_delivery_errors_option
+  end
+
+  def install_rspec
+    remove_dir 'test'
+    generate "rspec:install"
+    remove_file 'spec/rails_helper.rb'
+    copy_file '../assets/testing/rails_helper.rb', 'spec/rails_helper.rb'
+    remove_file '.rspec'
+    copy_file '../assets/testing/.rspec', '.rspec'
+    create_file 'spec/system/.keep'
+    create_support_directories
+  end
+
+  def create_support_directories
+    %w{
+      custom_matchers
+      shared_examples
+      configurations
+      helpers
+      helpers/system
+    }.each do |directory|
+      path = "spec/support/#{directory}"
+      empty_directory(path)
+      create_file("#{path}/.keep")
+    end
+
+    add_support_configuration_modules
+  end
+
+  def add_support_configuration_modules
+    files = %w{
+      faker_config
+      factory_bot_config
+      power_types_config
+      shoulda_matchers_config
+      system_tests_config
+    }
+    files << "devise_config" if selected?(:authentication)
+    files.each do |config_module|
+      copy_file(
+        "../assets/testing/#{config_module}.rb",
+        "spec/support/configurations/#{config_module}.rb"
+      )
+    end
+  end
+
+  def install_guard
+    run "bundle exec guard init"
+    run "bundle binstub guard"
+    line = /guard :rspec, cmd: "bundle exec rspec" do\n/
+    gsub_file 'Guardfile', line do
+      "guard :rspec, cmd: \"bin/rspec\" do\n"
+    end
+  end
+
+  def create_rspec_binary
+    run "bundle binstubs rspec-core"
+  end
+
+  def add_gems
     gather_gems(:development, :test) do
       gather_gem('rspec-rails')
       gather_gem('factory_bot_rails')
@@ -10,26 +81,12 @@ class Recipes::Testing < Rails::AppBuilder
 
     gather_gems(:test) do
       gather_gem('shoulda-matchers', require: false)
+      gather_gem('capybara')
+      gather_gem('webdrivers')
     end
+  end
 
-    after(:gem_install) do
-      remove_dir 'test'
-
-      generate "rspec:install"
-
-      remove_file 'spec/rails_helper.rb'
-      copy_file '../assets/testing/rails_helper.rb', 'spec/rails_helper.rb'
-
-      remove_file '.rspec'
-      copy_file '../assets/testing/.rspec', '.rspec'
-
-      empty_directory 'spec/support'
-      create_file 'spec/support/.keep'
-
-      run "bundle exec guard init"
-      run "bundle binstubs rspec-core"
-    end
-
+  def config_raise_delivery_errors_option
     raise_delivery_errors_regexp = /config.action_mailer.raise_delivery_errors = false\n/
     gsub_file 'config/environments/development.rb', raise_delivery_errors_regexp do
       "config.action_mailer.raise_delivery_errors = true"

data/lib/potassium/templates/application.rb

@@ -38,6 +38,7 @@ end
 
 run_action(:recipe_loading) do
   create :rails
+  create :spring
   create :readme
   create :heroku
   create :ci
@@ -65,6 +66,7 @@ run_action(:recipe_loading) do
   create :error_reporting
   create :pundit
   create :testing
+  create :coverage
   create :secrets
   create :api
   create :draper

data/lib/potassium/version.rb

@@ -1,12 +1,12 @@
 module Potassium
-  VERSION = "6.4.0"
+  VERSION = "6.5.0"
   RUBY_VERSION = "2.7.0"
-  RAILS_VERSION = "~> 6.0.2"
+  RAILS_VERSION = "~> 6.1.4.4"
   RUBOCOP_VERSION = "~> 1.9"
   RUBOCOP_RSPEC_VERSION = "~> 2.2"
   POSTGRES_VERSION = "11.3"
   MYSQL_VERSION = "5.7"
-  NODE_VERSION = "12"
+  NODE_VERSION = "14"
   TAILWINDCSS = "npm:@tailwindcss/postcss7-compat"
   VUE_LOADER_VERSION = "^15.9.7"
 end

data/spec/features/ci_spec.rb

@@ -12,6 +12,6 @@ RSpec.describe 'CI' 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')
+    expect(content).to include('cimg/ruby', 'cache', 'rspec', 'reviewdog')
   end
 end

data/spec/features/coverage_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+RSpec.describe "Coverage" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project
+  end
+
+  it "adds simplecov related gems to Gemfile" do
+    content = IO.read("#{project_path}/Gemfile")
+    expect(content).to include("gem 'simplecov'")
+    expect(content).to include("gem 'simplecov_linter_formatter'")
+    expect(content).to include("gem 'simplecov_text_formatter'")
+  end
+
+  it "requires simplecov config file before rails" do
+    content = IO.read("#{project_path}/spec/rails_helper.rb")
+    expect(content).to include("ENV['RACK_ENV'] ||= 'test'\nrequire 'simplecov_config'")
+  end
+
+  it "adds simplecov config file" do
+    content = IO.read("#{project_path}/spec/simplecov_config.rb")
+    expect(content).to include("SimpleCov.start 'rails'")
+  end
+end

data/spec/features/heroku_spec.rb

@@ -10,10 +10,6 @@ RSpec.describe "Heroku" do
     create_dummy_project("heroku" => true)
     app_name = PotassiumTestHelpers::APP_NAME.dasherize
 
-    expect(FakeHeroku).to(
-      have_gem_included(project_path, "rails_stdout_logging")
-    )
-
     procfile_path = "#{project_path}/Procfile"
     procfile = IO.read(procfile_path)
 

data/spec/features/node_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe "Node" do
-  let(:version) { "12" }
+  let(:version) { "14" }
 
   before(:all) do
     drop_dummy_database

data/spec/features/pundit_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+RSpec.describe "Pundit" do
+  before :all do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project("pundit" => true, "devise" => true, "admin" => true)
+  end
+
+  it "adds the Pundit gem to Gemfile" do
+    content = IO.read("#{project_path}/Gemfile")
+
+    expect(content).to include("gem 'pundit'")
+  end
+
+  it "setup active admin" do
+    content = IO.read("#{project_path}/config/initializers/active_admin.rb")
+
+    expect(content).to include("config.authorization_adapter = ActiveAdmin::PunditAdapter")
+    expect(content).to include("config.pundit_default_policy = 'BackOffice::DefaultPolicy'")
+    expect(content).to include("config.pundit_policy_namespace = :back_office")
+  end
+
+  it "creates default policy" do
+    content = IO.read("#{project_path}/app/policies/back_office/default_policy.rb")
+
+    expect(content).to include("class BackOffice::DefaultPolicy")
+  end
+
+  it "modifies the README file" do
+    readme = IO.read("#{project_path}/README.md")
+    expect(readme).to include("from `BackOffice::DefaultPolicy`")
+  end
+end

data/spec/features/testing_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+RSpec.describe "Testing" do
+  let(:gemfile_content) { IO.read("#{project_path}/Gemfile") }
+  let(:rails_helper_content) { IO.read("#{project_path}/spec/rails_helper.rb") }
+  let(:rspec_content) { IO.read("#{project_path}/.rspec") }
+
+  let(:support_directories) do
+    %w{
+      custom_matchers
+      shared_examples
+      configurations
+      helpers
+    }
+  end
+
+  let(:conf_files) do
+    %w{
+      factory_bot_config.rb
+      power_types_config.rb
+      shoulda_matchers_config.rb
+      devise_config.rb
+      system_tests_config.rb
+      faker_config.rb
+    }
+  end
+
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    create_dummy_project(devise: true)
+  end
+
+  it { expect(gemfile_content).to include("gem 'rspec-rails'") }
+  it { expect(gemfile_content).to include('rspec-rails') }
+  it { expect(gemfile_content).to include('factory_bot_rails') }
+  it { expect(gemfile_content).to include('faker') }
+  it { expect(gemfile_content).to include('guard-rspec') }
+  it { expect(gemfile_content).to include('rspec-nc') }
+  it { expect(gemfile_content).to include('shoulda-matchers') }
+  it { expect(gemfile_content).to include('capybara') }
+  it { expect(gemfile_content).to include('webdrivers') }
+
+  it { expect(rails_helper_content).to include("require 'spec_helper'") }
+  it { expect(rails_helper_content).to include("config.filter_run_when_matching :focus") }
+
+  it { expect(rspec_content).to include("--require rails_helper") }
+  it { expect(Dir.entries("#{project_path}/spec/support")).to include(*support_directories) }
+  it { expect(Dir.entries("#{project_path}/spec/support/configurations")).to include(*conf_files) }
+
+  it { expect(IO.read("#{project_path}/bin/rspec")).to include('path("rspec-core", "rspec")') }
+  it { expect(IO.read("#{project_path}/Guardfile")).to include(':rspec, cmd: "bin/rspec"') }
+  it { expect(IO.read("#{project_path}/bin/guard")).to include('path("guard", "guard")') }
+
+  it { expect(IO.read("#{project_path}/README.md")).to include("To run unit test") }
+end

data/spec/support/potassium_test_helpers.rb

@@ -17,7 +17,7 @@ module PotassiumTestHelpers
 
   def create_dummy_project(arguments = {})
     Dir.chdir(tmp_path) do
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         add_fakes_to_path
         add_project_bin_to_path
         full_arguments = hash_to_arguments(create_arguments(true).merge(arguments))
@@ -46,7 +46,7 @@ module PotassiumTestHelpers
 
   def on_project(&block)
     Dir.chdir(project_path) do
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         block.call
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potassium
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.5.0
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.1.4.4
 - !ruby/object:Gem::Dependency
   name: semantic
   requirement: !ruby/object:Gem::Requirement
@@ -277,10 +277,11 @@ files:
 - lib/potassium/assets/README.yml
 - lib/potassium/assets/active_admin/admin-component.vue
 - lib/potassium/assets/active_admin/admin_application.js
-- lib/potassium/assets/active_admin/admin_user_policy.rb
-- lib/potassium/assets/active_admin/comment_policy.rb
 - lib/potassium/assets/active_admin/init_activeadmin_vue.rb
-- lib/potassium/assets/active_admin/pundit_page_policy.rb
+- lib/potassium/assets/active_admin/policies/admin_user_policy.rb
+- lib/potassium/assets/active_admin/policies/comment_policy.rb
+- lib/potassium/assets/active_admin/policies/default_policy.rb
+- lib/potassium/assets/active_admin/policies/page_policy.rb
 - lib/potassium/assets/app/graphql/graphql_controller.rb
 - lib/potassium/assets/app/graphql/mutations/login_mutation.rb
 - lib/potassium/assets/app/graphql/queries/base_query.rb
@@ -325,8 +326,15 @@ files:
 - lib/potassium/assets/sidekiq.rb.erb
 - lib/potassium/assets/sidekiq.yml
 - lib/potassium/assets/testing/.rspec
+- lib/potassium/assets/testing/devise_config.rb
+- lib/potassium/assets/testing/factory_bot_config.rb
+- lib/potassium/assets/testing/faker_config.rb
 - lib/potassium/assets/testing/platanus.png
+- lib/potassium/assets/testing/power_types_config.rb
 - lib/potassium/assets/testing/rails_helper.rb
+- lib/potassium/assets/testing/shoulda_matchers_config.rb
+- lib/potassium/assets/testing/simplecov_config.rb
+- lib/potassium/assets/testing/system_tests_config.rb
 - lib/potassium/cli.rb
 - lib/potassium/cli/commands/create.rb
 - lib/potassium/cli/commands/install.rb
@@ -354,6 +362,7 @@ files:
 - lib/potassium/recipes/better_errors.rb
 - lib/potassium/recipes/ci.rb
 - lib/potassium/recipes/cleanup.rb
+- lib/potassium/recipes/coverage.rb
 - lib/potassium/recipes/data_migrate.rb
 - lib/potassium/recipes/database.rb
 - lib/potassium/recipes/database_container.rb
@@ -384,6 +393,7 @@ files:
 - lib/potassium/recipes/script.rb
 - lib/potassium/recipes/secrets.rb
 - lib/potassium/recipes/seeds.rb
+- lib/potassium/recipes/spring.rb
 - lib/potassium/recipes/style.rb
 - lib/potassium/recipes/testing.rb
 - lib/potassium/recipes/tzinfo.rb
@@ -401,6 +411,7 @@ files:
 - spec/features/api_spec.rb
 - spec/features/background_processor_spec.rb
 - spec/features/ci_spec.rb
+- spec/features/coverage_spec.rb
 - spec/features/data_migrate_spec.rb
 - spec/features/database_container_spec.rb
 - spec/features/database_spec.rb
@@ -417,7 +428,9 @@ files:
 - spec/features/new_project_spec.rb
 - spec/features/node_spec.rb
 - spec/features/power_types_spec.rb
+- spec/features/pundit_spec.rb
 - spec/features/schedule_spec.rb
+- spec/features/testing_spec.rb
 - spec/features/vue_admin_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_github.rb
@@ -444,7 +457,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: An application generator from Platanus
@@ -454,6 +467,7 @@ test_files:
 - spec/features/api_spec.rb
 - spec/features/background_processor_spec.rb
 - spec/features/ci_spec.rb
+- spec/features/coverage_spec.rb
 - spec/features/data_migrate_spec.rb
 - spec/features/database_container_spec.rb
 - spec/features/database_spec.rb
@@ -470,7 +484,9 @@ test_files:
 - spec/features/new_project_spec.rb
 - spec/features/node_spec.rb
 - spec/features/power_types_spec.rb
+- spec/features/pundit_spec.rb
 - spec/features/schedule_spec.rb
+- spec/features/testing_spec.rb
 - spec/features/vue_admin_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_github.rb

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

@@ -1,2 +0,0 @@
-class AdminUserPolicy < ApplicationPolicy
-end

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

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

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

@@ -1,5 +0,0 @@
-class ActiveAdmin::PagePolicy < ApplicationPolicy
-  def show?
-    true
-  end
-end