alchemy_cms 6.1.5 → 7.0.0.pre.b

data/app/helpers/alchemy/elements_helper.rb

@@ -73,22 +73,22 @@ module Alchemy
     def render_elements(options = {}, &blk)
       options = {
         from_page: @page,
-        render_format: "html",
+        render_format: "html"
       }.update(options)
 
       finder = options[:finder] || Alchemy::ElementsFinder.new(options)
 
       page_version = if @preview_mode
-          options[:from_page]&.draft_version
-        else
-          options[:from_page]&.public_version
-        end
+        options[:from_page]&.draft_version
+      else
+        options[:from_page]&.public_version
+      end
 
       elements = finder.elements(page_version: page_version)
 
       default_rendering = ->(element, i) { render_element(element, options, i + 1) }
       capture do
-        if block_given?
+        if blk
           elements.map.with_index(&blk)
         else
           elements.map.with_index(&default_rendering)
@@ -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:
     #
@@ -143,7 +143,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
 
@@ -155,8 +155,8 @@ module Alchemy
         locals: {
           element: element,
           counter: counter,
-          options: options.except(:locals, :partial),
-        }.merge(options[:locals] || {}),
+          options: options.except(:locals, :partial)
+        }.merge(options[:locals] || {})
       )
     rescue ActionView::MissingTemplate => e
       warning(%(
@@ -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))
@@ -183,7 +175,7 @@ module Alchemy
     def element_preview_code_attributes(element)
       return {} unless element.present? && @preview_mode && element.page == @page
 
-      { "data-alchemy-element" => element.id }
+      {"data-alchemy-element" => element.id}
     end
 
     # Returns the element's tags information as a string. Parameters and options
@@ -211,12 +203,12 @@ module Alchemy
     #
     def element_tags_attributes(element, options = {})
       options = {
-        formatter: lambda { |tags| tags.join(" ") },
+        formatter: lambda { |tags| tags.join(" ") }
       }.merge(options)
 
       return {} if !element.taggable? || element.tag_list.blank?
 
-      { "data-element-tags" => options[:formatter].call(element.tag_list) }
+      {"data-element-tags" => options[:formatter].call(element.tag_list)}
     end
   end
 end

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')
@@ -28,7 +24,7 @@ module Alchemy
         linkname: "name",
         show_title: true,
         spacer: "",
-        reverse: false,
+        reverse: false
       }.merge(options)
       languages = Language.on_current_site.published.with_root_page.order("name #{options[:reverse] ? "DESC" : "ASC"}")
       return nil if languages.count < 2
@@ -37,7 +33,7 @@ module Alchemy
         partial: "alchemy/language_links/language",
         collection: languages,
         spacer_template: "alchemy/language_links/spacer",
-        locals: { languages: languages, options: options },
+        locals: {languages: languages, options: options}
       )
     end
 
@@ -83,7 +79,7 @@ module Alchemy
     def render_menu(menu_type, options = {})
       root_node = Alchemy::Node.roots.find_by(
         menu_type: menu_type,
-        language: Alchemy::Language.current,
+        language: Alchemy::Language.current
       )
       if root_node.nil?
         warning("Menu with type #{menu_type} not found!")
@@ -114,12 +110,12 @@ module Alchemy
         page: @page,
         restricted_only: false,
         reverse: false,
-        link_active_page: false,
+        link_active_page: false
       }.merge(options)
 
-      pages = options[:page].
-        self_and_ancestors.contentpages.
-        published
+      pages = options[:page]
+        .self_and_ancestors.contentpages
+        .published
 
       if options.delete(:restricted_only)
         pages = pages.restricted
@@ -150,13 +146,13 @@ module Alchemy
       options = {
         prefix: "",
         suffix: "",
-        separator: "",
+        separator: ""
       }.update(options)
       title_parts = [options[:prefix]]
-      if response.status == 200
-        title_parts << @page.title
+      title_parts << if response.status == 200
+        @page.title
       else
-        title_parts << response.status
+        response.status
       end
       title_parts << options[:suffix]
       title_parts.reject(&:blank?).join(options[:separator]).html_safe

data/app/helpers/alchemy/url_helper.rb

@@ -20,7 +20,7 @@ module Alchemy
     def show_page_path_params(page, optional_params = {})
       raise ArgumentError, "Page is nil" if page.nil?
 
-      url_params = { urlname: page.urlname }.update(optional_params)
+      url_params = {urlname: page.urlname}.update(optional_params)
       prefix_locale?(page.language_code) ? url_params.update(locale: page.language_code) : url_params
     end
 

data/app/mailers/alchemy/messages_mailer.rb

@@ -8,7 +8,7 @@ module Alchemy
         from: mail_from,
         to: mail_to,
         reply_to: message.try(:email),
-        subject: subject,
+        subject: subject
       )
     end
   end

data/app/models/alchemy/attachment.rb

@@ -30,14 +30,17 @@ 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) }
     scope :recent, -> { where("#{table_name}.created_at > ?", Time.current - 24.hours).order(:created_at) }
-    scope :without_tag, -> { left_outer_joins(:taggings).where(gutentag_taggings: { id: nil }) }
+    scope :without_tag, -> { left_outer_joins(:taggings).where(gutentag_taggings: {id: nil}) }
 
     # We need to define this method here to have it available in the validations below.
     class << self
@@ -59,12 +62,12 @@ module Alchemy
         [
           {
             name: :by_file_type,
-            values: distinct.pluck(:file_mime_type).map { |type| [Alchemy.t(type, scope: "mime_types"), type] }.sort_by(&:first),
+            values: distinct.pluck(:file_mime_type).map { |type| [Alchemy.t(type, scope: "mime_types"), type] }.sort_by(&:first)
           },
           {
             name: :misc,
-            values: %w(recent last_upload without_tag),
-          },
+            values: %w[recent last_upload without_tag]
+          }
         ]
       end
 
@@ -76,7 +79,7 @@ module Alchemy
       end
 
       def searchable_alchemy_resource_attributes
-        %w(name file_name)
+        %w[name file_name]
       end
 
       def allowed_filetypes
@@ -103,7 +106,7 @@ module Alchemy
       {
         "name" => read_attribute(:file_name),
         "size" => read_attribute(:file_size),
-        "error" => errors[:file].join,
+        "error" => errors[:file].join
       }
     end
 

data/app/models/alchemy/base_record.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
+
 module Alchemy
   def self.table_name_prefix
     "alchemy_"
   end
 
   class BaseRecord < ActiveRecord::Base
+    extend Alchemy::SearchableResource
+
     self.abstract_class = true
   end
 end

data/app/models/alchemy/eager_loading.rb

@@ -20,19 +20,18 @@ module Alchemy
         [
           :tags,
           {
-            language: :site,
+            :language => :site,
             version => {
               elements: [
                 :page,
                 :touchable_pages,
                 :tags,
                 {
-                  ingredients: :related_object,
-                  contents: :essence,
-                },
-              ],
-            },
-          },
+                  ingredients: :related_object
+                }
+              ]
+            }
+          }
         ]
       end
     end

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

@@ -41,7 +41,7 @@ module Alchemy
       # The definition of this element.
       #
       def definition
-        if definition = self.class.definition_by_name(name)
+        if (definition = self.class.definition_by_name(name))
           definition
         else
           log_warning "Could not find element definition for #{name}. " \

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
       #
@@ -166,9 +159,9 @@ module Alchemy
               scope: "ingredient_validations",
               default: [
                 "fields.#{role}.#{error}".to_sym,
-                "errors.#{error}".to_sym,
+                "errors.#{error}".to_sym
               ],
-              field: Alchemy::Ingredient.translated_label_for(role, name),
+              field: Alchemy::Ingredient.translated_label_for(role, name)
             )
           end
         end
@@ -182,7 +175,7 @@ module Alchemy
         ingredient_definitions.each do |attributes|
           ingredients.build(
             role: attributes[:role],
-            type: Alchemy::Ingredient.normalize_type(attributes[:type]),
+            type: Alchemy::Ingredient.normalize_type(attributes[:type])
           )
         end
       end

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,13 +36,12 @@ module Alchemy
       "amount",
       "autogenerate",
       "nestable_elements",
-      "contents",
       "hint",
       "ingredients",
       "taggable",
       "compact",
       "message",
-      "deprecated",
+      "deprecated"
     ].freeze
 
     # All Elements that share the same page version and parent element and are fixed or not are considered a list.
@@ -60,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,
@@ -96,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
@@ -106,12 +96,11 @@ 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) }
     scope :unfixed, -> { where(fixed: false) }
-    scope :from_current_site, -> { where(Language.table_name => { site_id: Site.current || Site.default }).joins(page: "language") }
+    scope :from_current_site, -> { where(Language.table_name => {site_id: Site.current || Site.default}).joins(page: "language") }
     scope :folded, -> { where(folded: true) }
     scope :expanded, -> { where(folded: false) }
     scope :not_nested, -> { where(parent_element_id: nil) }
@@ -120,8 +109,6 @@ module Alchemy
 
     # Concerns
     include Definitions
-    include ElementContents
-    include ElementEssences
     include ElementIngredients
     include Presenters
 
@@ -158,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
       #
@@ -193,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.
@@ -278,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/elements_repository.rb

@@ -102,7 +102,7 @@ module Alchemy
     # Elements off setted by
     # @return [Alchemy::ElementRepository]
     def offset(offset)
-      self.class.new elements[offset.to_i..-1]
+      self.class.new elements[offset.to_i..]
     end
 
     # Elements limitted by

data/app/models/alchemy/image_cropper_settings.rb

@@ -21,7 +21,7 @@ module Alchemy
         min_size: large_enough? ? min_size : false,
         ratio: ratio,
         default_box: default_box,
-        image_size: [image_width, image_height],
+        image_size: [image_width, image_height]
       }.freeze
     end
 
@@ -80,7 +80,7 @@ module Alchemy
         default_crop_from[0],
         default_crop_from[1],
         default_crop_from[0] + default_crop_size[0],
-        default_crop_from[1] + default_crop_size[1],
+        default_crop_from[1] + default_crop_size[1]
       ]
     end
   end

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?
 
@@ -73,14 +75,19 @@ module Alchemy
         Alchemy.t(
           role,
           scope: "ingredient_roles.#{element_name}",
-          default: Alchemy.t("ingredient_roles.#{role}", default: role.humanize),
+          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
@@ -93,16 +100,6 @@ module Alchemy
       definition[:settings] || {}
     end
 
-    # Fetches value from settings
-    #
-    # @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
-    #                                     editor view.
-    def settings_value(key, options = {})
-      settings.merge(options || {})[key.to_sym]
-    end
-
     # Definition hash for this ingredient from +elements.yml+ file.
     #
     def definition
@@ -158,12 +155,28 @@ module Alchemy
       !!definition[:as_element_title]
     end
 
+    # The view component of the ingredient with mapped options.
+    #
+    # @param options [Hash] - Passed to the view component as keyword arguments
+    # @param html_options [Hash] - Passed to the view component
+    def as_view_component(options: {}, html_options: {})
+      view_component_class.new(self, **options, html_options: html_options)
+    end
+
     private
 
+    def view_component_class
+      @_view_component_class ||= "#{self.class.name}View".constantize
+    end
+
     def hint_translation_attribute
       role
     end
 
+    def hint_translation_scope
+      "ingredient_hints"
+    end
+
     def set_default_value
       self.value = default_value
     end

data/app/models/alchemy/ingredient_validator.rb

@@ -89,7 +89,7 @@ module Alchemy
     def duplicates
       ingredient.class
         .joins(:element).merge(Alchemy::Element.published)
-        .where(Alchemy::Element.table_name => { name: ingredient.element.name })
+        .where(Alchemy::Element.table_name => {name: ingredient.element.name})
         .where(value: ingredient.value)
         .where.not(id: ingredient.id)
     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