pageflow 17.0.5 → 17.1.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/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
 
@@ -64,7 +64,7 @@ module PageflowScrolled
         params.require(:content_element)
               .transform_keys(&:underscore)
               .permit(:type_name, :position)
-              .merge(configuration: configuration)
+              .merge(configuration:)
       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
 
@@ -59,7 +59,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
@@ -19,7 +20,7 @@ module PageflowScrolled
 
       render(
         locals: {
-          entry: entry,
+          entry:,
           widget_scope: get_entry_mode_from_env
         }
       )

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:, widget_scope:, &)
       condition =
         widget_scope == :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, widget_scope], &)
     end
   end
 end

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

@@ -17,6 +17,7 @@ module PageflowScrolled
                                  scrolled_entry,
                                  skip_files: true,
                                  skip_i18n: true,
+                                 include_hidden_sections: true,
                                  include_unused_additional_seed_data: true)
       end
 

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

@@ -15,11 +15,12 @@ module PageflowScrolled
       def scrolled_editor_iframe_seed_html_script_tag(entry)
         html = render(template: 'pageflow_scrolled/entries/show',
                       locals: {
-                        entry: entry,
+                        entry:,
                         widget_scope: :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,

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
 
@@ -23,17 +24,70 @@ module PageflowScrolled
     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)
 
       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,
+                    storylines: scrolled_entry_json_seed_storylines(revision),
+                    chapters: scrolled_entry_json_seed_chapters(revision, options),
+                    sections:,
+                    content_elements: scrolled_entry_json_seed_content_elements(revision, sections),
                     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/packs_helper.rb

@@ -22,6 +22,13 @@ module PageflowScrolled
       )
     end
 
+    def scrolled_editor_stylesheet_packs_tag(entry)
+      stylesheet_pack_tag(
+        *scrolled_editor_stylesheet_packs(entry),
+        media: 'all'
+      )
+    end
+
     def scrolled_frontend_packs(entry, widget_scope:)
       ['pageflow-scrolled-frontend'] +
         scrolled_additional_frontend_packs(entry, widget_scope) +
@@ -30,17 +37,24 @@ module PageflowScrolled
 
     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.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

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

@@ -33,35 +33,33 @@ module PageflowScrolled
     # see https://github.com/reactjs/react-rails/issues/970#issuecomment-476338244
     class WebpackerSplitChunksManifestContainer < React::ServerRendering::WebpackerManifestContainer
       CLIENT_EXEC =
-        %r{__webpack_exec__\("./node_modules/webpack-dev-server\/client\/index\.js[^"]*"\),}
+        %r{__webpack_exec__\("./node_modules/webpack-dev-server/client/index\.js[^"]*"\),}
 
-      def find_asset(logical_path)
+      def find_asset(logical_path) # rubocop:todo Metrics/AbcSize
         asset_paths = manifest.lookup_pack_with_chunks(logical_path, type: :javascript)
 
         asset_contents =
-          begin
-            if Webpacker.dev_server.running?
-              ds = Webpacker.dev_server
-              asset_paths.map do |asset_path|
-                # Remove the protocol and host from the asset
-                # path. Sometimes webpacker includes this, sometimes
-                # it does not
-                asset_path.slice!("#{ds.protocol}://#{ds.host_with_port}")
-                dev_server_asset =
-                  URI.open("#{ds.protocol}://#{ds.host_with_port}#{asset_path}").read
+          if Webpacker.dev_server.running?
+            ds = Webpacker.dev_server
+            asset_paths.map do |asset_path|
+              # Remove the protocol and host from the asset
+              # path. Sometimes webpacker includes this, sometimes
+              # it does not
+              asset_path.slice!("#{ds.protocol}://#{ds.host_with_port}")
+              dev_server_asset =
+                URI.open("#{ds.protocol}://#{ds.host_with_port}#{asset_path}").read # rubocop:disable Security/Open
 
-                # Remove webpack-dev-server client code that tries to
-                # interact with browser globals:
-                dev_server_asset.sub!(CLIENT_REQUIRE, '//\0') # for Webpack 4
-                dev_server_asset.sub!(CLIENT_EXEC, '/*\0*/')  # for Webpack 5
+              # Remove webpack-dev-server client code that tries to
+              # interact with browser globals:
+              dev_server_asset.sub!(CLIENT_REQUIRE, '//\0') # for Webpack 4
+              dev_server_asset.sub!(CLIENT_EXEC, '/*\0*/')  # for Webpack 5
 
-                dev_server_asset
-              end
-            else
-              asset_paths.map do |asset_path|
-                full_path = ::Rails.root.join('public', asset_path[1..-1])
-                File.read(full_path)
-              end
+              dev_server_asset
+            end
+          else
+            asset_paths.map do |asset_path|
+              full_path = ::Rails.root.join('public', asset_path[1..])
+              File.read(full_path)
             end
           end
 

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

@@ -6,9 +6,11 @@ module PageflowScrolled
                                   theme_file_role: nil,
                                   theme_file_style: :resized,
                                   relative_url: false)
+      theme_directory, path = extract_theme_directory_from_scrolled_theme_asset_path(theme, path)
+
       path =
         theme.files.dig(theme_file_role, theme_file_style) ||
-        asset_pack_path("static/pageflow-scrolled/themes/#{theme.name}/#{path}")
+        asset_pack_path("static/pageflow-scrolled/themes/#{theme_directory}/#{path}")
 
       if relative_url
         URI.parse(path).path
@@ -108,6 +110,7 @@ module PageflowScrolled
 
       def selector(rule_name)
         return ':root' if rule_name == :root
+
         ".#{@prefix}-#{rule_name.to_s.camelize(:lower)}"
       end
     end
@@ -122,5 +125,17 @@ module PageflowScrolled
         end
       end
     end
+
+    def extract_theme_directory_from_scrolled_theme_asset_path(theme, path)
+      if path.starts_with?('../shared/')
+        ['shared', path.gsub!('../shared/', '')]
+      elsif path.starts_with?('../')
+        raise(ArgumentError,
+              'Upward navigation to other directory than the shared ' \
+              'theme directory not allowed in theme asset path.')
+      else
+        [theme.name, path]
+      end
+    end
   end
 end

data/entry_types/scrolled/app/models/pageflow_scrolled/chapter.rb

@@ -1,5 +1,10 @@
 module PageflowScrolled
-  class Chapter < Pageflow::ApplicationRecord
+  class Chapter < Pageflow::ApplicationRecord # rubocop:todo Style/Documentation
+    POSITION_ORDER = [
+      'pageflow_scrolled_storylines.position ASC',
+      'pageflow_scrolled_chapters.position ASC'
+    ].join(',')
+
     include Pageflow::SerializedConfiguration
     include Pageflow::AutoGeneratedPermaId
     include Pageflow::NestedRevisionComponent
@@ -13,8 +18,9 @@ module PageflowScrolled
 
     nested_revision_components :sections
 
-    attr_accessor :revision # used on :create to lazily create storyline
-    before_validation :ensure_storyline, on: :create
+    def entry_for_auto_generated_perma_id
+      storyline.revision.entry
+    end
 
     def create_section(attributes = {})
       shift_section_positions(from: attributes[:position])
@@ -26,16 +32,19 @@ module PageflowScrolled
     end
 
     def duplicate_section(section)
-      shift_section_positions(from: section.position + 1)
+      transaction do
+        shift_section_positions(from: section.position + 1)
 
-      section.duplicate do |new_section|
-        new_section.position = section.position + 1
+        section.duplicate do |new_section|
+          new_section.position = section.position + 1
+        end
       end
     end
 
     def self.all_for_revision(revision)
       joins(storyline: :revision)
         .where(pageflow_scrolled_storylines: {revision_id: revision})
+        .order(POSITION_ORDER)
     end
 
     private
@@ -45,13 +54,5 @@ module PageflowScrolled
         .where('position >= ?', from)
         .update_all('position = position + 1')
     end
-
-    def ensure_storyline
-      return if storyline.present?
-      unless Storyline.all_for_revision(revision).exists?
-        Storyline.create!(revision: revision, configuration: {main: true})
-      end
-      self.storyline = Storyline.all_for_revision(revision).first
-    end
   end
 end

data/entry_types/scrolled/app/models/pageflow_scrolled/content_element.rb

@@ -1,15 +1,27 @@
 module PageflowScrolled
   # @api private
   class ContentElement < Pageflow::ApplicationRecord
+    POSITION_ORDER = [
+      'pageflow_scrolled_storylines.position ASC',
+      'pageflow_scrolled_chapters.position ASC',
+      'pageflow_scrolled_sections.position ASC',
+      'pageflow_scrolled_content_elements.position ASC'
+    ].join(',')
+
     include Pageflow::SerializedConfiguration
     include Pageflow::AutoGeneratedPermaId
     include Pageflow::NestedRevisionComponent
 
     belongs_to :section
 
+    def entry_for_auto_generated_perma_id
+      section.chapter.storyline.revision.entry
+    end
+
     def self.all_for_revision(revision)
       joins(section: {chapter: {storyline: :revision}})
         .where(pageflow_scrolled_storylines: {revision_id: revision})
+        .order(POSITION_ORDER)
     end
 
     def self.select_used_type_names(revision, type_names)

data/entry_types/scrolled/app/models/pageflow_scrolled/section.rb

@@ -1,5 +1,11 @@
 module PageflowScrolled
-  class Section < Pageflow::ApplicationRecord
+  class Section < Pageflow::ApplicationRecord # rubocop:todo Style/Documentation
+    POSITION_ORDER = [
+      'pageflow_scrolled_storylines.position ASC',
+      'pageflow_scrolled_chapters.position ASC',
+      'pageflow_scrolled_sections.position ASC'
+    ].join(',')
+
     include Pageflow::SerializedConfiguration
     include Pageflow::AutoGeneratedPermaId
     include Pageflow::NestedRevisionComponent
@@ -12,9 +18,14 @@ module PageflowScrolled
 
     nested_revision_components :content_elements
 
+    def entry_for_auto_generated_perma_id
+      chapter.storyline.revision.entry
+    end
+
     def self.all_for_revision(revision)
       joins(chapter: {storyline: :revision})
         .where(pageflow_scrolled_storylines: {revision_id: revision})
+        .order(POSITION_ORDER)
     end
   end
 end

data/entry_types/scrolled/app/models/pageflow_scrolled/storyline.rb

@@ -1,5 +1,5 @@
 module PageflowScrolled
-  class Storyline < Pageflow::ApplicationRecord
+  class Storyline < Pageflow::ApplicationRecord # rubocop:todo Style/Documentation
     SECTIONS_ORDER = [
       'pageflow_scrolled_chapters.position ASC',
       'pageflow_scrolled_sections.position ASC'
@@ -27,5 +27,23 @@ module PageflowScrolled
              through: :sections
 
     nested_revision_components :chapters
+
+    def sections_before_cutoff_section
+      sections_before(cutoff_section)
+    end
+
+    def self.create_defaults(draft)
+      create!(revision: draft, configuration: {main: true})
+    end
+
+    private
+
+    def sections_before(section)
+      section ? sections[0...sections.index(section)] : sections
+    end
+
+    def cutoff_section
+      sections.find_by_perma_id(revision.configuration['cutoff_section_perma_id'])
+    end
   end
 end

data/entry_types/scrolled/app/views/pageflow_scrolled/editor/entries/_head.html.erb

@@ -9,3 +9,4 @@
 
 <%= scrolled_webpack_public_path_script_tag %>
 <%= scrolled_editor_javascript_packs_tag(entry) %>
+<%= scrolled_editor_stylesheet_packs_tag(entry) %>

data/entry_types/scrolled/app/views/pageflow_scrolled/editor/sections/_section_with_content_elements.json.jbuilder

@@ -1,10 +1,10 @@
 json.key_format!(camelize: :lower)
 
-json.partial! 'pageflow_scrolled/sections/section', section: section
+json.partial!('pageflow_scrolled/sections/section', section:)
 
 json.content_elements do
   json.array!(section.content_elements) do |content_element|
     json.partial! 'pageflow_scrolled/content_elements/content_element',
-                  content_element: content_element
+                  content_element:
   end
 end

data/entry_types/scrolled/app/views/pageflow_scrolled/entries/show.html.erb

@@ -6,9 +6,11 @@
 
       <meta charset="utf-8" />
       <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
+      <meta name="robots" content="max-image-preview:large">
 
       <%= social_share_meta_tags_for(entry) %>
       <%= meta_tags_for_entry(entry) %>
+      <%= hreflang_link_tags_for_entry(entry) unless local_assigns[:skip_hreflang_link_tags] %>
       <%= feed_link_tags_for_entry(entry) unless local_assigns[:skip_feed_link_tags] %>
 
       <%= scrolled_favicons_for_entry(entry, entry_mode: widget_scope) %>