alchemy_cms 6.1.10 → 7.0.0.pre.a

data/app/helpers/alchemy/elements_block_helper.rb

@@ -24,69 +24,32 @@ module Alchemy
     # Block-level helper class for element views.
     #
     class ElementViewHelper < BlockHelper
-      # Renders one of the element's contents.
+      # Renders one of the element's ingredients.
       #
       # If the element uses +ingredients+ it renders the ingredient record.
       #
       def render(name, options = {}, html_options = {})
-        renderable = element.ingredient_by_role(name) || Alchemy::Deprecation.silence { content(name) }
+        renderable = element.ingredient_by_role(name)
         return if renderable.nil?
 
-        if Alchemy::DEPRECATED_ESSENCE_CLASSES.include?(renderable.try(:essence)&.class&.name)
-          Alchemy::Deprecation.warn(
-            "Using a '#{renderable.essence.class.name.demodulize}' content is deprecated. " \
-            "Please use a '#{Alchemy::DEPRECATED_ESSENCE_CLASS_MAPPING[renderable.essence.class.name].demodulize}' ingredient instead."
-          )
-        end
-
         helpers.render(renderable, {
           options: options,
           html_options: html_options,
         })
       end
 
-      # Returns one of the element's contents (ie. essence instances).
-      #
-      def content(name)
-        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)
-      end
-
       # Returns the value of one of the element's ingredients.
       #
       def value(name)
         element.value_for(name)
       end
 
-      # Returns true if the given content or ingredient has a value.
+      # Returns true if the given ingredient has a value.
       #
       def has?(name)
-        if element.ingredient_definitions.any?
-          element.has_value_for?(name)
-        else
-          Alchemy::Deprecation.silence do
-            element.has_ingredient?(name)
-          end
-        end
+        element.has_value_for?(name)
       end
 
-      # Return's the given content's essence.
-      #
-      def essence(name)
-        content(name).try(:essence)
-      end
-
-      deprecate essence: "Use `ingredient_by_role` instead", deprecator: Alchemy::Deprecation
-
       # Return's the ingredient record by given role.
       #
       def ingredient_by_role(role)
@@ -129,7 +92,7 @@ module Alchemy
     #   The HTML tag to be used for the wrapping element.
     # @option options :id (the element's dom_id)
     #   The wrapper tag's DOM ID.
-    # @option options :class (the element's essence name)
+    # @option options :class (the element's name)
     #   The wrapper tag's DOM class.
     # @option options :tags_formatter
     #   A lambda used for formatting the element's tags (see Alchemy::ElementsHelper::element_tags_attributes). Set to +false+ to not include tags in the wrapper element.

data/app/helpers/alchemy/elements_helper.rb

@@ -112,9 +112,9 @@ module Alchemy
     #
     #   # elements.yml
     #   - name: headline
-    #     contents:
-    #     - name: text
-    #       type: EssenceText
+    #     ingredients:
+    #       - role: text
+    #         type: Text
     #
     # Then your element view partial has to be named like:
     #
@@ -166,14 +166,6 @@ module Alchemy
       render "alchemy/elements/view_not_found", name: element.name
     end
 
-    # Returns a string for the id attribute of a html element for the given element
-    # @deprecated
-    def element_dom_id(element)
-      element&.dom_id
-    end
-
-    deprecate element_dom_id: "element.dom_id", deprecator: Alchemy::Deprecation
-
     # Renders the HTML tag attributes required for preview mode.
     def element_preview_code(element)
       tag_builder.tag_options(element_preview_code_attributes(element))

data/app/helpers/alchemy/pages_helper.rb

@@ -5,10 +5,6 @@ module Alchemy
     include Alchemy::BaseHelper
     include Alchemy::ElementsHelper
 
-    def picture_essence_caption(content)
-      content.try(:essence).try(:caption)
-    end
-
     # Renders links to language root pages of all published languages.
     #
     # @option options linkname [String] ('name')

data/app/models/alchemy/attachment.rb

@@ -30,9 +30,12 @@ module Alchemy
 
     stampable stamper_class_name: Alchemy.user_class.name
 
-    has_many :essence_files, class_name: "Alchemy::EssenceFile", foreign_key: "attachment_id"
-    has_many :contents, through: :essence_files
-    has_many :elements, through: :contents
+    has_many :file_ingredients,
+      class_name: "Alchemy::Ingredients::File",
+      foreign_key: "related_object_id",
+      inverse_of: :related_object
+
+    has_many :elements, through: :file_ingredients
     has_many :pages, through: :elements
 
     scope :by_file_type, ->(file_type) { where(file_mime_type: file_type) }

data/app/models/alchemy/base_record.rb

@@ -5,6 +5,8 @@ module Alchemy
   end
 
   class BaseRecord < ActiveRecord::Base
+    extend Alchemy::SearchableResource
+
     self.abstract_class = true
   end
 end

data/app/models/alchemy/eager_loading.rb

@@ -28,7 +28,6 @@ module Alchemy
                 :tags,
                 {
                   ingredients: :related_object,
-                  contents: :essence,
                 },
               ],
             },

data/app/models/alchemy/element/element_ingredients.rb

@@ -37,13 +37,6 @@ module Alchemy
         ingredients_by_type(type).first
       end
 
-      # All ingredients from element by given role.
-      def ingredients_by_role(role)
-        ingredients.select do |ingredient|
-          ingredient.role == Ingredient.normalize_type(role)
-        end
-      end
-
       # All ingredients from element by given type.
       def ingredients_by_type(type)
         ingredients.select do |ingredient|
@@ -133,7 +126,7 @@ module Alchemy
       # == Error message translation fallbacks
       #
       # In order to not translate every single ingredient for every element
-      # you can provide default error messages per content name:
+      # you can provide default error messages per ingredient role:
       #
       # === Example
       #

data/app/models/alchemy/element/presenters.rb

@@ -38,16 +38,15 @@ module Alchemy
 
       # Returns a preview text for element.
       #
-      # It's taken from the first Content found in the +elements.yml+ definition file.
+      # It's taken from the first Ingredient found in the +elements.yml+ definition file.
       #
-      # You can flag a Content as +as_element_title+ to take this as preview.
+      # You can flag a Ingredient as +as_element_title+ to take this as preview.
       #
       # @param maxlength [Fixnum] (60)
       #   Length of characters after the text will be cut off.
       #
       def preview_text(maxlength = 60)
         preview_text_from_preview_ingredient(maxlength) ||
-          preview_text_from_preview_content(maxlength) ||
           preview_text_from_nested_elements(maxlength)
       end
 
@@ -61,14 +60,14 @@ module Alchemy
       #
       #     - name: funky_element
       #       display_name: Funky Element
-      #       contents:
-      #       - name: headline
-      #         type: EssenceText
-      #       - name: text
-      #         type EssenceRichtext
-      #         as_element_title: true
+      #       ingredients:
+      #         - role: headline
+      #           type: Text
+      #         - role: text
+      #           type: Richtext
+      #           as_element_title: true
       #
-      # With "I want to tell you a funky story" as stripped_body for the EssenceRichtext Content produces:
+      # With "I want to tell you a funky story" as stripped_body for the Richtext ingredient produces:
       #
       #     Funky Element: I want to tell ...
       #
@@ -85,17 +84,6 @@ module Alchemy
         self.class.dom_id_class.new(self).call
       end
 
-      # The content that's used for element's preview text.
-      #
-      # It tries to find one of element's contents that is defined +as_element_title+.
-      # Takes element's first content if no content is defined +as_element_title+.
-      #
-      # @return (Alchemy::Content)
-      #
-      def preview_content
-        @_preview_content ||= contents.detect(&:preview_content?) || contents.first
-      end
-
       # The ingredient that's used for element's preview text.
       #
       # It tries to find one of element's ingredients that is defined +as_element_title+.
@@ -115,10 +103,6 @@ module Alchemy
         all_nested_elements.first.preview_text(maxlength)
       end
 
-      def preview_text_from_preview_content(maxlength)
-        preview_content.try!(:preview_text, maxlength)
-      end
-
       def preview_text_from_preview_ingredient(maxlength)
         preview_ingredient&.preview_text(maxlength)
       end

data/app/models/alchemy/element.rb

@@ -21,10 +21,7 @@
 #
 
 require_dependency "alchemy/element/definitions"
-require_dependency "alchemy/element/dom_id"
-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
@@ -39,14 +36,12 @@ module Alchemy
       "amount",
       "autogenerate",
       "nestable_elements",
-      "contents",
       "hint",
       "ingredients",
       "taggable",
       "compact",
       "message",
       "deprecated",
-      "warning",
     ].freeze
 
     # All Elements that share the same page version and parent element and are fixed or not are considered a list.
@@ -61,10 +56,6 @@ module Alchemy
 
     stampable stamper_class_name: Alchemy.user_class.name
 
-    has_many :contents, dependent: :destroy, inverse_of: :element
-
-    deprecate contents: :ingredients, deprecator: Alchemy::Deprecation
-
     before_destroy :delete_all_nested_elements
 
     has_many :all_nested_elements,
@@ -97,9 +88,7 @@ module Alchemy
     validates_presence_of :name, on: :create
     validates_format_of :name, on: :create, with: NAME_REGEXP
 
-    attr_accessor :autogenerate_contents
     attr_accessor :autogenerate_nested_elements
-    after_create :create_contents, unless: -> { autogenerate_contents == false }
     after_create :generate_nested_elements, unless: -> { autogenerate_nested_elements == false }
 
     after_update :touch_touchable_pages
@@ -107,7 +96,6 @@ module Alchemy
     scope :published, -> { where(public: true) }
     scope :hidden, -> { where(public: false) }
     scope :not_restricted, -> { joins(:page).merge(Page.not_restricted) }
-    scope :available, -> { published }
     scope :named, ->(names) { where(name: names) }
     scope :excluded, ->(names) { where.not(name: names) }
     scope :fixed, -> { where(fixed: true) }
@@ -121,8 +109,6 @@ module Alchemy
 
     # Concerns
     include Definitions
-    include ElementContents
-    include ElementEssences
     include ElementIngredients
     include Presenters
 
@@ -159,7 +145,7 @@ module Alchemy
         @_dom_id_class = klass
       end
 
-      # This methods does a copy of source and all depending contents and all of their depending essences.
+      # This methods does a copy of source and all its ingredients.
       #
       # == Options
       #
@@ -194,8 +180,6 @@ module Alchemy
 
         all_from_clipboard(clipboard).where(name: parent_element.definition["nestable_elements"])
       end
-
-      deprecate available: :published, deprecator: Alchemy::Deprecation
     end
 
     # Returns next public element from same page.
@@ -279,7 +263,7 @@ module Alchemy
     # Elements are defined in the +config/alchemy/elements.yml+ file
     #
     #     - name: article
-    #       contents:
+    #       ingredients:
     #       ...
     #
     # == Override the view

data/app/models/alchemy/ingredient.rb

@@ -13,11 +13,13 @@ module Alchemy
     belongs_to :element, touch: true, class_name: "Alchemy::Element", inverse_of: :ingredients
     belongs_to :related_object, polymorphic: true, optional: true
 
+    has_one :page, through: :element, class_name: "Alchemy::Page"
+
     after_initialize :set_default_value,
       if: -> { definition.key?(:default) && value.nil? }
 
     validates :type, presence: true
-    validates :role, presence: true
+    validates :role, presence: true, uniqueness: { scope: :element_id, case_sensitive: false }
 
     validates_with Alchemy::IngredientValidator, on: :update, if: :has_validations?
 
@@ -76,11 +78,16 @@ module Alchemy
           default: Alchemy.t("ingredient_roles.#{role}", default: role.humanize),
         )
       end
-    end
 
-    # Compatibility method for access from element
-    def essence
-      self
+      # Allow to define settings on the ingredient definition
+      def allow_settings(settings)
+        @allowed_settings = Array(settings)
+      end
+
+      # Allowed settings on the ingredient
+      def allowed_settings
+        @allowed_settings ||= []
+      end
     end
 
     # The value or the related object if present
@@ -97,7 +104,7 @@ module Alchemy
     #
     # @param key [Symbol]               - The hash key you want to fetch the value from
     # @param options [Hash]             - An optional Hash that can override the settings.
-    #                                     Normally passed as options hash into the content
+    #                                     Normally passed as options hash into the ingredient
     #                                     editor view.
     def settings_value(key, options = {})
       settings.merge(options || {})[key.to_sym]
@@ -164,6 +171,10 @@ module Alchemy
       role
     end
 
+    def hint_translation_scope
+      "ingredient_hints"
+    end
+
     def set_default_value
       self.value = default_value
     end

data/app/models/alchemy/ingredients/audio.rb

@@ -11,6 +11,8 @@ module Alchemy
         :muted,
         :loop
 
+      allow_settings %i[except only]
+
       related_object_alias :attachment, class_name: "Alchemy::Attachment"
 
       delegate :name, to: :attachment, allow_nil: true

data/app/models/alchemy/ingredients/datetime.rb

@@ -5,6 +5,8 @@ module Alchemy
     # A datetime value
     #
     class Datetime < Alchemy::Ingredient
+      allow_settings %i[date_format]
+
       def value
         ActiveRecord::Type::DateTime.new.cast(self[:value])
       end
@@ -13,7 +15,7 @@ module Alchemy
       def preview_text(_maxlength = nil)
         return "" unless value
 
-        ::I18n.l(value, format: :'alchemy.essence_date')
+        ::I18n.l(value, format: :'alchemy.ingredient_date')
       end
     end
   end

data/app/models/alchemy/ingredients/file.rb

@@ -12,6 +12,13 @@ module Alchemy
         :link_text,
         :title
 
+      allow_settings %i[
+          css_classes
+          except
+          link_text
+          only
+        ]
+
       related_object_alias :attachment, class_name: "Alchemy::Attachment"
 
       delegate :name, to: :attachment, allow_nil: true

data/app/models/alchemy/ingredients/headline.rb

@@ -12,6 +12,12 @@ module Alchemy
         :level,
         :size
 
+      allow_settings %i[
+          anchor
+          levels
+          sizes
+        ]
+
       before_create :set_level_and_size
 
       def preview_text(maxlength = 30)

data/app/models/alchemy/ingredients/link.rb

@@ -10,6 +10,8 @@ module Alchemy
         :link_target,
         :link_title
 
+      allow_settings %i[text]
+
       alias_method :link, :value
     end
   end

data/app/models/alchemy/ingredients/node.rb

@@ -9,6 +9,8 @@ module Alchemy
     class Node < Alchemy::Ingredient
       related_object_alias :node, class_name: "Alchemy::Node"
 
+      allow_settings %i[query_params]
+
       # The first 30 characters of node name
       #
       # Used by the Element#preview_text method.

data/app/models/alchemy/ingredients/page.rb

@@ -9,6 +9,8 @@ module Alchemy
     class Page < Alchemy::Ingredient
       related_object_alias :page, class_name: "Alchemy::Page"
 
+      allow_settings %i[query_params]
+
       # The first 30 characters of page name
       #
       # Used by the Element#preview_text method.

data/app/models/alchemy/ingredients/picture.rb

@@ -27,6 +27,17 @@ module Alchemy
 
       related_object_alias :picture, class_name: "Alchemy::Picture"
 
+      allow_settings %i[
+          crop
+          css_classes
+          fixed_ratio
+          linkable
+          size
+          sizes
+          srcset
+          upsample
+        ]
+
       # The first 30 characters of the pictures name
       #
       # Used by the Element#preview_text method.

data/app/models/alchemy/ingredients/richtext.rb

@@ -9,6 +9,12 @@ module Alchemy
         :stripped_body,
         :sanitized_body
 
+      allow_settings %i[
+          plain_text
+          sanitizer
+          tinymce
+        ]
+
       before_save :strip_content
       before_save :sanitize_content
 

data/app/models/alchemy/ingredients/select.rb

@@ -5,6 +5,7 @@ module Alchemy
     # A text value from a select box
     #
     class Select < Alchemy::Ingredient
+      allow_settings %i[display_inline select_values]
     end
   end
 end

data/app/models/alchemy/ingredients/text.rb

@@ -15,6 +15,14 @@ module Alchemy
         :link_target,
         :link_title,
         :link_class_name
+
+      allow_settings %i[
+          anchor
+          disable_link
+          display_inline
+          input_type
+          linkable
+        ]
     end
   end
 end

data/app/models/alchemy/ingredients/video.rb

@@ -16,6 +16,8 @@ module Alchemy
         :preload,
         :width
 
+      allow_settings %i[except only]
+
       related_object_alias :attachment, class_name: "Alchemy::Attachment"
 
       delegate :name, to: :attachment, allow_nil: true

data/app/models/alchemy/node.rb

@@ -4,7 +4,7 @@ module Alchemy
   class Node < BaseRecord
     VALID_URL_REGEX = /\A(\/|\D[a-z\+\d\.\-]+:)/
 
-    before_destroy :check_if_related_essence_nodes_present
+    before_destroy :check_if_related_node_ingredients_present
 
     acts_as_nested_set scope: "language_id", touch: true
     stampable stamper_class_name: Alchemy.user_class.name
@@ -14,7 +14,10 @@ module Alchemy
 
     has_one :site, through: :language
 
-    has_many :essence_nodes, class_name: "Alchemy::EssenceNode", foreign_key: :node_id, inverse_of: :ingredient_association
+    has_many :node_ingredients,
+      class_name: "Alchemy::Ingredients::Node",
+      foreign_key: :related_object_id,
+      inverse_of: :related_object
 
     before_validation :translate_root_menu_name, if: -> { root? }
     before_validation :set_menu_type_from_root, unless: -> { root? }
@@ -76,10 +79,10 @@ module Alchemy
 
     private
 
-    def check_if_related_essence_nodes_present
-      dependent_essence_nodes = self_and_descendants.flat_map(&:essence_nodes)
-      if dependent_essence_nodes.any?
-        errors.add(:base, :essence_nodes_present, page_names: dependent_essence_nodes.map(&:page).map(&:name).to_sentence)
+    def check_if_related_node_ingredients_present
+      dependent_node_ingredients = self_and_descendants.flat_map(&:node_ingredients)
+      if dependent_node_ingredients.any?
+        errors.add(:base, :node_ingredients_present, page_names: dependent_node_ingredients.map { |i| i.element&.page&.name }.to_sentence)
         throw(:abort)
       end
     end

data/app/models/alchemy/page/page_elements.rb

@@ -19,7 +19,7 @@ module Alchemy
           has_many :fixed_elements, -> { fixed.published }
         end
 
-        has_many :contents, through: :elements
+        has_many :ingredients, through: :elements
         has_and_belongs_to_many :to_be_swept_elements, -> { distinct },
           class_name: "Alchemy::Element",
           join_table: ElementToPage.table_name
@@ -58,17 +58,17 @@ module Alchemy
       #
       #   - name: headline
       #     unique: true
-      #     contents:
+      #     ingredients:
       #     - name: headline
-      #       type: EssenceText
+      #       type: Text
       #
       # == Example of limited element:
       #
       #   - name: article
       #     amount: 2
-      #     contents:
+      #     ingredients:
       #     - name: text
-      #       type: EssenceRichtext
+      #       type: Richtext
       #
       def available_element_definitions(only_element_named = nil)
         @_element_definitions ||= if only_element_named
@@ -156,27 +156,6 @@ module Alchemy
         end
       end
 
-      # Returns all elements that should be feeded via rss.
-      #
-      # Define feedable elements in your +page_layouts.yml+:
-      #
-      #   - name: news
-      #     feed: true
-      #     feed_elements: [element_name, element_2_name]
-      #
-      def feed_elements
-        elements.named(definition["feed_elements"])
-      end
-
-      # Returns an array of all EssenceRichtext contents ids from not folded elements
-      #
-      def richtext_contents_ids
-        Alchemy::Content.joins(:element)
-          .where(Element.table_name => { page_version_id: draft_version.id, folded: false })
-          .select(&:has_tinymce?)
-          .collect(&:id)
-      end
-
       # Returns an array of all Richtext ingredients ids from not folded elements
       #
       def richtext_ingredients_ids

data/app/models/alchemy/page/page_layouts.rb

@@ -23,20 +23,6 @@ module Alchemy
           mapped_layouts_for_select(selectable_layouts(language_id, layoutpages: layoutpages))
         end
 
-        # Returns page layouts including given layout ready for Rails' select form helper.
-        #
-        def layouts_with_own_for_select(page_layout_name, language_id, layoutpages: false)
-          layouts = selectable_layouts(language_id, layoutpages: layoutpages)
-          if layouts.detect { |l| l["name"] == page_layout_name }.nil?
-            @map_array = [[human_layout_name(page_layout_name), page_layout_name]]
-          else
-            @map_array = []
-          end
-          mapped_layouts_for_select(layouts)
-        end
-
-        deprecate :layouts_with_own_for_select, deprecator: Alchemy::Deprecation
-
         # Returns all layouts that can be used for creating a new page.
         #
         # It removes all layouts from available layouts that are unique and already taken and that are marked as hide.