alchemy_cms 8.2.7 → 8.3.0

data/app/components/alchemy/admin/dashboard/widget.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Admin
+    module Dashboard
+      class Widget < ViewComponent::Base
+        delegate :alchemy, to: :helpers
+
+        erb_template <<~ERB
+          <div class="widget <%= @style %>">
+            <turbo-frame id="<%= @id %>" src="<%= url %>" loading="<%= @loading %>">
+              <alchemy-spinner size="small"></alchemy-spinner>
+            </turbo-frame>
+          </div>
+        ERB
+
+        def initialize(id:, loading: "eager", style: "default", condition: nil)
+          @id = id
+          @loading = loading
+          @style = style
+          @condition = condition
+
+          if condition && !condition.respond_to?(:call)
+            raise ArgumentError, ":condition argument must be a proc or lambda"
+          end
+        end
+
+        private
+
+        def render?
+          return true if @condition.nil?
+
+          instance_exec(&@condition)
+        end
+
+        def url = alchemy.admin_dashboard_widget_path(id: @id)
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/attachment_counts.rb

@@ -0,0 +1,17 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class AttachmentCounts < StatWidget
+          private
+
+          def title = Alchemy::Attachment.model_name.human(count: :many)
+          def link = alchemy.admin_attachments_path
+          def icon = "file-copy-2"
+          def count = Alchemy::Attachment.count
+          def infos = number_to_human_size(Alchemy::Attachment.sum(&:file_size))
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/element_usage.rb

@@ -0,0 +1,37 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class ElementUsage < UsageWidget
+          private
+
+          def header_text(total:)
+            Alchemy.t(:element_usage, total:)
+          end
+
+          def definitions
+            Alchemy::ElementDefinition.all
+          end
+
+          def public_counts
+            @public_counts ||= Alchemy::Element.published.group(:name).count
+          end
+
+          def draft_counts
+            @draft_counts ||= Alchemy::Element
+              .where("alchemy_elements.public_on IS NULL OR alchemy_elements.public_until <= ?", Time.current)
+              .group(:name).count
+          end
+
+          def entry_label(entry)
+            Alchemy::Element.display_name_for(entry.name)
+          end
+
+          def entry_icon(entry)
+            entry.definition.icon_file
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/greeting.html.erb

@@ -0,0 +1,13 @@
+<div class="greeting">
+  <h1>
+    <%= Alchemy.t(@first_time ? :welcome_note : :welcome_back_note, name: "") %>
+    <span class="user-name">
+      <%= @user.alchemy_display_name %>
+    </span>
+  </h1>
+  <% if @last_sign_at %>
+    <p>
+      <%= Alchemy.t('Your last login was on', time: l(@last_sign_at, format: :'alchemy.default')) %>
+    </p>
+  <% end %>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/greeting.rb

@@ -0,0 +1,21 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class Greeting < ViewComponent::Base
+          def initialize(user:)
+            @user = user
+            if user.respond_to?(:sign_in_count) && user.respond_to?(:last_sign_in_at)
+              @last_sign_at = user.last_sign_in_at
+              @first_time = user.sign_in_count == 1 && @last_sign_at.nil?
+            end
+          end
+
+          def render?
+            @user.present?
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/locked_pages.html.erb

@@ -0,0 +1,54 @@
+<div class="widget-body">
+  <header>
+    <%= Alchemy.t('Currently locked pages') %>
+  </header>
+  <% if @all_locked_pages.blank? %>
+    <alchemy-message type="info">
+      <%= Alchemy.t('no pages') %>
+    </alchemy-message>
+  <% else %>
+    <div class="table-scroll">
+      <table class="list">
+        <% @all_locked_pages.each do |page| %>
+        <tr>
+          <td class="page_name">
+            <span class="label-with-icon">
+              <%= render_icon("file-edit") %>
+              <%= link_to_if current_alchemy_user.id == page.locked_by,
+                page.name,
+                alchemy.edit_admin_page_path(page),
+                data: {turbo_frame: "_top"} %>
+            </span>
+          </td>
+          <% if multi_site? %>
+            <td class="site_name">
+              <small><%= page.site_name %></small>
+            </td>
+          <% end %>
+          <% if page.site_languages.many? %>
+            <td class="locale">
+              <small><%= page.language.code.upcase %></small>
+            </td>
+          <% end %>
+          <td class="name">
+            <small>
+              <% if current_alchemy_user.id == page.locked_by %>
+                <%= Alchemy.t(:me) %>
+              <% else %>
+                <%= page.locker_name %>
+              <% end %>
+            </small>
+          </td>
+          <td class="button">
+            <% if (current_alchemy_user.id == page.locked_by) || can?(:manage, Alchemy::Current.site) %>
+              <%= button_to alchemy.unlock_admin_page_path(page, redirect_to: alchemy.admin_dashboard_path), class: "icon_button small", title: Alchemy.t(:explain_unlocking) do %>
+                <%= render_icon(:close, size: '1x') %>
+              <% end %>
+            <% end %>
+          </td>
+        </tr>
+        <% end %>
+      </table>
+    </div>
+  <% end %>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/locked_pages.rb

@@ -0,0 +1,20 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class LockedPages < ViewComponent::Base
+          delegate :alchemy, :can?, :current_alchemy_user, :render_icon, :multi_site?,
+            to: :helpers
+
+          def initialize
+            @all_locked_pages = Page.locked
+          end
+
+          private
+
+          def colspan = multi_site? ? 5 : 4
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/online_users.html.erb

@@ -0,0 +1,22 @@
+<div class="widget-body">
+  <header>
+    <%= Alchemy.t('Who else is online') %>
+    <aside><%= online_users&.count %></aside>
+  </header>
+  <% if online_users.blank? %>
+    <alchemy-message type="info">
+      <%= Alchemy.t('no users') %>
+    </alchemy-message>
+  <% else %>
+    <table class="list">
+    <% online_users.each do |user| %>
+      <tr>
+        <td class="name"><%= user.name %></td>
+        <td class="right">
+          <small><%= user.human_roles_string %></small>
+        </td>
+      </tr>
+    <% end %>
+    </table>
+  <% end %>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/online_users.rb

@@ -0,0 +1,19 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class OnlineUsers < ViewComponent::Base
+          delegate :current_alchemy_user, to: :helpers
+
+          private
+
+          def online_users
+            if Alchemy.config.user_class.respond_to?(:logged_in)
+              Alchemy.config.user_class.logged_in.to_a - [current_alchemy_user]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/page_counts.rb

@@ -0,0 +1,23 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class PageCounts < StatWidget
+          private
+
+          def link = alchemy.admin_pages_path
+          def icon = "pages"
+          def title = Alchemy::Page.model_name.human(count: :many)
+          def count = Alchemy::Page.count
+
+          def infos
+            safe_join([
+              number_with_delimiter(Alchemy::Page.published.count),
+              t(".published")
+            ], " ")
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/page_usage.rb

@@ -0,0 +1,46 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class PageUsage < UsageWidget
+          delegate :alchemy, to: :helpers
+
+          private
+
+          def header_text(total:)
+            Alchemy.t(:page_usage, total:)
+          end
+
+          def definitions
+            Alchemy::PageDefinition.all
+          end
+
+          def public_counts
+            @public_counts ||= Alchemy::Page.published.group(:page_layout).count
+          end
+
+          def draft_counts
+            @draft_counts ||= Alchemy::Page
+              .where.not(id: Alchemy::Page.published.select(:id))
+              .where.not(id: Alchemy::PageVersion.where("public_on > ?", Time.current).select(:page_id))
+              .group(:page_layout).count
+          end
+
+          def entry_label(entry)
+            link_to entry.definition.human_name,
+              alchemy.admin_pages_path(view: "list", q: {by_page_layout: entry.name}),
+              data: {turbo_frame: "_top"}
+          end
+
+          def tooltip_content(entry)
+            "#{entry.definition.human_name}: #{entry.public_count} #{Alchemy.t(:published)}, #{entry.draft_count} #{Alchemy.t(:draft)}"
+          end
+
+          def entry_icon(entry)
+            helpers.content_tag(:"alchemy-icon", "", name: "file")
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/picture_counts.rb

@@ -0,0 +1,17 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class PictureCounts < StatWidget
+          private
+
+          def title = Alchemy::Picture.model_name.human(count: :many)
+          def link = alchemy.admin_pictures_path
+          def icon = "multi-image"
+          def count = Alchemy::Picture.count
+          def infos = number_to_human_size(Alchemy::Picture.sum(&:image_file_size))
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/recent_pages.html.erb

@@ -0,0 +1,41 @@
+<div class="widget-body">
+  <header>
+    <%= Alchemy.t('Your last updated pages') %>
+  </header>
+  <% if last_edited_pages.blank? %>
+    <alchemy-message type="info">
+      <%= Alchemy.t('no pages') %>
+    </alchemy-message>
+  <% else %>
+    <div class="table-scroll">
+      <table class="list">
+        <% last_edited_pages.each do |page| %>
+        <tr>
+          <td class="page_name">
+            <span class="label-with-icon">
+              <%= render_icon(page.locked? ? "file-edit" : "file") %>
+              <%= link_to_if (page.locked_by.blank? || page.locked_by == user.id),
+                page.name,
+                alchemy.edit_admin_page_path(page),
+                data: {turbo_frame: "_top"} %>
+            </span>
+          </td>
+          <% if multi_site? %>
+            <td class="site_name">
+              <small><%= page.site_name %></small>
+            </td>
+          <% end %>
+          <% if page.site_languages.many? %>
+            <td class="locale">
+              <small><%= page.language.code.upcase %></small>
+            </td>
+          <% end %>
+          <td class="right">
+            <small><%= l(page.updated_at, format: :'alchemy.short_datetime') %></small>
+          </td>
+        </tr>
+        <% end %>
+      </table>
+    </div>
+  <% end %>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/recent_pages.rb

@@ -0,0 +1,16 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class RecentPages < ViewComponent::Base
+          delegate :alchemy, :current_alchemy_user, :render_icon, :multi_site?, to: :helpers
+
+          private
+
+          def user = current_alchemy_user
+          def last_edited_pages = Page.all_last_edited_from(user).limit(5)
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/sites.html.erb

@@ -0,0 +1,29 @@
+<div class="widget-body">
+  <header>
+    <%= Alchemy::Site.model_name.human(count: 2) %>
+    <aside><%= Alchemy::Site.count %></aside>
+  </header>
+  <table class="list">
+    <% sites.each do |site| %>
+    <tr>
+      <td>
+        <span class="label-with-icon">
+          <alchemy-icon name="global"></alchemy-icon>
+          <% if alchemy.respond_to?(:login_url) %>
+            <%= link_to_unless site == Alchemy::Current.site,
+              site.name,
+              alchemy.login_url(
+                protocol: 'http://',
+                host: site.host,
+                user: {login: current_alchemy_user.try(:login)}
+              ), target: '_blank' %>
+          <% else %>
+            <%= site.name %>
+          <% end %>
+        </span>
+      </td>
+      <td class="right"><small><%= site.host %></small></td>
+    </tr>
+    <% end %>
+  </table>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/sites.rb

@@ -0,0 +1,15 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class Sites < ViewComponent::Base
+          delegate :alchemy, :current_alchemy_user, to: :helpers
+
+          private
+
+          def sites = Site.all
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/stat_widget.html.erb

@@ -0,0 +1,23 @@
+<div class="widget-body">
+  <div class="name">
+    <% label = capture do %>
+      <% if icon %>
+        <alchemy-icon name="<%= icon %>"></alchemy-icon>
+      <% end %>
+      <%= title %>
+    <% end %>
+    <% if link %>
+      <%= link_to label, link, class: "label-with-icon", data: {turbo_frame: "_top"} %>
+    <% else %>
+      <span class="label-with-icon"><%= label %></span>
+    <% end %>
+  </div>
+  <div class="count">
+    <%= number_with_delimiter(count) %>
+  </div>
+  <% if infos %>
+    <div class="infos">
+      <%= infos %>
+    </div>
+  <% end %>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/stat_widget.rb

@@ -0,0 +1,19 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class StatWidget < ViewComponent::Base
+          delegate :alchemy, to: :helpers
+
+          private
+
+          def title = raise(NotImplementedError)
+          def count = raise(NotImplementedError)
+          def icon = nil
+          def link = nil
+          def infos = nil
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/system_info.html.erb

@@ -0,0 +1,32 @@
+<div class="widget system-info">
+  <div class="logo">
+    <%= logo %>
+  </div>
+  <div class="version-info">
+    <span class="version">
+      <%= @alchemy_version %>
+      <%= git_source %>
+    </span>
+
+    <%= render Alchemy::Admin::UpdateCheck.new %>
+
+    <span class="ruby-rails-version">
+      <span class="label-with-icon">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" class="icon">
+          <path fill-rule="evenodd" clip-rule="evenodd" d="M1 7.19l6.64 6.64h.72L15 7.19v-.72l-3.32-3.32-.36-.15H4.68l-.36.15L1 6.47v.72zm7 5.56L2.08 6.83 4.89 4h6.22l2.81 2.83L8 12.75zm0-7.73h2.69l1.81 1.81-4.5 4.4V5.02z"/>
+        </svg>
+        Ruby <%= RUBY_VERSION %>
+      </span>
+      <span class="label-with-icon">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="icon">
+          <path d="M.74,19.23s.32-3.12,2.53-6.82c2.22-3.69,5.99-6.49,9.06-6.76,6.11-.61,11.59,4.86,11.59,4.86,0,0-.18.13-.37.29-5.99-4.43-9.65-2.34-10.8-1.78-5.27,2.94-3.68,10.21-3.68,10.21H.74ZM18.1,6.24c-.34-.14-.67-.26-1.02-.38l.04-.7c.66.19.93.32,1.02.37l-.04.71h0ZM17.1,8.48c.34.02.69.06,1.04.14l-.04.65c-.35-.07-.7-.12-1.04-.13l.04-.66h0ZM13.2,5.18c-.31,0-.61.01-.92.04l-.2-.62c.35-.04.69-.06,1.01-.06l.21.64h-.11ZM13.7,9.07c.26-.12.57-.23.93-.34l.23.7c-.31.09-.61.22-.92.37l-.24-.73h0ZM8.92,6.29c-.27.14-.54.3-.81.47l-.49-.74c.29-.17.56-.31.82-.45l.47.73h0ZM11.08,11.04c.19-.24.41-.48.65-.71l.48.72c-.23.24-.44.49-.62.75l-.51-.76h0ZM9.55,14.44c.08-.38.18-.77.32-1.16l.76.6c-.11.41-.18.82-.22,1.23l-.86-.67h0ZM4.93,9.43c-.26.26-.5.55-.72.83l-.81-.7c.24-.26.51-.53.78-.79l.75.65h0ZM1.74,14.14c-.17.39-.39.91-.53,1.27l-1.21-.44c.11-.29.33-.81.53-1.27l1.21.44h0ZM9.39,17.12l1.14.41c.06.5.16.96.25,1.37l-1.27-.45c-.05-.32-.11-.77-.13-1.33h0Z"/>
+        </svg>
+        Rails <%= Rails.version %>
+      </span>
+    </span>
+
+    <a href="#legal_info" data-turbo="false">
+      <small><%= Alchemy.t(:legal_info) %></small>
+    </a>
+  </div>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/system_info.rb

@@ -0,0 +1,37 @@
+require "alchemy/version"
+
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class SystemInfo < ViewComponent::Base
+          delegate :alchemy, :render_message, to: :helpers
+
+          def initialize
+            @alchemy_version = Alchemy.version
+          end
+
+          private
+
+          def logo
+            @_logo_file ||= File.read(logo_file_path).html_safe
+          end
+
+          def git_source
+            git_info = Alchemy.git_revision_info
+            return unless git_info
+
+            branch = git_info[:branch]
+            revision = git_info[:revision]
+
+            "(#{[branch, revision[0, 7]].compact.join(" @ ")})"
+          end
+
+          def logo_file_path
+            Alchemy::Engine.root.join("app/assets/images/alchemy/admin/logo.svg")
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/alchemy/admin/dashboard/widgets/usage_widget.html.erb

@@ -0,0 +1,42 @@
+<div class="widget-body">
+  <header>
+    <%= header_text(total:) %>
+    <aside>
+      <%= number_with_delimiter(total) %>
+    </aside>
+  </header>
+  <div class="table-scroll">
+    <table class="list usage-stats">
+      <% stats.each_with_index do |entry, i| %>
+        <% row_total = entry.total %>
+        <% bar_pct = max.positive? ? (row_total / max * 100).round(2) : 0 %>
+        <% public_pct = row_total.positive? ? (entry.public_count / row_total.to_f * 100).round(2) : 0 %>
+        <% draft_pct = (100 - public_pct).round(2) %>
+        <% hue = (240 + i * 360.0 / stats.size).round % 360 %>
+        <% label = entry_label(entry) %>
+        <tr>
+          <td class="usage-stats--label">
+            <span class="label-with-icon">
+              <%= entry_icon(entry) %>
+              <%= label %>
+            </span>
+          </td>
+          <td class="usage-stats--bar">
+            <sl-tooltip content="<%= tooltip_content(entry) %>">
+              <span class="bar" style="width: <%= bar_pct %>%; --bar-hue: <%= hue %>">
+                <span class="bar__public" style="width: <%= public_pct %>%"></span>
+                <span class="bar__draft" style="width: <%= draft_pct %>%"></span>
+              </span>
+            </sl-tooltip>
+          </td>
+          <td class="usage-stats--value">
+            <%= number_to_percentage(total.positive? ? (row_total / total.to_f) * 100 : 0, precision: 2) %>
+          </td>
+          <td class="usage-stats--value">
+            <%= number_with_delimiter(row_total) %>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</div>

data/app/components/alchemy/admin/dashboard/widgets/usage_widget.rb

@@ -0,0 +1,66 @@
+module Alchemy
+  module Admin
+    module Dashboard
+      module Widgets
+        class UsageWidget < ViewComponent::Base
+          Entry = Data.define(:name, :public_count, :draft_count, :definition) do
+            def total = public_count + draft_count
+          end
+
+          private
+
+          def stats
+            @stats ||= definitions
+              .map do |definition|
+                Entry.new(
+                  name: definition.name,
+                  public_count: public_counts.fetch(definition.name, 0),
+                  draft_count: draft_counts.fetch(definition.name, 0),
+                  definition: definition
+                )
+              end
+              .sort_by { |entry| -entry.total }
+          end
+
+          def total
+            @total ||= stats.sum(&:total)
+          end
+
+          def max
+            @max ||= (stats.first&.total || 0).to_f
+          end
+
+          # Subclass hooks
+
+          def header_text(total:)
+            raise NotImplementedError
+          end
+
+          def definitions
+            raise NotImplementedError
+          end
+
+          def public_counts
+            raise NotImplementedError
+          end
+
+          def draft_counts
+            raise NotImplementedError
+          end
+
+          def entry_label(entry)
+            raise NotImplementedError
+          end
+
+          def tooltip_content(entry)
+            "#{entry_label(entry)}: #{entry.public_count} #{Alchemy.t(:published)}, #{entry.draft_count} #{Alchemy.t(:draft)}"
+          end
+
+          def entry_icon(entry)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end