alchemy_cms 8.1.9 → 8.2.0

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

@@ -7,14 +7,18 @@ module Alchemy
 
       before_action :load_page_and_version, only: [:index, :new]
       include Alchemy::Admin::Clipboard
+      include Alchemy::Admin::PreviewTime
 
       before_action :load_element, only: [:update, :destroy, :collapse, :expand, :publish]
       authorize_resource class: Alchemy::Element
 
       def index
-        elements = @page_version.elements.order(:position).includes(*element_includes)
-        @elements = elements.not_nested.unfixed
-        @fixed_elements = elements.not_nested.fixed
+        preloaded = Alchemy::ElementPreloader
+          .new(page_version: @page_version)
+          .call
+
+        @elements = preloaded.reject(&:fixed?)
+        @fixed_elements = preloaded.select(&:fixed?)
       end
 
       def new
@@ -89,12 +93,23 @@ module Alchemy
       end
 
       def publish
-        @element.public = !@element.public?
-        @element.save(validate: false)
-        render json: {
-          public: @element.public?,
-          label: @element.public? ? Alchemy.t(:hide_element) : Alchemy.t(:show_element)
-        }.merge(pagePublicationData(@element.page))
+        if schedule_element_params.present?
+          @element.assign_attributes(schedule_element_params)
+          @element.skip_ingredient_validations = true
+          @element.save
+          status = @element.valid? ? 200 : 422
+        else
+          @element.public = !@element.public?
+          @element.save(validate: false)
+          status = 200
+        end
+
+        respond_to do |format|
+          format.turbo_stream do
+            @page = @element.page
+            render status:
+          end
+        end
       end
 
       def order
@@ -119,12 +134,12 @@ module Alchemy
       def collapse
         # We do not want to trigger the touch callback or any validations
         @element.update_columns(folded: true)
-        # Collapse all nested elements
-        nested_elements_ids = collapse_nested_elements_ids(@element)
-        Alchemy::Element.where(id: nested_elements_ids).update_all(folded: true)
+        # Collapse all nested elements (except compact ones which stay as-is)
+        nested_element_ids = nested_element_ids_to_collapse(@element)
+        Alchemy::Element.where(id: nested_element_ids).update_all(folded: true)
 
         render json: {
-          nestedElementIds: nested_elements_ids,
+          nestedElementIds: nested_element_ids,
           title: Alchemy.t(@element.folded? ? :show_element_content : :hide_element_content)
         }
       end
@@ -152,30 +167,31 @@ module Alchemy
         @page = @page_version.page
       end
 
-      def collapse_nested_elements_ids(element)
+      # Collects IDs of nested elements that should be collapsed.
+      # Skips compact elements (they retain their fold state).
+      # Optimized to use a single query instead of N queries for N levels.
+      def nested_element_ids_to_collapse(element)
+        all_elements = Element
+          .where(page_version_id: element.page_version_id)
+          .select(:id, :parent_element_id, :folded, :name)
+          .to_a
+
+        children_by_parent = all_elements.group_by(&:parent_element_id)
+
         ids = []
-        element.all_nested_elements.includes(:all_nested_elements).reject(&:compact?).each do |nested_element|
-          ids.push nested_element.id if nested_element.expanded?
-          ids.concat collapse_nested_elements_ids(nested_element) if nested_element.all_nested_elements.reject(&:compact?).any?
+        stack = [element.id]
+
+        while stack.any?
+          current_id = stack.pop
+          children = children_by_parent[current_id] || []
+
+          children.reject(&:compact?).each do |child|
+            ids << child.id if child.expanded?
+            stack << child.id
+          end
         end
-        ids
-      end
 
-      def element_includes
-        [
-          {
-            ingredients: :related_object
-          },
-          :tags,
-          {
-            all_nested_elements: [
-              {
-                ingredients: :related_object
-              },
-              :tags
-            ]
-          }
-        ]
+        ids
       end
 
       def load_element
@@ -216,6 +232,10 @@ module Alchemy
       def create_element_params
         params.require(:element).permit(:name, :page_version_id, :parent_element_id)
       end
+
+      def schedule_element_params
+        params[:element]&.permit(:public_on, :public_until)
+      end
     end
   end
 end

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

@@ -5,6 +5,7 @@ module Alchemy
     class PagesController < ResourcesController
       include OnPageLayout::CallbacksRunner
       include Alchemy::Admin::Clipboard
+      include Alchemy::Admin::PreviewTime
 
       helper "alchemy/pages"
 

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

@@ -18,12 +18,7 @@ module Alchemy
       before_action :authorize_resource
 
       def index
-        @query = resource_handler.model.ransack(search_filter_params[:q])
-        @query.sorts = default_sort_order if @query.sorts.empty?
-        items = @query.result
-
-        items = items.includes(*resource_relations_names) if contains_relations?
-        items = items.tagged_with(search_filter_params[:tagged_with]) if search_filter_params[:tagged_with].present?
+        items = collection
 
         respond_to do |format|
           format.html do
@@ -121,6 +116,16 @@ module Alchemy
         authorize!(action_name.to_sym, resource_instance_variable || resource_handler.model)
       end
 
+      def collection
+        @query = resource_handler.model.ransack(search_filter_params[:q])
+        @query.sorts = default_sort_order if @query.sorts.empty?
+        items = @query.result(distinct: true)
+
+        items = items.includes(*resource_relations_names) if contains_relations?
+        items = items.tagged_with(search_filter_params[:tagged_with]) if search_filter_params[:tagged_with].present?
+        items
+      end
+
       # Permits all editable resource attributes as default.
       #
       # Define this method in your inheriting controller if you want to permit additional attributes.

data/app/controllers/alchemy/pages_controller.rb

@@ -230,8 +230,7 @@ module Alchemy
     # Otherwise all users will see the same cached page, regardless of user's state.
     #
     def page_etag
-      elements_cache_key = @page.public_version&.elements&.published&.order(:id)&.pluck(:id)
-      [@page, elements_cache_key, current_alchemy_user]
+      Alchemy::Page::EtagGenerator.new(@page).call(current_alchemy_user)
     end
 
     # We only render the page if either the cache is disabled for this page

data/app/helpers/alchemy/admin/base_helper.rb

@@ -17,15 +17,12 @@ module Alchemy
       #
       # In order to represent your own +User+'s class instance,
       # you should add a +alchemy_display_name+ method to your +User+ class
-      #
+      # @deprecated Use the +CurrentAlchemyUserName+ component instead.
       def current_alchemy_user_name
-        name = current_alchemy_user.try(:alchemy_display_name)
-        if name.present?
-          content_tag :span, class: "current-user-name" do
-            "#{render_icon(:user, size: "1x")} #{name}".html_safe
-          end
-        end
+        render Alchemy::Admin::CurrentUserName.new(user: current_alchemy_user)
       end
+      deprecate current_alchemy_user_name: "Use the Alchemy::Admin::CurrentUserName component instead.",
+        deprecator: Alchemy::Deprecation
 
       # This helper renders the link to an dialog.
       #

data/app/helpers/alchemy/url_helper.rb

@@ -8,20 +8,12 @@ module Alchemy
   module UrlHelper
     # Returns the path for rendering an alchemy page
     def show_alchemy_page_path(page, optional_params = {})
-      alchemy.show_page_path(show_page_path_params(page, optional_params))
+      page.url_path(optional_params)
     end
 
     # Returns the url for rendering an alchemy page
     def show_alchemy_page_url(page, optional_params = {})
-      alchemy.show_page_url(show_page_path_params(page, optional_params))
-    end
-
-    # Returns the correct params-hash for passing to show_page_path
-    def show_page_path_params(page, optional_params = {})
-      raise ArgumentError, "Page is nil" if page.nil?
-
-      url_params = {urlname: page.urlname}.update(optional_params)
-      prefix_locale?(page.language_code) ? url_params.update(locale: page.language_code) : url_params
+      "#{request.base_url}#{page.url_path(optional_params)}"
     end
 
     # Returns the path for downloading an alchemy attachment

data/app/javascript/alchemy_admin/components/element_editor/publish_element_button.js

@@ -1,42 +1,43 @@
-import { patch } from "alchemy_admin/utils/ajax"
-import { reloadPreview } from "alchemy_admin/components/preview_window"
-import { growl } from "alchemy_admin/growler"
-import { dispatchPageDirtyEvent } from "alchemy_admin/components/element_editor"
-
 export class PublishElementButton extends HTMLElement {
-  constructor() {
-    super()
+  #scheduleButtonVariant
+
+  connectedCallback() {
+    this.#scheduleButtonVariant = this.scheduleButton.getAttribute("variant")
+    this.publishButton.addEventListener("click", this)
+    this.dropdown.addEventListener("sl-show", this)
+    this.dropdown.addEventListener("sl-hide", this)
+  }
 
-    this.addEventListener("sl-change", this)
+  disconnectedCallback() {
+    this.publishButton.removeEventListener("click", this)
+    this.dropdown.removeEventListener("sl-show", this)
+    this.dropdown.removeEventListener("sl-hide", this)
   }
 
   handleEvent(event) {
-    const elementEditor = event.target.closest("alchemy-element-editor")
-    if (elementEditor === this.elementEditor) {
-      patch(Alchemy.routes.publish_admin_element_path(this.elementId))
-        .then((response) => {
-          const data = response.data
-          this.elementEditor.published = data.public
-          this.tooltip.setAttribute("content", data.label)
-          reloadPreview()
-          if (data.pageHasUnpublishedChanges) {
-            dispatchPageDirtyEvent(data)
-          }
-        })
-        .catch((error) => growl(error.message, "error"))
+    switch (event.type) {
+      case "click":
+        this.publishButton.loading = true
+        break
+      case "sl-show":
+        this.scheduleButton.setAttribute("variant", "primary")
+        break
+      case "sl-hide":
+        this.scheduleButton.setAttribute("variant", this.#scheduleButtonVariant)
+        break
     }
   }
 
-  get elementEditor() {
-    return this.closest("alchemy-element-editor")
+  get publishButton() {
+    return this.querySelector("sl-button[type='submit']")
   }
 
-  get tooltip() {
-    return this.closest("sl-tooltip")
+  get dropdown() {
+    return this.querySelector("sl-dropdown")
   }
 
-  get elementId() {
-    return this.elementEditor.elementId
+  get scheduleButton() {
+    return this.querySelector("sl-button[slot='trigger']")
   }
 }
 

data/app/javascript/alchemy_admin/components/element_editor.js

@@ -27,7 +27,7 @@ export class ElementEditor extends HTMLElement {
 
     // Dirty observer still needs to be jQuery
     // in order to support select2.
-    $(this).on("change", this.onChange)
+    $(this.form).on("change", this.onChange)
 
     this.header?.addEventListener("dblclick", () => {
       this.toggle()
@@ -87,7 +87,7 @@ export class ElementEditor extends HTMLElement {
     if (target.classList.contains("nested-elements")) {
       return
     }
-    this.setDirty(target)
+    this.closest("alchemy-element-editor").setDirty(target)
     event.stopPropagation()
     return false
   }
@@ -555,6 +555,15 @@ export class ElementEditor extends HTMLElement {
     return this.querySelector("alchemy-element-editor")
   }
 
+  /**
+   * The form element if present
+   *
+   * @returns {HTMLFormElement|undefined}
+   */
+  get form() {
+    return this.querySelector("form.element-body")
+  }
+
   /**
    * The parent element editor if present
    *

data/app/javascript/alchemy_admin/components/message.js

@@ -39,6 +39,10 @@ class Message extends HTMLElement {
     return this.hasAttribute("dismissable")
   }
 
+  get icon() {
+    return this.getAttribute("icon")
+  }
+
   get type() {
     return this.getAttribute("type") || "notice"
   }
@@ -50,7 +54,7 @@ class Message extends HTMLElement {
   }
 
   get iconName() {
-    switch (this.type) {
+    switch (this.icon || this.type) {
       case "warning":
       case "warn":
       case "alert":

data/app/javascript/alchemy_admin/components/uploader/file_upload.js

@@ -85,13 +85,13 @@ export class FileUpload extends AlchemyHTMLElement {
       errorMessage = translate("Uploaded bytes exceed file size")
     }
 
-    const fileConfiguration = this.file?.type.includes("image")
-      ? "allowed_filetype_pictures"
-      : "allowed_filetype_attachments"
+    const allowedFiletypes = this.file?.type.includes("image")
+      ? config.allowed_filetypes.alchemy_pictures
+      : config.allowed_filetypes.alchemy_attachments
 
     const isFileFormatSupported =
-      config[fileConfiguration] === "*" ||
-      config[fileConfiguration].includes(
+      allowedFiletypes.includes("*") ||
+      allowedFiletypes.includes(
         this.file?.type.replace(/^\w+\/(\w+)(\+\w+)?/i, "$1")
       )
 

data/app/javascript/alchemy_admin/image_cropper.js

@@ -6,13 +6,17 @@ export default class ImageCropper {
   #cropFromField = null
   #cropSizeField = null
 
-  constructor(image, defaultBox, aspectRatio, formFieldIds, elementId) {
+  constructor(image, settings) {
     this.image = image
-    this.defaultBox = defaultBox
-    this.aspectRatio = aspectRatio
-    this.#cropFromField = document.getElementById(formFieldIds[0])
-    this.#cropSizeField = document.getElementById(formFieldIds[1])
-    this.elementId = elementId
+    this.defaultBox = settings.default_box
+    this.aspectRatio = settings.ratio
+    this.#cropFromField = document.getElementById(
+      settings.crop_from_form_field_id
+    )
+    this.#cropSizeField = document.getElementById(
+      settings.crop_size_form_field_id
+    )
+    this.elementId = settings.element_id
     this.dialog = Alchemy.currentDialog()
     if (this.dialog) {
       this.dialog.options.closed = () => this.destroy()

data/app/javascript/alchemy_admin/initializer.js

@@ -1,48 +1,21 @@
 import Hotkeys from "alchemy_admin/hotkeys"
 import pleaseWaitOverlay from "alchemy_admin/please_wait_overlay"
 
-/**
- * add change listener to select to redirect the user after selecting another locale or site
- * @param {string} selectId
- * @param {string} parameterName
- * @param {boolean} forcedReload
- */
-function selectHandler(selectId, parameterName, forcedReload = false) {
-  $(`select#${selectId}`).on("change", function (e) {
-    let url = window.location.pathname
-    let delimiter = url.match(/\?/) ? "&" : "?"
-    const location = `${url}${delimiter}${parameterName}=${$(this).val()}`
-
-    if (forcedReload) {
-      window.location.href = location
-    } else {
-      Turbo.visit(location, {})
-    }
-  })
-}
-
 export default function Initializer() {
   // We obviously have javascript enabled.
-  $("html").removeClass("no-js")
+  document.documentElement.classList.remove("no-js")
 
   // Initialize hotkeys.
   Hotkeys()
 
   // Add observer for please wait overlay.
-  $(".please_wait").on("click", pleaseWaitOverlay)
+  document.querySelectorAll(".please_wait").forEach((element) => {
+    element.addEventListener("click", pleaseWaitOverlay)
+  })
 
   // Hack for enabling tab focus for <a>'s styled as button.
-  $("a.button").attr({ tabindex: 0 })
-
-  // Locale select handler
-  selectHandler("change_locale", "admin_locale", true)
-
-  // Site select handler
-  selectHandler("change_site", "site_id")
-
-  // Submit forms of selects with `data-autosubmit="true"`
-  $('select[data-auto-submit="true"]').on("change", function () {
-    $(this.form).submit()
+  document.querySelectorAll("a.button").forEach((button) => {
+    button.setAttribute("tabindex", 0)
   })
 
   // Override the filter of keymaster.js so we can blur the fields on esc key.

data/app/javascript/alchemy_admin/shoelace_theme.js

@@ -47,12 +47,16 @@ const spriteUrl = document
   .getAttribute("href")
 
 const iconMap = {
-  "x-lg": "close"
+  "x-lg": "close",
+  caret: "arrow-down-s"
 }
 
 const options = {
   resolver: (name) => `${spriteUrl}#ri-${iconMap[name] || name}-line`,
-  mutator: (svg) => svg.setAttribute("fill", "currentColor"),
+  mutator: (svg) => {
+    svg.setAttribute("fill", "currentColor")
+    svg.setAttribute("viewBox", "0 0 24 24")
+  },
   spriteSheet: true
 }
 

data/app/javascript/alchemy_admin/templates/compiled.js

@@ -1 +1 @@
-(()=>{var n=Handlebars.template;(Handlebars.templates=Handlebars.templates||{})["node_folder.hbs"]=n({1:function(n,e,l,a,r){return"right"},3:function(n,e,l,a,r){return"down"},compiler:[8,">= 4.3.0"],main:function(n,e,l,a,r){var o,t=n.lambda,d=n.escapeExpression,u=n.lookupProperty||function(n,e){if(Object.prototype.hasOwnProperty.call(n,e))return n[e]};return'<a class="node_folder" data-record-id="'+d(t(null!=(o=null!=e?u(e,"node"):e)?u(o,"id"):o,e))+'" data-record-type="'+d(t(null!=(o=null!=e?u(e,"node"):e)?u(o,"type"):o,e))+'">\n  <alchemy-icon name="arrow-'+(null!=(o=u(l,"if").call(null!=e?e:n.nullContext||{},null!=(o=null!=e?u(e,"node"):e)?u(o,"folded"):o,{name:"if",hash:{},fn:n.program(1,r,0),inverse:n.program(3,r,0),data:r,loc:{start:{line:2,column:28},end:{line:2,column:72}}}))?o:"")+'-s"></alchemy-icon>\n</a>\n'},useData:!0})})();
+(()=>{var n=Handlebars.template;(Handlebars.templates=Handlebars.templates||{})["node_folder.hbs"]=n({0:function(n,e,l,a,r){return"right"},1:function(n,e,l,a,r){return"down"},compiler:[8,">= 4.3.0"],main:function(n,e,l,a,r){var o,t=n.lambda,d=n.escapeExpression,u=n.lookupProperty||function(n,e){if(Object.prototype.hasOwnProperty.call(n,e))return n[e]};return'<a class="node_folder" data-record-id="'+d(t(null!=(o=null!=e?u(e,"node"):e)?u(o,"id"):o,e))+'" data-record-type="'+d(t(null!=(o=null!=e?u(e,"node"):e)?u(o,"type"):o,e))+'">\n  <alchemy-icon name="arrow-'+(null!=(o=u(l,"if").call(null!=e?e:n.nullContext||{},null!=(o=null!=e?u(e,"node"):e)?u(o,"folded"):o,{name:"if",hash:{},fn:n.program(0,r,0),inverse:n.program(1,r,0),data:r,loc:{start:{line:2,column:28},end:{line:2,column:72}}}))?o:"")+'-s"></alchemy-icon>\n</a>\n'},useData:!0})})();

data/app/javascript/alchemy_admin.js

@@ -2,7 +2,7 @@
 import "handlebars"
 import "jquery"
 import "@ungap/custom-elements"
-import "@hotwired/turbo-rails"
+import { Turbo } from "@hotwired/turbo-rails"
 import "select2"
 
 import Rails from "@rails/ujs"
@@ -49,4 +49,14 @@ Object.assign(Alchemy, {
 
 Rails.start()
 Turbo.config.forms.confirm = openConfirmDialog
-$(document).on("turbo:load", Initializer)
+document.addEventListener("turbo:load", Initializer)
+
+// Public API for extensions
+export { RemoteSelect } from "alchemy_admin/components/remote_select"
+export { on } from "alchemy_admin/utils/events"
+
+// Page-specific modules - bundled to avoid dual-loading
+export { default as ImageCropper } from "alchemy_admin/image_cropper"
+export { default as ImageOverlay } from "alchemy_admin/image_overlay"
+export { default as pictureSelector } from "alchemy_admin/picture_selector"
+export { default as NodeTree } from "alchemy_admin/node_tree"

data/app/models/alchemy/attachment.rb

@@ -114,7 +114,7 @@ module Alchemy
 
     # Checks if the attachment is restricted, because it is attached on restricted pages only
     def restricted?
-      pages.any? && pages.not_restricted.blank?
+      related_pages.any? && related_pages.not_restricted.blank?
     end
 
     # File name

data/app/models/alchemy/current.rb

@@ -1,6 +1,6 @@
 module Alchemy
   class Current < ActiveSupport::CurrentAttributes
-    attribute :preview_page, :page, :language, :site
+    attribute :preview_page, :preview_time, :page, :language, :site
 
     def language
       super || Language.default
@@ -10,6 +10,10 @@ module Alchemy
       super || Site.first
     end
 
+    def preview_time
+      super || Time.current
+    end
+
     def preview_page=(page)
       super
 

data/app/models/alchemy/element/element_ingredients.rb

@@ -75,11 +75,19 @@ module Alchemy
       # This is used to re-initialize the TinyMCE editor in the element editor.
       #
       def richtext_ingredients_ids
-        ids = ingredients.select(&:has_tinymce?).collect(&:id)
-        expanded_nested_elements = nested_elements.expanded
+        ids = ingredients.filter_map { |i| i.id if i.has_tinymce? }
+
+        # Use preloaded association if available, otherwise query
+        expanded_nested_elements = if association(:all_nested_elements).loaded?
+          all_nested_elements.select(&:expanded?)
+        else
+          nested_elements.expanded
+        end
+
         if expanded_nested_elements.present?
-          ids += expanded_nested_elements.collect(&:richtext_ingredients_ids)
+          ids += expanded_nested_elements.map(&:richtext_ingredients_ids)
         end
+
         ids.flatten
       end
 

data/app/models/alchemy/element.rb

@@ -37,6 +37,8 @@ module Alchemy
     include Alchemy::Taggable
     include Publishable
 
+    attr_accessor :skip_ingredient_validations
+
     FORBIDDEN_DEFINITION_ATTRIBUTES = [
       "amount",
       "autogenerate",
@@ -96,6 +98,7 @@ module Alchemy
 
     validates_presence_of :name, on: :create
     validates_format_of :name, on: :create, with: NAME_REGEXP
+    validate :validate_same_page_version_as_parent
 
     after_initialize :set_default_public_on, if: :new_record?
 
@@ -326,6 +329,13 @@ module Alchemy
       self.public_on ||= Time.current
     end
 
+    def validate_same_page_version_as_parent
+      return unless parent_element
+      return if page_version_id == parent_element.page_version_id
+
+      errors.add(:page_version_id, :must_match_parent)
+    end
+
     def generate_nested_elements
       definition.autogenerate.each do |nestable_element|
         if nestable_elements.include?(nestable_element)

data/app/models/alchemy/ingredient.rb

@@ -147,6 +147,8 @@ module Alchemy
 
     # @return [Boolean]
     def has_validations?
+      return false if element.skip_ingredient_validations
+
       definition.validate.any?
     end
 

data/app/models/alchemy/ingredients/select.rb

@@ -5,8 +5,7 @@ module Alchemy
     # A text value from a select box
     #
     class Select < Alchemy::Ingredient
-      allow_settings %i[display_inline select_values]
-      allow_settings %i[display_inline select_values multiple]
+      allow_settings %i[allow_clear display_inline select_values multiple]
 
       serialize :value, coder: JSON
 

data/app/models/alchemy/page/etag_generator.rb

@@ -0,0 +1,21 @@
+module Alchemy
+  # Generates an ETag for a page.
+  #
+  # By default, it uses the page's id and the ids of its published elements.
+  # You can customize this by providing your own generator in the configuration.
+  class Page::EtagGenerator
+    attr_reader :page
+
+    # @param page [Alchemy::Page] The page for which to generate the ETag.
+    def initialize(page)
+      @page = page
+    end
+
+    # @return [Array<Object>]
+    # @param args [Array<Object>] Additional arguments that can be used in the ETag generation.
+    def call(*args)
+      elements_cache_key = page.public_version&.elements&.published&.order(:id)&.pluck(:id)
+      [page, elements_cache_key, *args]
+    end
+  end
+end