alchemy_cms 6.1.5 → 7.0.0.pre.b

data/app/models/alchemy/content.rb

@@ -1,247 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: alchemy_contents
-#
-#  id           :integer          not null, primary key
-#  name         :string
-#  essence_type :string           not null
-#  essence_id   :integer          not null
-#  element_id   :integer          not null
-#  position     :integer
-#  created_at   :datetime         not null
-#  updated_at   :datetime         not null
-#  creator_id   :integer
-#  updater_id   :integer
-#
-
-require_dependency "alchemy/content/factory"
-
-module Alchemy
-  # @deprecated
-  class Content < BaseRecord
-    include Alchemy::Logger
-    include Alchemy::Hints
-
-    # Concerns
-    include Factory
-
-    belongs_to :essence, polymorphic: true, dependent: :destroy, inverse_of: :content
-    belongs_to :element, touch: true, inverse_of: :contents
-    has_one :page, through: :element
-
-    # Essence scopes
-    scope :essence_booleans, -> { where(essence_type: "Alchemy::EssenceBoolean") }
-    scope :essence_dates, -> { where(essence_type: "Alchemy::EssenceDate") }
-    scope :essence_files, -> { where(essence_type: "Alchemy::EssenceFile") }
-    scope :essence_htmls, -> { where(essence_type: "Alchemy::EssenceHtml") }
-    scope :essence_links, -> { where(essence_type: "Alchemy::EssenceLink") }
-    scope :essence_pictures, -> { where(essence_type: "Alchemy::EssencePicture") }
-    scope :essence_richtexts, -> { where(essence_type: "Alchemy::EssenceRichtext") }
-    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 }
-    scope :published, -> { joins(:element).merge(Element.published) }
-    scope :not_restricted, -> { joins(:element).merge(Element.not_restricted) }
-
-    delegate :restricted?, to: :page, allow_nil: true
-    delegate :public?, to: :element, allow_nil: true
-
-    class << self
-      # Returns the translated label for a content name.
-      #
-      # Translate it in your locale yml file:
-      #
-      #   alchemy:
-      #     content_names:
-      #       foo: Bar
-      #
-      # Optionally you can scope your content name to an element:
-      #
-      #   alchemy:
-      #     content_names:
-      #       article:
-      #         foo: Baz
-      #
-      def translated_label_for(content_name, element_name = nil)
-        Alchemy.t(
-          content_name,
-          scope: "content_names.#{element_name}",
-          default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize),
-        )
-      end
-    end
-
-    # The content's view partial is dependent from its name
-    #
-    # == Define contents
-    #
-    # Contents are defined in the +config/alchemy/elements.yml+ file
-    #
-    #     - name: article
-    #       contents:
-    #       - name: headline
-    #         type: EssenceText
-    #
-    # == Override the view
-    #
-    # Content partials live in +app/views/alchemy/essences+
-    #
-    def to_partial_path
-      "alchemy/essences/#{essence_partial_name}_view"
-    end
-
-    # Settings from the elements.yml definition
-    def settings
-      return {} if definition.blank?
-
-      @settings ||= definition.fetch(: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.update(options || {}).symbolize_keys[key.to_sym]
-    end
-
-    def siblings
-      return [] if !element
-
-      element.contents
-    end
-
-    # Gets the ingredient from essence
-    def ingredient
-      return nil if essence.nil?
-
-      essence.ingredient
-    end
-
-    # Serialized object representation for json api
-    #
-    def serialize
-      {
-        name: name,
-        value: serialized_ingredient,
-        link: essence.try(:link),
-      }.delete_if { |_k, v| v.blank? }
-    end
-
-    # Ingredient value from essence for json api
-    #
-    # If the essence responds to +serialized_ingredient+ method it takes this
-    # otherwise it uses the ingredient column.
-    #
-    def serialized_ingredient
-      essence.try(:serialized_ingredient) || ingredient
-    end
-
-    # Sets the ingredient from essence
-    def ingredient=(value)
-      raise EssenceMissingError if essence.nil?
-
-      essence.ingredient = value
-    end
-
-    # Updates the essence.
-    #
-    # Called from +Alchemy::Element#update_contents+
-    #
-    # Adds errors to self.base if essence validation fails.
-    #
-    def update_essence(params = {})
-      raise EssenceMissingError if essence.nil?
-
-      if essence.update(params)
-        true
-      else
-        errors.add(:essence, :validation_failed)
-        false
-      end
-    end
-
-    def essence_validation_failed?
-      essence.errors.any?
-    end
-
-    def has_validations?
-      definition["validate"].present?
-    end
-
-    # Returns a string used as dom id on html elements.
-    def dom_id
-      return "" if essence.nil?
-
-      "#{essence_partial_name}_#{id}"
-    end
-
-    # Returns the translated name for displaying in labels, etc.
-    def name_for_label
-      self.class.translated_label_for(name, element.name)
-    end
-
-    def linked?
-      essence && !essence.link.blank?
-    end
-
-    def deprecated?
-      !!definition["deprecated"]
-    end
-
-    # Returns true if this content should be taken for element preview.
-    def preview_content?
-      !!definition["as_element_title"]
-    end
-
-    # Proxy method that returns the preview text from essence.
-    #
-    def preview_text(maxlength = 30)
-      essence.preview_text(maxlength)
-    end
-
-    def essence_partial_name
-      return "" if essence.nil?
-
-      essence.partial_name
-    end
-
-    def normalized_essence_type
-      self.class.normalize_essence_type(essence_type)
-    end
-
-    # Returns true if there is a tinymce setting defined on the content definiton
-    # or if the +essence.has_tinymce?+ returns true.
-    def has_tinymce?
-      settings[:tinymce].present? || (essence.present? && essence.has_tinymce?)
-    end
-
-    # Returns true if there is a tinymce setting defined that contains settings.
-    def has_custom_tinymce_config?
-      settings[:tinymce].is_a?(Hash)
-    end
-
-    # Returns css class names for the content textarea.
-    def tinymce_class_name
-      "has_tinymce" + (has_custom_tinymce_config? ? " #{element.name}_#{name}" : "")
-    end
-
-    # Returns the default value from content definition
-    #
-    # If the value is a symbol it gets passed through i18n
-    # inside the +alchemy.default_content_texts+ scope
-    def default_value(default = definition[:default])
-      case default
-      when Symbol
-        Alchemy.t(default, scope: :default_content_texts)
-      else
-        default
-      end
-    end
-  end
-end

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