pages_core 3.15.3 → 3.15.5

data/app/controllers/concerns/pages_core/pages/rss_controller.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module Pages
+    module RssController
+      extend ActiveSupport::Concern
+
+      private
+
+      def all_feed_items
+        feeds = Page.enabled_feeds(locale, include_hidden: true)
+        Page.where(parent_page_id: feeds)
+            .order("published_at DESC")
+            .published
+            .localized(locale)
+      end
+
+      def per_page_rss_param(default = 20, max = 1000)
+        return default unless params[:per_page].is_a?(String)
+
+        params[:per_page].to_i.clamp(1, max)
+      end
+
+      def render_page_rss(page, pagination_page = 1)
+        if page.feed_enabled?
+          render_rss(page.pages.paginate(per_page: per_page_rss_param,
+                                         page: pagination_page)
+                         .includes(:image, :author),
+                     title: page.name)
+        else
+          render_error 404
+        end
+      end
+
+      def render_rss(items, title: nil)
+        @title = PagesCore.config.site_name
+        @title += ": #{title}" if title
+        @items = items
+        render template: "feeds/pages", layout: false
+      end
+    end
+  end
+end

data/app/controllers/errors_controller.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class ErrorsController < ApplicationController
+  include PagesCore::DocumentTitleController
+
   layout "errors"
 
   def show

data/app/controllers/images_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ImagesController < ApplicationController
+  include DynamicImage::Controller
+
+  static_cache :show, :uncropped, :original, permanent: true
+
+  private
+
+  def model
+    Image
+  end
+end

data/app/controllers/pages_core/frontend/pages_controller.rb

@@ -5,10 +5,9 @@ module PagesCore
     class PagesController < ::FrontendController
       include PagesCore::FrontendHelper
       include PagesCore::Templates::ControllerActions
-      include PagesCore::HeadTagsHelper
 
-      include PagesCore::PreviewPagesController
-      include PagesCore::RssController
+      include PagesCore::Pages::PreviewController
+      include PagesCore::Pages::RssController
 
       before_action :load_root_pages
       before_action :find_page_by_path, only: [:show]
@@ -75,7 +74,7 @@ module PagesCore
       def render_page
         return if redirect_page(@page)
 
-        unless document_title?
+        if document_title.blank?
           document_title(@page.meta_title? ? @page.meta_title : @page.name)
         end
 

data/app/controllers/pages_core/frontend_controller.rb

@@ -3,6 +3,7 @@
 # Abstract controller for all frontend controllers.
 module PagesCore
   class FrontendController < ::ApplicationController
+    include PagesCore::DocumentTitleController
     include ApplicationHelper
 
     before_action :set_i18n_locale
@@ -23,7 +24,11 @@ module PagesCore
     private
 
     def page_param
-      params[:page].is_a?(String) ? params[:page] : 1
+      if params[:page].is_a?(String)
+        [Integer(params[:page], exception: false), 1].compact.max
+      else
+        1
+      end
     end
 
     def set_i18n_locale

data/app/controllers/pages_core/sitemaps_controller.rb

@@ -1,32 +1,32 @@
 # frozen_string_literal: true
 
 module PagesCore
-  class SitemapsController < ::ApplicationController
+  class SitemapsController < ApplicationController
     include PagesCore::PagePathHelper
-    static_cache :show
+    static_cache :index, :pages
 
-    def show
-      @entries = formatted_entries
+    def index
+      @sitemaps = PagesCore::Sitemap.sitemaps.flat_map do |entry|
+        if entry.is_a?(Proc)
+          locales.map { |l| instance_exec(l, &entry) }
+        else
+          entry
+        end
+      end.compact_blank.uniq
     end
 
-    private
+    def pages
+      render_sitemap do |map|
+        Page.published.where.not(skip_index: true)
+            .localized(content_locale).find_each do |page|
+          next if page.redirects?
 
-    def format_time(timestamp)
-      if timestamp.is_a?(Date)
-        timestamp.strftime("%Y-%m-%d")
-      else
-        timestamp.strftime("%Y-%m-%dT%H:%M:%S#{timestamp.formatted_offset}")
+          map.add(page_url(page.locale, page), lastmod: page.updated_at)
+        end
       end
     end
 
-    def format_record(record)
-      { loc: record_url(record),
-        lastmod: format_time(record.updated_at) }
-    end
-
-    def formatted_entries
-      records.map { |r| format_record(r) }
-    end
+    private
 
     def locales
       if PagesCore.config.locales
@@ -36,41 +36,10 @@ module PagesCore
       end
     end
 
-    def localized?(record)
-      record.is_a?(LocalizableModel::InstanceMethods)
-    end
-
-    def pages
-      ([Page.root.try(:localize, I18n.default_locale)] +
-       locales.flat_map do |locale|
-         Page.published.localized(locale).includes(:parent)
-       end).compact
-    end
-
-    def page_record_url(record)
-      if record == root_page && record.locale == I18n.default_locale
-        root_url
-      else
-        page_url(record.locale, record)
-      end
-    end
-
-    def record_url(record)
-      if record.is_a?(Page)
-        page_record_url(record)
-      elsif localized?(record)
-        polymorphic_url(record, locale: record.locale)
-      else
-        polymorphic_url(record)
+    def render_sitemap(&)
+      respond_to do |format|
+        format.xml { render xml: PagesCore::Sitemap.new(&).to_xml }
       end
     end
-
-    def records
-      pages
-    end
-
-    def root_page
-      @root_page ||= Page.root
-    end
   end
 end

data/app/helpers/pages_core/admin/image_uploads_helper.rb

@@ -31,7 +31,7 @@ module PagesCore
         return {} unless image
 
         { src: dynamic_image_path(image, size: "#{width * 2}x"),
-          image: ::Admin::ImageResource.new(image).to_hash }
+          image: ::Admin::ImageResource.new(image).to_h }
       end
 
       def editable_image_options(image, width: 250, caption: false, locale: nil)

data/app/helpers/pages_core/application_helper.rb

@@ -5,10 +5,7 @@
 module PagesCore
   module ApplicationHelper
     include PagesCore::AttachmentsHelper
-    include PagesCore::HeadTagsHelper
     include PagesCore::ImagesHelper
-    include PagesCore::MetaTagsHelper
-    include PagesCore::OpenGraphTagsHelper
     include PagesCore::PagePathHelper
 
     def page_link(page, options = {})

data/app/helpers/pages_core/attachments_helper.rb

@@ -10,16 +10,6 @@ module PagesCore
       super(*attachment_params(args))
     end
 
-    def page_file_path(*args)
-      ActiveSupport::Deprecation.warn(
-        "#page_file_path is deprecated, use #attachment_path"
-      )
-      page_file = args.detect { |a| a.is_a?(PageFile) }
-      return attachment_path(page_file.attachment) if page_file
-
-      super
-    end
-
     private
 
     def attachment_params(args)

data/app/helpers/pages_core/feed_tags_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module FeedTagsHelper
+    # Generates links for all RSS feeds. Specify
+    # :include_hidden to also include hidden pages.
+    #
+    #  feed_tags
+    #  feed_tags include_hidden: true
+    #
+    def feed_tags(options = {})
+      feeds = Page.enabled_feeds(content_locale, options)
+      return unless feeds.any?
+
+      feed_tags = [
+        rss_link_tag(PagesCore.config(:site_name),
+                     pages_url(content_locale, format: :rss))
+      ] + feeds.map do |page|
+        rss_link_tag("#{PagesCore.config(:site_name)}: #{page.name}",
+                     page_url(content_locale, page, format: :rss))
+      end
+      safe_join(feed_tags, "\n")
+    end
+
+    private
+
+    def rss_link_tag(title, href)
+      tag.link(rel: "alternate", type: "application/rss+xml", title:, href:)
+    end
+  end
+end

data/app/helpers/pages_core/frontend_helper.rb

@@ -2,6 +2,9 @@
 
 module PagesCore
   module FrontendHelper
+    include PagesCore::FeedTagsHelper
+    include PagesCore::HeadTagsHelper
+
     def root_pages
       @root_pages ||= Page.roots.localized(content_locale).published
     end

data/app/helpers/pages_core/head_tags_helper.rb

@@ -2,95 +2,105 @@
 
 module PagesCore
   module HeadTagsHelper
-    # Sets a document title.
-    #
-    #  document_title "Dashboard"
-    #
-    def document_title(*args)
-      if args.any?
-        @document_title = args.first
-      else
-        safe_join([@document_title, PagesCore.config(:site_name)].compact.uniq,
-                  " - ")
-      end
+    def document_title_tag(separator: " - ")
+      parts = [document_title, PagesCore.config.site_name]
+      tag.title(parts.compact_blank.uniq.join(separator))
     end
 
-    # Returns true if document title has been set.
-    def document_title?
-      @document_title ? true : false
-    end
+    def head_tag(&)
+      PagesCore.deprecator.warn(
+        "head_tag helper is deprecated and will be removed"
+      )
 
-    # Generates links for all RSS feeds. Specify
-    # :include_hidden to also include hidden pages.
-    #
-    #  feed_tags
-    #  feed_tags include_hidden: true
-    #
-    def feed_tags(options = {})
-      feeds = Page.enabled_feeds(content_locale, options)
-      return unless feeds.any?
-
-      feed_tags = [
-        rss_link_tag(PagesCore.config(:site_name),
-                     pages_url(content_locale, format: :rss))
-      ] + feeds.map do |page|
-        rss_link_tag("#{PagesCore.config(:site_name)}: #{page.name}",
-                     page_url(content_locale, page, format: :rss))
+      tag.head do
+        safe_join([document_title_tag,
+                   pages_meta_tags(instance_variable_get(:@page)),
+                   ([csrf_meta_tags, csp_meta_tag] unless static_cached?),
+                   (block_given? ? capture(&) : nil)].flatten.compact_blank,
+                  "\n")
       end
-      safe_join(feed_tags, "\n")
     end
 
-    # Outputs a HTML5 doctype and head tags, with document title
-    # and relevant meta tags. Takes a block which will be placed
-    # inside <head>.
-    #
-    #  <%= head_tag do %>
-    #    <%= stylesheet_link_tag "application" %>
-    #    <%= javascript_include_tag "application" %>
-    #    <%= feed_tags %>
-    #  <% end %>
-    #
-    def head_tag(&)
-      # The block output must be captured first
-      block_output = block_given? ? capture(&) : nil
+    def meta_image_url(image, size: "1200x")
+      return if image.blank?
+      return image unless image.is_a?(Image)
 
-      tag.head { safe_join(head_tag_contents(block_output), "\n") }
+      dynamic_image_url(image, size:, only_path: false)
     end
 
-    # Generates a link to an RSS feed.
-    #
-    #  rss_link_tag "My feed", "feed.rss"
-    #
-    def rss_link_tag(title, href)
-      tag.link(rel: "alternate",
-               type: "application/rss+xml",
-               title:,
-               href:)
+    def pages_meta_tags(page = nil)
+      safe_join(
+        [(tag.meta(name: "robots", content: "noindex") if page&.skip_index?),
+         meta_description_tag(meta_description(page)),
+         meta_image_tag(meta_image(page)),
+         open_graph_tags(page)].compact_blank, "\n"
+      )
     end
 
     private
 
-    def head_tag_contents(block_output)
-      [tag.meta(charset: "utf-8"),
-       tag.title(document_title),
-       meta_description_tag,
-       meta_keywords_tag,
-       (tag.link(rel: "image_src", href: meta_image) if meta_image?),
-       open_graph_tags,
-       (csrf_meta_tags unless static_cached?),
-       block_output].compact_blank
+    def meta_description(record = nil)
+      description = content_for(:meta_description)
+      description ||= record.meta_description if record.try(&:meta_description?)
+      description ||= record.excerpt if record.try(&:excerpt?)
+      strip_tags(description)&.strip
     end
 
-    def meta_description_tag
-      return unless meta_description?
+    def meta_description_tag(content)
+      return if content.blank?
 
-      tag.meta(name: "description", content: meta_description&.strip)
+      tag.meta(name: "description", content:)
     end
 
-    def meta_keywords_tag
-      return unless meta_keywords?
+    def meta_image(record = nil)
+      meta_image_url(
+        content_for(:meta_image) ||
+          record.try(:meta_image) || record.try(:image)
+      )
+    end
+
+    def meta_image_tag(href)
+      return if href.blank?
 
-      tag.meta(name: "keywords", content: meta_keywords&.strip)
+      tag.link(rel: "image_src", href:)
+    end
+
+    def open_graph_description(record = nil)
+      if content_for?(:open_graph_description)
+        content_for(:open_graph_description)
+      elsif record.try(:open_graph_description?)
+        record.open_graph_description
+      else
+        meta_description(record)
+      end
+    end
+
+    def open_graph_properties(record = nil)
+      { type: "website",
+        site_name: PagesCore.config(:site_name),
+        title: open_graph_title(record),
+        image: meta_image(record),
+        description: open_graph_description(record)&.strip,
+        url: request.url }
+    end
+
+    def open_graph_tags(record = nil)
+      safe_join(
+        open_graph_properties(record)
+          .compact
+          .map { |name, content| tag.meta(property: "og:#{name}", content:) },
+        "\n"
+      )
+    end
+
+    def open_graph_title(record = nil)
+      if content_for?(:open_graph_title)
+        content_for(:open_graph_title)
+      elsif record.try(:open_graph_title?)
+        record.open_graph_title
+      else
+        document_title
+      end
     end
   end
 end

data/app/helpers/pages_core/page_path_helper.rb

@@ -13,9 +13,7 @@ module PagesCore
       end
     end
 
-    def page_url(page_or_locale, page = nil, opts = {})
-      locale, page = page_url_locale_and_page(page_or_locale, page, opts)
-
+    def page_url(locale, page, opts = {})
       page.localize(locale) do |p|
         if p.redirects? && html_format?(opts)
           page_redirect_url(locale, p)
@@ -48,15 +46,6 @@ module PagesCore
       path.split("/").map { |s| CGI.escape(s) }.join("/")
     end
 
-    def page_url_locale_and_page(page_or_locale, page, opts)
-      return [page_or_locale, page] if page
-
-      ActiveSupport::Deprecation.warn(
-        "Calling page_url without locale is deprecated"
-      )
-      [opts[:locale] || content_locale, page_or_locale]
-    end
-
     def paginated_section(opts)
       return "" unless opts[:page]
 

data/app/javascript/components/Attachments/Attachment.tsx

@@ -1,4 +1,4 @@
-import React, { MouseEvent } from "react";
+import { MouseEvent } from "react";
 import copyToClipboard from "../../lib/copyToClipboard";
 import AttachmentEditor from "./AttachmentEditor";
 import useModalStore from "../../stores/useModalStore";
@@ -9,7 +9,7 @@ import { Locale } from "../../types";
 
 import { useDraggable } from "../drag";
 
-interface Props {
+type Props = {
   attributeName: string;
   placeholder: boolean;
   draggable: Drag.Draggable<Attachments.Record>;
@@ -23,7 +23,7 @@ interface Props {
     evt: MouseEvent,
     draggable: Drag.Draggable<Attachments.Record>
   ) => void;
-}
+};
 
 export default function Attachment(props: Props) {
   const { attributeName, draggable, locales, locale } = props;

data/app/javascript/components/Attachments/AttachmentEditor.tsx

@@ -1,4 +1,4 @@
-import React, { ChangeEvent, MouseEvent, useState } from "react";
+import { ChangeEvent, MouseEvent, useState } from "react";
 import copyToClipboard, { copySupported } from "../../lib/copyToClipboard";
 import useModalStore from "../../stores/useModalStore";
 import useToastStore from "../../stores/useToastStore";
@@ -6,12 +6,12 @@ import { putJson } from "../../lib/request";
 import * as Attachments from "../../types/Attachments";
 import { Locale } from "../../types";
 
-interface Props {
+type Props = {
   attachment: Attachments.Resource;
   locale: string;
   locales: { [index: string]: Locale };
   onUpdate: (attachment: Partial<Attachments.Resource>) => void;
-}
+};
 
 export default function AttachmentEditor(props: Props) {
   const { attachment, locales } = props;
@@ -40,13 +40,13 @@ export default function AttachmentEditor(props: Props) {
     notice("Embed code copied to clipboard");
   };
 
-  const save = (evt: MouseEvent) => {
+  const save = async (evt: MouseEvent) => {
     evt.preventDefault();
     evt.stopPropagation();
 
     const data = { ...localizations };
 
-    void putJson(`/admin/attachments/${attachment.id}`, { attachment: data });
+    await putJson(`/admin/attachments/${attachment.id}`, { attachment: data });
 
     if (props.onUpdate) {
       props.onUpdate(data);

data/app/javascript/components/Attachments/Deleted.tsx

@@ -0,0 +1,28 @@
+import * as Attachments from "../../types/Attachments";
+
+type Props = {
+  attributeName: (record: Attachments.Record) => string;
+  deleted: Attachments.Record[];
+};
+
+export default function Deleted({ attributeName, deleted }: Props) {
+  return (
+    <div className="deleted">
+      {deleted.map((r) => (
+        <span className="deleted-attachment" key={r.id}>
+          <input name={`${attributeName(r)}[id]`} type="hidden" value={r.id} />
+          <input
+            name={`${attributeName(r)}[attachment_id]`}
+            type="hidden"
+            value={(r.attachment && r.attachment.id) || ""}
+          />
+          <input
+            name={`${attributeName(r)}[_destroy]`}
+            type="hidden"
+            value="true"
+          />
+        </span>
+      ))}
+    </div>
+  );
+}

data/app/javascript/components/Attachments/List.tsx

@@ -1,5 +1,5 @@
-import React from "react";
 import Attachment from "./Attachment";
+import Deleted from "./Deleted";
 import Placeholder from "./Placeholder";
 import FileUploadButton from "../FileUploadButton";
 import { post } from "../../lib/request";
@@ -8,9 +8,9 @@ import * as Drag from "../../types/Drag";
 
 import { createDraggable, draggedOrder, useDragUploader } from "../drag";
 
-interface Props extends Attachments.Options {
+type Props = Attachments.Options & {
   state: Attachments.State;
-}
+};
 
 function filenameToName(str: string): string {
   return str.replace(/\.[\w\d]+$/, "").replace(/_/g, " ");
@@ -24,7 +24,7 @@ export default function List(props: Props) {
     const name = {};
     locales.forEach((l) => (name[l] = file.name));
 
-    const draggable = createDraggable({
+    const draggable = createDraggable<Attachments.Record>({
       attachment: { filename: file.name, name: name },
       uploading: true
     });
@@ -58,7 +58,10 @@ export default function List(props: Props) {
     });
   };
 
-  const dragEnd = (dragState: Drag.State, files: File[]) => {
+  const dragEnd = (
+    dragState: Drag.State<Attachments.Record>,
+    files: File[]
+  ) => {
     collection.dispatch({
       type: "reorder",
       payload: draggedOrder(collection, dragState)
@@ -69,7 +72,7 @@ export default function List(props: Props) {
     });
   };
 
-  const [dragState, dragStart, listeners] = useDragUploader<Attachments.Record>(
+  const [dragState, dragStart, listeners] = useDragUploader(
     [collection],
     dragEnd
   );
@@ -110,7 +113,7 @@ export default function List(props: Props) {
     }
   };
 
-  const attachment = (draggable: Drag.Item<Attachments.Record>) => {
+  const attachment = (draggable: Drag.DraggableOrFiles<Attachments.Record>) => {
     const { dragging } = dragState;
 
     if (draggable === "Files") {
@@ -144,23 +147,7 @@ export default function List(props: Props) {
   return (
     <div className={classes.join(" ")} ref={collection.ref} {...listeners}>
       <div className="files">{dragOrder.map((d) => attachment(d))}</div>
-      <div className="deleted">
-        {deleted.map((r) => (
-          <span className="deleted-attachment" key={r.id}>
-            <input name={`${attrName(r)}[id]`} type="hidden" value={r.id} />
-            <input
-              name={`${attrName(r)}[attachment_id]`}
-              type="hidden"
-              value={(r.attachment && r.attachment.id) || ""}
-            />
-            <input
-              name={`${attrName(r)}[_destroy]`}
-              type="hidden"
-              value="true"
-            />
-          </span>
-        ))}
-      </div>
+      <Deleted attributeName={attrName} deleted={deleted} />
       <div className="drop-target">
         <FileUploadButton
           multiple={true}

data/app/javascript/components/Attachments/Placeholder.tsx

@@ -1,5 +1,3 @@
-import React from "react";
-
 export default function Placeholder() {
   return (
     <div className="attachment drop-placeholder" key="file-placeholder">