alchemy_cms 6.1.2 → 7.0.0.pre.a

data/app/models/alchemy/element.rb

@@ -21,9 +21,7 @@
 #
 
 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
@@ -38,7 +36,6 @@ module Alchemy
       "amount",
       "autogenerate",
       "nestable_elements",
-      "contents",
       "hint",
       "ingredients",
       "taggable",
@@ -59,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,
@@ -95,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
@@ -105,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) }
@@ -119,8 +109,6 @@ module Alchemy
 
     # Concerns
     include Definitions
-    include ElementContents
-    include ElementEssences
     include ElementIngredients
     include Presenters
 
@@ -157,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
       #
@@ -192,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.
@@ -277,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.

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

@@ -17,12 +17,6 @@ module Alchemy
         public_until ? public_until - Time.current : nil
       end
 
-      def taggable?
-        definition["taggable"] == true
-      end
-
-      deprecate :taggable?, deprecator: Alchemy::Deprecation
-
       def rootpage?
         !new_record? && parent_id.blank?
       end
@@ -33,10 +27,6 @@ module Alchemy
         folded_pages.where(user_id: user_id, folded: true).any?
       end
 
-      def contains_feed?
-        definition["feed"]
-      end
-
       # Returns an Array of Alchemy roles which are able to edit this template
       #
       #     # config/alchemy/page_layouts.yml

data/app/models/alchemy/page.rb

@@ -163,14 +163,6 @@ module Alchemy
     # site_name accessor
     delegate :name, to: :site, prefix: true, allow_nil: true
 
-    # Old public_on and public_until attributes for historical reasons
-    #
-    # These attributes now exist on the page versions
-    #
-    attr_readonly :legacy_public_on, :legacy_public_until
-    deprecate :legacy_public_on, deprecator: Alchemy::Deprecation
-    deprecate :legacy_public_until, deprecator: Alchemy::Deprecation
-
     # Class methods
     #
     class << self

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

@@ -33,36 +33,6 @@ module Alchemy
       image_file.thumbnail(upsample ? size : "#{size}>")
     end
 
-    # Returns true if picture's width is greater than it's height
-    #
-    def landscape_format?
-      image_file.landscape?
-    end
-
-    alias_method :landscape?, :landscape_format?
-    deprecate landscape_format?: "Use image_file.landscape? instead", deprecator: Alchemy::Deprecation
-    deprecate landscape?: "Use image_file.landscape? instead", deprecator: Alchemy::Deprecation
-
-    # Returns true if picture's width is smaller than it's height
-    #
-    def portrait_format?
-      image_file.portrait?
-    end
-
-    alias_method :portrait?, :portrait_format?
-    deprecate portrait_format?: "Use image_file.portrait? instead", deprecator: Alchemy::Deprecation
-    deprecate portrait?: "Use image_file.portrait? instead", deprecator: Alchemy::Deprecation
-
-    # Returns true if picture's width and height is equal
-    #
-    def square_format?
-      image_file.aspect_ratio == 1.0
-    end
-
-    alias_method :square?, :square_format?
-    deprecate square_format?: "Use image_file.aspect_ratio instead", deprecator: Alchemy::Deprecation
-    deprecate square?: "Use image_file.aspect_ratio instead", deprecator: Alchemy::Deprecation
-
     # Returns true if the class we're included in has a meaningful render_size attribute
     #
     def render_size?

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

@@ -36,7 +36,7 @@ module Alchemy
         else
           uid = PictureThumb::Uid.call(signature, variant)
           ActiveRecord::Base.connected_to(role: ActiveRecord::Base.writing_role) do
-            PictureThumb.generator_class.call(variant, signature, uid)
+            PictureThumb::Create.call(variant, signature, uid)
           end
           uid
         end

data/app/models/alchemy/picture.rb

@@ -47,17 +47,16 @@ module Alchemy
     include Alchemy::TouchElements
     include Calculations
 
-    has_many :essence_pictures,
-      class_name: "Alchemy::EssencePicture",
-      foreign_key: "picture_id",
-      inverse_of: :ingredient_association
+    has_many :picture_ingredients,
+      class_name: "Alchemy::Ingredients::Picture",
+      foreign_key: "related_object_id",
+      inverse_of: :related_object
 
-    has_many :contents, through: :essence_pictures
-    has_many :elements, through: :contents
+    has_many :elements, through: :picture_ingredients
     has_many :pages, through: :elements
     has_many :thumbs, class_name: "Alchemy::PictureThumb", dependent: :destroy
 
-    # Raise error, if picture is in use (aka. assigned to an EssencePicture)
+    # Raise error, if picture is in use (aka. assigned to an Picture ingredient)
     #
     # === CAUTION
     #
@@ -114,7 +113,10 @@ module Alchemy
 
     scope :named, ->(name) { where("#{table_name}.name LIKE ?", "%#{name}%") }
     scope :recent, -> { where("#{table_name}.created_at > ?", Time.current - 24.hours).order(:created_at) }
-    scope :deletable, -> { where("#{table_name}.id NOT IN (SELECT picture_id FROM #{EssencePicture.table_name})") }
+    scope :deletable,
+      -> {
+        where("#{table_name}.id NOT IN (SELECT related_object_id FROM alchemy_ingredients WHERE related_object_type = 'Alchemy::Picture')")
+      }
     scope :without_tag, -> { left_outer_joins(:taggings).where(gutentag_taggings: { id: nil }) }
     scope :by_file_format, ->(format) { where(image_file_format: format) }
 
@@ -279,10 +281,10 @@ module Alchemy
       pages.any? && pages.not_restricted.blank?
     end
 
-    # Returns true if picture is not assigned to any EssencePicture.
+    # Returns true if picture is not assigned to any Picture ingredient.
     #
     def deletable?
-      essence_pictures.empty?
+      picture_ingredients.empty?
     end
 
     # A size String from original image file values.

data/app/models/alchemy/picture_thumb/create.rb

@@ -2,9 +2,11 @@
 
 module Alchemy
   class PictureThumb < BaseRecord
-    # Stores the render result of a Alchemy::PictureVariant
-    # in the configured Dragonfly datastore
-    # (Default: Dragonfly::FileDataStore)
+    # Creates a Alchemy::PictureThumb
+    #
+    # Stores the processes result of a Alchemy::PictureVariant
+    # in the configured +Alchemy::PictureThumb.storage_class+
+    # (Default: {Alchemy::PictureThumb::FileStore})
     #
     class Create
       class << self
@@ -24,26 +26,13 @@ module Alchemy
             thumb.uid = uid
           end
           begin
-            # process the image
-            image = variant.image
-            # store the processed image
-            image.to_file(server_path(uid)).close
-          rescue RuntimeError => e
+            Alchemy::PictureThumb.storage_class.call(variant, uid)
+          rescue StandardError => e
             ErrorTracking.notification_handler.call(e)
             # destroy the thumb if processing or storing fails
             @thumb&.destroy
           end
         end
-
-        private
-
-        # Alchemys dragonfly datastore config seperates the storage path from the public server
-        # path for security reasons. The Dragonfly FileDataStorage does not support that,
-        # so we need to build the path on our own.
-        def server_path(uid)
-          dragonfly_app = ::Dragonfly.app(:alchemy_pictures)
-          "#{dragonfly_app.datastore.server_root}/#{uid}"
-        end
       end
     end
   end

data/app/models/alchemy/picture_thumb/file_store.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class PictureThumb < BaseRecord
+    # Stores the render result of a Alchemy::PictureVariant
+    # in the configured Dragonfly datastore
+    # (Default: Dragonfly::FileDataStore)
+    #
+    class FileStore
+      class << self
+        # @param [Alchemy::PictureVariant] variant the to be rendered image
+        # @param [String] uid The Unique Image Identifier the image is stored at
+        #
+        def call(variant, uid)
+          # process the image
+          image = variant.image
+          # store the processed image
+          image.to_file(server_path(uid)).close
+        end
+
+        private
+
+        # Alchemys dragonfly datastore config seperates the storage path from the public server
+        # path for security reasons. The Dragonfly FileDataStorage does not support that,
+        # so we need to build the path on our own.
+        def server_path(uid)
+          dragonfly_app = ::Dragonfly.app(:alchemy_pictures)
+          "#{dragonfly_app.datastore.server_root}/#{uid}"
+        end
+      end
+    end
+  end
+end

data/app/models/alchemy/picture_thumb.rb

@@ -7,7 +7,7 @@ module Alchemy
   # different thumbnail store (ie. a remote file storage).
   #
   #     config/initializers/alchemy.rb
-  #     Alchemy::PictureThumb.generator_class = My::ThumbnailGenerator
+  #     Alchemy::PictureThumb.storage_class = My::ThumbnailStore
   #
   class PictureThumb < BaseRecord
     belongs_to :picture, class_name: "Alchemy::Picture"
@@ -16,18 +16,18 @@ module Alchemy
     validates :uid, presence: true
 
     class << self
-      # Thumbnail generator class
+      # Thumbnail storage class
       #
-      # @see Alchemy::PictureThumb::Create
-      def generator_class
-        @_generator_class ||= Alchemy::PictureThumb::Create
+      # @see Alchemy::PictureThumb::FileStore
+      def storage_class
+        @_storage_class ||= Alchemy::PictureThumb::FileStore
       end
 
-      # Set a thumbnail generator class
+      # Set a thumbnail storage class
       #
-      # @see Alchemy::PictureThumb::Create
-      def generator_class=(klass)
-        @_generator_class = klass
+      # @see Alchemy::PictureThumb::FileStore
+      def storage_class=(klass)
+        @_storage_class = klass
       end
 
       # Upfront generation of picture thumbnails
@@ -49,7 +49,7 @@ module Alchemy
           next if thumb
 
           uid = Alchemy::PictureThumb::Uid.call(signature, variant)
-          generator_class.call(variant, signature, uid)
+          Alchemy::PictureThumb::Create.call(variant, signature, uid)
         end
       end
     end