pageflow 17.0.5 → 17.2.0

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

@@ -4,9 +4,9 @@ module PageflowScrolled
     include Pageflow::RenderJsonHelper
     include PageflowScrolled::EntryJsonSeedHelper
 
-    def render_scrolled_entry(entry)
+    def render_scrolled_entry(entry, options = {})
       seed_json = render_json do |json|
-        scrolled_entry_json_seed(json, entry)
+        scrolled_entry_json_seed(json, entry, options)
       end
 
       ReactServerSideRenderingHelper.renderer.render('Root', "{seed: #{seed_json}}", {})
@@ -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/sprockets_helper.rb

@@ -0,0 +1,16 @@
+module PageflowScrolled
+  # @api private
+  module SprocketsHelper
+    def scrolled_sprockets_asset_tags(entry, entry_mode:)
+      tags = []
+
+      if Pageflow.config_for(entry).include_legacy_frontend_javascript
+        tags << javascript_include_tag('pageflow_scrolled/legacy')
+      end
+
+      tags << stylesheet_link_tag('pageflow_scrolled/ui', media: 'all') if entry_mode != :published
+
+      safe_join(tags)
+    end
+  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
@@ -30,6 +32,7 @@ module PageflowScrolled
       ].flatten
 
       content_tag('style', raw(<<~CSS), data: {theme: ''})
+        #{scrolled_theme_font_face_rules(theme)}
         :root {
           #{declarations.join("\n")}
         }
@@ -39,6 +42,23 @@ module PageflowScrolled
       CSS
     end
 
+    def scrolled_theme_font_face_rules(theme)
+      scrolled_theme_font_faces(theme).filter_map(&:generate).join("\n")
+    end
+
+    def scrolled_theme_font_preload_link_tags(theme)
+      safe_join(
+        scrolled_theme_font_faces(theme).filter_map(&:preload_source).map do |source|
+          tag.link(rel: 'preload',
+                   as: 'font',
+                   type: source[:type],
+                   href: source[:url],
+                   crossorigin: 'anonymous',
+                   data: {theme: ''})
+        end
+      )
+    end
+
     def scrolled_theme_typography_rules(theme)
       RuleSet.new(prefix: 'typography').generate(theme.options.fetch(:typography, {}))
     end
@@ -50,6 +70,159 @@ module PageflowScrolled
 
     private
 
+    def scrolled_theme_font_faces(theme)
+      theme.options.fetch(:font_faces, []).map do |face|
+        FontFaceRule.new(face, theme:) { |path| scrolled_theme_asset_path(theme, path) }
+      end
+    end
+
+    # @api private
+    class FontFaceRule
+      FORMATS = {
+        '.woff2' => 'woff2',
+        '.woff' => 'woff',
+        '.ttf' => 'truetype',
+        '.otf' => 'opentype'
+      }.freeze
+
+      MIME_TYPES = {
+        'woff2' => 'font/woff2',
+        'woff' => 'font/woff',
+        'truetype' => 'font/ttf',
+        'opentype' => 'font/otf'
+      }.freeze
+
+      WEIGHT_PATTERN = /\A(normal|bold|\d{1,4}( \d{1,4})?)\z/
+      STYLE_PATTERN = /\A(normal|italic)\z/
+      FORMAT_PATTERN = /\A(woff2?|truetype|opentype|embedded-opentype|svg)(-variations)?\z/
+      UNICODE_RANGE_PATTERN = /\A\s*U\+[0-9a-f?]{1,6}(-[0-9a-f]{1,6})?
+                               (\s*,\s*U\+[0-9a-f?]{1,6}(-[0-9a-f]{1,6})?)*\s*\z/xi
+
+      # Quotes and backslashes would allow breaking out of the quoted
+      # strings family names and urls are interpolated into.
+      UNSAFE_IN_FAMILY = /["'\\[[:cntrl:]]]/
+      UNSAFE_IN_URL = /["'\\\s]/
+
+      ABSOLUTE_URL = %r{\A((https?:)?//|/|data:)}
+
+      def initialize(face, theme:, &resolve_path)
+        @face = face
+        @theme = theme
+        @resolve_path = resolve_path
+      end
+
+      def generate
+        return unless valid?
+
+        <<~CSS
+          @font-face {
+            #{declarations.join("\n  ")}
+          }
+        CSS
+      end
+
+      # Only the first source is preloaded since the browser downloads
+      # exactly one of the alternative formats.
+      def preload_source
+        return unless valid? && face[:preload]
+
+        source = sources_with_safe_urls.first
+
+        {url: source[:url], type: mime_type(source)}
+      end
+
+      private
+
+      attr_reader :face, :theme
+
+      def valid?
+        family.present? && sources_with_safe_urls.any?
+      end
+
+      def declarations
+        [
+          %(font-family: "#{family}";),
+          "src: #{source_values.join(', ')};",
+          'font-display: swap;',
+          *descriptors
+        ]
+      end
+
+      def family
+        @family ||= face[:family].to_s.gsub(UNSAFE_IN_FAMILY, '').strip
+      end
+
+      def source_values
+        sources_with_safe_urls.map { |source| source_value(source) }
+      end
+
+      def sources_with_safe_urls
+        @sources_with_safe_urls ||= sources.reject { |source| source[:url].match?(UNSAFE_IN_URL) }
+      end
+
+      def sources
+        if face[:file_role]
+          sources_from_files
+        else
+          sources_from_src
+        end
+      end
+
+      def sources_from_files
+        Array(face[:file_role]).compact.filter_map do |role|
+          url = theme.files.dig(role.to_sym, :original)
+          {url: url.to_s, format: face[:format]} if url
+        end
+      end
+
+      def sources_from_src
+        Array(face[:src]).filter_map do |src|
+          src = {url: src} unless src.is_a?(Hash)
+          next if src[:url].blank?
+
+          {url: resolve_url(src[:url]), format: src.fetch(:format, face[:format])}
+        end
+      end
+
+      def resolve_url(url)
+        return url.to_s if url.to_s.match?(ABSOLUTE_URL)
+
+        @resolve_path.call(url).to_s
+      end
+
+      def source_value(source)
+        format = source_format(source)
+
+        return %(url("#{source[:url]}")) unless format
+
+        %(url("#{source[:url]}") format("#{format}"))
+      end
+
+      def mime_type(source)
+        MIME_TYPES[source_format(source).to_s.delete_suffix('-variations')]
+      end
+
+      def source_format(source)
+        [source[:format], FORMATS[extension(source[:url])]].find do |candidate|
+          candidate.to_s.match?(FORMAT_PATTERN)
+        end
+      end
+
+      def extension(url)
+        File.extname(url.split(/[?#]/).first.to_s).downcase
+      end
+
+      def descriptors
+        [
+          ['font-weight', face[:weight], WEIGHT_PATTERN],
+          ['font-style', face[:style], STYLE_PATTERN],
+          ['unicode-range', face[:unicode_range], UNICODE_RANGE_PATTERN]
+        ].filter_map do |property, value, pattern|
+          "#{property}: #{value.to_s.strip};" if value.to_s.match?(pattern)
+        end
+      end
+    end
+
     BREAKPOINTS = {
       sm: '640px',
       md: '768px',
@@ -81,8 +254,8 @@ module PageflowScrolled
       private
 
       def extract_breakpoint_declarations!(declarations)
-        BREAKPOINTS.keys.each_with_object({}) { |breakpoint_name, result|
-          result[breakpoint_name] = declarations.delete(breakpoint_name)
+        BREAKPOINTS.keys.to_h { |breakpoint_name|
+          [breakpoint_name, declarations.delete(breakpoint_name)]
         }.compact
       end
 
@@ -108,6 +281,7 @@ module PageflowScrolled
 
       def selector(rule_name)
         return ':root' if rule_name == :root
+
         ".#{@prefix}-#{rule_name.to_s.camelize(:lower)}"
       end
     end
@@ -122,5 +296,17 @@ module PageflowScrolled
         end
       end
     end
+
+    def extract_theme_directory_from_scrolled_theme_asset_path(theme, path)
+      if path.starts_with?('../shared/')
+        ['shared', path.sub('../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)
@@ -21,15 +33,16 @@ module PageflowScrolled
 
     # @api private
     class Batch
-      def initialize(section, items)
+      def initialize(section, items, comment_thread_subject_ranges: nil)
         @section = section
         @storyline = section.chapter.storyline
         @items = items
+        @comment_thread_subject_ranges = comment_thread_subject_ranges
       end
 
       def save!
         ContentElement.transaction do
-          @items.map.with_index { |item, index|
+          result = @items.map.with_index { |item, index|
             if item[:_delete]
               @section.content_elements.delete(item[:id])
               nil
@@ -37,6 +50,10 @@ module PageflowScrolled
               create_or_update(item, index)
             end
           }.compact
+
+          update_subject_ranges
+          reconcile_section_perma_ids
+          result
         end
       end
 
@@ -48,11 +65,48 @@ module PageflowScrolled
           position: index
         }.merge(item.slice(:type_name, :configuration))
 
-        if item[:id]
-          @storyline.content_elements.update(item[:id], attributes)
-        else
-          @section.content_elements.create(attributes)
-        end
+        content_element = if item[:id]
+                            @storyline.content_elements.update(item[:id], attributes)
+                          else
+                            @section.content_elements.create(attributes)
+                          end
+
+        migrate_comment_threads(content_element, item[:migrate_comment_threads])
+        content_element
+      end
+
+      def migrate_comment_threads(content_element, thread_ids)
+        Pageflow::CommentThread.migrate_to_subject(
+          revision: @storyline.revision,
+          subject_type: 'ContentElement',
+          subject_id: content_element.perma_id,
+          thread_ids:
+        )
+      end
+
+      def update_subject_ranges
+        return if @comment_thread_subject_ranges.blank?
+
+        Pageflow::CommentThread.update_subject_ranges_for(
+          revision: @storyline.revision,
+          subject_type: 'ContentElement',
+          subject_id: @section.content_elements.pluck(:perma_id),
+          ranges: @comment_thread_subject_ranges
+        )
+      end
+
+      # A comment thread's section follows its content element. Reconcile
+      # the section perma id of threads on this section's content elements
+      # so threads stay relocatable to the right section once their
+      # content element is deleted — e.g. after a content element was
+      # moved here from another section.
+      def reconcile_section_perma_ids
+        Pageflow::CommentThread.update_section_perma_id_for(
+          revision: @storyline.revision,
+          subject_type: 'ContentElement',
+          subject_id: @section.content_elements.pluck(:perma_id),
+          section_perma_id: @section.perma_id
+        )
       end
     end
   end

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

@@ -0,0 +1,6 @@
+module PageflowScrolled
+  # @api private
+  class LottieFile < Pageflow::ApplicationRecord
+    include Pageflow::UploadableFile
+  end
+end

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

@@ -0,0 +1,16 @@
+module PageflowScrolled
+  # @api private
+  class LottieFileUrlTemplates
+    def call
+      {
+        original: Pageflow::UrlTemplate.from_attachment(example_file.attachment, :original)
+      }
+    end
+
+    private
+
+    def example_file
+      @example_file ||= LottieFile.new(id: 0, file_name: ':basename.:extension')
+    end
+  end
+end

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,24 @@ 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})
+      create!(revision: draft, position: 1)
+    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

@@ -1,4 +1,4 @@
-<%= cache_scrolled_entry(entry: entry, widget_scope: widget_scope) do %>
+<%= cache_scrolled_entry(entry: entry, entry_mode: entry_mode) do %>
   <!DOCTYPE html>
   <%= content_tag(:html, lang: entry.locale, dir: text_direction(entry.locale)) do %>
     <head>
@@ -6,20 +6,26 @@
 
       <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">
+      <% if seed_options[:load_commenting] %>
+        <%= csrf_meta_tags %>
+      <% end %>
 
       <%= 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) %>
+      <%= scrolled_favicons_for_entry(entry, entry_mode: entry_mode) %>
 
-      <%= javascript_include_tag 'pageflow_scrolled/legacy' %>
-      <%= scrolled_frontend_stylesheet_packs_tag(entry, widget_scope: widget_scope) %>
+      <%= scrolled_sprockets_asset_tags(entry, entry_mode: entry_mode) %>
+      <%= scrolled_frontend_stylesheet_packs_tag(entry, entry_mode: entry_mode, seed_options: seed_options) %>
 
+      <%= scrolled_theme_font_preload_link_tags(entry.theme) %>
       <%= scrolled_theme_properties_style_tag(entry.theme) %>
       <%= scrolled_theme_stylesheet_pack_tags(entry.theme) %>
 
-      <%= render_widget_head_fragments(entry, scope: widget_scope) %>
+      <%= render_widget_head_fragments(entry, scope: entry_mode) %>
 
       <% if Rails.env.development? %>
         <script>
@@ -33,11 +39,8 @@
         </script>
       <% end %>
 
-      <% ssr_html = local_assigns[:skip_ssr] ? '' : render_scrolled_entry(entry) %>
+      <% ssr_html = local_assigns[:skip_ssr] ? '' : render_scrolled_entry(entry, seed_options) %>
 
-      <% if !local_assigns[:skip_ssr] && (params[:frontend] == 'v2' || entry.feature_state('frontend_v2')) %>
-        <%= generated_media_queries_tags_for(ssr_html) %>
-      <% end %>
     </head>
     <body>
       <%= structured_data_for_entry(entry) unless local_assigns[:skip_structured_data] %>
@@ -48,13 +51,13 @@
       <div id="root"><%= ssr_html %></div>
 
       <div id='template-widget-container'>
-        <%= render_widgets(entry, scope: widget_scope, insert_point: :bottom_of_entry) %>
+        <%= render_widgets(entry, scope: entry_mode, insert_point: :bottom_of_entry) %>
       </div>
 
       <%= scrolled_webpack_public_path_script_tag %>
-      <%= scrolled_frontend_javascript_packs_tag(entry, widget_scope: widget_scope) %>
+      <%= scrolled_frontend_javascript_packs_tag(entry, entry_mode: entry_mode) %>
 
-      <%= scrolled_entry_json_seed_script_tag(entry, local_assigns[:seed_options] || {}) %>
+      <%= scrolled_entry_json_seed_script_tag(entry, seed_options) %>
     </body>
   <% end %>
 <% end %>