pageflow 17.0.5 → 17.2.0

data/entry_types/paged/app/controllers/pageflow_paged/entries_controller.rb

@@ -5,6 +5,7 @@ module PageflowPaged
     include WithoutControllerNamespacePartialPathPrefix
 
     helper Pageflow::FeedsHelper
+    helper Pageflow::HreflangLinksHelper
     helper Pageflow::MetaTagsHelper
     helper Pageflow::StructuredDataHelper
     helper Pageflow::PublicI18nHelper

data/entry_types/paged/app/helpers/pageflow_paged/page_background_asset_helper.rb

@@ -7,7 +7,7 @@ module PageflowPaged
     def page_background_asset(page)
       render('pageflow_paged/page_background_asset/element',
              entry: @entry,
-             page: page)
+             page:)
     end
   end
 end

data/entry_types/paged/app/helpers/pageflow_paged/third_party_embed_consent_helper.rb

@@ -5,24 +5,24 @@ module PageflowPaged
 
     def third_party_embed_opt_in(entry:, vendor_name:, message:)
       link_html = third_party_embed_privacy_link(
-        entry: entry,
+        entry:,
         text: t('pageflow.public.third_party_embed_consent.opt_in.more_information'),
-        vendor_name: vendor_name
+        vendor_name:
       )
 
       render('pageflow_paged/third_party_embed_consent/opt_in',
-             message: message,
-             vendor_name: vendor_name,
-             link_html: link_html)
+             message:,
+             vendor_name:,
+             link_html:)
     end
 
     def third_party_embed_opt_out_info(entry)
       link_html = third_party_embed_privacy_link(
-        entry: entry,
+        entry:,
         text: t('pageflow.public.third_party_embed_consent.opt_out_info.prompt_link')
       )
 
-      render('pageflow_paged/third_party_embed_consent/opt_out_info', link_html: link_html)
+      render('pageflow_paged/third_party_embed_consent/opt_out_info', link_html:)
     end
 
     def third_party_embed_privacy_link(entry:, text:, vendor_name: nil)

data/entry_types/paged/app/views/pageflow_paged/editor/entries/_seed.json.jbuilder

@@ -0,0 +1 @@
+# Pageflow Paged does not use editor JSON seed

data/entry_types/paged/app/views/pageflow_paged/entries/show.html.erb

@@ -12,6 +12,7 @@
 
     <%= tag :link, :rel => 'icon', :href => image_path("pageflow/themes/#{@entry.theme.directory_name}/favicon.ico"), :type => 'image/ico' %>
     <%= meta_tags_for_entry(@entry) %>
+    <%= hreflang_link_tags_for_entry(@entry) %>
     <%= feed_link_tags_for_entry(@entry) %>
   <% end %>
 <% end %>

data/entry_types/paged/lib/pageflow_paged/plugin.rb

@@ -7,6 +7,10 @@ module PageflowPaged
       end
 
       config.features.enable_by_default('paged_entry_type')
+
+      config.for_entry_type(PageflowPaged.entry_type) do |c|
+        c.revision_components.register(Pageflow::Storyline, create_defaults: true)
+      end
     end
   end
 end

data/entry_types/paged/lib/pageflow_paged/react/page_type.rb

@@ -1,6 +1,6 @@
 module PageflowPaged
   module React
-    class PageType < Pageflow::PageType
+    class PageType < Pageflow::PageType # rubocop:todo Style/Documentation
       attr_reader :name, :component_name, :file_types
 
       def initialize(name, options)

data/entry_types/paged/lib/pageflow_paged/react/widget_type.rb

@@ -1,6 +1,6 @@
 module PageflowPaged
   module React
-    class WidgetType < Pageflow::WidgetType
+    class WidgetType < Pageflow::WidgetType # rubocop:todo Style/Documentation
       attr_reader :name, :role, :options
 
       def initialize(name, role, options = {})
@@ -19,8 +19,8 @@ module PageflowPaged
 
       def render(template, entry)
         template.render(File.join('pageflow_paged', 'react', 'widget'),
-                        entry: entry,
-                        name: name,
+                        entry:,
+                        name:,
                         server_rendering: options[:server_rendering])
       end
     end

data/entry_types/paged/lib/pageflow_paged.rb

@@ -12,7 +12,7 @@ module PageflowPaged
                               frontend_app: PageflowPaged::EntriesController.action(:show),
                               configuration: PageflowPaged::Configuration,
                               editor_app: PageflowPaged::Engine,
-                              editor_fragment_renderer: editor_fragment_renderer)
+                              editor_fragment_renderer:)
     end
 
     private

data/entry_types/scrolled/app/assets/stylesheets/pageflow_scrolled/ui.scss

@@ -0,0 +1,2 @@
+@import "pageflow/ui/properties";
+@import "pageflow/ui/overrides";

data/entry_types/scrolled/app/controllers/pageflow_scrolled/editor/chapters_controller.rb

@@ -5,11 +5,13 @@ module PageflowScrolled
       include Pageflow::EditorController
 
       def create
-        chapter = Chapter.create(chapter_params.merge(revision: @entry.draft))
+        chapter = find_storyline.chapters.create(chapter_params)
 
         render partial: 'pageflow_scrolled/chapters/chapter',
-               locals: {chapter: chapter},
+               locals: {chapter:},
                status: :created
+      rescue ActiveRecord::RecordNotFound
+        head :not_found
       end
 
       def update
@@ -49,7 +51,7 @@ module PageflowScrolled
         configuration = params.require(:chapter)[:configuration].try(:permit!) || {}
         params.require(:chapter)
               .permit(:position)
-              .merge(configuration: configuration)
+              .merge(configuration:)
       end
 
       def find_storyline

data/entry_types/scrolled/app/controllers/pageflow_scrolled/editor/content_elements_controller.rb

@@ -9,7 +9,7 @@ module PageflowScrolled
         content_element = section.content_elements.create(content_element_params)
 
         render partial: 'pageflow_scrolled/content_elements/content_element',
-               locals: {content_element: content_element},
+               locals: {content_element:},
                status: :created
       end
 
@@ -17,17 +17,26 @@ module PageflowScrolled
         section = Section.all_for_revision(@entry.draft).find(params[:section_id])
 
         items = params.require(:content_elements).map do |item|
-          item.transform_keys(&:underscore).permit(:id, :type_name, :_delete, configuration: {})
+          item.transform_keys(&:underscore).permit(:id, :type_name, :_delete,
+                                                   configuration: {},
+                                                   migrate_comment_threads: [])
         end
 
-        @content_elements = ContentElement::Batch.new(section, items).save!
+        @content_elements = ContentElement::Batch.new(
+          section, items,
+          comment_thread_subject_ranges: permitted_subject_ranges
+        ).save!
       rescue ActiveRecord::RecordNotFound
         head :not_found
       end
 
       def update
         content_element = ContentElement.all_for_revision(@entry.draft).find(params[:id])
-        content_element.update(content_element_params)
+
+        ContentElement.transaction do
+          content_element.update(content_element_params)
+          update_comment_thread_subject_ranges(content_element)
+        end
 
         head :no_content
       rescue ActiveRecord::RecordNotFound
@@ -64,7 +73,28 @@ module PageflowScrolled
         params.require(:content_element)
               .transform_keys(&:underscore)
               .permit(:type_name, :position)
-              .merge(configuration: configuration)
+              .merge(configuration:)
+      end
+
+      def update_comment_thread_subject_ranges(content_element)
+        ranges = permitted_subject_ranges
+        return if ranges.blank?
+
+        Pageflow::CommentThread.update_subject_ranges_for(
+          revision: @entry.draft,
+          subject_type: 'ContentElement',
+          subject_id: content_element.perma_id,
+          ranges:
+        )
+      end
+
+      def permitted_subject_ranges
+        ranges = params[:comment_thread_subject_ranges]
+        return nil if ranges.blank?
+
+        ranges.to_unsafe_h.transform_values do |range|
+          range.is_a?(Hash) ? range.slice('anchor', 'focus') : {}
+        end
       end
     end
   end

data/entry_types/scrolled/app/controllers/pageflow_scrolled/editor/sections_controller.rb

@@ -9,7 +9,7 @@ module PageflowScrolled
         section = chapter.create_section(section_params)
 
         render partial: 'pageflow_scrolled/editor/sections/section_with_content_elements',
-               locals: {section: section},
+               locals: {section:},
                status: :created
       end
 
@@ -41,11 +41,10 @@ module PageflowScrolled
 
       def order
         chapter = Chapter.all_for_revision(@entry.draft).find(params[:chapter_id])
-        storyline = chapter.storyline
 
         params.require(:ids).each_with_index do |id, index|
-          storyline.sections.find(id).update(chapter_id: chapter.id,
-                                             position: index)
+          Section.all_for_revision(@entry.draft).find(id).update(chapter_id: chapter.id,
+                                                                 position: index)
         end
 
         head :no_content
@@ -59,7 +58,7 @@ module PageflowScrolled
         configuration = params.require(:section)[:configuration].try(:permit!) || {}
         params.require(:section)
               .permit(:position)
-              .merge(configuration: configuration)
+              .merge(configuration:)
       end
     end
   end

data/entry_types/scrolled/app/controllers/pageflow_scrolled/entries_controller.rb

@@ -5,6 +5,7 @@ module PageflowScrolled
 
     helper Pageflow::EntriesHelper
     helper Pageflow::FeedsHelper
+    helper Pageflow::HreflangLinksHelper
     helper Pageflow::WidgetsHelper
     helper Pageflow::SocialShareHelper
     helper Pageflow::MetaTagsHelper
@@ -14,15 +15,35 @@ module PageflowScrolled
 
     def show
       entry = get_published_entry_from_env
+      mode = get_entry_mode_from_env
 
       I18n.locale = entry.locale
 
       render(
         locals: {
-          entry: entry,
-          widget_scope: get_entry_mode_from_env
+          entry:,
+          entry_mode: mode,
+          seed_options: seed_options(entry, mode)
         }
       )
     end
+
+    private
+
+    def seed_options(entry, mode)
+      options = {
+        embed: get_embed_from_env,
+        origin_url: request.original_url
+      }
+
+      if mode == :preview
+        # Published entries are cached without taking the requesting
+        # user into account. Only previews may depend on their locale.
+        options[:ui_locale] = get_ui_locale_from_env
+        options[:load_commenting] = true if entry.feature_state('commenting')
+      end
+
+      options
+    end
   end
 end

data/entry_types/scrolled/app/helpers/pageflow_scrolled/cache_helper.rb

@@ -1,11 +1,11 @@
 module PageflowScrolled
   # @api private
   module CacheHelper
-    def cache_scrolled_entry(entry:, widget_scope:, &block)
+    def cache_scrolled_entry(entry:, entry_mode:, &)
       condition =
-        widget_scope == :published &&
+        entry_mode == :published &&
         entry.feature_state('scrolled_entry_fragment_caching')
-      cache_if(condition, [entry, :head_and_body, widget_scope], &block)
+      cache_if(condition, [entry, :head_and_body, entry_mode], &)
     end
   end
 end

data/entry_types/scrolled/app/helpers/pageflow_scrolled/editor/entry_json_seed_helper.rb

@@ -11,13 +11,16 @@ module PageflowScrolled
         entry_config = Pageflow.config_for(scrolled_entry)
 
         scrolled_entry_editor_legacy_typography_variants_seed(json, entry_config)
-        scrolled_entry_editor_consent_vendor_host_matchers_seed(json, entry_config)
+        scrolled_entry_editor_consent_vendor_url_matchers_seed(json, entry_config)
 
         scrolled_entry_json_seed(json,
                                  scrolled_entry,
                                  skip_files: true,
                                  skip_i18n: true,
-                                 include_unused_additional_seed_data: true)
+                                 include_hidden_sections: true,
+                                 include_unused_additional_seed_data: true,
+                                 include_unused_file_reference_locations: true,
+                                 include_theme_translations: true)
       end
 
       private
@@ -30,10 +33,10 @@ module PageflowScrolled
         )
       end
 
-      def scrolled_entry_editor_consent_vendor_host_matchers_seed(json, entry_config)
-        json.consent_vendor_host_matchers(
+      def scrolled_entry_editor_consent_vendor_url_matchers_seed(json, entry_config)
+        json.consent_vendor_url_matchers(
           entry_config
-            .consent_vendor_host_matchers
+            .consent_vendor_url_matchers
             .transform_keys { |regexp| regexp.inspect[1..-2] }
         )
       end

data/entry_types/scrolled/app/helpers/pageflow_scrolled/editor/seed_html_helper.rb

@@ -8,6 +8,7 @@ module PageflowScrolled
       include Pageflow::StructuredDataHelper
       include Pageflow::TextDirectionHelper
       include PageflowScrolled::CacheHelper
+      include PageflowScrolled::SprocketsHelper
       include FaviconHelper
       include PacksHelper
       include WebpackPublicPathHelper
@@ -15,15 +16,18 @@ module PageflowScrolled
       def scrolled_editor_iframe_seed_html_script_tag(entry)
         html = render(template: 'pageflow_scrolled/entries/show',
                       locals: {
-                        entry: entry,
-                        widget_scope: :editor,
+                        entry:,
+                        entry_mode: :editor,
                         skip_ssr: true,
                         skip_structured_data: true,
                         skip_feed_link_tags: true,
+                        skip_hreflang_link_tags: true,
                         seed_options: {
                           skip_collections: true,
                           include_unused_additional_seed_data: true,
-                          translations: {include_inline_editing: true}
+                          include_unused_file_reference_locations: true,
+                          include_theme_translations: true,
+                          load_inline_editing: true
                         }
                       })
 

data/entry_types/scrolled/app/helpers/pageflow_scrolled/entry_json_seed_helper.rb

@@ -9,6 +9,7 @@ module PageflowScrolled
     include Pageflow::EntriesHelper
     include Pageflow::MetaTagsHelper
     include Pageflow::SocialShareLinksHelper
+    include Pageflow::PublicI18n::LocalesHelper
     include PageflowScrolled::I18nHelper
     include PageflowScrolled::ThemesHelper
 
@@ -17,23 +18,84 @@ module PageflowScrolled
         scrolled_entry_json_seed(json, scrolled_entry, options)
       end
 
-      content_tag(:script, <<-JS.html_safe)
-        pageflowScrolledRender(#{sanitize_json(seed_json)});
-      JS
+      content_tag(:script,
+                  sanitize_json(seed_json).html_safe,
+                  type: 'application/json',
+                  data: {pageflow_scrolled_seed: true})
     end
 
     def scrolled_entry_json_seed(json, scrolled_entry, options = {})
-      main_storyline = Storyline.all_for_revision(scrolled_entry.revision).first
-      main_storyline ||= Storyline.new
+      revision = scrolled_entry.revision
+      sections = scrolled_entry_json_seed_sections(scrolled_entry, options)
+      content_elements = scrolled_entry_json_seed_content_elements(revision, sections)
+      entry_config = Pageflow.config_for(scrolled_entry)
 
       json.partial!('pageflow_scrolled/entry_json_seed/entry',
-                    chapters: main_storyline.chapters,
                     entry: scrolled_entry,
-                    entry_config: Pageflow.config_for(scrolled_entry),
-                    sections: main_storyline.sections,
-                    content_elements: main_storyline.content_elements,
+                    entry_config:,
+                    storylines: scrolled_entry_json_seed_storylines(revision),
+                    chapters: scrolled_entry_json_seed_chapters(revision, options),
+                    sections:,
+                    content_elements:,
+                    file_reference_locations: EntryFileReferenceLocations.new(
+                      entry_config,
+                      content_elements,
+                      include_unused: options[:include_unused_file_reference_locations]
+                    ),
                     widgets: scrolled_entry.resolve_widgets(insert_point: :react),
-                    options: options)
+                    options:)
+    end
+
+    private
+
+    def scrolled_entry_json_seed_storylines(revision)
+      Storyline.all_for_revision(revision)
+    end
+
+    def scrolled_entry_json_seed_sections(scrolled_entry, options)
+      main_storyline = Storyline.all_for_revision(scrolled_entry.revision).first || Storyline.new
+
+      sections =
+        if scrolled_entry.cutoff_mode_enabled_for?(request)
+          main_storyline.sections_before_cutoff_section
+        else
+          Section.all_for_revision(scrolled_entry.revision)
+        end
+
+      return sections if options[:include_hidden_sections]
+
+      sections.reject { |section| section.configuration['hidden'] }
+    end
+
+    def scrolled_entry_json_seed_chapters(revision, options)
+      chapters = Chapter.all_for_revision(revision)
+      return chapters if options[:include_hidden_sections]
+
+      has_visible_sections, has_hidden_sections =
+        scrolled_entry_json_seed_chapter_section_visibilites(revision)
+
+      chapters.reject do |chapter|
+        has_hidden_sections[chapter.id] && !has_visible_sections[chapter.id]
+      end
+    end
+
+    def scrolled_entry_json_seed_chapter_section_visibilites(revision)
+      has_visible_sections = {}
+      has_hidden_sections = {}
+
+      Section.all_for_revision(revision).each do |section|
+        if section.configuration['hidden']
+          has_hidden_sections[section.chapter_id] = true
+        else
+          has_visible_sections[section.chapter_id] = true
+        end
+      end
+
+      [has_visible_sections, has_hidden_sections]
+    end
+
+    def scrolled_entry_json_seed_content_elements(revision, sections)
+      ContentElement.all_for_revision(revision).where(section: sections)
     end
   end
 end

data/entry_types/scrolled/app/helpers/pageflow_scrolled/i18n_helper.rb

@@ -1,16 +1,23 @@
 module PageflowScrolled
   # @api private
   module I18nHelper
-    def scrolled_i18n_translations(entry, include_inline_editing: false)
-      result = scrolled_i18n_public_translations(entry)
+    def scrolled_i18n_translations(entry,
+                                   ui_locale: I18n.locale,
+                                   include_inline_editing: false,
+                                   include_review: false)
+      ui_scopes = []
+      ui_scopes << :inline_editing if include_inline_editing
+      ui_scopes << :review if include_review
 
-      return result unless include_inline_editing
-
-      result.deep_merge(I18n.locale.to_s => {
-                          pageflow_scrolled: {
-                            inline_editing: I18n.t('pageflow_scrolled.inline_editing')
-                          }
-                        })
+      ui_scopes.reduce(scrolled_i18n_public_translations(entry)) do |result, scope|
+        result.deep_merge(
+          ui_locale.to_s => {
+            pageflow_scrolled: {
+              scope => I18n.t("pageflow_scrolled.#{scope}", locale: ui_locale)
+            }
+          }
+        )
+      end
     end
 
     private
@@ -19,11 +26,19 @@ module PageflowScrolled
       value.presence || fallback
     end
 
+    # Entry locales are not expected to be complete. Merge translations
+    # of all fallback locales since the frontend does not know about
+    # fallbacks.
     def scrolled_i18n_public_translations(entry)
-      translations =
-        I18n.t('pageflow_scrolled.public', locale: I18n.default_locale, default: {})
-            .deep_merge(I18n.t('pageflow_scrolled.public', locale: entry.locale, default: {}),
-                        &MERGE_IGNORING_NIL)
+      locales = [I18n.default_locale, *I18n.fallbacks[entry.locale].reverse].uniq &
+                I18n.available_locales
+
+      translations = locales.reduce({}) do |result, locale|
+        result.deep_merge(
+          I18n.t('pageflow_scrolled.public', locale:, default: {}),
+          &MERGE_IGNORING_NIL
+        )
+      end
 
       {
         entry.locale => {

data/entry_types/scrolled/app/helpers/pageflow_scrolled/packs_helper.rb

@@ -4,17 +4,24 @@ module PageflowScrolled
     def scrolled_frontend_javascript_packs_tag(entry, options)
       javascript_pack_tag(
         *scrolled_frontend_packs(entry, **options),
-        defer: false
+        defer: true
       )
     end
 
-    def scrolled_frontend_stylesheet_packs_tag(entry, options)
+    def scrolled_frontend_stylesheet_packs_tag(entry, **)
       stylesheet_pack_tag(
-        *scrolled_frontend_packs(entry, **options),
+        *scrolled_frontend_stylesheet_packs(entry, **),
         media: 'all'
       )
     end
 
+    def scrolled_frontend_stylesheet_packs(entry, entry_mode:, seed_options: {})
+      packs = scrolled_frontend_packs(entry, entry_mode:, format: :css)
+      packs += ['pageflow-scrolled-frontend-inlineEditing'] if seed_options[:load_inline_editing]
+      packs += ['pageflow-scrolled-frontend-commenting'] if seed_options[:load_commenting]
+      packs
+    end
+
     def scrolled_editor_javascript_packs_tag(entry)
       javascript_pack_tag(
         *scrolled_editor_packs(entry),
@@ -22,25 +29,40 @@ module PageflowScrolled
       )
     end
 
-    def scrolled_frontend_packs(entry, widget_scope:)
+    def scrolled_editor_stylesheet_packs_tag(entry)
+      stylesheet_pack_tag(
+        *scrolled_editor_stylesheet_packs(entry),
+        media: 'all'
+      )
+    end
+
+    def scrolled_frontend_packs(entry, entry_mode:, format: :js)
       ['pageflow-scrolled-frontend'] +
-        scrolled_additional_frontend_packs(entry, widget_scope) +
-        scrolled_frontend_widget_type_packs(entry, widget_scope)
+        scrolled_additional_frontend_packs(entry, entry_mode) +
+        scrolled_frontend_widget_type_packs(entry, entry_mode, format)
     end
 
     def scrolled_editor_packs(entry)
       ['pageflow-scrolled-editor'] +
-        Pageflow.config_for(entry).additional_editor_packs.paths +
+        Pageflow.config_for(entry).additional_editor_packs.paths(entry) +
+        Pageflow.config_for(entry).additional_frontend_packs.paths(entry) +
         scrolled_frontend_widget_type_packs(entry, :editor)
     end
 
+    def scrolled_editor_stylesheet_packs(entry)
+      ['pageflow-scrolled-editor'] +
+        Pageflow.config_for(entry).additional_editor_packs.stylesheet_paths(entry) +
+        Pageflow.config_for(entry).additional_frontend_packs.paths(entry)
+    end
+
     private
 
     def scrolled_additional_frontend_packs(entry, widget_scope)
       additional_packs = Pageflow.config_for(entry).additional_frontend_packs
-      return additional_packs.paths if widget_scope == :editor
+      return additional_packs.paths(entry) if widget_scope == :editor
 
       additional_packs.paths_for_content_element_types(
+        entry,
         ContentElement.select_used_type_names(
           entry.revision,
           additional_packs.content_element_type_names
@@ -48,15 +70,22 @@ module PageflowScrolled
       )
     end
 
-    def scrolled_frontend_widget_type_packs(entry, widget_scope)
-      scrolled_frontend_pack_widget_types(entry, widget_scope).map(&:pack)
+    def scrolled_frontend_widget_type_packs(entry, widget_scope, format = :js)
+      scrolled_frontend_pack_widget_types(entry, widget_scope)
+        .select { |widget_type| widget_type.respond_to?(:packs) }
+        .flat_map { |widget_type| widget_type.packs(entry:, request:) }
+        .filter_map { |pack|
+          path, stylesheet = pack.is_a?(Hash) ? pack.values_at(:path, :stylesheet) : [pack, false]
+          path if format == :js || stylesheet
+        }
+        .uniq
     end
 
     def scrolled_frontend_pack_widget_types(entry, widget_scope)
       if widget_scope == :editor
-        ReactWidgetType.all_for(entry)
+        Pageflow.config_for(entry).widget_types.select(&:enabled_in_editor?)
       else
-        entry.resolve_widgets(insert_point: :react).map(&:widget_type)
+        entry.resolve_widgets.map(&:widget_type)
       end
     end
   end