potassium 6.1.0 → 6.2.0

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## 6.2.0
+
+Features:
+  - Add Google Tag Manager [#326](https://github.com/platanus/potassium/pull/326)
+  - Update rubocop and rubocop-rspec for potassium and generated projects [#337](https://github.com/platanus/potassium/pull/337)
+  - Adds `mailers` queue to `sidekiq.yml` when installing or creating mailer recipe [#341](https://github.com/platanus/potassium/pull/341)
+
+Fixes:
+  - Change `backgroud_processor` cli option to a switch. As of [#137](https://github.com/platanus/potassium/pull/137) we no longer have `delayed_jobs` as an option, it's only `sidekiq` now [#340](https://github.com/platanus/potassium/pull/340)
+  - Fixes mailer recipe install when background_processor wasn't installed [#341](https://github.com/platanus/potassium/pull/341)
+  - Update `heroku` recipe to check if an app or pipeline name is valid before creating it on Heroku [#344](https://github.com/platanus/potassium/pull/344)
+
 ## 6.1.0
 
 Features:

data/README.md

@@ -60,13 +60,13 @@ The following optional integrations are also added:
 - [ActiveAdmin](http://activeadmin.info) for admin interfaces
 - [ActiveAdminAddons](https://github.com/platanus/activeadmin_addons) for some help with ActiveAdmin
 - [Pundit](https://github.com/elabs/pundit) for role-based authorization
-- [DelayedJob](https://github.com/collectiveidea/delayed_job) to execute longer tasks in the background
 - [Sidekiq](https://github.com/mperham/sidekiq) a simple, efficient background processing for Ruby
 - [Sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler) to run scheduled processes
 - Mailing configuration for [AWS SES](https://github.com/aws/aws-sdk-rails)
   and [Sendgrid](https://github.com/platanus/send_grid_mailer) with recipient interceptor support
 - [Sentry](https://sentry.io) to monitor exceptions and errors
 - [Vue.js](https://vuejs.org) or [Angular 2](https://angular.io/) for frontend development
+- [Google Tag Manager](https://tagmanager.google.com/) for analytics
 - Creates the Github repository of your choice for the project. A local git repository will always be created.
 
 A few more things are added to the project:

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

@@ -112,9 +112,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)"

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

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/google_tag_manager.rb

@@ -0,0 +1,90 @@
+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|
+        if Rails.env.development?
+          policy.connect_src :self, :https, 'http://localhost:3035', 'ws://localhost:3035'
+          policy.script_src :self, :https, :unsafe_eval
+        else
+          policy.script_src :self, :https
+          # google tag manager requires to enable unsafe inline:
+          # https://developers.google.com/tag-manager/web/csp
+          policy.connect_src :self, :https, 'https://www.google-analytics.com'
+          policy.script_src :self,
+            :https,
+            :unsafe_inline,
+            '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
+      end
+    HERE
+  end
+end

data/lib/potassium/recipes/heroku.rb

@@ -1,13 +1,7 @@
 class Recipes::Heroku < Rails::AppBuilder
   NAME_PREFIX = 'pl'
-
-  attr_accessor :app_name_staging
-
-  def initialize(args)
-    super(args)
-    set(:heroku_app_name_staging, app_name_for('staging'))
-    set(:heroku_app_name_production, app_name_for('production'))
-  end
+  ENVIRONMENTS = ['staging', 'production']
+  HEROKU_NAMES_MAX_CHARS = 30
 
   def ask
     heroku = answer(:heroku) do
@@ -16,6 +10,8 @@ class Recipes::Heroku < Rails::AppBuilder
 
     if heroku
       set(:heroku, heroku)
+
+      ENVIRONMENTS.each { |environment| set_app_name_for(environment) }
     end
   end
 
@@ -47,31 +43,34 @@ class Recipes::Heroku < Rails::AppBuilder
     template "../assets/bin/setup_heroku.erb", "bin/setup_heroku", force: true
     run "chmod a+x bin/setup_heroku"
 
-    if logged_in?
-      %w(staging production).each do |environment|
-        create_app_on_heroku(environment)
-      end
-      puts "Remember to connect the github repository to the new pipeline"
-      open_pipeline_command = "\e[33mheroku pipelines:open #{heroku_pipeline_name}\e[0m"
-      puts "run #{open_pipeline_command} to open the dashboard"
-    else
-      puts "You are not logged in into heroku"
-      login_command = "\e[33mheroku login\e[0m"
-      puts "Run #{login_command} and enter your credentials"
-      puts "You can install the heroku recipe again create the app in heroku"
-      install_command = "\e[33mpostassium install heroku --force\e[0m"
-      puts "Just run #{install_command}"
-    end
+    logged_in? ? create_apps : puts_not_logged_in_msg
 
     add_readme_header :deployment
   end
 
+  def create_apps
+    ENVIRONMENTS.each { |environment| create_app_on_heroku(environment) }
+    puts "Remember to connect the github repository to the new pipeline"
+    open_pipeline_command = "\e[33mheroku pipelines:open #{heroku_pipeline_name}\e[0m"
+    puts "run #{open_pipeline_command} to open the dashboard"
+  end
+
+  def puts_not_logged_in_msg
+    puts "You are not logged in into heroku"
+    login_command = "\e[33mheroku login\e[0m"
+    puts "Run #{login_command} and enter your credentials"
+    puts "You can install the heroku recipe again to create the app in heroku"
+    install_command = "\e[33mpostassium install heroku --force\e[0m"
+    puts "Just run #{install_command}"
+  end
+
   def heroku_pipeline_name
-    app_name.dasherize
+    @heroku_pipeline_name ||= valid_heroku_name(app_name.dasherize, 'pipeline', false)
   end
 
-  def app_name_for(environment)
-    "#{NAME_PREFIX}-#{app_name.dasherize}-#{environment}"
+  def set_app_name_for(environment)
+    default_name = "#{NAME_PREFIX}-#{app_name.dasherize}-#{environment}"
+    set("heroku_app_name_#{environment}".to_sym, valid_heroku_name(default_name, environment))
   end
 
   def logged_in?
@@ -84,7 +83,7 @@ class Recipes::Heroku < Rails::AppBuilder
 
   def create_app_on_heroku(environment)
     rack_env = "RACK_ENV=production"
-    staged_app_name = app_name_for(environment)
+    staged_app_name = get("heroku_app_name_#{environment}".to_sym)
 
     run_toolbelt_command "create #{staged_app_name} --remote #{environment}"
     run_toolbelt_command "labs:enable runtime-dyno-metadata", staged_app_name
@@ -99,14 +98,14 @@ class Recipes::Heroku < Rails::AppBuilder
   def set_rails_secrets(environment)
     run_toolbelt_command(
       "config:add SECRET_KEY_BASE=#{generate_secret}",
-      app_name_for(environment)
+      get("heroku_app_name_#{environment}".to_sym)
     )
   end
 
   def set_app_multi_buildpack(environment)
     run_toolbelt_command(
       "buildpacks:set https://github.com/heroku/heroku-buildpack-multi.git",
-      app_name_for(environment)
+      get("heroku_app_name_#{environment}".to_sym)
     )
   end
 
@@ -133,4 +132,18 @@ class Recipes::Heroku < Rails::AppBuilder
       `heroku #{command} --app #{app_env_name}`
     end
   end
+
+  def valid_heroku_name(name, element, force_suffix = true)
+    suffix = "-#{element}"
+    while name.length > HEROKU_NAMES_MAX_CHARS
+      puts "Heroku names must be shorter than #{HEROKU_NAMES_MAX_CHARS} chars."
+      if force_suffix
+        puts "Potassium uses the heroku-stage gem, because of that '#{suffix}' will be "\
+             "added to your app name. The suffix, #{suffix}, counts towards the app name length."
+      end
+      name = Ask.input("Please enter a valid name for #{element}:")
+      name += suffix if force_suffix && !name.end_with?(suffix)
+    end
+    name
+  end
 end

data/lib/potassium/recipes/mailer.rb

@@ -24,11 +24,7 @@ class Recipes::Mailer < Rails::AppBuilder
     dependencies(email_service)
     config(email_service)
 
-    background_processor_recipe = load_recipe(:background_processor)
-    background_processor_answer = get(:background_processor)
-
-    background_processor_recipe.add_sidekiq unless background_processor_recipe.installed? ||
-      background_processor_answer
+    ensure_sidekiq_install_and_add_mailers_queue
   end
 
   def install
@@ -36,6 +32,10 @@ class Recipes::Mailer < Rails::AppBuilder
     create
   end
 
+  def add_mailer_queue
+    insert_into_file "config/sidekiq.yml", "  - mailers", after: "- default\n"
+  end
+
   private
 
   def email_services(service_name)
@@ -102,4 +102,17 @@ class Recipes::Mailer < Rails::AppBuilder
     gather_gems(:development) { gather_gem("letter_opener") }
     application "config.action_mailer.delivery_method = :letter_opener", env: "development"
   end
+
+  def ensure_sidekiq_install_and_add_mailers_queue
+    background_processor_recipe = load_recipe(:background_processor)
+    background_processor_answer = get(:background_processor)
+
+    if background_processor_recipe.installed?
+      add_mailer_queue
+    else
+      recipe = self
+      after(:install_sidekiq) { recipe.add_mailer_queue }
+      background_processor_recipe.add_sidekiq unless background_processor_answer
+    end
+  end
 end