maglevcms 3.0.0.beta2 → 3.0.0

data/app/controllers/maglev/editor/section_blocks_controller.rb

@@ -4,6 +4,7 @@ module Maglev
   module Editor
     class SectionBlocksController < Maglev::Editor::BaseController
       helper Maglev::Editor::SettingsHelper
+      helper_method :source_lock_version
 
       before_action :set_section
       before_action :set_section_block, only: %i[edit update destroy]
@@ -31,7 +32,6 @@ module Maglev
 
       def update
         update_section_block
-        refresh_lock_version
         flash.now[:notice] = flash_t(:success)
       end
 
@@ -59,12 +59,12 @@ module Maglev
 
       def set_section
         @section = current_maglev_sections.find { |section| section.id == params[:section_id] }
-        raise ActiveRecord::StaleObjectError unless @section
+        redirect_to editor_sections_path_with_context unless @section
       end
 
       def set_section_block
         @section_block = @section.blocks.find(params[:id])
-        raise ActiveRecord::StaleObjectError unless @section_block
+        redirect_to editor_sections_path_with_context unless @section_block
       end
 
       def update_section_block
@@ -77,12 +77,12 @@ module Maglev
         )
       end
 
-      def refresh_lock_version
-        source = @section.site_scoped? ? maglev_site : current_maglev_page
-        @section_block.lock_version = source.find_section_block_by_id(
-          @section.id,
-          @section_block.id
-        )['lock_version']
+      def lock_source
+        @section.site_scoped? ? maglev_site : current_maglev_page
+      end
+
+      def source_lock_version
+        lock_source.lock_version || 0
       end
 
       def redirect_to_section_blocks_path(success: true)
@@ -96,6 +96,10 @@ module Maglev
 
         redirect_to path, status: :see_other, **flash
       end
+
+      def editor_sections_path_with_context
+        editor_sections_path(maglev_editing_route_context)
+      end
     end
   end
 end

data/app/controllers/maglev/editor/sections_controller.rb

@@ -4,7 +4,9 @@ module Maglev
   module Editor
     class SectionsController < Maglev::Editor::BaseController
       helper Maglev::Editor::SettingsHelper
+      helper_method :source_lock_version
 
+      before_action :ensure_turbo_frame_request, only: [:new]
       before_action :set_section, only: %i[edit update]
 
       def show
@@ -12,8 +14,11 @@ module Maglev
       end
 
       def new
-        @grouped_sections = maglev_theme.sections.available_for(current_maglev_sections).grouped_by_category
+        set_query_and_category_id
         @position = (params[:position] || -1).to_i
+        @theme_sections = maglev_theme.sections.filter(current_maglev_sections, keyword: @query,
+                                                                                category_id: @category_id)
+        render layout: false
       end
 
       def create
@@ -34,7 +39,6 @@ module Maglev
 
       def update
         update_section
-        refresh_lock_version
         flash.now[:notice] = flash_t(:success)
       end
 
@@ -56,7 +60,7 @@ module Maglev
 
       def set_section
         @section = current_maglev_sections.find { |section| section.id == params[:id] }
-        raise ActiveRecord::StaleObjectError unless @section
+        redirect_to editor_sections_path_with_context unless @section
       end
 
       def update_section
@@ -73,6 +77,14 @@ module Maglev
         render 'index', status: :unprocessable_content
       end
 
+      def set_query_and_category_id
+        # we can't filter by both query and category_id in the same time
+        @query = params[:category_id].present? ? nil : params[:query]
+        # if no category_id is provided AND we don't have a query, we take the first category
+        @category_id = params[:category_id] || maglev_theme.section_categories.first.id
+        @category_id = nil if @query.present?
+      end
+
       def newly_added_section_to_flash
         # use flash because we can't pass directly the information to the redirect
         { section_id: @section[:id], position: current_maglev_page.position_of_section(@section[:id]) }
@@ -83,13 +95,20 @@ module Maglev
         headers['X-Section-Position'] = flash[:position]
       end
 
-      def refresh_lock_version
-        source = @section.site_scoped? ? maglev_site : current_maglev_page
-        @section.lock_version = source.find_section_by_id(@section.id)['lock_version']
+      def lock_source
+        @section.site_scoped? ? maglev_site : current_maglev_page
+      end
+
+      def source_lock_version
+        lock_source.lock_version || 0
       end
 
       def redirect_to_sections_path
-        redirect_to editor_sections_path(maglev_editing_route_context), notice: flash_t(:success), status: :see_other
+        redirect_to editor_sections_path_with_context, notice: flash_t(:success), status: :see_other
+      end
+
+      def editor_sections_path_with_context
+        editor_sections_path(maglev_editing_route_context)
       end
     end
   end

data/app/controllers/maglev/published_page_preview_controller.rb

@@ -13,6 +13,10 @@ module Maglev
     helper Maglev::PagePreviewHelper
 
     def index
+      # use the title + SEO informations from the published payload
+      # Warning: the page may not exist even in draft
+      maglev_page&.apply_published_payload
+
       render_maglev_page
     end
 

data/app/controllers/maglev/site_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Maglev
+  class SiteController < Maglev::ApplicationController
+    def create
+      redirect_to editor_root_path and return if Maglev::Site.exists? || !Rails.env.local?
+
+      Maglev::GenerateSite.call(
+        theme: Maglev.local_themes.first
+      )
+
+      redirect_to editor_root_path
+    end
+  end
+end

data/app/helpers/maglev/application_helper.rb

@@ -3,6 +3,7 @@
 # rubocop:disable Metrics/ModuleLength
 module Maglev
   module ApplicationHelper
+    ## "system" helpers
     def turbo_stream
       # we don't want to pollute the global Turbo::Streams::TagBuilder
       Maglev::Turbo::Streams::TagBuilder.new(self)
@@ -26,6 +27,17 @@ module Maglev
       ], "\n"
     end
 
+    def maglev_delayed_stream_tag
+      # since we set the turbo request id before the build of the fetch request, Turbo will set
+      # the X-TURBO-REQUEST-ID header to a comma-separated list of request ids
+      # we only want to use the first request id (ours), so we split the header value and take the first part
+      safe_join [
+        tag.meta(name: 'turbo-request-id', content: ::Turbo.current_request_id.split(',').first),
+        tag.meta(name: 'turbo-delayed-stream', content: 'true')
+      ], "\n"
+    end
+
+    ## Editor helpers
     def maglev_editor_title
       case maglev_config.title
       when nil
@@ -93,20 +105,20 @@ module Maglev
     def maglev_button_classes(...)
       ClassVariants.build(
         base: %(
-        rounded-xs transition-colors transition-background duration-200 text-center cursor-pointer
-        group-[.is-success]/form:bg-green-500/95 group-[.is-success]/form:hover:bg-green-500/100
+        rounded-sm transition-colors transition-background duration-200 text-center cursor-pointer
+        group-[.is-success]/form:bg-green-500 group-[.is-success]/form:hover:bg-green-500/90
         group-[.is-success]/form:disabled:bg-green-500/75
-        group-[.is-error]/form:bg-red-500/95 group-[.is-error]/form:hover:bg-red-500/100
+        group-[.is-error]/form:bg-red-500 group-[.is-error]/form:hover:bg-red-500/90
         group-[.is-error]/form:disabled:bg-red-500/75
         ),
         variants: {
           color: {
-            primary: 'text-white bg-editor-primary/95 hover:bg-editor-primary/100 disabled:bg-editor-primary/75',
+            primary: 'text-white bg-editor-primary hover:bg-editor-primary/90 disabled:bg-editor-primary/75',
             secondary: 'text-gray-800 hover:bg-gray-100'
           },
           size: {
-            big: 'flex items-center justify-center w-full px-6 py-4',
-            medium: 'inline-flex items-center justify-center px-4 py-2'
+            big: 'flex items-center justify-center w-full px-6 h-14',
+            medium: 'inline-flex items-center justify-center px-4 h-10'
           }
         },
         defaults: {
@@ -139,9 +151,15 @@ module Maglev
                                                disappear_after: 3.seconds).with_content(message)
     end
 
-    def maglev_page_icon(page, size: '1.15rem')
+    def maglev_page_icon(page, size: '1.15rem', wrapper_class_names: nil)
       icon_name = page.index? ? 'home' : 'file'
-      render Maglev::Uikit::IconComponent.new(name: icon_name, size: size, class_names: 'shrink-0')
+      content_tag :span, class: class_names('shrink-0 relative', wrapper_class_names) do
+        if page.need_to_be_published?
+          concat(content_tag(:span, '',
+                             class: 'absolute -bottom-0.25 right-0 bg-yellow-600 rounded-full w-1.5 h-1.5'))
+        end
+        concat render(Maglev::Uikit::IconComponent.new(name: icon_name, size: size))
+      end
     end
 
     def maglev_page_preview_reload_data

data/app/helpers/maglev/editor/section_blocks_helper.rb

@@ -39,7 +39,7 @@ module Maglev
       def add_section_block_no_dropdown_button(section, block_type)
         button_to(
           t('maglev.editor.section_blocks.index.add_button'),
-          editor_section_blocks_path(section, block_type: block_type, lock_version: section.lock_version,
+          editor_section_blocks_path(section, block_type: block_type, lock_version: source_lock_version,
                                               **maglev_editing_route_context),
           class: maglev_button_classes(size: :big),
           **section_block_button_common_attributes(section)
@@ -72,7 +72,7 @@ module Maglev
       def add_child_section_block_no_dropdown_button(section, parent_id, block_type)
         button_to(
           editor_section_blocks_path(section, block_type: block_type, parent_id: parent_id,
-                                              lock_version: section.lock_version,
+                                              lock_version: source_lock_version,
                                               **maglev_editing_route_context),
           class: maglev_icon_button_classes,
           name: 'add_child_section_block',

data/app/models/maglev/page/publishable_concern.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ClassAndModuleChildren
+module Maglev::Page::PublishableConcern
+  extend ActiveSupport::Concern
+
+  included do
+    # force JSON column for MariaDB
+    attribute :published_payload, :json
+  end
+
+  def published?
+    published_at.present?
+  end
+
+  def need_to_be_published?
+    !published? || updated_at.blank? || updated_at > published_at
+  end
+
+  # opposite of #need_to_be_published?
+  def published_and_up_to_date?
+    published? && updated_at <= published_at
+  end
+
+  def discard_draft?
+    published? && updated_at > published_at
+  end
+
+  # called when a publishedpage is being previewed
+  def apply_published_payload
+    return if !published? || published_payload.blank?
+
+    published_payload_attributes.each do |attribute|
+      send("#{attribute}=", published_payload[attribute])
+    end
+  end
+
+  # called when a page is being published
+  def update_published_payload
+    # in MySQL, default values for json columns are not supported, so we need to set an empty hash if the value is nil
+    self.published_payload ||= {}
+
+    published_payload_attributes.each do |attribute|
+      value = send(attribute.to_sym)
+
+      # in MySQL, default values for json columns are not supported, so we need to set an empty hash if the value is nil
+      value = {} if attribute.ends_with?('_translations') && value.nil?
+
+      self.published_payload[attribute] = value
+    end
+  end
+
+  private
+
+  def published_payload_attributes
+    published_payload_core_attributes + published_payload_additional_attributes
+  end
+
+  def published_payload_additional_attributes
+    # override this method to add additional attributes to the published payload
+    []
+  end
+
+  def published_payload_core_attributes
+    %w[title_translations seo_title_translations meta_description_translations og_title_translations
+       og_description_translations og_image_url_translations]
+  end
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/app/models/maglev/page.rb

@@ -10,6 +10,8 @@
 #  og_description_translations   :jsonb
 #  og_image_url_translations     :jsonb
 #  og_title_translations         :jsonb
+#  published_at                  :datetime
+#  published_payload             :jsonb
 #  sections_translations         :jsonb
 #  seo_title_translations        :jsonb
 #  title_translations            :jsonb
@@ -24,6 +26,7 @@ module Maglev
     include Maglev::SectionsConcern
     include Maglev::Page::PathConcern
     include Maglev::Page::SearchConcern
+    include Maglev::Page::PublishableConcern
 
     ## associations ##
     has_many :sections_content_stores, as: :container, dependent: :destroy

data/app/models/maglev/section/block.rb

@@ -30,6 +30,10 @@ class Maglev::Section::Block
     settings.select(&:advanced?)
   end
 
+  def empty?
+    settings.none?
+  end
+
   def as_json
     super(only: %i[name type settings root accept])
   end

data/app/models/maglev/section/content_concern.rb

@@ -85,13 +85,15 @@ module Maglev::Section::ContentConcern
     return [] if blocks.blank?
 
     blocks.map do |block|
+      next unless block.root?
+
       3.times.to_a.map do
         {
           type: block.type,
           settings: fallback_build_default_settings_content(block.settings)
         }
       end
-    end.flatten
+    end.compact.flatten
   end
 end
 # rubocop:enable Style/ClassAndModuleChildren

data/app/models/maglev/section.rb

@@ -78,6 +78,14 @@ module Maglev
       "maglev.themes.#{theme.id}.sections.#{id}"
     end
 
+    def empty?
+      settings.none? && blocks.none?
+    end
+
+    def local_screenshot?
+      screenshot_timestamp.present?
+    end
+
     ## class methods ##
 
     def self.build(hash)
@@ -104,7 +112,7 @@ module Maglev
 
     class Store
       extend Forwardable
-      def_delegators :@array, :all, :first, :last, :count, :each, :each_with_index, :map, :group_by
+      def_delegators :@array, :all, :first, :last, :count, :each, :each_with_index, :map, :group_by, :any?
 
       attr_reader :array
 
@@ -134,6 +142,18 @@ module Maglev
         self.class.new(new_array)
       end
 
+      def filter(sections_content, keyword: nil, category_id: nil)
+        new_array = if keyword.present?
+                      @array.select { |section| section.name.downcase.include?(keyword.downcase) }
+                    elsif category_id.present?
+                      @array.select { |section| section.category == category_id }
+                    else
+                      @array
+                    end
+
+        self.class.new(new_array).available_for(sections_content)
+      end
+
       def as_json(**_options)
         @array.as_json
       end

data/app/models/maglev/sections_content_store.rb

@@ -14,9 +14,7 @@
 #
 # Indexes
 #
-#  index_maglev_sections_content_stores_on_published       (published)
-#  maglev_sections_content_stores_container                (container_id,container_type)
-#  maglev_sections_content_stores_container_and_published  (container_id,container_type,published)
+#  maglev_sections_content_stores_container_and_published  (container_id,container_type,published) UNIQUE
 #
 module Maglev
   class SectionsContentStore < ApplicationRecord

data/app/models/maglev/site.rb

@@ -8,6 +8,7 @@
 #  locales               :jsonb
 #  lock_version          :integer
 #  name                  :string
+#  published_at          :datetime
 #  sections_translations :jsonb
 #  style                 :jsonb
 #  created_at            :datetime         not null
@@ -35,6 +36,10 @@ module Maglev
 
     ## methods ##
 
+    def published?
+      published_at.present?
+    end
+
     def api_attributes
       %i[id name]
     end

data/app/services/concerns/maglev/content/helpers_concern.rb

@@ -68,22 +68,19 @@ module Maglev
       end
 
       def check_section_lock_version!(source)
-        check_lock_version!(source, find_section(source), 'update_section')
+        check_lock_version!(source, 'update_section')
       end
 
       def check_block_lock_version!(source)
-        check_lock_version!(source, find_block(source), 'update_block')
+        check_lock_version!(source, 'update_block')
       end
 
-      def check_lock_version!(source, section_or_block, action_name)
+      def check_lock_version!(source, action_name)
         return if lock_version.blank? # without a lock version, we disable the lock version check
 
-        current_lock_version = section_or_block['lock_version'].to_i
+        current_lock_version = source.lock_version.to_i
+        source.lock_version = lock_version.to_i
 
-        # always increment the lock version
-        section_or_block['lock_version'] = lock_version.to_i + 1
-
-        # if the lock version is the same, we don't need to raise an error
         return if current_lock_version == lock_version.to_i
 
         raise ActiveRecord::StaleObjectError.new(source, action_name)

data/app/services/maglev/app_container.rb

@@ -8,7 +8,7 @@ module Maglev
       Maglev.config
     end
 
-    # hold the Rails request context
+    # hold the Rails HTTP request context
     dependency :context
 
     dependency :fetch_site,                 class: Maglev::FetchSite, depends_on: %i[config context]
@@ -19,7 +19,7 @@ module Maglev
     dependency :fetch_section_screenshot_path, class: Maglev::FetchSectionScreenshotPath,
                                                depends_on: :fetch_sections_path
     dependency :fetch_section_screenshot_url, class: Maglev::FetchSectionScreenshotUrl,
-                                              depends_on: :fetch_section_screenshot_path
+                                              depends_on: %i[fetch_section_screenshot_path context]
 
     dependency :fetch_collection_items, class: Maglev::FetchCollectionItems, depends_on: %i[fetch_site config]
     dependency :fetch_static_pages, class: Maglev::FetchStaticPages, depends_on: %i[config]
@@ -67,7 +67,9 @@ module Maglev
     dependency :sort_section_blocks,        class: Maglev::Content::SortSectionBlocksService,
                                             depends_on: %i[fetch_site fetch_theme]
 
+    dependency :has_unpublished_changes,    class: Maglev::HasUnpublishedChanges
     dependency :publish,                    class: Maglev::PublishService
+    dependency :discard_page_draft,         class: Maglev::DiscardPageDraftService
 
     def call
       self

data/app/services/maglev/discard_page_draft_service.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Maglev
+  class DiscardPageDraftService
+    include Injectable
+
+    argument :site
+    argument :page
+
+    def call
+      ActiveRecord::Base.transaction do
+        revert_container_sections!(site)
+        revert_container_sections!(page)
+        revert_page_information!
+      end
+      true
+    end
+
+    private
+
+    def revert_container_sections!(container)
+      store = find_published_store(container)
+
+      raise Maglev::Errors::UnpublishedPage if store.blank?
+
+      container.sections_translations_will_change!
+      container.sections_translations = store.sections_translations
+      container.save!
+
+      # Update updated_at to be before published_at to mark as up-to-date
+      # rubocop:disable Rails/SkipsModelValidations
+      container.update_column(:updated_at, container.published_at) if container.published_at.present?
+      # rubocop:enable Rails/SkipsModelValidations
+    end
+
+    def find_published_store(container)
+      container.sections_content_stores.published.first
+    end
+
+    def revert_page_information!
+      page.apply_published_payload
+      page.save!
+    end
+  end
+end

data/app/services/maglev/fetch_section_screenshot_url.rb

@@ -5,9 +5,13 @@ module Maglev
     include Injectable
 
     dependency :fetch_section_screenshot_path
+    dependency :context
+
     argument :section
 
     def call
+      return nil unless section.local_screenshot?
+
       screenshot_path = fetch_section_screenshot_path.call(section: section) + query_string
       asset_host ? URI.join(asset_host, screenshot_path).to_s : screenshot_path
     end
@@ -15,11 +19,18 @@ module Maglev
     private
 
     def asset_host
-      Rails.application.config.asset_host
+      host = Rails.application.config.asset_host
+      return nil if host.blank?
+
+      host.start_with?('http://', 'https://') ? host : "#{request_protocol}#{host}"
     end
 
     def query_string
       "?#{section.screenshot_timestamp}"
     end
+
+    def request_protocol
+      context.controller.request.protocol
+    end
   end
 end

data/app/services/maglev/fetch_site.rb

@@ -14,7 +14,9 @@ module Maglev
     private
 
     def site
-      @site ||= Maglev::Site.first
+      @site ||= Maglev::Site.first.tap do |site|
+        raise Maglev::Errors::SiteNotFound unless site
+      end
     end
 
     def change_default_locales(site)

data/app/services/maglev/get_published_page_sections_service.rb

@@ -15,7 +15,7 @@ module Maglev
     argument :locale, default: nil
 
     def call
-      fetch_container_store(page).sections.map do |section|
+      (fetch_container_store(page).sections || []).map do |section|
         transform_section(section.dup)
       end.compact
     end

data/app/services/maglev/has_unpublished_changes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Maglev
+  class HasUnpublishedChanges
+    include Injectable
+
+    argument :site
+    argument :page
+    argument :theme
+
+    def call
+      page.need_to_be_published? || site_need_to_be_published?
+    end
+
+    private
+
+    def site_need_to_be_published?
+      !site.published? || site.updated_at.blank? || site.updated_at > site.published_at
+    end
+  end
+end

data/app/services/maglev/publish_service.rb

@@ -9,22 +9,38 @@ module Maglev
 
     def call
       ActiveRecord::Base.transaction do
-        publish_container_sections!(site)
-        publish_container_sections!(page)
+        unsafe_call
       end
       true
     end
 
     private
 
+    def unsafe_call
+      # copy content from the containers (site and page) to the published stores
+      publish_container_sections!(site)
+      publish_container_sections!(page)
+
+      # copy the page information to the page published payload
+      publish_page_information!
+    end
+
     def publish_container_sections!(container)
       store = find_or_build_published_store(container)
       store.sections_translations = container.sections_translations
       store.save!
+      # mark the container as published.
+      # We need to add a delay to ensure that published_at will be posterior to the native updated_at of the container.
+      container.update(published_at: Time.current + 0.2.seconds)
     end
 
     def find_or_build_published_store(container)
       container.sections_content_stores.find_or_initialize_by(container: container, published: true)
     end
+
+    def publish_page_information!
+      page.update_published_payload
+      page.save!
+    end
   end
 end