Merge pull request #2231 from tf/excursions

Add support for excursion chapters

Author: tf

app/models/pageflow/entry.rb

@@ -53,7 +53,7 @@ class PasswordMissingError < StandardError
 
     after_create unless: :skip_draft_creation do
       create_draft!
-      draft.storylines.create!(configuration: {main: true})
+      create_default_revision_components
       entry_template.copy_defaults_to(draft)
     end
 
@@ -161,6 +161,10 @@ def entry_type_is_available_for_account
       errors.add(:type_name, :must_be_available_for_account, type_name: type_name)
     end
 
+    def create_default_revision_components
+      Pageflow.config_for(self).revision_components.create_defaults(draft)
+    end
+
     def update_password!(options)
       if options[:password].present?
         self.password = options[:password]

app/models/pageflow/storyline.rb

@@ -13,5 +13,9 @@ class Storyline < ApplicationRecord
     nested_revision_components :chapters
 
     delegate :entry, to: :revision
+
+    def self.create_defaults(draft)
+      create!(revision: draft, configuration: {main: true})
+    end
   end
 end

config/initializers/revision_components.rb

@@ -0,0 +1,14 @@
+class EnsureScrolledEntriesHaveMainStoryline < ActiveRecord::Migration[5.2]
+  def up
+    execute(<<-SQL)
+      INSERT INTO pageflow_scrolled_storylines (revision_id, perma_id, position, configuration, created_at, updated_at)
+      SELECT r.id, 1, 1, '{"main":true}', NOW(), NOW()
+      FROM pageflow_revisions r
+      INNER JOIN pageflow_entries e ON r.entry_id = e.id
+      LEFT JOIN pageflow_scrolled_storylines s ON s.revision_id = r.id
+      WHERE e.type_name = 'scrolled' AND s.revision_id IS NULL;
+    SQL
+  end
+
+  def down; end
+end

db/migrate/20250508172234_ensure_scrolled_entries_have_main_storyline.rb

@@ -7,6 +7,10 @@ def configure(config)
       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

entry_types/paged/lib/pageflow_paged/plugin.rb

@@ -5,11 +5,13 @@ class ChaptersController < ActionController::Base
       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
@@ -53,11 +55,7 @@ def chapter_params
       end
 
       def find_storyline
-        if params[:storyline_id]
-          Storyline.all_for_revision(@entry.draft).find(params[:storyline_id])
-        else
-          Storyline.all_for_revision(@entry.draft).first
-        end
+        Storyline.all_for_revision(@entry.draft).find(params[:storyline_id])
       end
     end
   end

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

@@ -24,50 +24,58 @@ def scrolled_entry_json_seed_script_tag(scrolled_entry, options = {})
     end
 
     def scrolled_entry_json_seed(json, scrolled_entry, options = {})
-      main_storyline = Storyline.all_for_revision(scrolled_entry.revision).first || Storyline.new
-      sections = scrolled_entry_json_seed_sections(scrolled_entry, main_storyline, options)
+      revision = scrolled_entry.revision
+      sections = scrolled_entry_json_seed_sections(scrolled_entry, options)
 
       json.partial!('pageflow_scrolled/entry_json_seed/entry',
                     entry: scrolled_entry,
                     entry_config: Pageflow.config_for(scrolled_entry),
-                    chapters: scrolled_entry_json_seed_chapters(main_storyline, options),
+                    storylines: scrolled_entry_json_seed_storylines(revision),
+                    chapters: scrolled_entry_json_seed_chapters(revision, options),
                     sections:,
-                    content_elements: main_storyline.content_elements.where(section: sections),
+                    content_elements: scrolled_entry_json_seed_content_elements(revision, sections),
                     widgets: scrolled_entry.resolve_widgets(insert_point: :react),
                     options:)
     end
 
     private
 
-    def scrolled_entry_json_seed_sections(scrolled_entry, main_storyline, options)
+    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
-          main_storyline.sections
+          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(main_storyline, options)
-      return main_storyline.chapters if options[:include_hidden_sections]
+    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(main_storyline)
+        scrolled_entry_json_seed_chapter_section_visibilites(revision)
 
-      main_storyline.chapters.reject do |chapter|
+      chapters.reject do |chapter|
         has_hidden_sections[chapter.id] && !has_visible_sections[chapter.id]
       end
     end
 
-    def scrolled_entry_json_seed_chapter_section_visibilites(main_storyline)
-      has_visible_sections = []
-      has_hidden_sections = []
+    def scrolled_entry_json_seed_chapter_section_visibilites(revision)
+      has_visible_sections = {}
+      has_hidden_sections = {}
 
-      main_storyline.sections.each do |section|
+      Section.all_for_revision(revision).each do |section|
         if section.configuration['hidden']
           has_hidden_sections[section.chapter_id] = true
         else
@@ -77,5 +85,9 @@ def scrolled_entry_json_seed_chapter_section_visibilites(main_storyline)
 
       [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

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

@@ -1,5 +1,10 @@
 module PageflowScrolled
   class Chapter < Pageflow::ApplicationRecord
+    POSITION_ORDER = [
+      'pageflow_scrolled_storylines.position ASC',
+      'pageflow_scrolled_chapters.position ASC'
+    ].join(',')
+
     include Pageflow::SerializedConfiguration
     include Pageflow::AutoGeneratedPermaId
     include Pageflow::NestedRevisionComponent
@@ -13,9 +18,6 @@ class Chapter < Pageflow::ApplicationRecord
 
     nested_revision_components :sections
 
-    attr_accessor :revision # used on :create to lazily create storyline
-    before_validation :ensure_storyline, on: :create
-
     def create_section(attributes = {})
       shift_section_positions(from: attributes[:position])
 
@@ -36,6 +38,7 @@ def duplicate_section(section)
     def self.all_for_revision(revision)
       joins(storyline: :revision)
         .where(pageflow_scrolled_storylines: {revision_id: revision})
+        .order(POSITION_ORDER)
     end
 
     private
@@ -45,13 +48,5 @@ def shift_section_positions(from:)
         .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

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

@@ -1,6 +1,13 @@
 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
@@ -10,6 +17,7 @@ class ContentElement < Pageflow::ApplicationRecord
     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)

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

@@ -1,5 +1,11 @@
 module PageflowScrolled
   class Section < Pageflow::ApplicationRecord
+    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
@@ -15,6 +21,7 @@ class Section < Pageflow::ApplicationRecord
     def self.all_for_revision(revision)
       joins(chapter: {storyline: :revision})
         .where(pageflow_scrolled_storylines: {revision_id: revision})
+        .order(POSITION_ORDER)
     end
   end
 end