feat: persist and fetch mirrored sections

Author: did

app/models/concerns/maglev/sections_concern.rb

@@ -21,6 +21,26 @@ def prepare_sections_translations(theme)
     end
   end
 
+  def find_section_by_type(type)
+    sections&.find { |section| section['type'] == type }
+  end
+
+  def find_section(id)
+    sections.find { |section| section['id'] == id }
+  end
+
+  def update_section_content(id, attributes)
+    find_section(id).tap do |section|
+      replace_section_content(section, attributes)
+    end
+  end
+
+  def replace_section_content(section, attributes)
+    section['settings'] = attributes['settings']
+    section['blocks'] = attributes['blocks']
+    section
+  end
+
   private
 
   def prepare_section(theme, section)

app/models/maglev/sections_content_store.rb

@@ -14,10 +14,6 @@ class SectionsContentStore < ApplicationRecord
 
     validates :handle, presence: true, uniqueness: true
 
-    def find_section(type)
-      sections&.find { |section| section['type'] == type }
-    end
-
     def translate_in(locale, source_locale)
       translate_attr_in(:sections, locale, source_locale)
     end

app/services/concerns/maglev/mirrored_sections_concern.rb

@@ -0,0 +1,35 @@
+# It requires the parent class to implement 2 methods:
+# - scoped_pages
+# - find_store
+module Maglev::MirroredSectionsConcern
+
+  private
+
+  def persist_mirrored_sections(sections_content)
+    sections_content.map { |group| group['sections'] }.flatten.find do |section|
+      next unless section.dig('mirror_of', 'enabled')
+      persist_mirror_section(section.except('mirror_of'), section['mirror_of'])
+    end
+  end
+
+  def persist_mirror_section(section, mirror_of)
+    store = find_store_from_mirrored_section(mirror_of)
+    store.update_section_content(mirror_of['section_id'], section)
+    store.save
+  end
+
+  def find_store_from_mirrored_section(mirror_of)
+    other_page = scoped_pages.find_by(id: mirror_of['page_id'])
+    return unless other_page
+    layout = fetch_layout(other_page.layout_id)
+    group = layout.groups.find { |group| group.id == mirror_of['layout_group_id'] }
+    return unless group
+    find_store(group.guess_store_handle(other_page))
+  end
+
+  def find_section_from_mirrored_section(mirror_of)
+    store = find_store_from_mirrored_section(mirror_of)
+    return unless store
+    store.find_section(mirror_of['section_id'])
+  end
+end

app/services/maglev/fetch_sections_content.rb

@@ -7,6 +7,7 @@ module Maglev
   class FetchSectionsContent
     include Injectable
     include Maglev::FetchSectionsContent::TransformSectionConcern
+    include Maglev::MirroredSectionsConcern
 
     dependency :fetch_site
     dependency :fetch_theme
@@ -18,13 +19,8 @@ class FetchSectionsContent
     argument :locale, default: nil
 
     def call
-      store = find_store
-      [
-        store.sections.map do |section|
-          transform_section(section.dup)
-        end.compact,
-        store.lock_version
-      ]
+      store = find_or_build_store
+      [transform_sections(store), store.lock_version]
     end
 
     private
@@ -33,14 +29,46 @@ def theme
       @theme ||= fetch_theme.call
     end
 
-    def find_store
-      scoped_store.find_or_initialize_by(handle: handle) do |store|
+    def find_or_build_store
+      scoped_stores.find_or_initialize_by(handle: handle) do |store|
         store.sections = []
       end
     end
 
-    def scoped_store
+    def transform_sections(store)
+      # look for mirrored sections and get the fresh content
+      set_content_from_mirror_sections(store)
+
+      store.sections.map do |section|
+        transform_section(section.dup)
+      end.compact
+    end
+
+    def set_content_from_mirror_sections(store)
+      store.sections.each do |section|
+        next unless section.dig('mirror_of', 'enabled')
+        mirror_section = find_section_from_mirrored_section(section['mirror_of'])
+        next unless mirror_section
+        store.replace_section_content(section, mirror_section)
+      end
+    end
+
+    def fetch_layout(layout_id = nil)
+      theme.find_layout(layout_id || page.layout_id).tap do |layout|
+        raise Maglev::Errors::MissingLayout, "#{layout_id || page.layout_id} doesn't match a layout of the theme" if layout.nil?
+      end
+    end
+
+    def find_store(handle)
+      scoped_stores.find_by(handle: handle)
+    end
+
+    def scoped_stores
       Maglev::SectionsContentStore
     end
+
+    def scoped_pages
+      Maglev::Page
+    end
   end
 end

app/services/maglev/persist_sections_content.rb

@@ -3,6 +3,7 @@
 module Maglev
   class PersistSectionsContent
     include Injectable
+    include Maglev::MirroredSectionsConcern
 
     dependency :fetch_theme
 
@@ -20,7 +21,9 @@ def call
     def unsafe_call
       layout.groups.map do |group|
         [group.id, persist_group_content(group)]
-      end.to_h
+      end.to_h.tap do
+        persist_mirrored_sections(sections_content)
+      end
     end
 
     private
@@ -30,9 +33,7 @@ def theme
     end
 
     def layout
-      theme.find_layout(page.layout_id).tap do |layout|
-        raise Maglev::Errors::MissingLayout, "#{layout_id} doesn't match a layout of the theme" if layout.nil?
-      end
+      @layout ||= fetch_layout(page.layout_id)
     end
 
     def persist_group_content(group)
@@ -49,11 +50,21 @@ def extract_store_attributes(group)
     end
 
     def find_store(handle)
-      scoped_store.find_or_create_by(handle: handle)
+      scoped_stores.find_or_create_by(handle: handle)
     end
 
-    def scoped_store
+    def fetch_layout(layout_id = nil)
+      theme.find_layout(layout_id || page.layout_id).tap do |layout|
+        raise Maglev::Errors::MissingLayout, "#{layout_id || page.layout_id} doesn't match a layout of the theme" if layout.nil?
+      end
+    end
+
+    def scoped_stores
       Maglev::SectionsContentStore
     end
+
+    def scoped_pages
+      Maglev::Page
+    end
   end
 end

spec/factories/maglev/pages.rb

@@ -10,6 +10,7 @@
       sections do
         [
           {
+            id: 'def',
             type: 'jumbotron',
             settings: [
               { id: :title, value: 'Hello world' },
@@ -18,6 +19,7 @@
             blocks: []
           },
           {
+            id: 'ghi',
             type: 'showcase',
             settings: [
               { id: :title, value: 'Our projects' }

spec/factories/maglev/sections_content_stores.rb

@@ -133,7 +133,7 @@
     # work with the sidebar trait
     trait :page_link_in_link do
       after :build do |record|
-        record.find_section('navbar')['blocks'][0]['settings'][1]['value'] = {
+        record.find_section_by_type('navbar')['blocks'][0]['settings'][1]['value'] = {
           link_type: 'page',
           link_id: '42',
           open_new_window: true,

spec/services/maglev/fetch_sections_content_spec.rb

@@ -26,11 +26,9 @@
 
   # rubocop:disable Style/StringHashKeys
   context 'the store has some sections' do
-    let(:page) { create(:page) }
+    let!(:page) { create(:page) }
     let(:handle) { "main-#{page.id}" }
 
-    let!(:store) { create(:sections_content_store, page: page) }
-
     it 'returns the sections' do
       expect(subject).to eq([[
                               {
@@ -61,7 +59,7 @@
     end
 
     context 'the section have unused settings' do
-      let!(:store) { create(:sections_content_store, :with_unused_settings, page: page) }
+      let!(:page) { create(:page, :with_unused_settings) }
       it 'skips the unused settings' do
         expect(subject).to eq([[
                                 {
@@ -85,6 +83,7 @@
     end
 
     context 'the sections include a link in text type setting' do
+      let(:page) { create(:page, sections: nil) }
       let!(:store) { create(:sections_content_store, :page_link_in_text, page: page) }
 
       it 'sets the href properties' do
@@ -95,7 +94,8 @@
     end
 
     context 'the sections include a link in link type setting' do
-      let!(:store) { create(:sections_content_store, :sidebar, :page_link_in_link) }
+      let(:page) { create(:page, sections: nil) }
+      let!(:store) { create(:sections_content_store, :sidebar, :page_link_in_link, page: page) }
       let(:handle) { 'sidebar' }
 
       it 'sets the href properties' do
@@ -106,7 +106,7 @@
     end
 
     context 'the sections include collection items' do
-      let!(:store) { create(:sections_content_store, :featured_product, page: page) }
+      let!(:page) { create(:page, :featured_product) }
 
       it 'fetches the product from the DB' do
         expect(fetch_collection_items).to receive(:call).with(collection_id: 'products', id: 42).and_return(
@@ -117,7 +117,7 @@
       end
 
       context 'the setting content points to the any item' do
-        let!(:store) { create(:sections_content_store, :any_featured_product, page: page) }
+        let!(:page) { create(:page, :any_featured_product) }
 
         it 'fetches the first product' do
           expect(fetch_collection_items).to receive(:call).with(collection_id: 'products', id: 'any').and_return(
@@ -128,6 +128,56 @@
         end
       end
     end
+
+    context 'there is a mirrored section' do
+      let(:another_sections_content) do
+        JSON.parse([
+            {
+              id: 'fake-section-id',
+              type: 'jumbotron',
+              settings: [{ id: :title, value: 'Hello world 🤓' }, { id: :body, value: '<p>Lorem ipsum!</p>' }],
+              blocks: []
+            },
+          ].to_json)
+      end
+      let(:another_page) { create(:page, title: 'another page', path: 'another-page', sections: another_sections_content) }
+
+      let(:sections_content) do
+        JSON.parse([
+          {
+            type: 'jumbotron',
+            settings: [{ id: :title, value: '' }, { id: :body, value: '' }],
+            blocks: [],
+            mirror_of: {
+              enabled: true,
+              page_id: another_page.id,
+              layout_group_id: 'main',
+              section_id: 'fake-section-id'
+            }
+          },
+        ].to_json)
+      end
+      let!(:page) { create(:page, sections: sections_content) }
+      
+      it 'returns the sections' do
+        expect(subject).to eq([[
+                                {
+                                  'type' => 'jumbotron',
+                                  'settings' => [
+                                    { 'id' => 'title', 'value' => 'Hello world 🤓' },
+                                    { 'id' => 'body', 'value' => '<p>Lorem ipsum!</p>' }
+                                  ],
+                                  'blocks' => [],
+                                  'mirror_of' => {
+                                    'enabled' => true,
+                                    'page_id' => another_page.id,
+                                    'layout_group_id' => 'main',
+                                    'section_id' => 'fake-section-id'
+                                  }
+                                }
+                              ], 0])
+      end
+    end
   end
 
   # rubocop:enable Style/StringHashKeys