alchemy_cms 6.1.10 → 7.0.0.pre.a

data/app/decorators/alchemy/content_editor.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  class ContentEditor < SimpleDelegator
-    alias_method :content, :__getobj__
-
-    def to_partial_path
-      "alchemy/essences/#{essence_partial_name}_editor"
-    end
-
-    def css_classes
-      [
-        "content_editor",
-        essence_partial_name,
-        deprecated? ? "deprecated" : nil,
-      ].compact
-    end
-
-    def data_attributes
-      {
-        content_id: id,
-        content_name: name,
-      }
-    end
-
-    # Returns a string to be passed to Rails form field tags to ensure we have same params layout everywhere.
-    #
-    # === Example:
-    #
-    #   <%= text_field_tag content_editor.form_field_name, content_editor.ingredient %>
-    #
-    # === Options:
-    #
-    # You can pass an Essence column_name. Default is 'ingredient'
-    #
-    # ==== Example:
-    #
-    #   <%= text_field_tag content_editor.form_field_name(:link), content_editor.ingredient %>
-    #
-    def form_field_name(essence_column = "ingredient")
-      "contents[#{id}][#{essence_column}]"
-    end
-
-    def form_field_id(essence_column = "ingredient")
-      "contents_#{id}_#{essence_column}"
-    end
-
-    # Fixes Rails partial renderer calling to_model on the object
-    # which reveals the delegated content instead of this decorator.
-    def respond_to?(method_name)
-      return false if method_name == :to_model
-
-      super
-    end
-
-    def has_warnings?
-      definition.blank? || deprecated?
-    end
-
-    def warnings
-      return unless has_warnings?
-
-      if definition.blank?
-        Logger.warn("Content #{name} is missing its definition", caller(1..1))
-        Alchemy.t(:content_definition_missing)
-      else
-        deprecation_notice
-      end
-    end
-
-    # Returns a deprecation notice for contents marked deprecated
-    #
-    # You can either use localizations or pass a String as notice
-    # in the content definition.
-    #
-    # == Custom deprecation notices
-    #
-    # Use general content deprecation notice
-    #
-    #     - name: element_name
-    #       contents:
-    #         - name: old_content
-    #           type: EssenceText
-    #           deprecated: true
-    #
-    # Add a translation to your locale file for a per content notice.
-    #
-    #     en:
-    #       alchemy:
-    #         content_deprecation_notices:
-    #           element_name:
-    #             old_content: Foo baz widget is deprecated
-    #
-    # or use the global translation that apply to all deprecated contents.
-    #
-    #     en:
-    #       alchemy:
-    #         content_deprecation_notice: Foo baz widget is deprecated
-    #
-    # or pass string as deprecation notice.
-    #
-    #     - name: element_name
-    #       contents:
-    #         - name: old_content
-    #           type: EssenceText
-    #           deprecated: This content will be removed soon.
-    #
-    def deprecation_notice
-      case definition["deprecated"]
-      when String
-        definition["deprecated"]
-      when TrueClass
-        Alchemy.t(name,
-                  scope: [:content_deprecation_notices, element.name],
-                  default: Alchemy.t(:content_deprecated))
-      end
-    end
-  end
-end

data/app/helpers/alchemy/admin/contents_helper.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  module Admin
-    module ContentsHelper
-      include Alchemy::Admin::BaseHelper
-
-      # Renders the name of elements content.
-      #
-      # Displays a warning icon if content is missing its definition.
-      #
-      # Displays a mandatory field indicator, if the content has validations.
-      #
-      def render_content_name(content)
-        if content.blank?
-          warning("Content is nil")
-          return
-        end
-
-        content_name = content.name_for_label
-
-        if content.has_warnings?
-          icon = hint_with_tooltip(content.warnings)
-          content_name = "#{icon} #{content_name}".html_safe
-        end
-
-        if content.has_validations?
-          "#{content_name}<span class='validation_indicator'>*</span>".html_safe
-        else
-          content_name
-        end
-      end
-
-      # Renders the label and a remove link for a content.
-      def content_label(content)
-        content_tag :label, for: content.form_field_id do
-          [render_content_name(content), render_hint_for(content)].compact.join("&nbsp;").html_safe
-        end
-      end
-    end
-  end
-end

data/app/helpers/alchemy/admin/essences_helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  module Admin
-    module EssencesHelper
-      # Renders a thumbnail for given EssencePicture content with correct cropping and size
-      def essence_picture_thumbnail(content)
-        picture = content.ingredient
-        essence = content.essence
-
-        return if picture.nil?
-
-        image_tag(
-          essence.thumbnail_url,
-          alt: picture.name,
-          class: "img_paddingtop",
-          title: Alchemy.t(:image_name, name: picture.name),
-        )
-      end
-
-      # Size value for edit picture dialog
-      def edit_picture_dialog_size(content)
-        if content.settings[:caption_as_textarea]
-          content.settings[:sizes] ? "380x320" : "380x300"
-        else
-          content.settings[:sizes] ? "380x290" : "380x255"
-        end
-      end
-    end
-  end
-end

data/app/models/alchemy/content/factory.rb

@@ -1,143 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  # Holds everything concerning the building and creating of contents and the related essence object.
-  #
-  class Content < BaseRecord
-    module Factory
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        SKIPPED_ATTRIBUTES_ON_COPY = %w(position created_at updated_at creator_id updater_id element_id id)
-
-        # Builds a new content as descriped in the elements.yml file.
-        #
-        # @param [Hash]
-        #   The content definition used for finding the content in +elements.yml+ file
-        #
-        def new(attributes = {})
-          element = attributes[:element] || Element.find_by(id: attributes[:element_id])
-          return super if attributes.empty? || element.nil?
-
-          definition = element.content_definition_for(attributes[:name])
-          if definition.blank? && attributes[:essence_type].nil?
-            raise ContentDefinitionError, "No definition found in elements.yml for #{attributes.inspect} and #{element.inspect}"
-          end
-
-          super(
-            name: attributes[:name],
-            essence_type: attributes[:essence_type] || normalize_essence_type(definition[:type]),
-            element: element,
-          ).tap(&:build_essence)
-        end
-
-        # Creates a new content from elements definition in the +elements.yml+ file.
-        #
-        # 1. It builds the content
-        # 2. It creates the essence record (content object gets saved)
-        #
-        # @return [Alchemy::Content]
-        #
-        def create(attributes = {})
-          new(attributes).tap do |content|
-            content.essence.save && content.save
-          end
-        end
-
-        # Creates a copy of source and also copies the associated essence.
-        #
-        # You can pass a differences hash to update the attributes of the copy.
-        #
-        # === Example
-        #
-        #   @copy = Alchemy::Content.copy(@content, {element_id: 3})
-        #   @copy.element_id # => 3
-        #
-        def copy(source, differences = {})
-          Content.new(
-            source.attributes.with_indifferent_access.
-              except(*SKIPPED_ATTRIBUTES_ON_COPY).
-              merge(differences.with_indifferent_access)
-          ).tap do |new_content|
-            new_content.build_essence(
-              source.essence.attributes.
-                except(*SKIPPED_ATTRIBUTES_ON_COPY)
-            )
-            new_content.save
-          end
-        end
-
-        # Returns all content definitions from elements.yml
-        #
-        def definitions
-          definitions = Element.definitions.flat_map { |e| e["contents"] }
-          definitions.compact!
-          definitions
-        end
-
-        # Returns a normalized Essence type
-        #
-        # Adds Alchemy module name in front of given essence type
-        # unless there is a Class with the specified name that is an essence.
-        #
-        # @param [String]
-        #   the essence type to normalize
-        #
-        def normalize_essence_type(essence_type)
-          essence_type = essence_type.classify
-          return essence_type if is_an_essence?(essence_type)
-
-          "Alchemy::#{essence_type}"
-        end
-
-        private
-
-        def is_an_essence?(essence_type)
-          klass = Module.const_get(essence_type)
-          klass.is_a?(Class) && klass.new.acts_as_essence?
-        rescue NameError
-          false
-        end
-      end
-
-      # Instance Methods
-
-      # Returns the definition hash from +elements.yml+ file.
-      #
-      def definition
-        if element.blank?
-          log_warning "Content with id #{id} is missing its Element."
-          return {}
-        end
-        element.content_definition_for(name) || {}
-      end
-
-      # Build essence from definition.
-      #
-      # If an optional type is passed, this type of essence gets created.
-      #
-      def build_essence(attributes = {})
-        self.essence = essence_class.new(
-          { content: self, ingredient: default_value }.merge(attributes)
-        )
-      end
-
-      # Creates essence from definition.
-      #
-      # If an optional type is passed, this type of essence gets created.
-      #
-      def create_essence!(attrs = {})
-        build_essence(attrs).save!
-        save!
-      end
-
-      private
-
-      # Returns a class constant from definition's type field or the essence_type column
-      #
-      def essence_class
-        (essence_type || Content.normalize_essence_type(definition["type"])).constantize
-      end
-    end
-  end
-end

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