alchemy_cms 7.0.0.pre.a → 7.0.0.pre.c

data/Rakefile

@@ -41,17 +41,12 @@ namespace :alchemy do
     task :prepare do
       system(
         <<~BASH
-          yarn install && \
-          yarn link && \
           cd spec/dummy && \
-          yarn link @alchemy_cms/admin && \
           export RAILS_ENV=test && \
           bin/rake db:create && \
           bin/rake db:environment:set && \
           bin/rake db:migrate:reset && \
-          bin/rails javascript:install:esbuild && \
           bin/rails g alchemy:install --skip --skip-demo-files --auto-accept --skip-db-create && \
-          bin/rails javascript:build && \
           cd -
         BASH
       ) || fail
@@ -81,18 +76,4 @@ namespace :alchemy do
       File.delete(backup)
     end
   end
-
-  desc "Release a new Ruby gem and npm package in one command"
-  task :release do
-    require "json"
-    require_relative "lib/alchemy/version"
-    package = File.read("package.json")
-    unless JSON.parse(package)["version"] == Alchemy.version
-      abort "Ruby gem and npm package versions are out of sync! Please fix."
-    end
-    # Release the Ruby gem with bundler
-    Rake::Task["release"].invoke
-    # Publish npm package via CLI
-    system "npm publish"
-  end
 end

data/alchemy_cms.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.summary = "A powerful, userfriendly and flexible CMS for Rails"
   gem.description = "Alchemy is a powerful, userfriendly and flexible Rails CMS."
   gem.requirements << "ImageMagick (libmagick), v6.6 or greater."
-  gem.required_ruby_version = ">= 2.5.0"
+  gem.required_ruby_version = ">= 3.0.0"
   gem.license = "BSD New"
   gem.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   gem.require_paths = ["lib"]
@@ -41,6 +41,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "dragonfly_svg", ["~> 0.0.4"]
   gem.add_runtime_dependency "gutentag", ["~> 2.2", ">= 2.2.1"]
   gem.add_runtime_dependency "handlebars_assets", ["~> 0.23"]
+  gem.add_runtime_dependency "importmap-rails", ["~> 1.2", ">= 1.2.1"]
   gem.add_runtime_dependency "jquery-rails", ["~> 4.0", ">= 4.0.4"]
   gem.add_runtime_dependency "jquery-ui-rails", ["~> 6.0"]
   gem.add_runtime_dependency "kaminari", ["~> 1.1"]
@@ -51,7 +52,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "sassc-rails", ["~> 2.1"]
   gem.add_runtime_dependency "simple_form", [">= 4.0", "< 6"]
   gem.add_runtime_dependency "sprockets", [">= 3.0", "< 5"]
-  gem.add_runtime_dependency "turbolinks", [">= 2.5"]
+  gem.add_runtime_dependency "turbo-rails", [">= 1.4"]
+  gem.add_runtime_dependency "view_component", ["~> 3.0"]
 
   gem.add_development_dependency "capybara", ["~> 3.0"]
   gem.add_development_dependency "capybara-screenshot", ["~> 1.0"]

data/app/assets/config/alchemy_manifest.js

@@ -13,3 +13,4 @@
 //= link_tree ../images/alchemy/
 //= link_tree ../../../vendor/assets/fonts/
 //= link_tree ../../../vendor/assets/images/
+//= link_tree ../../javascript .js

data/app/assets/javascripts/alchemy/admin.js

@@ -2,7 +2,6 @@
 // ------------------------------
 //= require jquery2
 //= require jquery_ujs
-//= require turbolinks
 //= require jquery-ui/effects/effect-fade
 //= require jquery-ui/widgets/draggable
 //= require jquery-ui/widgets/sortable
@@ -38,7 +37,6 @@
 //= require alchemy/alchemy.uploader
 //= require alchemy/alchemy.preview_window
 //= require alchemy/alchemy.spinner
-//= require alchemy/alchemy.tinymce
 //= require alchemy/alchemy.tooltips
 //= require alchemy/page_select
 //= require alchemy/node_select

data/app/assets/javascripts/alchemy/alchemy.dirty.js.coffee

@@ -40,7 +40,7 @@ $.extend Alchemy,
         $form.submit()
     else if $(element).is("a")
       callback = ->
-        Turbolinks.visit(element.pathname)
+        Turbo.visit(element.pathname)
     if Alchemy.isPageDirty()
       Alchemy.openConfirmDialog Alchemy.t('page_dirty_notice'),
         title: Alchemy.t('warning')

data/app/assets/javascripts/alchemy/alchemy.initializer.js.coffee

@@ -1,6 +1,6 @@
 # Initialize all onload scripts at once.
 #
-# Called at jQuery ready event and Turbolinks page change event.
+# Called at jQuery ready event and Turbo page change event.
 #
 Alchemy.Initializer = ->
 
@@ -26,13 +26,13 @@ Alchemy.Initializer = ->
   $('select#change_locale').on 'change', (e) ->
     url = window.location.pathname
     delimiter = if url.match(/\?/) then '&' else '?'
-    Turbolinks.visit "#{url}#{delimiter}admin_locale=#{$(this).val()}"
+    Turbo.visit "#{url}#{delimiter}admin_locale=#{$(this).val()}"
 
   # Site select handler
   $('select#change_site').on 'change', (e) ->
     url = window.location.pathname
     delimiter = if url.match(/\?/) then '&' else '?'
-    Turbolinks.visit "#{url}#{delimiter}site_id=#{$(this).val()}"
+    Turbo.visit "#{url}#{delimiter}site_id=#{$(this).val()}"
 
   # Submit forms of selects with `data-autosubmit="true"`
   $('select[data-auto-submit="true"]').on 'change', (e) ->
@@ -46,18 +46,11 @@ Alchemy.Initializer = ->
     tagName = (event.target || event.srcElement).tagName
     key.isPressed('esc') || !(tagName == 'INPUT' || tagName == 'SELECT' || tagName == 'TEXTAREA')
 
-# Enabling the Turbolinks Progress Bar for v2.5
-Turbolinks.enableProgressBar() if Turbolinks.enableProgressBar
-
-# Turbolinks DOM Ready.
-# Handle both v2.5(page:change), and v.5.0 (turbolinks:load)
-$(document).on 'page:change turbolinks:load', ->
+$(document).on 'turbo:load', ->
   Alchemy.Initializer()
   return
 
-# Turbolinks before parsing a new page
-# Handle both v2.5(page:receive), and v.5.0 (turbolinks:request-end)
-$(document).on 'page:receive turbolinks:request-end', ->
+$(document).on 'turbo:before-fetch-request', ->
   # Ensure that all tinymce editors get removed before parsing a new page
   Alchemy.Tinymce.removeFrom $('.has_tinymce')
   return

data/app/assets/javascripts/alchemy/alchemy.link_dialog.js.coffee

@@ -59,12 +59,17 @@ class window.Alchemy.LinkDialog extends Alchemy.Dialog
   initPageSelect: ->
     pageTemplate = HandlebarsTemplates.page
     element_anchor_placeholder = @$element_anchor.attr('placeholder')
+    if @link_object.dataset.languageId
+      api_url = "#{Alchemy.routes.api_pages_path}?language_id=#{@link_object.dataset.languageId}"
+    else
+      api_url = Alchemy.routes.api_pages_path
+
     @$internal_link.select2
       placeholder: Alchemy.t('Search page')
       allowClear: true
       minimumInputLength: 3
       ajax:
-        url: Alchemy.routes.api_pages_path
+        url: api_url
         datatype: 'json'
         quietMillis: 300
         data: (term, page) ->

data/app/assets/stylesheets/alchemy/base.scss

@@ -3,8 +3,8 @@ html {
   height: 100%;
   font-size: $base-font-size;
 
-  &.turbolinks-progress-bar::before,
-  .turbolinks-progress-bar {
+  &.turbo-progress-bar::before,
+  .turbo-progress-bar {
     background-color: $blue !important;
     z-index: 400001;
   }

data/app/components/alchemy/ingredients/audio_view.rb

@@ -0,0 +1,37 @@
+module Alchemy
+  module Ingredients
+    class AudioView < BaseView
+      def call
+        content_tag(:audio, **html_options) do
+          tag(:source, src: src, type: type)
+        end
+      end
+
+      def render?
+        !!ingredient.attachment
+      end
+
+      private
+
+      def src
+        alchemy.show_attachment_path(
+          ingredient.attachment,
+          format: ingredient.attachment.suffix
+        )
+      end
+
+      def type
+        ingredient.attachment.file_mime_type
+      end
+
+      def html_options
+        {
+          controls: ingredient.controls,
+          autoplay: ingredient.autoplay,
+          loop: ingredient.loop,
+          muted: ingredient.muted
+        }
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/base_view.rb

@@ -0,0 +1,38 @@
+module Alchemy
+  module Ingredients
+    class BaseView < ViewComponent::Base
+      attr_reader :ingredient, :html_options
+
+      delegate :alchemy, to: :helpers
+      delegate :settings, :value, to: :ingredient
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param html_options [Hash] Options that will be passed to the wrapper tag.
+      def initialize(ingredient, html_options: {})
+        raise ArgumentError, "Ingredient missing!" if ingredient.nil?
+
+        @ingredient = ingredient
+        @html_options = html_options
+      end
+
+      def call
+        value
+      end
+
+      def render?
+        value.present?
+      end
+
+      private
+
+      # Fetches value from ingredient settings and allows to merge a value on top of it
+      #
+      # @param key [Symbol] - The settings key you want to fetch the value from
+      # @param value [Object] - A optional value that can override the setting.
+      #   Normally passed as into the ingredient view.
+      def settings_value(key, value: nil, default: nil)
+        value.nil? ? settings.fetch(key, default) : value
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/boolean_view.rb

@@ -0,0 +1,13 @@
+module Alchemy
+  module Ingredients
+    class BooleanView < BaseView
+      def call
+        Alchemy.t(value, scope: "ingredient_values.boolean")
+      end
+
+      def render?
+        !value.nil?
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/datetime_view.rb

@@ -0,0 +1,22 @@
+module Alchemy
+  module Ingredients
+    class DatetimeView < BaseView
+      attr_reader :date_format
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param date_format [String] The date format to use. Use either a strftime format string, a I18n format symbol or "rfc822".
+      def initialize(ingredient, date_format: nil, html_options: {})
+        super(ingredient)
+        @date_format = settings_value(:date_format, value: date_format)
+      end
+
+      def call
+        if date_format == "rfc822"
+          ingredient.value.to_s(:rfc822)
+        else
+          ::I18n.l(ingredient.value, format: date_format)
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/file_view.rb

@@ -0,0 +1,40 @@
+module Alchemy
+  module Ingredients
+    class FileView < BaseView
+      delegate :attachment, to: :ingredient
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param link_text [String] The link text. If not given, the ingredients link_text setting or the attachments name will be used.
+      # @param html_options [Hash] Options that will be passed to the a tag.
+      def initialize(ingredient, link_text: nil, html_options: {})
+        super(ingredient, html_options: html_options)
+        @link_text = settings_value(:link_text, value: link_text, default: attachment&.name)
+      end
+
+      def call
+        link_to(
+          link_text,
+          attachment.url(
+            download: true,
+            name: attachment.slug,
+            format: attachment.suffix
+          ),
+          {
+            class: ingredient.css_class.presence,
+            title: ingredient.title.presence
+          }.merge(html_options)
+        )
+      end
+
+      def render?
+        !attachment.nil?
+      end
+
+      private
+
+      def link_text
+        ingredient.link_text.presence || @link_text
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/headline_view.rb

@@ -0,0 +1,20 @@
+module Alchemy
+  module Ingredients
+    class HeadlineView < BaseView
+      def initialize(ingredient, level: nil, html_options: {})
+        super(ingredient, html_options: html_options)
+        @level = level
+      end
+
+      def call
+        content_tag "h#{@level || ingredient.level}",
+          ingredient.value,
+          id: ingredient.dom_id.presence,
+          class: [
+            ingredient.size ? "h#{ingredient.size}" : nil,
+            html_options[:class]
+          ]
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/html_view.rb

@@ -0,0 +1,9 @@
+module Alchemy
+  module Ingredients
+    class HtmlView < BaseView
+      def call
+        value.to_s.html_safe
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/link_view.rb

@@ -0,0 +1,25 @@
+module Alchemy
+  module Ingredients
+    class LinkView < BaseView
+      attr_reader :link_text
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param text [String] The link text. If not given, the ingredient's text setting or the value will be used.
+      # @param html_options [Hash] Options that will be passed to the a tag.
+      def initialize(ingredient, text: nil, html_options: {})
+        super(ingredient, html_options: html_options)
+        @link_text = settings_value(:text, value: text, default: value)
+      end
+
+      def call
+        link_to(link_text, value, {target: link_target}.merge(html_options))
+      end
+
+      private
+
+      def link_target
+        (ingredient.link_target == "blank") ? "_blank" : nil
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/node_view.rb

@@ -0,0 +1,11 @@
+module Alchemy
+  module Ingredients
+    class NodeView < BaseView
+      delegate :node, to: :ingredient
+
+      def call
+        render(node)
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/page_view.rb

@@ -0,0 +1,15 @@
+module Alchemy
+  module Ingredients
+    class PageView < BaseView
+      delegate :page, to: :ingredient
+
+      def call
+        link_to page.name, alchemy.show_page_path(urlname: page.urlname)
+      end
+
+      def render?
+        !!page
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/picture_view.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # Renders a picture ingredient view
+    class PictureView < BaseView
+      attr_reader :ingredient,
+        :show_caption,
+        :disable_link,
+        :srcset,
+        :sizes,
+        :html_options,
+        :picture_options,
+        :picture
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param show_caption [Boolean] (true) Whether to show a caption or not, even if present on the picture.
+      # @param disable_link [Boolean] (false) Whether to disable the link even if the picture has a link.
+      # @param srcset [Array<String>] An array of srcset sizes that will generate variants of the picture.
+      # @param sizes [Array<String>] An array of sizes that will be passed to the img tag.
+      # @param picture_options [Hash] Options that will be passed to the picture url. See {Alchemy::PictureVariant} for options.
+      # @param html_options [Hash] Options that will be passed to the img tag.
+      # @see Alchemy::PictureVariant
+      def initialize(
+        ingredient,
+        show_caption: nil,
+        disable_link: nil,
+        srcset: nil,
+        sizes: nil,
+        picture_options: {},
+        html_options: {}
+      )
+        super(ingredient)
+        @show_caption = settings_value(:show_caption, value: show_caption, default: true)
+        @disable_link = settings_value(:disable_link, value: disable_link, default: false)
+        @srcset = settings_value(:srcset, value: srcset, default: [])
+        @sizes = settings_value(:sizes, value: sizes, default: [])
+        @picture_options = picture_options || {}
+        @html_options = html_options || {}
+        @picture = ingredient.picture
+      end
+
+      def call
+        return if picture.blank?
+
+        output = caption ? img_tag + caption : img_tag
+
+        if is_linked?
+          output = link_to(output, url_for(ingredient.link), {
+            title: ingredient.link_title.presence,
+            target: (ingredient.link_target == "blank") ? "_blank" : nil,
+            data: {link_target: ingredient.link_target.presence}
+          })
+        end
+
+        if caption
+          content_tag(:figure, output, {class: ingredient.css_class.presence}.merge(html_options))
+        else
+          output
+        end
+      end
+
+      private
+
+      def caption
+        return unless show_caption?
+
+        @_caption ||= content_tag(:figcaption, ingredient.caption)
+      end
+
+      def src
+        ingredient.picture_url(picture_options)
+      end
+
+      def img_tag
+        @_img_tag ||= image_tag(
+          src, {
+            alt: alt_text,
+            title: ingredient.title.presence,
+            class: caption ? nil : ingredient.css_class.presence,
+            srcset: srcset_options.join(", ").presence,
+            sizes: sizes.join(", ").presence
+          }.merge(caption ? {} : html_options)
+        )
+      end
+
+      def show_caption?
+        show_caption && ingredient.caption.present?
+      end
+
+      def is_linked?
+        !disable_link && ingredient.link.present?
+      end
+
+      def srcset_options
+        srcset.map do |size|
+          url = ingredient.picture_url(size: size)
+          width, height = size.split("x")
+          width.present? ? "#{url} #{width}w" : "#{url} #{height}h"
+        end
+      end
+
+      def alt_text
+        ingredient.alt_tag.presence || html_options.delete(:alt) || ingredient.picture.name&.humanize
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/richtext_view.rb

@@ -0,0 +1,22 @@
+module Alchemy
+  module Ingredients
+    class RichtextView < BaseView
+      attr_reader :plain_text
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param plain_text [Boolean] (false) Whether to show as plain text or with markup
+      def initialize(ingredient, plain_text: nil, html_options: {})
+        super(ingredient)
+        @plain_text = settings_value(:plain_text, value: plain_text, default: false)
+      end
+
+      def call
+        if plain_text
+          ingredient.stripped_body
+        else
+          value.to_s.html_safe
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/select_view.rb

@@ -0,0 +1,6 @@
+module Alchemy
+  module Ingredients
+    class SelectView < BaseView
+    end
+  end
+end

data/app/components/alchemy/ingredients/text_view.rb

@@ -0,0 +1,41 @@
+module Alchemy
+  module Ingredients
+    class TextView < BaseView
+      attr_reader :disable_link
+
+      delegate :dom_id, :link, :link_title, :link_target,
+        to: :ingredient
+
+      # @param ingredient [Alchemy::Ingredient]
+      # @param disable_link [Boolean] (false) Whether to disable the link even if the picture has a link.
+      # @param html_options [Hash] Options that will be passed to the a tag.
+      def initialize(ingredient, disable_link: nil, html_options: {})
+        super(ingredient, html_options: html_options)
+        @disable_link = settings_value(:disable_link, value: disable_link, default: false)
+      end
+
+      def call
+        if disable_link?
+          dom_id.present? ? anchor : value
+        else
+          link_to(value, url_for(link), {
+            id: dom_id.presence,
+            title: link_title,
+            target: ((link_target == "blank") ? "_blank" : nil),
+            data: {link_target: link_target}
+          }.merge(html_options))
+        end
+      end
+
+      private
+
+      def anchor
+        content_tag(:a, value, {id: dom_id}.merge(html_options))
+      end
+
+      def disable_link?
+        link.blank? || disable_link
+      end
+    end
+  end
+end

data/app/components/alchemy/ingredients/video_view.rb

@@ -0,0 +1,39 @@
+module Alchemy
+  module Ingredients
+    class VideoView < BaseView
+      delegate :attachment, to: :ingredient
+
+      def call
+        content_tag(:video, html_options) do
+          tag(:source, src: src, type: attachment.file_mime_type)
+        end
+      end
+
+      def render?
+        !attachment.nil?
+      end
+
+      private
+
+      def src
+        alchemy.show_attachment_path(
+          attachment,
+          format: attachment.suffix
+        )
+      end
+
+      def html_options
+        {
+          controls: ingredient.controls,
+          autoplay: ingredient.autoplay,
+          loop: ingredient.loop,
+          muted: ingredient.muted,
+          playsinline: ingredient.playsinline,
+          preload: ingredient.preload.presence,
+          width: ingredient.width.presence,
+          height: ingredient.height.presence
+        }.merge(@html_options)
+      end
+    end
+  end
+end

data/app/controllers/alchemy/admin/attachments_controller.rb

@@ -52,7 +52,7 @@ module Alchemy
           render_errors_or_redirect(
             @attachment,
             admin_attachments_path(search_filter_params),
-            Alchemy.t("File successfully updated"),
+            Alchemy.t("File successfully updated")
           )
         end
       end
@@ -68,7 +68,7 @@ module Alchemy
         @attachment = Attachment.find(params[:id])
         send_file @attachment.file.path, {
           filename: @attachment.file_name,
-          type: @attachment.file_mime_type,
+          type: @attachment.file_mime_type
         }
       end
 
@@ -77,7 +77,7 @@ module Alchemy
       def search_filter_params
         @_search_filter_params ||= params.except(*COMMON_SEARCH_FILTER_EXCLUDES + [:attachment]).permit(
           *common_search_filter_includes + [
-            :form_field_id,
+            :form_field_id
           ]
         )
       end