potassium 6.3.0 → 6.6.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/assets/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "useDefineForClassFields": true,
+    "jsx": "preserve",
+    "noImplicitThis": true,
+    "strict": true,
+    "isolatedModules": true,
+    "preserveValueImports": true,
+    "importsNotUsedAsValues": "error",
+    "target": "esnext",
+    "allowJs": true,
+
+    // Recommended
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    // See <https://github.com/vuejs/vue-cli/pull/5688>
+    "skipLibCheck": true,
+    "baseUrl": "app/javascript/",
+    "types": ["@types/jest", "@types/node"],
+  },
+  "include": [
+    "app/javascript/**/*.ts",
+    "app/javascript/**/*.vue"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

data/lib/potassium/cli/commands/create.rb

@@ -12,17 +12,19 @@ module Potassium::CLI
     c.action do |_global_options, options, _args|
       require 'potassium/newest_version_ensurer'
       require 'potassium/node_version_ensurer'
+      require 'potassium/platanus_config'
       require 'potassium/generators/application'
       require 'potassium/template_finder'
 
       begin
         Potassium::NewestVersionEnsurer.new.ensure! if options['version-check']
         Potassium::NodeVersionEnsurer.new.ensure! if options['node-version-check']
+        options = Potassium::PlatanusConfig.new(options).generate! if options['platanus-config']
         template_finder = Potassium::TemplateFinder.new
         template = template_finder.default_template
         template.cli_options = options
         template.source_paths << Rails::Generators::AppGenerator.source_root
-        ARGV.push('--skip-webpack-install', '--skip-bundle')
+        ARGV.push('--skip-javascript', '--skip-bundle')
         template.start
       rescue VersionError => e
         print "\nError: #{e.message}" # rubocop:disable Rails/Output

data/lib/potassium/cli_options.rb

@@ -75,11 +75,11 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       default_test_value: false
     },
     {
-      type: :flag,
+      type: :switch,
       name: "api",
-      desc: "Which API interface to use",
+      desc: "Whether to include power_api for API support or not",
       default_value: "none",
-      default_test_value: "None"
+      default_test_value: false
     },
     {
       type: :flag,
@@ -192,6 +192,22 @@ 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
+    },
+    {
+      type: :switch,
+      name: 'platanus-config',
+      desc: 'Wheter to use the Platanus configuration.',
+      negatable: true,
+      default_value: false,
+      default_test_value: false
     }
   ]
 
@@ -211,4 +227,8 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       memo
     end
   end
+
+  def self.option_names
+    CREATE_OPTIONS.map { |option| option[:name] }.flatten.map(&:to_sym)
+  end
 end

data/lib/potassium/platanus_config.rb

@@ -0,0 +1,20 @@
+module Potassium
+  class PlatanusConfig
+    def initialize(options)
+      @options = options
+      @option_key_names = Potassium::CliOptions.option_names
+    end
+
+    def generate!
+      default_options = {
+        'db': 'postgresql', 'locale': 'es-CL', 'email_service': 'sendgrid', 'devise': true,
+        'devise-user-model': true, 'admin': true, 'vue_admin': true, 'pundit': true,
+        'api': true, 'storage': 'shrine', 'heroku': true, 'background_processor': true,
+        'draper': true, 'schedule': true, 'sentry': true, 'front_end': 'vue',
+        'google_tag_manager': true, 'test': true, 'spring': true
+      }
+      default_options = default_options.filter { |key, _| @option_key_names.include?(key) }
+      @options.merge(default_options, default_options.stringify_keys)
+    end
+  end
+end

data/lib/potassium/recipes/admin.rb

@@ -32,12 +32,12 @@ 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"
+      run 'bin/yarn add @activeadmin/activeadmin'
       line = "ActiveAdmin.setup do |config|"
       initializer = "config/initializers/active_admin.rb"
       gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
@@ -50,26 +50,47 @@ 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"
+
+      aa_style = "app/javascript/stylesheets/active_admin.scss"
+
+      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"
 
-          @import "active_skin";
+      gsub_file(
+        aa_js,
+        js_line,
+        <<~HERE
+          #{js_line}
+          import '@fortawesome/fontawesome-free/css/all.css';
+          import 'arctic_admin';
         HERE
-      end
+      )
 
-      generate "activeadmin_addons:install"
+      run "mv app/javascript/packs/active_admin.js app/javascript/active_admin.js"
+      gsub_file(
+        "app/javascript/active_admin.js",
+        'import "../stylesheets/active_admin";',
+        'import "./stylesheets/active_admin.scss";'
+      )
+
+      run 'rm -rf config/webpack/plugins'
+      run 'rm -rf app/javascript/packs/active_admin'
     end
   end
 end

data/lib/potassium/recipes/api.rb

@@ -1,22 +1,11 @@
 class Recipes::Api < Rails::AppBuilder
   def ask
-    api_interfaces = {
-      rest: "REST (with Power API)",
-      graphql: "GraphQL (beta)",
-      none: "None, thanks"
-    }
-    api_interface = answer(:api) do
-      api_interfaces.keys[Ask.list("Which API interface are you using?", api_interfaces.values)]
-    end
-    set :api, api_interface.to_sym
+    api_support = answer(:api) { Ask.confirm("Do you want to enable API support?") }
+    set :api, api_support
   end
 
   def create
-    if get(:api) == :graphql
-      add_graphql
-    elsif get(:api) == :rest
-      add_power_api
-    end
+    add_power_api if get(:api)
   end
 
   def install
@@ -25,91 +14,25 @@ class Recipes::Api < Rails::AppBuilder
   end
 
   def installed?
-    gem_exists?(/power_api/) || gem_exists?(/graphql/)
+    gem_exists?(/power_api/)
   end
 
   private
 
   def add_power_api
-    gather_gem 'power_api'
+    gather_gem 'power_api', '~> 2.0'
 
     gather_gems(:development, :test) do
       gather_gem 'rswag-specs'
     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"
-    end
-  end
-
-  def add_graphql
-    gather_gem 'graphql'
-    if get(:authentication)
-      gather_gem 'jwt'
-    end
-    gather_gems(:development, :test) do
-      gather_gem 'graphql_playground-rails'
-    end
-
-    after(:gem_install) do
-      generate "graphql:install --skip_graphiql"
-      playground_route = <<~HEREDOC
-      \n
-        if Rails.env.development?
-          mount GraphqlPlayground::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"
-        end
-      HEREDOC
-      inject_into_file(
-        'config/routes.rb',
-        playground_route,
-        after: 'post "/graphql", to: "graphql#execute"'
-      )
-      copy_file(
-        "../assets/config/graphql_playground.rb",
-        "config/initializers/graphql_playground.rb"
-      )
-      remove_dir 'app/graphql/types'
-      directory '../assets/app/graphql/types', 'app/graphql/types'
-      gsub_file 'app/graphql/mutations/base_mutation.rb', 'Types::Base', 'Types::Base::Base'
-      directory '../assets/app/graphql/queries', 'app/graphql/queries'
-      gsub_file 'app/graphql/mutations/base_mutation.rb', 'RelayClassic', ''
-      gsub_file(
-        'app/graphql/mutations/base_mutation.rb',
-        "    input_object_class Types::Base::BaseInputObject\n", ''
-      )
-
-      if get(:authentication)
-        copy_file(
-          '../assets/app/graphql/graphql_controller.rb',
-          'app/controllers/graphql_controller.rb',
-          force: true
-        )
-        gsub_file(
-          'app/controllers/graphql_controller.rb',
-          'GqlSampleSchema',
-          "#{get(:titleized_app_name).delete(' ')}Schema"
-        )
-        copy_file(
-          '../assets/app/graphql/mutations/login_mutation.rb',
-          'app/graphql/mutations/login_mutation.rb'
-        )
-        inject_into_file(
-          'app/graphql/types/mutation_type.rb',
-          "\n    field :login, mutation: Mutations::LoginMutation",
-          after: 'class MutationType < Types::Base::BaseObject'
-        )
-        append_to_file(".env.development", "HMAC_SECRET=\n")
-      end
-
-      inject_into_file(
-        'app/controllers/graphql_controller.rb',
-        "\n\n  skip_before_action :verify_authenticity_token",
-        after: '# protect_from_forgery with: :null_session'
-      )
-
-      add_readme_section :internal_dependencies, :graphql
+      generate "power_api:internal_api_config"
     end
   end
 end

data/lib/potassium/recipes/coverage.rb

@@ -0,0 +1,66 @@
+class Recipes::Coverage < Rails::AppBuilder
+  def create
+    load_gems
+    configure_rails_helper
+    append_to_file('.gitignore', "/coverage/*\n")
+    recipe = self
+    after(:setup_jest) do
+      recipe.configure_jest_coverage
+      recipe.setup_jest_text_formatter
+    end
+  end
+
+  def installed?
+    gem_exists?(/simplecov/)
+  end
+
+  def install
+    create
+  end
+
+  def configure_jest_coverage
+    json_file = File.read(Pathname.new("package.json"))
+    js_package = JSON.parse(json_file)
+    js_package = add_coverage_config(js_package)
+    json_string = JSON.pretty_generate(js_package)
+    create_file 'package.json', json_string, force: true
+  end
+
+  def setup_jest_text_formatter
+    run "bin/yarn add jest-text-formatter@1.0.2 --dev"
+  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
+
+  def add_coverage_config(js_package)
+    js_package['scripts']['test:changes'] = 'jest --changedSince=master'
+    js_package['jest'] = js_package['jest'].merge(coverage_defaults)
+    js_package
+  end
+
+  def coverage_defaults
+    {
+      collectCoverage: true,
+      collectCoverageFrom: ['**/*.{js,ts,vue}', '!**/node_modules/**'],
+      coverageReporters: ['text']
+    }
+  end
+end

data/lib/potassium/recipes/file_storage.rb

@@ -44,6 +44,56 @@ class Recipes::FileStorage < Rails::AppBuilder
     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')
     append_to_file('.gitignore', "/public/uploads\n")
+    add_image_handling_and_cover_image_uploader
+  end
+
+  def add_image_handling_and_cover_image_uploader
+    gather_gem('image_processing', '~> 1.8')
+    gather_gem('blurhash', '~> 0.1')
+    gather_gem('ruby-vips', '~> 2.1')
+    append_to_file('.env.development', "SHRINE_SECRET_KEY=#{SecureRandom.hex}\n")
+    copy_file('../assets/app/jobs/shrine_promote_job.rb', 'app/jobs/shrine_promote_job.rb')
+    add_image_handling_plugin
+    add_cover_image_uploader
+    add_image_handling_serializer_concern if get(:api)
+    add_image_handling_heroku_setup if get(:heroku)
+  end
+
+  def add_cover_image_uploader
+    copy_file(
+      '../assets/app/uploaders/cover_image_uploader.rb', 'app/uploaders/cover_image_uploader.rb'
+    )
+    insert_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
+      <<~HERE.indent(2)
+        mount CoverImageUploader.derivation_endpoint => "/derivations/cover_image"
+      HERE
+    end
+  end
+
+  def add_image_handling_plugin
+    copy_file(
+      '../assets/config/initializers/shrine/plugins/image_handling_utilities.rb',
+      'config/initializers/shrine/plugins/image_handling_utilities.rb'
+    )
+  end
+
+  def add_image_handling_serializer_concern
+    copy_file(
+      '../assets/app/serializers/concerns/image_handling_attributes.rb',
+      'app/serializers/concerns/image_handling_attributes.rb'
+    )
+    copy_file('../assets/app/serializers/base_serializer.rb', 'app/serializers/base_serializer.rb')
+  end
+
+  def add_image_handling_heroku_setup
+    append_to_file(
+      '.buildpacks',
+      <<~HERE
+        https://github.com/heroku/heroku-buildpack-apt
+        https://github.com/brandoncc/heroku-buildpack-vips
+      HERE
+    )
+    copy_file('../assets/Aptfile', 'Aptfile')
   end
 
   def common_setup