potassium 6.3.0 → 6.6.0

data/lib/potassium/assets/app/serializers/base_serializer.rb

@@ -0,0 +1,3 @@
+class BaseSerializer < ActiveModel::Serializer
+  include ImageHandlingAttributes
+end

data/lib/potassium/assets/app/serializers/concerns/image_handling_attributes.rb

@@ -0,0 +1,20 @@
+module ImageHandlingAttributes
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def add_image_handling_attributes(attachment_name:, derivatives:, include_original_image: false)
+      attributes attachment_name, "#{attachment_name}_blurhash".to_sym
+
+      define_method(attachment_name) do
+        attachment_hash = derivatives.reduce({}) do |hash, derivative|
+          hash[derivative] = { url: object.send("#{attachment_name}_url", derivative) }
+          hash
+        end
+        if include_original_image
+          attachment_hash[:original] = { url: object.send("#{attachment_name}_url") }
+        end
+        attachment_hash
+      end
+    end
+  end
+end

data/lib/potassium/assets/app/uploaders/cover_image_uploader.rb

@@ -0,0 +1,52 @@
+require "image_processing/vips"
+
+class CoverImageUploader < ImageUploader
+  plugin :derivation_endpoint, prefix: "derivations/cover_image"
+  plugin :add_metadata
+  plugin :image_handling_utilities
+
+  DERIVATIVES = {
+    sm: { size: [426, 240], type: 'jpg' },
+    md: { size: [960, 540], type: 'jpg' },
+    lg: { size: [1280, 720], type: 'jpg' },
+    webp_sm: { size: [426, 240], type: 'webp' },
+    webp_md: { size: [960, 540], type: 'webp' },
+    webp_lg: { size: [1280, 720], type: 'webp' }
+  }
+
+  Attacher.derivatives do |original|
+    vips = ImageProcessing::Vips.source(original)
+
+    DERIVATIVES.reduce({}) do |derivatives_hash, (name, derivative_info)|
+      derivatives_hash[name] = vips.convert(derivative_info[:type]).resize_to_limit!(
+        *derivative_info[:size]
+      )
+      derivatives_hash
+    end
+  end
+
+  derivation :thumbnail do |file, width, height|
+    ImageProcessing::Vips
+      .source(file)
+      .resize_to_limit!(width.to_i, height.to_i)
+  end
+
+  Attacher.default_url do |derivative: nil, **|
+    file&.derivation_url(:thumbnail, *DERIVATIVES.dig(derivative, :size)) if derivative.present?
+  end
+
+  add_metadata :blurhash do |io, derivative: nil, **|
+    if derivative.nil?
+      Shrine.with_file(io) do |file|
+        image = Vips::Image.new_from_file(file.path, access: :sequential)
+        image = image.resize(100.0 / image.width)
+        flat_rgb_pixels = []
+        image.to_a.each do |row|
+          row.each { |pixel| flat_rgb_pixels.concat(pixel[0..2])  }
+        end
+
+        Blurhash.encode(image.width, image.height, flat_rgb_pixels)
+      end
+    end
+  end
+end

data/lib/potassium/assets/app/views/example_mailer/example_mail.html.mjml

@@ -0,0 +1,7 @@
+<mj-section>
+  <mj-column>
+    <mj-text>
+      Hello <%= @email %>, welcome to Potassium
+    </mj-text>
+  </mj-column>
+</mj-section>

data/lib/potassium/assets/app/views/layouts/default_mail.html.mjml

@@ -0,0 +1,49 @@
+<mjml>
+  <mj-head>
+    <mj-attributes>
+      <mj-all font-family="'Helvetica Neue', Helvetica, Arial, sans-serif"></mj-all>
+      <mj-text font-weight="400" font-size="16px" color="#000000" line-height="24px" font-family="'Helvetica Neue', Helvetica, Arial, sans-serif"></mj-text>
+    </mj-attributes>
+    <mj-style inline="inline">
+      .body-section {
+        -webkit-box-shadow: 1px 4px 11px 0px rgba(0, 0, 0, 0.15);
+        -moz-box-shadow: 1px 4px 11px 0px rgba(0, 0, 0, 0.15);
+        box-shadow: 1px 4px 11px 0px rgba(0, 0, 0, 0.15);
+      }
+    </mj-style>
+    <mj-style inline="inline">
+      .text-link {
+        color: #5e6ebf
+      }
+    </mj-style>
+    <mj-style inline="inline">
+      .footer-link {
+        color: #888888
+      }
+    </mj-style>
+
+  </mj-head>
+  <mj-body width="600px">
+    <mj-section full-width="full-width" background-color="#71717A" padding-bottom="0">
+      <mj-column width="100%" background-color="#A1A1AA">
+        <mj-spacer height="25px" />
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#A1A1AA" padding-bottom="0" padding-top="0">
+      <mj-column>
+        <mj-image width="100px" src="<%= image_url('/mails/platanus-logo.png') %>" align="center">
+      </mj-column>
+      <mj-column width="100%">
+        <mj-spacer height="25px" />
+      </mj-column>
+    </mj-section>
+    <mj-wrapper padding-top="0" padding-bottom="0" css-class="body-section" background-color="#ffffff" padding-left="15px" padding-right="15px">
+      <%= yield %>
+    </mj-wrapper>
+    <mj-section background-color="#A1A1AA" padding-bottom="0" padding-top="0">
+      <mj-column width="100%">
+        <mj-spacer height="25px" />
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>

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/testing/.rspec

@@ -2,3 +2,4 @@
 --require rails_helper
 --format=doc
 --format=Nc
+--tag ~type:system

data/lib/potassium/assets/testing/devise_config.rb

@@ -0,0 +1,6 @@
+require 'devise'
+
+RSpec.configure do |config|
+  config.include Devise::Test::ControllerHelpers, type: :controller
+  config.include Devise::Test::IntegrationHelpers, type: :request
+end

data/lib/potassium/assets/testing/factory_bot_config.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/lib/potassium/assets/testing/faker_config.rb

@@ -0,0 +1 @@
+require 'faker'

data/lib/potassium/assets/testing/power_types_config.rb

@@ -0,0 +1 @@
+PowerTypes::Observable.observable_disabled = true

data/lib/potassium/assets/testing/rails_helper.rb

@@ -1,60 +1,141 @@
-# This file is copied to spec/ when you run 'rails generate rspec:install'
 ENV['RACK_ENV'] ||= 'test'
 require File.expand_path('../config/environment', __dir__)
 require 'rspec/rails'
 require 'spec_helper'
-require 'shoulda/matchers'
-require 'faker'
-# Add additional requires below this line. Rails is not loaded until this point!
-
-# Requires supporting ruby files with custom matchers and macros, etc, in
-# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
-# run as spec files by default. This means that files in spec/support that end
-# in _spec.rb will both be required and run as specs, causing the specs to be
-# run twice. It is recommended that you do not name files matching this glob to
-# end with _spec.rb. You can configure this pattern with the --pattern
-# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-#
-# The following line is provided for convenience purposes. It has the downside
-# of increasing the boot-up time by auto-requiring all files in the support
-# directory. Alternatively, in the individual `*_spec.rb` files, manually
-# require only the support files necessary.
-#
-Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
-
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.maintain_test_schema!
 
-PowerTypes::Observable.observable_disabled = true
+=begin
 
-RSpec.configure do |config|
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
+General
+=======
 
-  # RSpec Rails can automatically mix in different behaviours to your tests
-  # based on their file location, for example enabling you to call `get` and
-  # `post` in specs under `spec/controllers`.
-  #
-  # You can disable this behaviour by removing the line below, and instead
-  # explicitly tag your specs with their type, e.g.:
-  #
-  #     RSpec.describe UsersController, :type => :controller do
-  #       # ...
-  #     end
-  #
-  # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/docs
-  config.infer_spec_type_from_file_location!
+1) Place your unit tests inside the "spec" directory.
+2) Run unit tests executing `bin/guard`.
+3) Use support directories to add helpers and settings.
+   You can only put RSpec configuration on this file.
 
-  config.include FactoryBot::Syntax::Methods
-end
+Support
+-------
+
+* spec/support/configurations: put testing related gem settings here.
+
+  For example: spec/support/configurations/shoulda_matchers_config.rb
+
+  ----------------------------------------
+  require 'shoulda/matchers'
+
+  Shoulda::Matchers.configure do |config|
+    config.integrate do |with|
+      with.test_framework :rspec
+      with.library :rails
+    end
+  end
+  ----------------------------------------
+
+* spec/support/helpers: place here helpers created by you to use in your unit tests.
+
+  For example: spec/support/helpers/attachments_helpers.rb
+
+  ----------------------------------------------------------------------------------
+  module AttachmentsHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      def create_attachment_file(filename: "pikachu.png", content_type: "image/png")
+        Rack::Test::UploadedFile.new(file_fixture(filename), content_type)
+      end
+    end
+  end
+
+  RSpec.configure do |config|
+    config.fixture_path = "#{::Rails.root}/spec/assets"
+    config.file_fixture_path = "#{::Rails.root}/spec/assets"
+
+    config.include AttachmentsHelpers
+  end
+  ----------------------------------------------------------------------------------
+
+* spec/support/custom_matchers: place here your custom matchers
+  (https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/custom-matchers)
+
+* spec/support/shared_examples: place here your shared examples
+  (https://relishapp.com/rspec/rspec-core/v/3-10/docs/example-groups/shared-examples)
+
+System Tests
+============
+
+1) Place your system tests inside the "spec/system" directory.
+2) Run system tests executing `bin/rspec --tag type:system`.
+
+Support
+-------
+
+* spec/support/configurations/system_tests_config.rb: on this file you will find the
+  general configuration of the system tests. Keep in mind that this type of test will
+  run with the `selenium_chrome_headless` driver unless you put the `no_js` tag.
 
-Shoulda::Matchers.configure do |config|
-  config.integrate do |with|
-    with.test_framework :rspec
-    with.library :rails
+  For example: spec/system/login_spec.rb
+
+  ----------------------------------------------------------------------------
+  require "rails_helper"
+
+  RSpec.describe "Login" do
+    let!(:user) { create(:user, email: "lean@platan.us") }
+
+    context "without logged user", :no_js do # will use :rack_test driver
+      before { visit("/") }
+
+      it { expect(page).to have_text("Ingresa") }
+    end
+
+    context "with logged user" do # will use :selenium_chrome_headless driver
+      before { sign_in(user) }
+
+      it { expect(page).to have_text("Hola!") }
+    end
+  end
+  ----------------------------------------------------------------------------
+
+* spec/support/helpers/system: place here helpers created by you
+  to use in your system tests.
+
+  For example: spec/support/helpers/login_helpers.rb
+
+  ------------------------------------------------
+  module LoginHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      def sign_in(email, password)
+        visit('/users/sign_in')
+
+        within(:xpath, '//*[@id="new_user"]') do
+          fill_in('Email', with: email)
+          fill_in('Contraseña', with: password)
+        end
+
+        click_button('Ingresar')
+      end
+
+      def logout
+        visit('/users/sign_out')
+      end
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include LoginHelpers, type: :system
   end
+  ------------------------------------------------
+
+  Remember to include the system helpers with the tag `type: :system`
+=end
+
+Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |f| require f }
+
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_run_when_matching :focus unless Rails.env.production?
 end

data/lib/potassium/assets/testing/shoulda_matchers_config.rb

@@ -0,0 +1,8 @@
+require 'shoulda/matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end