alchemy_cms 6.1.10 → 7.0.0.pre.a

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

@@ -1,200 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  class Element < BaseRecord
-    # Methods concerning contents for elements
-    #
-    module ElementContents
-      # Find first content from element by given name.
-      # @deprecated
-      def content_by_name(name)
-        contents_by_name(name).first
-      end
-
-      deprecate content_by_name: :ingredient_by_role, deprecator: Alchemy::Deprecation
-
-      # Find first content from element by given essence type.
-      # @deprecated
-      def content_by_type(essence_type)
-        contents_by_type(essence_type).first
-      end
-
-      deprecate content_by_type: :ingredient_by_type, deprecator: Alchemy::Deprecation
-
-      # All contents from element by given name.
-      # @deprecated
-      def contents_by_name(name)
-        contents.select { |content| content.name == name.to_s }
-      end
-
-      deprecate contents_by_name: :ingredients_by_role, deprecator: Alchemy::Deprecation
-
-      alias_method :all_contents_by_name, :contents_by_name
-
-      # All contents from element by given essence type.
-      # @deprecated
-      def contents_by_type(essence_type)
-        contents.select do |content|
-          content.essence_type == Content.normalize_essence_type(essence_type)
-        end
-      end
-
-      deprecate contents_by_type: :ingredients_by_type, deprecator: Alchemy::Deprecation
-
-      alias_method :all_contents_by_type, :contents_by_type
-
-      # Updates all related contents by calling +update_essence+ on each of them.
-      #
-      # @param contents_attributes [Hash]
-      #   Hash of contents attributes.
-      #   The keys has to be the #id of the content to update.
-      #   The values a Hash of attribute names and values
-      #
-      # @return [Boolean]
-      #   True if +errors+ are blank or +contents_attributes+ hash is nil
-      #
-      # == Example
-      #
-      #   @element.update_contents(
-      #     "1" => {ingredient: "Title"},
-      #     "2" => {link: "https://google.com"}
-      #   )
-      #
-      # @deprecated
-      def update_contents(contents_attributes)
-        return true if contents_attributes.nil?
-
-        contents.each do |content|
-          content_hash = contents_attributes[content.id.to_s] || next
-          content.update_essence(content_hash) || errors.add(:base, :essence_validation_failed)
-        end
-        errors.blank?
-      end
-
-      deprecate :update_contents, deprecator: Alchemy::Deprecation
-
-      # Copy current content's contents to given target element
-      # @deprecated
-      def copy_contents_to(element)
-        contents.map do |content|
-          Content.copy(content, element_id: element.id)
-        end
-      end
-
-      deprecate :copy_contents_to, deprecator: Alchemy::Deprecation
-
-      # Returns the content that is marked as rss title.
-      #
-      # Mark a content as rss title in your +elements.yml+ file:
-      #
-      #   - name: news
-      #     contents:
-      #     - name: headline
-      #       type: EssenceText
-      #       rss_title: true
-      #
-      # @deprecated
-      def content_for_rss_title
-        content_for_rss_meta("title")
-      end
-
-      deprecate :content_for_rss_title, deprecator: Alchemy::Deprecation
-
-      # Returns the content that is marked as rss description.
-      #
-      # Mark a content as rss description in your +elements.yml+ file:
-      #
-      #   - name: news
-      #     contents:
-      #     - name: body
-      #       type: EssenceRichtext
-      #       rss_description: true
-      #
-      # @deprecated
-      def content_for_rss_description
-        content_for_rss_meta("description")
-      end
-
-      deprecate :content_for_rss_description, deprecator: Alchemy::Deprecation
-
-      # Returns the array with the hashes for all element contents in the elements.yml file
-      # @deprecated
-      def content_definitions
-        return nil if definition.blank?
-
-        definition["contents"]
-      end
-
-      deprecate content_definitions: :ingredient_definitions, deprecator: Alchemy::Deprecation
-
-      # Returns the definition for given content_name
-      # @deprecated
-      def content_definition_for(content_name)
-        if content_definitions.blank?
-          log_warning "Element #{name} is missing the content definition for #{content_name}"
-          nil
-        else
-          content_definitions.detect { |d| d["name"] == content_name.to_s }
-        end
-      end
-
-      deprecate content_definition_for: :ingredient_definition_for, deprecator: Alchemy::Deprecation
-
-      # Returns an array of all EssenceRichtext contents ids from elements
-      #
-      # This is used to re-initialize the TinyMCE editor in the element editor.
-      #
-      # @deprecated
-      def richtext_contents_ids
-        # This is not very efficient SQL wise I know, but we need to iterate
-        # recursivly through all descendent elements and I don't know how to do this
-        # in pure SQL. Anyone with a better idea is welcome to submit a patch.
-        ids = contents.select(&:has_tinymce?).collect(&:id)
-        expanded_nested_elements = nested_elements.expanded
-        if expanded_nested_elements.present?
-          ids += expanded_nested_elements.collect(&:richtext_contents_ids)
-        end
-        ids.flatten
-      end
-
-      deprecate richtext_contents_ids: :richtext_ingredients_ids, deprecator: Alchemy::Deprecation
-
-      # True, if any of the element's contents has essence validations defined.
-      # @deprecated
-      def has_validations?
-        !contents.detect(&:has_validations?).blank?
-      end
-
-      deprecate :has_validations?, deprecator: Alchemy::Deprecation
-
-      # All element contents where the essence validation has failed.
-      # @deprecated
-      def contents_with_errors
-        contents.select(&:essence_validation_failed?)
-      end
-
-      deprecate contents_with_errors: :ingredients_with_errors, deprecator: Alchemy::Deprecation
-
-      private
-
-      def content_for_rss_meta(type)
-        definition = content_definitions.detect { |c| c["rss_#{type}"] }
-        return if definition.blank?
-
-        contents.detect { |content| content.name == definition["name"] }
-      end
-
-      # creates the contents for this element as described in the elements.yml
-      #
-      # If ingredients are defined as well no contents get created,
-      # ingredients get created instead.
-      def create_contents
-        return if definition.fetch(:ingredients, []).any?
-
-        definition.fetch("contents", []).each do |attributes|
-          Content.create(attributes.merge(element: self))
-        end
-      end
-    end
-  end
-end

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

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  class Element < BaseRecord
-    module ElementEssences
-      # Returns the contents essence value (aka. ingredient) for passed content name.
-      def ingredient(name)
-        ing = ingredient_by_role(name)
-        if ing
-          Alchemy::Deprecation.warn(<<~WARN)
-            Using `element.ingredient` to get the value of an ingredient is deprecated and will change in Alchemy 6.1
-            If you want to read the value of an elements ingredient please use `element.value_for(:ingredient_role)` instead.
-            The next version of Alchemy will return a `Alchemy::Ingredient` record instead.
-          WARN
-          ing.value
-        else
-          content = content_by_name(name)
-          return nil if content.blank?
-
-          content.ingredient
-        end
-      end
-
-      # True if the element has a content for given name,
-      # that has an essence value (aka. ingredient) that is not blank.
-      # @deprecated
-      def has_ingredient?(name)
-        ingredient(name).present?
-      end
-
-      deprecate has_ingredient?: :has_value_for?, deprecator: Alchemy::Deprecation
-
-      # Returns all essence errors in the format of:
-      #
-      #   {
-      #     content.name => [
-      #       error_message_for_validation_1,
-      #       error_message_for_validation_2
-      #     ]
-      #   }
-      #
-      # Get translated error messages with +Element#essence_error_messages+
-      #
-      # @deprecated
-      def essence_errors
-        essence_errors = {}
-        contents.each do |content|
-          if content.essence_validation_failed?
-            essence_errors[content.name] = content.essence.validation_errors
-          end
-        end
-        essence_errors
-      end
-
-      deprecate :essence_errors, deprecator: Alchemy::Deprecation
-
-      # Essence validation errors
-      #
-      # == Error messages are translated via I18n
-      #
-      # Inside your translation file add translations like:
-      #
-      #   alchemy:
-      #     content_validations:
-      #       name_of_the_element:
-      #         name_of_the_content:
-      #           validation_error_type: Error Message
-      #
-      # NOTE: +validation_error_type+ has to be one of:
-      #
-      #   * blank
-      #   * taken
-      #   * invalid
-      #
-      # === Example:
-      #
-      #   de:
-      #     alchemy:
-      #       content_validations:
-      #         contactform:
-      #           email:
-      #             invalid: 'Die Email hat nicht das richtige Format'
-      #
-      #
-      # == Error message translation fallbacks
-      #
-      # In order to not translate every single content for every element
-      # you can provide default error messages per content name:
-      #
-      # === Example
-      #
-      #   en:
-      #     alchemy:
-      #       content_validations:
-      #         fields:
-      #           email:
-      #             invalid: E-Mail has wrong format
-      #             blank: E-Mail can't be blank
-      #
-      # And even further you can provide general field agnostic error messages:
-      #
-      # === Example
-      #
-      #   en:
-      #     alchemy:
-      #       content_validations:
-      #         errors:
-      #           invalid: %{field} has wrong format
-      #           blank: %{field} can't be blank
-      #
-      # @deprecated
-      def essence_error_messages
-        messages = []
-        essence_errors.each do |content_name, errors|
-          errors.each do |error|
-            messages << Alchemy.t(
-              "#{name}.#{content_name}.#{error}",
-              scope: "content_validations",
-              default: [
-                "fields.#{content_name}.#{error}".to_sym,
-                "errors.#{error}".to_sym,
-              ],
-              field: Content.translated_label_for(content_name, name),
-            )
-          end
-        end
-        messages
-      end
-
-      deprecate essence_error_messages: :ingredient_error_messages, deprecator: Alchemy::Deprecation
-    end
-  end
-end

data/app/models/alchemy/essence_audio.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  # @deprecated
-  class EssenceAudio < ActiveRecord::Base
-    acts_as_essence(
-      ingredient_column: :attachment,
-      preview_text_method: :name,
-    )
-
-    belongs_to :attachment, optional: true
-  end
-end

data/app/models/alchemy/essence_boolean.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_essence_booleans
-#
-#  id         :integer          not null, primary key
-#  value      :boolean
-#  created_at :datetime         not null
-#  updated_at :datetime         not null
-#
-
-# Stores boolean values.
-# Provides a checkbox in the editor views.
-module Alchemy
-  # @deprecated
-  class EssenceBoolean < BaseRecord
-    acts_as_essence ingredient_column: "value"
-  end
-end

data/app/models/alchemy/essence_date.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_essence_dates
-#
-#  id         :integer          not null, primary key
-#  date       :datetime
-#  created_at :datetime         not null
-#  updated_at :datetime         not null
-#
-
-module Alchemy
-  # @deprecated
-  class EssenceDate < BaseRecord
-    acts_as_essence ingredient_column: "date"
-
-    # Returns self.date for the Element#preview_text method.
-    def preview_text(_maxlength = nil)
-      return "" if date.blank?
-
-      ::I18n.l(date, format: :'alchemy.essence_date')
-    end
-  end
-end

data/app/models/alchemy/essence_file.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_essence_files
-#
-#  id            :integer          not null, primary key
-#  attachment_id :integer
-#  title         :string
-#  css_class     :string
-#  created_at    :datetime         not null
-#  updated_at    :datetime         not null
-#  link_text     :string
-#
-
-module Alchemy
-  # @deprecated
-  class EssenceFile < BaseRecord
-    belongs_to :attachment, optional: true
-    acts_as_essence ingredient_column: "attachment"
-
-    def attachment_url
-      return if attachment.nil?
-
-      routes.download_attachment_path(
-        id: attachment.id,
-        name: attachment.slug,
-        format: attachment.suffix,
-      )
-    end
-
-    def preview_text(max = 30)
-      return "" if attachment.blank?
-
-      attachment.name.to_s[0..max - 1]
-    end
-
-    # Returns a serialized ingredient value for json api
-    def serialized_ingredient
-      attachment_url
-    end
-
-    private
-
-    def routes
-      @routes ||= Engine.routes.url_helpers
-    end
-  end
-end

data/app/models/alchemy/essence_headline.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  # @deprecated
-  class EssenceHeadline < BaseRecord
-    acts_as_essence
-
-    after_initialize :set_level_and_size
-
-    def preview_text(maxlength = 30)
-      "H#{level}: #{body}"[0..maxlength - 1]
-    end
-
-    def level_options
-      levels.map { |level| ["H#{level}", level] }
-    end
-
-    def size_options
-      sizes.map { |size| ["H#{size}", size] }
-    end
-
-    private
-
-    def content_settings
-      content&.settings || {}
-    end
-
-    def levels
-      content_settings.fetch(:levels, (1..6))
-    end
-
-    def sizes
-      content_settings.fetch(:sizes, [])
-    end
-
-    def set_level_and_size
-      self.level ||= levels.first
-      self.size ||= sizes.first
-    end
-  end
-end

data/app/models/alchemy/essence_html.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_essence_htmls
-#
-#  id         :integer          not null, primary key
-#  source     :text
-#  created_at :datetime         not null
-#  updated_at :datetime         not null
-#
-
-module Alchemy
-  # @deprecated
-  class EssenceHtml < BaseRecord
-    acts_as_essence ingredient_column: "source"
-
-    # Returns the first x (default = 30) (HTML escaped) characters from self.source for the Element#preview_text method.
-    def preview_text(maxlength = 30)
-      ::CGI.escapeHTML(source.to_s)[0..maxlength]
-    end
-  end
-end

data/app/models/alchemy/essence_link.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_essence_links
-#
-#  id              :integer          not null, primary key
-#  link            :string
-#  link_title      :string
-#  link_target     :string
-#  link_class_name :string
-#  created_at      :datetime         not null
-#  updated_at      :datetime         not null
-#
-
-module Alchemy
-  # @deprecated
-  class EssenceLink < BaseRecord
-    acts_as_essence ingredient_column: "link"
-  end
-end

data/app/models/alchemy/essence_node.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  # @deprecated
-  class EssenceNode < BaseRecord
-    acts_as_essence(
-      ingredient_column: :node,
-      preview_text_column: :node_name,
-      belongs_to: {
-        class_name: "Alchemy::Node",
-        foreign_key: :node_id,
-        inverse_of: :essence_nodes,
-        optional: true,
-      },
-    )
-
-    delegate :name, to: :node, prefix: true, allow_nil: true
-  end
-end

data/app/models/alchemy/essence_page.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  # @deprecated
-  class EssencePage < BaseRecord
-    acts_as_essence(
-      ingredient_column: :page,
-      preview_text_method: :name,
-      belongs_to: {
-        class_name: "Alchemy::Page",
-        foreign_key: :page_id,
-        inverse_of: :essence_pages,
-        optional: true,
-      },
-    )
-  end
-end

data/app/models/alchemy/essence_picture.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_essence_pictures
-#
-#  id              :integer          not null, primary key
-#  picture_id      :integer
-#  caption         :string
-#  title           :string
-#  alt_tag         :string
-#  link            :string
-#  link_class_name :string
-#  link_title      :string
-#  css_class       :string
-#  link_target     :string
-#  created_at      :datetime         not null
-#  updated_at      :datetime         not null
-#  crop_from       :string
-#  crop_size       :string
-#  render_size     :string
-#
-
-module Alchemy
-  # @deprecated
-  class EssencePicture < BaseRecord
-    include Alchemy::PictureThumbnails
-
-    acts_as_essence ingredient_column: :picture, belongs_to: {
-      class_name: "Alchemy::Picture",
-      foreign_key: :picture_id,
-      inverse_of: :essence_pictures,
-      optional: true,
-    }
-
-    delegate :settings, to: :content
-
-    before_save :replace_newlines
-
-    # The name of the picture used as preview text in element editor views.
-    #
-    # @param max [Integer]
-    #   The maximum length of the text returned.
-    #
-    # @return [String]
-    def preview_text(max = 30)
-      return "" if picture.nil?
-
-      picture.name.to_s[0..max - 1]
-    end
-
-    # Returns a serialized ingredient value for json api
-    #
-    # @return [String]
-    def serialized_ingredient
-      picture_url(content.settings)
-    end
-
-    private
-
-    def replace_newlines
-      return nil if caption.nil?
-
-      caption.gsub!(/(\r\n|\r|\n)/, "<br/>")
-    end
-  end
-end