alchemy_cms 5.2.1 → 6.0.0.b1

data/app/helpers/alchemy/admin/elements_helper.rb

@@ -3,6 +3,7 @@
 module Alchemy
   module Admin
     module ElementsHelper
+      include Alchemy::Admin::IngredientsHelper
       include Alchemy::Admin::ContentsHelper
       include Alchemy::Admin::EssencesHelper
 

data/app/helpers/alchemy/admin/essences_helper.rb

@@ -14,7 +14,7 @@ module Alchemy
           essence.thumbnail_url,
           alt: picture.name,
           class: "img_paddingtop",
-          title: Alchemy.t(:image_name) + ": #{picture.name}",
+          title: Alchemy.t(:image_name, name: picture.name),
         )
       end
 

data/app/helpers/alchemy/admin/ingredients_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Admin
+    module IngredientsHelper
+      include Alchemy::Admin::BaseHelper
+
+      # Renders the translated role of ingredient.
+      #
+      # Displays a warning icon if ingredient is missing its definition.
+      #
+      # Displays a mandatory field indicator, if the ingredient has validations.
+      #
+      def render_ingredient_role(ingredient)
+        if ingredient.blank?
+          warning("Ingredient is nil")
+          return
+        end
+
+        content = ingredient.translated_role
+
+        if ingredient.has_warnings?
+          icon = hint_with_tooltip(ingredient.warnings)
+          content = "#{icon} #{content}".html_safe
+        end
+
+        if ingredient.has_validations?
+          "#{content}<span class='validation_indicator'>*</span>".html_safe
+        else
+          content
+        end
+      end
+
+      # Renders the label and hint for a ingredient.
+      def ingredient_label(ingredient, column = :value)
+        label_tag ingredient.form_field_id(column) do
+          [render_ingredient_role(ingredient), render_hint_for(ingredient)].compact.join("&nbsp;").html_safe
+        end
+      end
+    end
+  end
+end

data/app/helpers/alchemy/elements_block_helper.rb

@@ -26,12 +26,13 @@ module Alchemy
     class ElementViewHelper < BlockHelper
       # Renders one of the element's contents.
       #
+      # If the element uses +ingredients+ it renders the ingredient record.
+      #
       def render(name, options = {}, html_options = {})
-        content = element.content_by_name(name)
-        return if content.nil?
+        renderable = element.ingredient_by_role(name) || content(name)
+        return if renderable.nil?
 
-        helpers.render(content, {
-          content: content,
+        helpers.render(renderable, {
           options: options,
           html_options: html_options,
         })
@@ -43,16 +44,28 @@ module Alchemy
         element.content_by_name(name)
       end
 
+      deprecate content: "Use `ingredient_by_role` instead", deprecator: Alchemy::Deprecation
+
       # Returns the ingredient of one of the element's contents.
       #
+      # If the element uses +ingredients+ it returns the +value+ of the ingredient record.
+      #
       def ingredient(name)
-        element.ingredient(name)
+        element.ingredient(name).presence || element.ingredient_by_role(name)&.value
+      end
+
+      deprecate ingredient: :value, deprecator: Alchemy::Deprecation
+
+      # Returns the value of one of the element's ingredients.
+      #
+      def value(name)
+        element.ingredient_by_role(name)&.value
       end
 
-      # Returns true if the given content has been filled by the user.
+      # Returns true if the given content or ingredient has been filled by the user.
       #
       def has?(name)
-        element.has_ingredient?(name)
+        element.has_ingredient?(name) || element.has_value_for?(name)
       end
 
       # Return's the given content's essence.
@@ -60,6 +73,8 @@ module Alchemy
       def essence(name)
         content(name).try(:essence)
       end
+
+      deprecate essence: "Use `ingredient_by_role` instead", deprecator: Alchemy::Deprecation
     end
 
     # Block-level helper for element views. Constructs a DOM element wrapping

data/app/helpers/alchemy/elements_helper.rb

@@ -25,7 +25,7 @@ module Alchemy
     # === Render elements from global page:
     #
     #   <footer>
-    #     <%= render_elements from_page: 'footer' %>
+    #     <%= render_elements from_page: Alchemy::Page.find_by(page_layout: 'footer') %>
     #   </footer>
     #
     # === Custom elements finder:
@@ -50,8 +50,8 @@ module Alchemy
     #     <%= render_elements finder: MyCustomNewsArchive.new %>
     #   </div>
     #
-    # @option options [Alchemy::Page|String] :from_page (@page)
-    #   The page the elements are rendered from. You can pass a page_layout String or a {Alchemy::Page} object.
+    # @option options [Alchemy::Page] :from_page (@page)
+    #   The page the elements are rendered from.
     # @option options [Array<String>|String] :only
     #   A list of element names only to be rendered.
     # @option options [Array<String>|String] :except
@@ -77,7 +77,14 @@ module Alchemy
       }.update(options)
 
       finder = options[:finder] || Alchemy::ElementsFinder.new(options)
-      elements = finder.elements(page: options[:from_page])
+
+      page_version = if @preview_mode
+          options[:from_page]&.draft_version
+        else
+          options[:from_page]&.public_version
+        end
+
+      elements = finder.elements(page_version: page_version)
 
       buff = []
       elements.each_with_index do |element, i|
@@ -133,7 +140,7 @@ module Alchemy
     def render_element(element, options = {}, counter = 1)
       if element.nil?
         warning("Element is nil")
-        render "alchemy/elements/view_not_found", {name: "nil"}
+        render "alchemy/elements/view_not_found", { name: "nil" }
         return
       end
 

data/app/helpers/alchemy/pages_helper.rb

@@ -66,8 +66,8 @@ module Alchemy
     #
     # renders +app/views/alchemy/site_layouts/_default_site.html.erb+ for the site named "Default Site".
     #
-    def render_site_layout
-      render current_alchemy_site
+    def render_site_layout(&block)
+      render current_alchemy_site, &block
     rescue ActionView::MissingTemplate
       warning("Site layout for #{current_alchemy_site.try(:name)} not found. Please run `rails g alchemy:site_layouts`")
       ""
@@ -98,14 +98,6 @@ module Alchemy
       WARN
     end
 
-    # Returns true if page is in the active branch
-    def page_active?(page)
-      Alchemy::Deprecation.warn("page_active? helper is deprecated and will be removed from Alchemy 6.0")
-
-      @_page_ancestors ||= @page.self_and_ancestors.contentpages
-      @_page_ancestors.include?(page)
-    end
-
     # Returns page links in a breadcrumb beginning from root to current page.
     #
     # === Options:
@@ -127,7 +119,7 @@ module Alchemy
 
       pages = options[:page].
         self_and_ancestors.contentpages.
-        accessible_by(current_ability, :see)
+        published
 
       if options.delete(:restricted_only)
         pages = pages.restricted

data/app/jobs/alchemy/base_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class BaseJob < ActiveJob::Base
+    # Automatically retry jobs that encountered a deadlock
+    # retry_on ActiveRecord::Deadlocked
+
+    # Most jobs are safe to ignore if the underlying records are no longer available
+    # discard_on ActiveJob::DeserializationError
+  end
+end

data/app/jobs/alchemy/publish_page_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class PublishPageJob < BaseJob
+    queue_as :default
+
+    def perform(page, public_on:)
+      Alchemy::Page::Publisher.new(page).publish!(public_on: public_on)
+    end
+  end
+end

data/app/models/alchemy/content.rb

@@ -39,19 +39,14 @@ module Alchemy
     scope :essence_selects, -> { where(essence_type: "Alchemy::EssenceSelect") }
     scope :essence_texts, -> { where(essence_type: "Alchemy::EssenceText") }
     scope :named, ->(name) { where(name: name) }
-    scope :available, -> { published.not_trashed }
+    scope :available, -> { published }
     scope :published, -> { joins(:element).merge(Element.published) }
-    scope :not_trashed, -> { joins(:element).merge(Element.not_trashed) }
     scope :not_restricted, -> { joins(:element).merge(Element.not_restricted) }
 
     delegate :restricted?, to: :page, allow_nil: true
-    delegate :trashed?, to: :element, allow_nil: true
-    deprecate :trashed?, deprecator: Alchemy::Deprecation
     delegate :public?, to: :element, allow_nil: true
 
     class << self
-      deprecate :not_trashed, deprecator: Alchemy::Deprecation
-
       # Returns the translated label for a content name.
       #
       # Translate it in your locale yml file:

data/app/models/alchemy/content/factory.rb

@@ -7,7 +7,7 @@ module Alchemy
     extend ActiveSupport::Concern
 
     module ClassMethods
-      SKIPPED_ATTRIBUTES_ON_COPY = %w(position created_at updated_at creator_id updater_id id)
+      SKIPPED_ATTRIBUTES_ON_COPY = %w(position created_at updated_at creator_id updater_id element_id id)
 
       # Builds a new content as descriped in the elements.yml file.
       #
@@ -19,14 +19,14 @@ module Alchemy
         return super if attributes.empty? || element.nil?
 
         definition = element.content_definition_for(attributes[:name])
-        if definition.blank?
+        if definition.blank? && attributes[:essence_type].nil?
           raise ContentDefinitionError, "No definition found in elements.yml for #{attributes.inspect} and #{element.inspect}"
         end
 
         super(
-          name: definition[:name],
-          essence_type: normalize_essence_type(definition[:type]),
-          element_id: element.id
+          name: attributes[:name],
+          essence_type: attributes[:essence_type] || normalize_essence_type(definition[:type]),
+          element: element
         ).tap(&:build_essence)
       end
 
@@ -53,18 +53,16 @@ module Alchemy
       #   @copy.element_id # => 3
       #
       def copy(source, differences = {})
-        new_content = Content.new(
-          source.attributes.
+        Content.new(
+          source.attributes.with_indifferent_access.
             except(*SKIPPED_ATTRIBUTES_ON_COPY).
-            merge(differences.with_indifferent_access),
-        )
-        new_essence = source.essence.class.create!(
-          source.essence.attributes.
-            except(*SKIPPED_ATTRIBUTES_ON_COPY),
-        )
-        new_content.tap do |content|
-          content.essence = new_essence
-          content.save
+            merge(differences.with_indifferent_access)
+        ).tap do |new_content|
+          new_content.build_essence(
+            source.essence.attributes.
+              except(*SKIPPED_ATTRIBUTES_ON_COPY)
+          )
+          new_content.save
         end
       end
 
@@ -117,29 +115,27 @@ module Alchemy
     #
     # If an optional type is passed, this type of essence gets created.
     #
-    def build_essence(type = essence_type)
-      self.essence = essence_class(type).new({
-        ingredient: default_value,
-      })
+    def build_essence(attributes = {})
+      self.essence = essence_class.new(
+        { content: self, ingredient: default_value }.merge(attributes)
+      )
     end
 
     # Creates essence from definition.
     #
     # If an optional type is passed, this type of essence gets created.
     #
-    def create_essence!(type = nil)
-      build_essence(type).save!
+    def create_essence!(attrs = {})
+      build_essence(attrs).save!
       save!
     end
 
     private
 
-    # Returns a class constant from definition's type field.
+    # Returns a class constant from definition's type field or the essence_type column
     #
-    # If an optional type is passed, this type of essence gets constantized.
-    #
-    def essence_class(type = nil)
-      Content.normalize_essence_type(type || definition["type"]).constantize
+    def essence_class
+      (essence_type || Content.normalize_essence_type(definition["type"])).constantize
     end
   end
 end

data/app/models/alchemy/element.rb

@@ -7,7 +7,7 @@
 #  id                :integer          not null, primary key
 #  name              :string
 #  position          :integer
-#  page_id           :integer          not null
+#  page_version_id   :integer          not null
 #  public            :boolean          default(TRUE)
 #  fixed             :boolean          default(FALSE)
 #  folded            :boolean          default(FALSE)
@@ -20,6 +20,12 @@
 #  parent_element_id :integer
 #
 
+require_dependency "alchemy/element/definitions"
+require_dependency "alchemy/element/element_contents"
+require_dependency "alchemy/element/element_ingredients"
+require_dependency "alchemy/element/element_essences"
+require_dependency "alchemy/element/presenters"
+
 module Alchemy
   class Element < BaseRecord
     NAME_REGEXP = /\A[a-z0-9_-]+\z/
@@ -34,39 +40,31 @@ module Alchemy
       "nestable_elements",
       "contents",
       "hint",
+      "ingredients",
       "taggable",
       "compact",
       "message",
       "deprecated",
     ].freeze
 
-    SKIPPED_ATTRIBUTES_ON_COPY = [
-      "cached_tag_list",
-      "created_at",
-      "creator_id",
-      "id",
-      "folded",
-      "position",
-      "updated_at",
-      "updater_id",
-    ].freeze
-
-    # All Elements that share the same page id and parent element id and are fixed or not are considered a list.
+    # All Elements that share the same page version and parent element and are fixed or not are considered a list.
     #
-    # If parent element id is nil (typical case for a simple page),
+    # If parent_element_id is nil (typical case for a simple page),
     # then all elements on that page are still in one list,
     # because acts_as_list correctly creates this statement:
     #
-    #   WHERE page_id = 1 and fixed = FALSE AND parent_element_id = NULL
+    #   WHERE page_version_id = 1 and fixed = FALSE AND parent_element_id = NULL
     #
-    acts_as_list scope: [:page_id, :fixed, :parent_element_id]
+    acts_as_list scope: [:page_version_id, :fixed, :parent_element_id]
 
     stampable stamper_class_name: Alchemy.user_class_name
 
     has_many :contents, dependent: :destroy, inverse_of: :element
 
+    before_destroy :delete_all_nested_elements
+
     has_many :all_nested_elements,
-      -> { order(:position).not_trashed },
+      -> { order(:position) },
       class_name: "Alchemy::Element",
       foreign_key: :parent_element_id,
       dependent: :destroy
@@ -78,7 +76,8 @@ module Alchemy
       dependent: :destroy,
       inverse_of: :parent_element
 
-    belongs_to :page, touch: true, inverse_of: :elements
+    belongs_to :page_version, touch: true, inverse_of: :elements
+    has_one :page, through: :page_version
 
     # A nested element belongs to a parent element.
     belongs_to :parent_element,
@@ -101,11 +100,10 @@ module Alchemy
 
     after_update :touch_touchable_pages
 
-    scope :trashed, -> { where(position: nil).order("updated_at DESC") }
-    scope :not_trashed, -> { where.not(position: nil) }
     scope :published, -> { where(public: true) }
+    scope :hidden, -> { where(public: false) }
     scope :not_restricted, -> { joins(:page).merge(Page.not_restricted) }
-    scope :available, -> { published.not_trashed }
+    scope :available, -> { published }
     scope :named, ->(names) { where(name: names) }
     scope :excluded, ->(names) { where.not(name: names) }
     scope :fixed, -> { where(fixed: true) }
@@ -118,16 +116,14 @@ module Alchemy
     delegate :restricted?, to: :page, allow_nil: true
 
     # Concerns
-    include Alchemy::Element::Definitions
-    include Alchemy::Element::ElementContents
-    include Alchemy::Element::ElementEssences
-    include Alchemy::Element::Presenters
+    include Definitions
+    include ElementContents
+    include ElementEssences
+    include ElementIngredients
+    include Presenters
 
     # class methods
     class << self
-      deprecate :trashed, deprecator: Alchemy::Deprecation
-      deprecate :not_trashed, deprecator: Alchemy::Deprecation
-
       # Builds a new element as described in +/config/alchemy/elements.yml+
       #
       # - Returns a new Alchemy::Element object if no name is given in attributes,
@@ -159,26 +155,7 @@ module Alchemy
       #   @copy.public? # => false
       #
       def copy(source_element, differences = {})
-        attributes = source_element.attributes.with_indifferent_access
-          .except(*SKIPPED_ATTRIBUTES_ON_COPY)
-          .merge(differences)
-          .merge({
-            autogenerate_contents: false,
-            autogenerate_nested_elements: false,
-            tag_list: source_element.tag_list,
-          })
-
-        new_element = create!(attributes)
-
-        if source_element.contents.any?
-          source_element.copy_contents_to(new_element)
-        end
-
-        if source_element.nested_elements.any?
-          source_element.copy_nested_elements_to(new_element)
-        end
-
-        new_element
+        Alchemy::DuplicateElement.new(source_element).call(differences)
       end
 
       def all_from_clipboard(clipboard)
@@ -225,19 +202,6 @@ module Alchemy
       end
     end
 
-    # Trashing an element means nullifying its position, folding and unpublishing it.
-    def trash!
-      self.public = false
-      self.folded = true
-      remove_from_list
-    end
-    deprecate :trash!, deprecator: Alchemy::Deprecation
-
-    def trashed?
-      position.nil?
-    end
-    deprecate :trashed?, deprecator: Alchemy::Deprecation
-
     # Returns true if the definition of this element has a taggable true value.
     def taggable?
       definition["taggable"] == true
@@ -322,22 +286,12 @@ module Alchemy
       definition.fetch("nestable_elements", [])
     end
 
-    # Copy all nested elements from current element to given target element.
-    def copy_nested_elements_to(target_element)
-      nested_elements.map do |nested_element|
-        Element.copy(nested_element, {
-          parent_element_id: target_element.id,
-          page_id: target_element.page_id,
-        })
-      end
-    end
-
     private
 
     def generate_nested_elements
       definition.fetch("autogenerate", []).each do |nestable_element|
         if nestable_elements.include?(nestable_element)
-          Element.create(page: page, parent_element_id: id, name: nestable_element)
+          Element.create(page_version: page_version, parent_element_id: id, name: nestable_element)
         else
           log_warning("Element '#{nestable_element}' not a nestable element for '#{name}'. Skipping!")
         end
@@ -358,5 +312,18 @@ module Alchemy
 
       touchable_pages.each(&:touch)
     end
+
+    def delete_all_nested_elements
+      deeply_nested_elements = descendent_elements(self).flatten
+      DeleteElements.new(deeply_nested_elements).call
+      nested_elements.reset
+      all_nested_elements.reset
+    end
+
+    def descendent_elements(element)
+      element.all_nested_elements + element.all_nested_elements.map do |nested_element|
+        descendent_elements(nested_element)
+      end
+    end
   end
 end