RubyGems - potassium - Versions diffs - 5.2.2 → 6.3.0 - Mend

potassium 5.2.2 → 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (121) hide show

checksums.yaml +4 -4
data/.circleci/config.yml +103 -28
data/.circleci/setup-rubygems.sh +3 -0
data/.gitignore +2 -1
data/.node-version +1 -0
data/.rubocop.yml +530 -0
data/.ruby-version +1 -1
data/CHANGELOG.md +92 -1
data/README.md +51 -45
data/docs/DSL.md +5 -5
data/lib/potassium/assets/.circleci/config.yml.erb +151 -0
data/lib/potassium/assets/.eslintrc.json +352 -0
data/lib/potassium/assets/.github/pull_request_template.md +9 -0
data/lib/potassium/assets/.rubocop.yml +528 -0
data/lib/potassium/assets/.stylelintrc.json +46 -0
data/lib/potassium/assets/Makefile.erb +21 -32
data/lib/potassium/assets/README.yml +59 -15
data/lib/potassium/assets/active_admin/admin-component.vue +35 -0
data/lib/potassium/assets/active_admin/admin_application.js +14 -0
data/lib/potassium/assets/active_admin/init_activeadmin_vue.rb +10 -0
data/lib/potassium/assets/app/graphql/graphql_controller.rb +55 -0
data/lib/potassium/assets/app/graphql/mutations/login_mutation.rb +23 -0
data/lib/potassium/assets/app/graphql/queries/base_query.rb +4 -0
data/lib/potassium/assets/app/graphql/types/base/base_argument.rb +4 -0
data/lib/potassium/assets/app/graphql/types/base/base_enum.rb +4 -0
data/lib/potassium/assets/app/graphql/types/base/base_field.rb +5 -0
data/lib/potassium/assets/app/graphql/types/base/base_input_object.rb +5 -0
data/lib/potassium/assets/app/graphql/types/base/base_interface.rb +7 -0
data/lib/potassium/assets/app/graphql/types/base/base_object.rb +5 -0
data/lib/potassium/assets/app/graphql/types/base/base_scalar.rb +4 -0
data/lib/potassium/assets/app/graphql/types/base/base_union.rb +4 -0
data/lib/potassium/assets/app/graphql/types/mutation_type.rb +10 -0
data/lib/potassium/assets/app/graphql/types/query_type.rb +13 -0
data/lib/potassium/assets/app/javascript/app.spec.js +14 -0
data/lib/potassium/assets/app/uploaders/base_uploader.rb +11 -0
data/lib/potassium/assets/app/uploaders/image_uploader.rb +5 -0
data/lib/potassium/assets/app/views/shared/_gtm_body.html.erb +4 -0
data/lib/potassium/assets/app/views/shared/_gtm_head.html.erb +7 -0
data/lib/potassium/assets/bin/release +1 -1
data/lib/potassium/assets/bin/setup.erb +1 -1
data/lib/potassium/assets/config/database_mysql.yml.erb +2 -2
data/lib/potassium/assets/config/database_postgresql.yml.erb +2 -2
data/lib/potassium/assets/config/graphql_playground.rb +20 -0
data/lib/potassium/assets/config/puma.rb +1 -1
data/lib/potassium/assets/config/shrine.rb +36 -0
data/lib/potassium/assets/lib/tasks/auto_annotate_models.rake +2 -1
data/lib/potassium/assets/package.json +4 -1
data/lib/potassium/assets/redis.yml +1 -2
data/lib/potassium/assets/testing/rails_helper.rb +2 -0
data/lib/potassium/cli/commands/create.rb +12 -19
data/lib/potassium/cli_options.rb +77 -26
data/lib/potassium/helpers/gem-helpers.rb +1 -1
data/lib/potassium/helpers/template-helpers.rb +8 -0
data/lib/potassium/newest_version_ensurer.rb +19 -36
data/lib/potassium/node_version_ensurer.rb +30 -0
data/lib/potassium/recipes/admin.rb +3 -3
data/lib/potassium/recipes/annotate.rb +1 -1
data/lib/potassium/recipes/api.rb +93 -21
data/lib/potassium/recipes/background_processor.rb +66 -19
data/lib/potassium/recipes/ci.rb +10 -38
data/lib/potassium/recipes/data_migrate.rb +44 -0
data/lib/potassium/recipes/database.rb +4 -0
data/lib/potassium/recipes/database_container.rb +7 -5
data/lib/potassium/recipes/draper.rb +1 -10
data/lib/potassium/recipes/file_storage.rb +66 -0
data/lib/potassium/recipes/front_end.rb +225 -9
data/lib/potassium/recipes/github.rb +93 -15
data/lib/potassium/recipes/google_tag_manager.rb +90 -0
data/lib/potassium/recipes/heroku.rb +42 -29
data/lib/potassium/recipes/mailer.rb +18 -2
data/lib/potassium/recipes/monitoring.rb +5 -0
data/lib/potassium/recipes/node.rb +21 -0
data/lib/potassium/recipes/rack_cors.rb +18 -15
data/lib/potassium/recipes/schedule.rb +17 -2
data/lib/potassium/recipes/style.rb +21 -3
data/lib/potassium/recipes/vue_admin.rb +124 -0
data/lib/potassium/templates/application.rb +10 -7
data/lib/potassium/version.rb +7 -4
data/potassium.gemspec +11 -6
data/spec/features/api_spec.rb +25 -0
data/spec/features/background_processor_spec.rb +19 -6
data/spec/features/ci_spec.rb +7 -4
data/spec/features/data_migrate_spec.rb +14 -0
data/spec/features/database_container_spec.rb +1 -5
data/spec/features/draper_spec.rb +1 -6
data/spec/features/file_storage_spec.rb +75 -0
data/spec/features/front_end_spec.rb +102 -0
data/spec/features/github_spec.rb +53 -8
data/spec/features/google_tag_manager_spec.rb +59 -0
data/spec/features/graphql_spec.rb +71 -0
data/spec/features/heroku_spec.rb +1 -1
data/spec/features/mailer_spec.rb +16 -0
data/spec/features/new_project_spec.rb +6 -14
data/spec/features/node_spec.rb +28 -0
data/spec/features/power_types_spec.rb +5 -16
data/spec/features/schedule_spec.rb +11 -4
data/spec/features/vue_admin_spec.rb +47 -0
data/spec/spec_helper.rb +5 -0
data/spec/support/fake_octokit.rb +31 -0
data/spec/support/potassium_test_helpers.rb +26 -9
data/tmp/.keep +0 -0
metadata +152 -46
data/lib/potassium/assets/.circleci/config.yml +0 -20
data/lib/potassium/assets/Dockerfile.ci +0 -6
data/lib/potassium/assets/active_admin/active_admin.js.coffee +0 -4
data/lib/potassium/assets/active_admin/init_activeadmin_angular.rb +0 -8
data/lib/potassium/assets/api/api_error_concern.rb +0 -32
data/lib/potassium/assets/api/base_controller.rb +0 -9
data/lib/potassium/assets/api/draper_responder.rb +0 -62
data/lib/potassium/assets/api/responder.rb +0 -41
data/lib/potassium/assets/aws.rb +0 -1
data/lib/potassium/assets/bin/cibuild.erb +0 -100
data/lib/potassium/assets/docker-compose.ci.yml +0 -11
data/lib/potassium/assets/sidekiq_scheduler.yml +0 -9
data/lib/potassium/assets/testing/paperclip.rb +0 -59
data/lib/potassium/recipes/active_storage.rb +0 -40
data/lib/potassium/recipes/angular_admin.rb +0 -56
data/lib/potassium/recipes/aws_sdk.rb +0 -7
data/lib/potassium/recipes/paperclip.rb +0 -47
data/spec/features/active_storage_spec.rb +0 -30
data/spec/features/front_end.rb +0 -30

data/lib/potassium/recipes/google_tag_manager.rb ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -24,8 +24,7 @@ class Recipes::Mailer < Rails::AppBuilder
     dependencies(email_service)
     config(email_service)
-    background_processor = load_recipe(:background_processor)
-    background_processor.add_sidekiq unless background_processor.installed?
+    ensure_sidekiq_install_and_add_mailers_queue
   end
   def install
@@ -33,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)
@@ -99,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

data/lib/potassium/recipes/monitoring.rb ADDED Viewed

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

data/lib/potassium/recipes/node.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'net/http'
+require 'semantic'
+require 'json'
+class Recipes::Node < Rails::AppBuilder
+  def create
+    info "Using node version LTS #{version}"
+    create_file '.node-version', version, force: true
+    json_file = File.read(Pathname.new("package.json"))
+    js_package = JSON.parse(json_file)
+    js_package["engines"] = { "node" => "#{version}.x" }
+    json_string = JSON.pretty_generate(js_package)
+    create_file 'package.json', json_string, force: true
+  end
+  private
+  def version
+    Potassium::NODE_VERSION
+  end
+end

data/lib/potassium/recipes/rack_cors.rb CHANGED Viewed

@@ -4,23 +4,26 @@ class Recipes::RackCors < Rails::AppBuilder
   end
   def create
-    gather_gem('rack-cors', '~> 0.4.0')
+    gather_gem('rack-cors', '~> 1.1')
+    recipe = self
     after(:gem_install) do
-      rack_cors_config =
-        <<~RUBY
-          config.middleware.insert_before 0, Rack::Cors do
-            allow do
-              origins '*'
-              resource '*',
-                headers: :any,
-                expose: ['X-Page', 'X-PageTotal'],
-                methods: [:get, :post, :delete, :put, :options]
-            end
-          end
+      application recipe.rack_cors_config
+    end
+  end
-        RUBY
+  def rack_cors_config
+    <<~RUBY
+      config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          origins '*'
+          resource '/public/*', headers: :any, methods: :get
+          resource '/api/*',
+            headers: :any,
+            expose: ['X-Page', 'X-PageTotal'],
+            methods: [:get, :post, :patch, :put, :delete, :options]
+        end
+      end
-      application rack_cors_config
-    end
+    RUBY
   end
 end

data/lib/potassium/recipes/schedule.rb CHANGED Viewed

@@ -8,10 +8,10 @@ class Recipes::Schedule < Rails::AppBuilder
   def create
     if selected?(:schedule)
-      gather_gem 'sidekiq-scheduler'
+      gather_gem 'sidekiq-scheduler', '>= 3.0.1'
       add_readme_section :internal_dependencies, :sidekiq_scheduler
+      append_schedule_section_to_yml
     end
-    template '../assets/sidekiq_scheduler.yml', 'config/sidekiq.yml', force: true
   end
   def install
@@ -22,4 +22,19 @@ class Recipes::Schedule < Rails::AppBuilder
   def installed?
     gem_exists?(/sidekiq-scheduler/) && file_exist?('config/sidekiq.yml')
   end
+  private
+  def append_schedule_section_to_yml
+    append_to_file(
+      'config/sidekiq.yml',
+      <<-HERE.gsub(/^ {8}/, '')
+        # :schedule:
+          #  an_scheduled_task:
+          #    cron: '0 * * * * *'  # Runs once per minute
+          #    class: ExampleJob
+          #    args: ['a', 'b']
+      HERE
+    )
+  end
 end

data/lib/potassium/recipes/style.rb CHANGED Viewed

@@ -1,12 +1,30 @@
 class Recipes::Style < Rails::AppBuilder
   def create
-    append_to_file ".gitignore", ".rubocop.yml\n"
-    append_to_file ".gitignore", ".eslintrc.json\n"
-    append_to_file ".gitignore", ".sscs-lint.yml\n"
+    add_linters
+    add_config_files
     add_readme_header :style_guide
   end
   def install
     create
   end
+  private
+  def add_linters
+    gather_gems(:development, :test) do
+      gather_gem 'rubocop', Potassium::RUBOCOP_VERSION
+      gather_gem 'rubocop-performance'
+      gather_gem 'rubocop-rails'
+      gather_gem 'rubocop-rspec', Potassium::RUBOCOP_RSPEC_VERSION
+    end
+    run 'bin/yarn add --dev stylelint eslint eslint-plugin-import'
+    run 'bin/yarn add --dev eslint-plugin-vue' if selected?(:front_end, :vue)
+  end
+  def add_config_files
+    copy_file '../assets/.rubocop.yml', '.rubocop.yml'
+    copy_file '../assets/.eslintrc.json', '.eslintrc.json'
+    copy_file '../assets/.stylelintrc.json', '.stylelintrc.json'
+  end
 end

data/lib/potassium/recipes/vue_admin.rb ADDED Viewed

@@ -0,0 +1,124 @@
+class Recipes::VueAdmin < Rails::AppBuilder
+  def ask
+    if selected?(:admin_mode)
+      vue_admin = answer(:vue_admin) do
+        Ask.confirm "Do you want Vue support for ActiveAdmin?"
+      end
+      set(:vue_admin, vue_admin)
+      set(:front_end, :vue) if vue_admin
+    end
+  end
+  def create
+    recipe = self
+    if selected?(:vue_admin)
+      after(:admin_install) do
+        recipe.add_vue_admin
+      end
+    end
+  end
+  def install
+    active_admin = load_recipe(:admin)
+    if active_admin.installed?
+      add_vue_admin
+      info "VueAdmin installed"
+    else
+      info "VueAdmin can't be installed because Active Admin isn't installed."
+    end
+  end
+  def installed?
+    dir_exist?("app/assets/javascripts/admin")
+  end
+  def add_vue_admin
+    add_vue_component_library
+    add_component_integration
+    copy_file '../assets/active_admin/init_activeadmin_vue.rb',
+      'config/initializers/init_activeadmin_vue.rb'
+    copy_file '../assets/active_admin/admin_application.js',
+      'app/javascript/packs/admin_application.js',
+      force: true
+    empty_directory 'app/javascript/components'
+    copy_file '../assets/active_admin/admin-component.vue',
+      'app/javascript/components/admin-component.vue',
+      force: true
+  end
+  def add_component_integration
+    line = "class CustomFooter < ActiveAdmin::Component"
+    initializer = "config/initializers/active_admin.rb"
+    gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
+      <<~HERE
+        require "vue_component.rb"
+        AUTO_BUILD_ELEMENTS=[:admin_component, :template, :slot]
+        component_creator(AUTO_BUILD_ELEMENTS)
+        #{line}
+      HERE
+    end
+  end
+  def add_vue_component_library
+    lib_component_path = "lib/vue_component.rb"
+    class_definitions =
+      <<~HERE
+        #{vue_component}
+        #{component_builder}
+      HERE
+    File.open(lib_component_path, "w") { |file| file.write(class_definitions) }
+  end
+  def vue_component
+    <<~HERE
+      class VueComponent < Arbre::Component
+        builder_method :root
+        def tag_name
+          :root
+        end
+        def initialize(*)
+          super
+        end
+        def build(attributes = {})
+          super(process_attributes(attributes))
+        end
+        def process_attributes(attributes)
+          vue_attributes = {}
+          attributes.each do |key, value|
+            dasherized_key = key.to_s.dasherize
+            if value.is_a?(String)
+              vue_attributes[dasherized_key] = value
+            elsif !dasherized_key.index(':').nil? && dasherized_key.index(':').zero?
+              vue_attributes[dasherized_key] = value.to_json
+            else
+              vue_attributes[":" + dasherized_key] = value.to_json
+            end
+          end
+          vue_attributes
+        end
+      end
+    HERE
+  end
+  def component_builder
+    <<~HERE
+      def component_creator(auto_build_elements)
+        auto_build_elements.each do |element|
+          as_string=element.to_s
+          camelized_element = as_string.camelize
+          Object.const_set(camelized_element,Class.new(VueComponent))
+          Object.const_get(camelized_element).class_eval do
+            builder_method as_string.to_sym
+            def tag_name
+              self.class.to_s.underscore
+            end
+          end
+        end
+      end
+    HERE
+  end
+end