potassium 6.5.0 → 6.6.0

data/lib/potassium/assets/config/initializers/shrine/plugins/image_handling_utilities.rb

@@ -0,0 +1,143 @@
+class Shrine
+  module Plugins
+    module ImageHandlingUtilities
+      # rubocop:disable Metrics/ModuleLength
+      module AttachmentMethods
+        def included(klass)
+          super
+
+          define_instance_methods
+          define_class_methods(klass)
+        end
+
+        private
+
+        def define_instance_methods
+          define_with_stored_attacher_method
+          define_blurhash_instance_method
+          define_generate_derivatives_instance_method
+          define_generate_metadata_instance_method
+          define_generate_derivatives_and_metadata_instance_method
+        end
+
+        def define_blurhash_instance_method
+          name = @name
+          define_method(:"#{@name}_blurhash") do
+            send(name)&.metadata&.[]('blurhash')
+          end
+        end
+
+        def define_generate_derivatives_instance_method
+          name = @name
+          define_method(:"generate_#{name}_derivatives") do
+            send("with_stored_#{name}_attacher") do |attacher|
+              old_derivatives = attacher.derivatives
+
+              attacher.set_derivatives({})
+              attacher.create_derivatives
+
+              begin
+                attacher.atomic_persist
+                attacher.delete_derivatives(old_derivatives) if old_derivatives.present?
+              rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
+                attacher.delete_derivatives
+              end
+            end
+          end
+        end
+
+        def define_generate_metadata_instance_method
+          name = @name
+          define_method(:"generate_#{name}_metadata") do
+            send("with_stored_#{name}_attacher") do |attacher|
+              attacher.refresh_metadata!
+              attacher.atomic_persist
+            end
+          end
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def define_generate_derivatives_and_metadata_instance_method
+          name = @name
+          define_method(:"generate_#{name}_derivatives_and_metadata") do
+            send("with_stored_#{name}_attacher") do |attacher|
+              old_derivatives = attacher.derivatives
+
+              attacher.set_derivatives({})
+              attacher.file.open do
+                attacher.create_derivatives
+                attacher.refresh_metadata!
+              end
+
+              begin
+                attacher.atomic_persist
+                attacher.delete_derivatives(old_derivatives) if old_derivatives.present?
+              rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
+                attacher.delete_derivatives
+              end
+            end
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def define_class_methods(klass)
+          define_generate_all_derivatives_class_method(klass)
+          define_generate_all_metadata_class_method(klass)
+          define_generate_all_derivatives_and_metadata_class_method(klass)
+        end
+
+        def define_generate_all_derivatives_class_method(klass)
+          name = @name
+          klass.send(
+            :define_singleton_method, :"generate_all_#{name}_derivatives"
+          ) do |&error_block|
+            all.find_each do |record|
+              record.send(:"generate_#{name}_derivatives")
+            rescue StandardError => e
+              error_block.call(record, e) if error_block.present?
+            end
+          end
+        end
+
+        def define_generate_all_metadata_class_method(klass)
+          name = @name
+          klass.send(:define_singleton_method, :"generate_all_#{name}_metadata") do |&error_block|
+            all.find_each do |record|
+              record.send(:"generate_#{name}_metadata")
+            rescue StandardError => e
+              error_block.call(record, e) if error_block.present?
+            end
+          end
+        end
+
+        def define_generate_all_derivatives_and_metadata_class_method(klass)
+          name = @name
+          klass.send(
+            :define_singleton_method, :"generate_all_#{name}_derivatives_and_metadata"
+          ) do |&error_block|
+            all.find_each do |record|
+              record.send(:"generate_#{name}_derivatives_and_metadata")
+            rescue StandardError => e
+              error_block.call(record, e) if error_block.present?
+            end
+          end
+        end
+
+        def define_with_stored_attacher_method
+          name = @name
+          define_method(:"with_stored_#{name}_attacher") do |&block|
+            return if send(name).blank?
+
+            attacher = send(:"#{name}_attacher")
+
+            block.call(attacher) if attacher.stored?
+          end
+          private :"with_stored_#{name}_attacher"
+        end
+      end
+      # rubocop:enable Metrics/ModuleLength
+    end
+
+    register_plugin(:image_handling_utilities, ImageHandlingUtilities)
+  end
+end

data/lib/potassium/assets/config/mailer.rb.erb

@@ -7,8 +7,6 @@ Rails.application.config.action_mailer.default_url_options = {
 }
 
 Rails.application.config.action_mailer.default_options = { from: ENV['DEFAULT_EMAIL_ADDRESS'] }
-ASSET_HOST = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))
-Rails.application.config.action_mailer.asset_host = ASSET_HOST
 
 if ENV["EMAIL_RECIPIENTS"].present?
   Mail.register_interceptor RecipientInterceptor.new(

data/lib/potassium/assets/config/shrine.rb

@@ -34,3 +34,18 @@ Shrine.plugin :activerecord
 Shrine.plugin :cached_attachment_data
 Shrine.plugin :restore_cached_data
 Shrine.plugin :determine_mime_type, analyzer: :marcel
+Shrine.plugin :derivatives
+Shrine.plugin :default_url
+Shrine.plugin :derivation_endpoint, secret_key: ENV.fetch('SHRINE_SECRET_KEY')
+Shrine.plugin :refresh_metadata
+Shrine.plugin :backgrounding
+
+Shrine::Attacher.promote_block do |attacher|
+  ShrinePromoteJob.perform_later(
+    attacher.class.name,
+    attacher.record.class.name,
+    attacher.record.id,
+    attacher.name,
+    attacher.file_data
+  )
+end

data/lib/potassium/assets/config/webpack/rules/css.js

@@ -0,0 +1,5 @@
+module.exports = {
+  resolve: {
+    extensions: ['.css', '.scss']
+  }
+}

data/lib/potassium/assets/config/webpack/rules/index.js

@@ -0,0 +1,11 @@
+const vueConfig = require('./vue');
+const cssConfig = require('./css');
+const jQueryConfig = require('./jquery');
+const typescriptConfig = require('./typescript');
+
+module.exports = {
+  vueConfig,
+  cssConfig,
+  jQueryConfig,
+  typescriptConfig,
+};

data/lib/potassium/assets/config/webpack/rules/jquery.js

@@ -0,0 +1,11 @@
+const webpack = require('webpack');
+
+module.exports = {
+  plugins: [
+    new webpack.ProvidePlugin({
+      $: 'jquery',
+      jQuery: 'jquery',
+      "window.jQuery":"jquery"
+    })
+  ],
+}

data/lib/potassium/assets/config/webpack/rules/typescript.js

@@ -0,0 +1,32 @@
+const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.ts$/,
+        loader: 'ts-loader',
+        exclude: /node_modules/,
+        options: {
+          appendTsSuffixTo: [/\.vue$/],
+          transpileOnly: true,
+        },
+      },
+    ],
+  },
+  resolve: {
+    extensions: ['.ts'],
+  },
+  plugins: [
+    new ForkTsCheckerWebpackPlugin({
+      typescript: {
+        extensions: {
+          vue: {
+            enabled: true,
+            compiler: '@vue/compiler-sfc',
+          },
+        },
+      },
+    }),
+  ],
+};

data/lib/potassium/assets/config/webpack/rules/vue.js

@@ -0,0 +1,19 @@
+const { VueLoaderPlugin } = require('vue-loader')
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.vue$/,
+        loader: 'vue-loader'
+      }
+    ]
+  },
+  plugins: [new VueLoaderPlugin()],
+  resolve: {
+    extensions: ['.vue'],
+    alias: {
+      'vue$': 'vue/dist/vue.esm-bundler.js',
+    }
+  },
+}

data/lib/potassium/assets/config/webpack/webpack.config.js

@@ -0,0 +1,4 @@
+const { webpackConfig, merge } = require('shakapacker');
+const { vueConfig, cssConfig, jQueryConfig, typescriptConfig } = require('./rules');
+
+module.exports = merge(typescriptConfig, cssConfig, jQueryConfig, webpackConfig);

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,
@@ -200,6 +200,14 @@ module Potassium::CliOptions # rubocop:disable Metrics/ModuleLength
       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
     }
   ]
 
@@ -219,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

@@ -37,6 +37,7 @@ class Recipes::Admin < Rails::AppBuilder
     add_readme_section :internal_dependencies, :active_admin
     after(:gem_install, wrap_in_action: :admin_install) do
       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|
@@ -80,6 +81,16 @@ class Recipes::Admin < Rails::AppBuilder
           import 'arctic_admin';
         HERE
       )
+
+      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,13 +14,13 @@ 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'
@@ -43,75 +32,7 @@ class Recipes::Api < Rails::AppBuilder
 
     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

@@ -3,6 +3,11 @@ class Recipes::Coverage < Rails::AppBuilder
     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?
@@ -13,6 +18,18 @@ class Recipes::Coverage < Rails::AppBuilder
     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
@@ -32,4 +49,18 @@ class Recipes::Coverage < Rails::AppBuilder
       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