potassium 6.1.0 → 6.5.0

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

@@ -97,10 +97,10 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       default_test_value: false
     },
     {
-      type: :flag,
+      type: :switch,
       name: "background_processor",
-      desc: "Decides which background processor to use. Available: sidekiq, delayed_job, none",
-      default_test_value: "None"
+      desc: "Whether to use Sidekiq for background processing or not",
+      default_test_value: false
     },
     {
       type: :switch,
@@ -177,6 +177,14 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       desc: "Decides which front-end framework to use. Available: Vue, Angular 2, None",
       default_test_value: "None"
     },
+    {
+      type: :switch,
+      name: 'google_tag_manager',
+      desc: 'Whether to use google tag manager',
+      negatable: true,
+      default_value: 'none',
+      default_test_value: false
+    },
     {
       type: :switch,
       name: "test",
@@ -184,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/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/admin.rb

@@ -32,12 +32,11 @@ class Recipes::Admin < Rails::AppBuilder
   private
 
   def add_active_admin
-    gather_gem 'activeadmin', '~> 2.6'
+    gather_gem 'activeadmin', '~> 2.9'
     gather_gem 'activeadmin_addons'
-    gather_gem 'active_skin', github: 'SoftwareBrothers/active_skin'
     add_readme_section :internal_dependencies, :active_admin
     after(:gem_install, wrap_in_action: :admin_install) do
-      generate "active_admin:install"
+      generate "active_admin:install --use_webpacker"
       line = "ActiveAdmin.setup do |config|"
       initializer = "config/initializers/active_admin.rb"
       gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
@@ -50,26 +49,37 @@ class Recipes::Admin < Rails::AppBuilder
           end\n
           ActiveAdmin.setup do |config|
             config.view_factory.footer = CustomFooter
+            meta_tags_options = { viewport: 'width=device-width, initial-scale=1' }
+            config.meta_tags = meta_tags_options
+            config.meta_tags_for_logged_out_pages = meta_tags_options
         HERE
       end
 
-      line = "@import \"active_admin/base\";"
-      style = "app/assets/stylesheets/active_admin.css.scss"
-      style = File.exist?(style) ? style : "app/assets/stylesheets/active_admin.scss"
+      generate "activeadmin_addons:install"
 
-      gsub_file style, /(#{Regexp.escape(line)})/mi do |_match|
-        <<~HERE
-          #{line}
-          $skinActiveColor: #001CEE;
-          $skinHeaderBck: #002744;
-          $panelHeaderBck: #002744;
-          //$skinLogo: $skinHeaderBck image-url("logo_admin.png") no-repeat center center;
+      run "bin/yarn add arctic_admin @fortawesome/fontawesome-free"
 
-          @import "active_skin";
-        HERE
-      end
+      aa_style = "app/javascript/stylesheets/active_admin.scss"
 
-      generate "activeadmin_addons:install"
+      gsub_file(
+        aa_style,
+        "@import \"~@activeadmin/activeadmin/src/scss/mixins\";\n" +
+        "@import \"~@activeadmin/activeadmin/src/scss/base\";",
+        "@import '~arctic_admin/src/scss/main'; \n"
+      )
+
+      aa_js = "app/javascript/packs/active_admin.js"
+      js_line = "import \"@activeadmin/activeadmin\";\n"
+
+      gsub_file(
+        aa_js,
+        js_line,
+        <<~HERE
+          #{js_line}
+          import '@fortawesome/fontawesome-free/css/all.css';
+          import 'arctic_admin';
+        HERE
+      )
     end
   end
 end

data/lib/potassium/recipes/api.rb

@@ -38,6 +38,8 @@ class Recipes::Api < Rails::AppBuilder
     end
 
     add_readme_section :internal_dependencies, :power_api
+    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/background_processor.rb

@@ -1,12 +1,12 @@
 class Recipes::BackgroundProcessor < Rails::AppBuilder
   def ask
-    response = if selected?(:email_service, :none)
+    response = if enabled_mailer?
+                 info "Note: Emails should be sent on background jobs. We'll install sidekiq"
+                 true
+               else
                  answer(:background_processor) do
                    Ask.confirm("Do you want to use Sidekiq for background job processing?")
                  end
-               else
-                 info "Note: Emails should be sent on background jobs. We'll install sidekiq"
-                 true
                end
     set(:background_processor, response)
   end
@@ -30,6 +30,42 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
     gem_exists?(/sidekiq/)
   end
 
+  def add_sidekiq
+    recipe = self
+    run_action(:install_sidekiq) do
+      gather_gem("sidekiq")
+      recipe.add_adapters("sidekiq")
+      add_readme_section :internal_dependencies, :sidekiq
+      recipe.edit_procfile("bundle exec sidekiq")
+      append_to_file(".env.development", "DB_POOL=25\n")
+      template("../assets/sidekiq.rb.erb", "config/initializers/sidekiq.rb", force: true)
+      copy_file("../assets/sidekiq.yml", "config/sidekiq.yml", force: true)
+      copy_file("../assets/redis.yml", "config/redis.yml", force: true)
+      recipe.mount_sidekiq_routes
+    end
+  end
+
+  def edit_procfile(cmd)
+    heroku = load_recipe(:heroku)
+    if selected?(:heroku) || heroku.installed?
+      gsub_file('Procfile', /^.*$/m) { |match| "#{match}worker: #{cmd}" }
+    end
+  end
+
+  def add_adapters(name)
+    application("config.active_job.queue_adapter = :#{name}")
+    application "config.active_job.queue_adapter = :async", env: "development"
+    application "config.active_job.queue_adapter = :test", env: "test"
+  end
+
+  def mount_sidekiq_routes
+    insert_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
+      <<-HERE.gsub(/^ {6}/, '')
+        mount Sidekiq::Web => '/queue'
+      HERE
+    end
+  end
+
   private
 
   def add_docker_compose_redis_config
@@ -59,33 +95,8 @@ class Recipes::BackgroundProcessor < Rails::AppBuilder
     )
   end
 
-  def add_sidekiq
-    gather_gem("sidekiq")
-    add_adapters("sidekiq")
-    add_readme_section :internal_dependencies, :sidekiq
-    edit_procfile("bundle exec sidekiq")
-    append_to_file(".env.development", "DB_POOL=25\n")
-    template("../assets/sidekiq.rb.erb", "config/initializers/sidekiq.rb", force: true)
-    copy_file("../assets/sidekiq.yml", "config/sidekiq.yml", force: true)
-    copy_file("../assets/redis.yml", "config/redis.yml", force: true)
-
-    insert_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
-      <<-HERE.gsub(/^ {6}/, '')
-        mount Sidekiq::Web => '/queue'
-      HERE
-    end
-  end
-
-  def edit_procfile(cmd)
-    heroku = load_recipe(:heroku)
-    if selected?(:heroku) || heroku.installed?
-      gsub_file('Procfile', /^.*$/m) { |match| "#{match}worker: #{cmd}" }
-    end
-  end
-
-  def add_adapters(name)
-    application("config.active_job.queue_adapter = :#{name}")
-    application "config.active_job.queue_adapter = :async", env: "development"
-    application "config.active_job.queue_adapter = :test", env: "test"
+  def enabled_mailer?
+    mailer_answer = get(:email_service)
+    mailer_answer && ![:none, :None].include?(mailer_answer.to_sym)
   end
 end

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

@@ -1,4 +1,6 @@
 class Recipes::FrontEnd < Rails::AppBuilder
+  VUE_LOADER_VERSION = Potassium::VUE_LOADER_VERSION
+
   def ask
     frameworks = {
       vue: "Vue",
@@ -15,21 +17,13 @@ class Recipes::FrontEnd < Rails::AppBuilder
   end
 
   def create
-    return if [:none, :None].include? get(:front_end).to_sym
-
     recipe = self
     after(:gem_install) do
       value = get(:front_end)
       run "rails webpacker:install"
-      run "rails webpacker:install:#{value}" if value
-
-      if value == :vue
-        recipe.setup_vue_with_compiler_build
-        recipe.setup_jest
-        if get(:api) == :graphql
-          recipe.setup_apollo
-        end
-      end
+      run "rails webpacker:install:#{value}" unless [:none, :None].include? value.to_sym
+
+      recipe.setup_vue if value == :vue
       recipe.add_responsive_meta_tag
       recipe.setup_tailwind
       add_readme_header :webpack
@@ -69,7 +63,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
@@ -107,6 +102,19 @@ class Recipes::FrontEnd < Rails::AppBuilder
     )
   end
 
+  def foce_vue_loader_version
+    run "bin/yarn add vue-loader@#{VUE_LOADER_VERSION}"
+  end
+
+  def setup_vue
+    foce_vue_loader_version
+    setup_vue_with_compiler_build
+    setup_jest
+    if get(:api) == :graphql
+      setup_apollo
+    end
+  end
+
   private
 
   def frameworks(framework)
@@ -147,6 +155,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 +276,8 @@ class Recipes::FrontEnd < Rails::AppBuilder
         },
         "snapshotSerializers": [
           "<rootDir>/node_modules/jest-serializer-vue"
-        ]
+        ],
+        "testEnvironment": "jsdom"
       }
     }
   end

data/lib/potassium/recipes/google_tag_manager.rb

@@ -0,0 +1,94 @@
+class Recipes::GoogleTagManager < Rails::AppBuilder
+  def ask
+    use_google_tag_manager = answer(:google_tag_manager) do
+      Ask.confirm 'Do you want to use Google Tag Manager?'
+    end
+
+    set(:google_tag_manager, use_google_tag_manager)
+  end
+
+  def create
+    install if selected?(:google_tag_manager)
+  end
+
+  def install
+    add_google_tag_manager
+  end
+
+  def add_google_tag_manager
+    copy_tag_manager_files
+    append_to_file '.env.development', "GTM_CONTAINER_ID=\n"
+    include_tag_manager
+    add_content_security_policy
+  end
+
+  def add_content_security_policy
+    inject_into_file(
+      'config/initializers/content_security_policy.rb',
+      content_security_policy_code
+    )
+  end
+
+  def copy_tag_manager_files
+    copy_file(
+      '../assets/app/views/shared/_gtm_head.html.erb',
+      'app/views/shared/_gtm_head.html.erb',
+      force: true
+    )
+
+    copy_file(
+      '../assets/app/views/shared/_gtm_body.html.erb',
+      'app/views/shared/_gtm_body.html.erb',
+      force: true
+    )
+  end
+
+  def include_tag_manager
+    inject_into_file(
+      'app/views/layouts/application.html.erb',
+      render_string('shared/gtm_head'),
+      before: '</head>'
+    )
+
+    inject_into_file(
+      'app/views/layouts/application.html.erb',
+      render_string('shared/gtm_body'),
+      after: '<body>'
+    )
+  end
+
+  private
+
+  def render_string(file_path)
+    "  <%if Rails.env.production? %>
+      <%= render \"#{file_path}\" %>
+    <% end %>\n  "
+  end
+
+  def content_security_policy_code
+    <<~HERE
+      Rails.application.config.content_security_policy do |policy|
+        policy.connect_src(
+          :self,
+          :https,
+          'http://localhost:3035',
+          'ws://localhost:3035',
+          'https://www.google-analytics.com'
+        )
+        # google tag manager requires to enable unsafe inline and vue unsave eval:
+        # https://developers.google.com/tag-manager/web/csp
+        # https://vuejs.org/v2/guide/installation.html#CSP-environments
+        policy.script_src(
+          :self,
+          :https,
+          :unsafe_inline,
+          :unsafe_eval,
+          'https://www.googletagmanager.com',
+          'https://www.google-analytics.com',
+          'https://ssl.google-analytics.com'
+        )
+        policy.img_src :self, :https, 'https://www.googletagmanager.com', 'https://www.google-analytics.com'
+      end
+    HERE
+  end
+end