alchemy_cms 8.2.10 → 8.3.0

data/app/views/alchemy/admin/translations/_en.js

@@ -1,4 +1,5 @@
 Alchemy.translations = {
+  Add: "Add",
   allowed_chars: "of %{count} chars",
   cancel: "Cancel",
   cancelled: "Cancelled",
@@ -23,6 +24,9 @@ Alchemy.translations = {
   "Uploaded bytes exceed file size": "Uploaded bytes exceed file size",
   "Abort upload": "Abort upload",
   "Cancel all uploads": "Cancel all uploads",
+  "Clear selection": "Clear selection",
+  Remove: "Remove",
+  "No results found": "No results found",
   None: "None",
   "No anchors found": "No anchors found",
   "Select a page first": "Select a page first",

data/app/views/layouts/alchemy/admin.html.erb

@@ -45,13 +45,13 @@
     </noscript>
     <alchemy-overlay text="<%= Alchemy.t(:please_wait) %>"></alchemy-overlay>
     <%= render "alchemy/admin/left_menu" %>
-    <% if current_alchemy_user %>
-      <%= render "alchemy/admin/top_menu", locked_pages: @locked_pages %>
-    <% end %>
     <%= render 'alchemy/admin/partials/flash_notices' %>
     <div id="main_content">
       <%= yield %>
     </div>
+    <% if current_alchemy_user %>
+      <%= render "alchemy/admin/top_menu", locked_pages: @locked_pages %>
+    <% end %>
     <%= render 'alchemy/admin/uploader/setup' %>
     <%= yield(:javascripts) %>
   <% end %>

data/config/importmap.rb

@@ -7,24 +7,15 @@ pin "jquery", to: "jquery.min.js", preload: true
 pin "keymaster", to: "keymaster.min.js", preload: true
 pin "select2", to: "select2.min.js", preload: true
 pin "sortablejs", to: "sortable.min.js", preload: true # @1.15.1
+pin "@floating-ui/dom", to: "floating-ui.min.js", preload: true
 pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
 pin "shoelace", to: "shoelace.min.js", preload: true
 pin "@rails/ujs", to: "rails-ujs.min.js", preload: true # @7.1.2
 pin "tinymce", to: "tinymce.min.js", preload: true
+pin "tom-select", to: "tom-select.min.js", preload: true
 
 pin "alchemy_admin", to: "alchemy/alchemy_admin.min.js", preload: true
-# Individually importable admin components. These resolve to their source
-# files (not the bundle) so host engines can import a single component without
-# loading and executing the whole admin bundle. Not preloaded, so they add no
-# fetches to normal admin page loads (which import the bundle instead).
-pin "alchemy_admin/components/page_select"
-pin "alchemy_admin/components/attachment_select"
-pin "alchemy_admin/components/element_select"
-pin "alchemy_admin/components/tags_autocomplete"
-pin "alchemy_admin/components/tinymce"
-pin "alchemy_admin/components/remote_select"
-pin "alchemy_admin/components/select"
-pin "alchemy_admin/i18n"
+pin "alchemy_admin/components/remote_select", to: "alchemy/alchemy_admin.min.js"
 pin "alchemy_admin/image_cropper", to: "alchemy/alchemy_admin.min.js"
 pin "alchemy_admin/image_overlay", to: "alchemy/alchemy_admin.min.js"
 pin "alchemy_admin/picture_selector", to: "alchemy/alchemy_admin.min.js"

data/config/locales/alchemy.en.yml

@@ -230,6 +230,12 @@ en:
           label: "Sorting"
           by_latest: "Latest"
           alphabetical: "A-Z"
+      dashboard:
+        widgets:
+          page_counts:
+            published: "published"
+          user_counts:
+            online: "online"
       elements:
         toolbar:
           hide: Hide
@@ -571,6 +577,10 @@ en:
       restricted:
         "true": "Page is only accessible by members."
         "false": "Page is accessible by all visitors."
+      scheduled:
+        public_on: "Page is visible from %{public_on}"
+        public_until: "Page is visible until %{public_until}"
+        "false": ""
     page_status_titles:
       public:
         "true": "online"
@@ -581,6 +591,9 @@ en:
       restricted:
         "true": "restricted"
         "false": "accessible"
+      scheduled:
+        "true": "scheduled"
+        "false": ""
     page_status: "Status"
     page_title: "Title"
     page_type: "Type"
@@ -834,6 +847,8 @@ en:
             base:
               restrict_dependent_destroy:
                 has_many: "There are still %{record} attached to this page. Please remove them first."
+            page_layout:
+              conflicting_wildcard_param_key: 'has a conflicting wildcard param "%{param}" already used by the "%{conflicting_layout}" page layout'
             descendants:
               still_attached_to_nodes: "The following descendant pages are still attached to menu nodes: %{page_names}. Please remove them first."
         alchemy/element:

data/config/routes.rb

@@ -11,6 +11,7 @@ Alchemy::Engine.routes.draw do
     get "/", to: redirect("#{Alchemy.admin_path}/dashboard"), as: :admin
     get "/dashboard", to: "admin/dashboard#index", as: :admin_dashboard
     get "/dashboard/info", to: "admin/dashboard#info", as: :dashboard_info
+    get "/dashboard/widgets/:id", to: "admin/dashboard/widgets#show", as: :admin_dashboard_widget
     get "/help", to: "admin/dashboard#help", as: :help
     get "/update_check" => "admin/update_checks#show", :as => :update_check
     get "/leave", to: "admin/base#leave", as: :leave_admin

data/lib/alchemy/configuration/class_option.rb

@@ -5,11 +5,54 @@ require "alchemy/configuration/base_option"
 module Alchemy
   class Configuration
     class ClassOption < BaseOption
-      def self.value_class
-        String
+      def allowed_classes
+        [String, Array]
       end
 
-      def value = @value&.constantize
+      def validate(value)
+        super
+
+        if value.is_a?(Array)
+          validate_array!(value)
+        end
+      end
+
+      def value
+        @_cached_value ||= case @value
+        when Array
+          @value[0] = @value[0]&.constantize
+          @value
+        when String
+          @value&.constantize
+        end
+      end
+
+      private
+
+      def validate_array!(value)
+        @array = value
+        has_length_two! && first_value_is_string! && second_value_is_hash!
+      end
+
+      def has_length_two!
+        return true if @array.length == 2
+
+        raise(ConfigurationError.new(name, @array, [
+          Class.new(Array) { def self.name = "an Array of length two" }
+        ]))
+      end
+
+      def first_value_is_string!
+        return true if @array[0].is_a?(String)
+
+        raise(ConfigurationError.new(name, @array[0], [String]))
+      end
+
+      def second_value_is_hash!
+        return true if @array[1].is_a?(Hash)
+
+        raise(ConfigurationError.new(name, @array[1], [Hash]))
+      end
     end
   end
 end

data/lib/alchemy/configuration/collection_option.rb

@@ -43,6 +43,10 @@ module Alchemy
         @value.delete to_item(value)
       end
 
+      def insert(index, value)
+        @value.insert(index, to_item(value))
+      end
+
       delegate :join, :[], to: :to_a
 
       delegate :clear, :empty?, to: :@value

data/lib/alchemy/configurations/dashboard.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Configurations
+    class Dashboard < Alchemy::Configuration
+      option :stats, :collection, item_type: :class, default: [
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "PageCounts",
+            style: "stat"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "UserCounts",
+            style: "stat"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "PictureCounts",
+            style: "stat"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "AttachmentCounts",
+            style: "stat"
+          }
+        ]
+      ]
+
+      option :widgets, :collection, item_type: :class, default: [
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "LockedPages",
+            style: "wide"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "RecentPages",
+            style: "wide"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "ElementUsage",
+            style: "usage",
+            loading: "lazy"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "PageUsage",
+            style: "usage",
+            loading: "lazy"
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "Sites",
+            loading: "lazy",
+            condition: -> { helpers.multi_site? }
+          }
+        ],
+        [
+          "Alchemy::Admin::Dashboard::Widget", {
+            id: "OnlineUsers",
+            loading: "lazy",
+            condition: -> {
+              Alchemy.config.user_class.respond_to?(:logged_in)
+            }
+          }
+        ]
+      ]
+    end
+  end
+end

data/lib/alchemy/configurations/main.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "alchemy/configuration"
+require "alchemy/configurations/dashboard"
 require "alchemy/configurations/default_language"
 require "alchemy/configurations/default_site"
 require "alchemy/configurations/importmap"
@@ -434,6 +435,16 @@ module Alchemy
       # The path to the page showing the user they're unauthorized
       option :unauthorized_path, :string, default: "/"
 
+      # === Admin Users Path
+      #
+      # The path to the admin users list.
+      #
+      # == Example
+      #
+      #     "/admin/users"
+      #
+      option :admin_users_path, :string
+
       # === Edit User Path
       #
       # The path to the edit user form.
@@ -453,6 +464,10 @@ module Alchemy
       # == Example
       #     Alchemy.config.abilities.add("MyCustom::Ability")
       option :abilities, :collection, item_type: :class
+
+      # === Dashboard configuration
+      #
+      configuration :dashboard, Dashboard
     end
   end
 end

data/lib/alchemy/engine.rb

@@ -17,7 +17,8 @@ module Alchemy
     end
 
     initializer "alchemy.assets" do |app|
-      if defined?(Sprockets)
+      if defined?(::Sprockets)
+        require_relative "sprockets/skip_builds_compression"
         require_relative "../non_stupid_digest_assets"
         NonStupidDigestAssets.whitelist += [/^tinymce\//]
         app.config.assets.precompile << "alchemy_manifest.js"
@@ -25,7 +26,7 @@ module Alchemy
     end
 
     initializer "alchemy.admin_stylesheets" do |app|
-      if defined?(Sprockets)
+      if defined?(::Sprockets)
         Alchemy.config.admin_stylesheets.each do |stylesheet|
           app.config.assets.precompile << stylesheet
         end
@@ -33,7 +34,7 @@ module Alchemy
     end
 
     initializer "alchemy.propshaft" do |app|
-      if defined?(Propshaft)
+      if defined?(::Propshaft)
         if app.config.assets.server
           # Monkey-patch Propshaft::Asset to enable access
           # of TinyMCE assets without a hash digest.
@@ -67,6 +68,11 @@ module Alchemy
         end
 
         if app.config.importmap.sweep_cache
+          # The importmap pins resolve to the bundled files in app/assets/builds,
+          # so the cache must be swept when those are rebuilt. Without this the
+          # cached importmap keeps emitting the previous digest after a rebuild
+          # and the asset 404s until the server is restarted.
+          watch_paths << Alchemy::Engine.root.join("app/assets/builds")
           Alchemy.importmap.cache_sweeper(watches: watch_paths)
           ActiveSupport.on_load(:action_controller_base) do
             before_action { Alchemy.importmap.cache_sweeper.execute_if_updated }

data/lib/alchemy/sprockets/skip_builds_compression.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+begin
+  require "sprockets/sass_compressor"
+rescue LoadError
+  # Sprockets::SassCompressor is only defined if sassc-rails is present,
+  # which is not the case in all environments (for example, when using Propshaft).
+  # In that case, we can skip prepending our patch module.
+end
+
+module Alchemy
+  module Sprockets
+    # Alchemy ships pre-built, already-minified admin CSS in +app/assets/builds+
+    # that uses modern CSS syntax (relative colors, +oklch()+ and friends). The
+    # legacy SassC/libSass +css_compressor+ — the Sprockets default whenever
+    # +sassc-rails+ is present (for example through Solidus) — re-parses every
+    # +text/css+ asset as SCSS and raises on that syntax. These files are already
+    # minified, so leave them untouched; all other stylesheets still get
+    # compressed as before.
+    module SkipBuildsCompression
+      def call(input)
+        builds_path = Alchemy::Engine.root.join("app/assets/builds").to_s
+        if input[:filename].to_s.start_with?(builds_path)
+          {data: input[:data]}
+        else
+          super
+        end
+      end
+
+      ::Sprockets::SassCompressor.singleton_class.prepend(self)
+    end
+  end
+end

data/lib/alchemy/test_support/capybara_helpers.rb

@@ -25,6 +25,23 @@ module Alchemy
         end
       end
 
+      # Tom Select capybara helper
+      def tom_select(value, options)
+        label = find_label_by_text(options[:from])
+
+        within label.find(:xpath, "..") do
+          find(".ts-control").click
+        end
+
+        # The dropdown is appended to the body, so search the whole page for it.
+        within_entire_page do
+          find(
+            ".ts-dropdown .option",
+            text: /#{Regexp.escape(value)}/i, match: :prefer_exact
+          ).click
+        end
+      end
+
       def select2_search(value, options)
         if options[:from]
           label = find_label_by_text(options[:from])

data/lib/alchemy/test_support/relatable_resource_examples.rb

@@ -55,4 +55,24 @@ RSpec.shared_examples_for "a relatable resource" do |args|
       it { is_expected.to be(true) }
     end
   end
+
+  describe "after_touch" do
+    let(:related_object) { create(:"alchemy_#{args[:resource_name]}") }
+
+    context "when related ingredients exist" do
+      let!(:ingredient) { create(:"alchemy_ingredient_#{args[:ingredient_type]}", related_object:) }
+
+      it "enqueues InvalidateElementsCacheJob" do
+        expect {
+          related_object.touch
+        }.to have_enqueued_job(Alchemy::InvalidateElementsCacheJob).with(described_class.name, related_object.id)
+      end
+    end
+
+    context "when no related ingredients exist" do
+      it "does not enqueue InvalidateElementsCacheJob" do
+        expect { related_object.touch }.to_not have_enqueued_job(Alchemy::InvalidateElementsCacheJob)
+      end
+    end
+  end
 end

data/lib/alchemy/test_support/rspec_matchers.rb

@@ -12,3 +12,11 @@ RSpec::Matchers.define :include_language_information_for do |expected|
     actual[:alchemy_language_id] == expected.id
   end
 end
+
+# This matcher checks for the presence of an alchemy-select component with a given label.
+RSpec::Matchers.define :have_alchemy_select do |expected|
+  match do |session|
+    label = session.find(:css, "label", exact_text: expected)
+    label.has_sibling?(%(select[is="alchemy-select"]), visible: :all)
+  end
+end

data/lib/alchemy/test_support/shared_publishable_examples.rb

@@ -3,7 +3,7 @@
 RSpec.shared_examples_for "being publishable" do |factory_name|
   describe "validations" do
     context "when public_until is older than public_on" do
-      let(:record) do
+      let(:publishable) do
         build(
           factory_name,
           public_on: Time.current,
@@ -12,8 +12,8 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
       end
 
       it "is not valid" do
-        expect(record).not_to be_valid
-        expect(record.errors[:public_until]).to include(
+        expect(publishable).not_to be_valid
+        expect(publishable.errors[:public_until]).to include(
           I18n.t("errors.attributes.public_until.must_be_after_public_on")
         )
       end
@@ -81,22 +81,12 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
         ])
       end
     end
-
-    context "with a publication window that has not started yet" do
-      let!(:future_window) do
-        create(factory_name, public_on: Date.tomorrow, public_until: Date.tomorrow + 2.days)
-      end
-
-      it "does not return the record" do
-        expect(described_class.published.where(id: future_window.id)).to be_empty
-      end
-    end
   end
 
   describe "#scheduled?" do
-    subject { record.scheduled? }
+    subject { publishable.scheduled? }
 
-    let(:record) { build(factory_name, public_on:, public_until:) }
+    let(:publishable) { build(factory_name, public_on:, public_until:) }
 
     context "when public_on is nil" do
       let(:public_on) { nil }
@@ -153,17 +143,17 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
   end
 
   describe "#public?" do
-    subject { page_version.public? }
+    subject { publishable.public? }
 
     context "when public_on is not set" do
-      let(:page_version) { build(factory_name, public_on: nil) }
+      let(:publishable) { build(factory_name, public_on: nil) }
 
       it { is_expected.to be(false) }
     end
 
     context "when public_on is set to past date" do
       context "and public_until is set to nil" do
-        let(:page_version) do
+        let(:publishable) do
           build(factory_name,
             public_on: Time.current - 2.days,
             public_until: nil)
@@ -173,7 +163,7 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
       end
 
       context "and public_until is set to future date" do
-        let(:page_version) do
+        let(:publishable) do
           build(factory_name,
             public_on: Time.current - 2.days,
             public_until: Time.current + 2.days)
@@ -183,7 +173,7 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
       end
 
       context "and public_until is set to past date" do
-        let(:page_version) do
+        let(:publishable) do
           build(factory_name,
             public_on: Time.current - 2.days,
             public_until: Time.current - 1.days)
@@ -194,13 +184,13 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
     end
 
     context "when public_on is set to future date" do
-      let(:page_version) { build(factory_name, public_on: Time.current + 2.days) }
+      let(:publishable) { build(factory_name, public_on: Time.current + 2.days) }
 
       it { is_expected.to be(false) }
     end
 
     context "when Current.preview_time is set" do
-      let(:page_version) do
+      let(:publishable) do
         build(factory_name,
           public_on: Time.zone.parse("2025-06-01 00:00:00"),
           public_until: Time.zone.parse("2025-06-30 23:59:59"))
@@ -208,54 +198,61 @@ RSpec.shared_examples_for "being publishable" do |factory_name|
 
       it "uses preview_time to determine visibility" do
         Alchemy::Current.preview_time = Time.zone.parse("2025-06-15 12:00:00")
-        expect(page_version.public?).to be(true)
+        expect(publishable.public?).to be(true)
       end
 
       it "returns false when preview_time is outside the public range" do
         Alchemy::Current.preview_time = Time.zone.parse("2025-07-15 12:00:00")
-        expect(page_version.public?).to be(false)
+        expect(publishable.public?).to be(false)
       end
 
       it "returns false when preview_time is before public_on" do
         Alchemy::Current.preview_time = Time.zone.parse("2025-05-15 12:00:00")
-        expect(page_version.public?).to be(false)
+        expect(publishable.public?).to be(false)
       end
     end
   end
 
   describe "#publishable?" do
+    let(:publishable) { build(factory_name, public_on:, public_until:) }
+    let(:public_on) { nil }
+    let(:public_until) { nil }
+
+    subject { publishable.publishable? }
+
     context "when public_on is nil" do
-      let(:page_version) { build(factory_name, public_on: nil) }
+      let(:public_on) { nil }
 
-      it { expect(page_version.publishable?).to be(false) }
+      it { is_expected.to be(false) }
     end
 
     context "when public_on is set and public_until is nil" do
-      let(:page_version) { build(factory_name, public_on: Time.current) }
+      let(:public_on) { Time.current }
 
-      it { expect(page_version.publishable?).to be(true) }
+      it { is_expected.to be(true) }
+    end
+
+    context "when public_on is set and public_until is in the future" do
+      let(:public_on) { Time.current }
+      let(:public_until) { Time.current + 1.day }
+
+      it { is_expected.to be(true) }
     end
 
     context "when public_on is set and public_until is in the past" do
-      let(:page_version) do
-        build(factory_name,
-          public_on: Time.current - 2.days,
-          public_until: Time.current - 1.day)
-      end
+      let(:public_on) { Time.current - 2.days }
+      let(:public_until) { Time.current - 1.day }
 
-      it { expect(page_version.publishable?).to be(false) }
+      it { is_expected.to be(false) }
     end
 
     context "when Current.preview_time is set to a future time" do
-      let(:page_version) do
-        build(factory_name,
-          public_on: Time.current - 1.day,
-          public_until: Time.current + 1.day)
-      end
+      let(:public_on) { Time.current - 1.day }
+      let(:public_until) { Time.current + 1.day }
 
       it "uses Time.current instead of the preview_time" do
         Alchemy::Current.preview_time = Time.current + 1.week
-        expect(page_version.publishable?).to be(true)
+        is_expected.to be(true)
       end
     end
   end

data/lib/alchemy/tinymce.rb

@@ -5,7 +5,6 @@ module Alchemy
     mattr_accessor :languages, :plugins
 
     DEFAULT_PLUGINS = %w[
-      alchemy_link
       anchor
       charmap
       code
@@ -13,6 +12,7 @@ module Alchemy
       fullscreen
       link
       lists
+      alchemy_link
     ]
 
     @@plugins = DEFAULT_PLUGINS

data/lib/alchemy/version.rb

@@ -1,13 +1,27 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "8.2.10"
+  extend self
 
-  def self.version
+  VERSION = "8.3.0"
+
+  def version
     VERSION
   end
 
-  def self.gem_version
+  def gem_version
     Gem::Version.new(VERSION)
   end
+
+  def git_revision_info
+    source = Bundler.locked_gems.sources.find { _1.name == "alchemy_cms" }
+    return unless source.respond_to?(:revision)
+
+    {
+      revision: source.revision,
+      branch: source.branch
+    }
+  rescue
+    nil
+  end
 end