alchemy_cms 4.3.2 → 4.4.0

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

@@ -38,7 +38,7 @@ module Alchemy
 
       # Renders the label and a remove link for a content.
       def content_label(content)
-        content_tag :label do
+        content_tag :label, for: content.form_field_id do
           [render_hint_for(content), render_content_name(content)].compact.join(' ').html_safe
         end
       end

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

@@ -48,12 +48,18 @@ module Alchemy
       # @note If the partial is not found
       #   <tt>alchemy/elements/_editor_not_found.html.erb</tt> gets rendered.
       #
+      # @deprecated Using element editor partials is deprecated and will be removed in Alchemy 5.0
       def render_editor(element)
         if element.nil?
           warning('Element is nil')
           render "alchemy/elements/editor_not_found", {name: 'nil'}
           return
         end
+        Alchemy::Deprecation.warn <<~WARN
+          Using element editor partials is deprecated and will be removed in Alchemy 5.0.
+          You can delete the `app/views/alchemy/elements/_#{element.name}_editor` partial
+          and Alchemy will render the content editors for you.
+        WARN
 
         render "alchemy/elements/#{element.name}_editor", element: element
       rescue ActionView::MissingTemplate => e

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

@@ -8,9 +8,23 @@ module Alchemy
 
       # Renders the Content editor partial from the given Content.
       # For options see -> render_essence
+      # @deprecated
       def render_essence_editor(content, options = {}, html_options = {})
+        if !options.empty?
+          Alchemy::Deprecation.warn <<~WARN
+            Passing options to `render_essence_editor` is deprecated and will be removed from Alchemy 5.0.
+            Add your static `#{options.keys}` options to the `#{content.name}` content definitions `settings` of `#{content.element&.name}` element.
+            For dynamic options consider adding your own essence class.
+          WARN
+        end
+        if !html_options.empty?
+          Alchemy::Deprecation.warn <<~WARN
+            Passing html_options to `render_essence_editor` is deprecated and will be removed in Alchemy 5.0 without replacement.
+          WARN
+        end
         render_essence(content, :editor, {for_editor: options}, html_options)
       end
+      deprecate :render_essence_editor, deprecator: Alchemy::Deprecation
 
       # Renders the Content editor partial found in views/contents/ for the content with name inside the passed Element.
       # For options see -> render_essence
@@ -18,7 +32,7 @@ module Alchemy
       # Content creation on the fly:
       #
       # If you update the elements.yml file after creating an element this helper displays a error message with an option to create the content.
-      #
+      # @deprecated
       def render_essence_editor_by_name(element, name, options = {}, html_options = {})
         if element.blank?
           return warning('Element is nil', Alchemy.t(:no_element_given))
@@ -30,6 +44,7 @@ module Alchemy
           render_essence_editor(content, options, html_options)
         end
       end
+      deprecate :render_essence_editor_by_name, deprecator: Alchemy::Deprecation
 
       # Returns all public pages from current language as an option tags string suitable or the Rails +select_tag+ helper.
       #
@@ -41,7 +56,7 @@ module Alchemy
       #   Used as prompt message in the select tag
       # @param [Symbol]
       #   Method that is called on the page object to get the value that is passed with the params of the form.
-      #
+      # @deprecated
       def pages_for_select(pages = nil, selected = nil, prompt = "Choose page", page_attribute = :id)
         values = [[Alchemy.t(prompt), ""]]
         pages ||= begin
@@ -51,12 +66,14 @@ module Alchemy
         values += pages_attributes_for_select(pages, page_attribute, nested)
         options_for_select(values, selected.to_s)
       end
+      deprecate :pages_for_select, deprecator: Alchemy::Deprecation
 
       # Renders the missing content partial
-      #
+      # @deprecated
       def render_missing_content(element, name, options)
         render 'alchemy/admin/contents/missing', {element: element, name: name, options: options}
       end
+      deprecate :render_missing_content, deprecator: Alchemy::Deprecation
 
       # Renders a thumbnail for given EssencePicture content with correct cropping and size
       def essence_picture_thumbnail(content, options = {})
@@ -101,6 +118,7 @@ module Alchemy
           ]
         end
       end
+      deprecate :pages_attributes_for_select, deprecator: Alchemy::Deprecation
 
       # Returns the page name for pages_for_select helper
       #
@@ -111,11 +129,12 @@ module Alchemy
       #
       def page_name_attribute_for_select(page, indent = false)
         if indent
-          ("&nbsp;&nbsp;" * (page.level - 1) + page.name).html_safe
+          ("&nbsp;&nbsp;" * (page.depth - 1) + page.name).html_safe
         else
           page.name
         end
       end
+      deprecate :page_name_attribute_for_select, deprecator: Alchemy::Deprecation
     end
   end
 end

data/app/helpers/alchemy/elements_block_helper.rb

@@ -26,8 +26,15 @@ module Alchemy
     class ElementViewHelper < BlockHelper
       # Renders one of the element's contents.
       #
-      def render(name, *args)
-        helpers.render_essence_view_by_name(element, name.to_s, *args)
+      def render(name, options = {}, html_options = {})
+        content = element.content_by_name(name)
+        return if content.nil?
+
+        helpers.render(content, {
+          content: content,
+          options: options,
+          html_options: html_options
+        })
       end
 
       # Returns one of the element's contents (ie. essence instances).
@@ -56,11 +63,12 @@ module Alchemy
     end
 
     # Block-level helper class for element editors.
-    #
+    # @deprecated
     class ElementEditorHelper < BlockHelper
       def edit(name, *args)
         helpers.render_essence_editor_by_name(element, name.to_s, *args)
       end
+      deprecate :edit, deprecator: Alchemy::Deprecation
     end
 
     # Block-level helper for element views. Constructs a DOM element wrapping

data/app/helpers/alchemy/elements_helper.rb

@@ -123,7 +123,7 @@ module Alchemy
     #
     # == View partial naming
     #
-    # The partial has to be named after the name of the element as defined in the <tt>elements.yml</tt> file and has to be suffixed with <tt>_view</tt>.
+    # The partial has to be named after the name of the element as defined in the <tt>elements.yml</tt> file.
     #
     # === Example
     #
@@ -137,7 +137,7 @@ module Alchemy
     #
     # Then your element view partial has to be named like:
     #
-    #   app/views/alchemy/elements/_headline_view.html.{erb|haml|slim}
+    #   app/views/alchemy/elements/_headline.html.{erb|haml|slim}
     #
     # === Element partials generator
     #
@@ -147,7 +147,7 @@ module Alchemy
     #
     # == Usage
     #
-    #   <%= render_element(Alchemy::Element.published.named(:headline).first) %>
+    #   <%= render_element(Alchemy::Element.available.named(:headline).first) %>
     #
     # @param [Alchemy::Element] element
     #   The element you want to render the view for

data/app/helpers/alchemy/essences_helper.rb

@@ -27,6 +27,7 @@ module Alchemy
   #
   # And the +render_essence_editor_by_name+ helper for Alchemy backend views.
   #
+  # @deprecated Use Rails' `render(content)` method directly instead
   module EssencesHelper
     # Renders the +Essence+ view partial from +Element+ by name.
     #
@@ -38,14 +39,22 @@ module Alchemy
     #
     #   <%= render_essence_view_by_name(element, "intro") %>
     #
+    # @deprecated Use Rails' `render(content)` method directly instead
     def render_essence_view_by_name(element, name, options = {}, html_options = {})
       if element.blank?
-        warning('Element is nil')
-        return ""
+        warning('Element is nil') && return
       end
       content = element.content_by_name(name)
-      render_essence_view(content, options, html_options)
+      return if content.nil?
+
+      render content, {
+        content: content,
+        options: options,
+        html_options: html_options
+      }
     end
+    deprecate render_essence_view_by_name: "Use Rails' `render(content)` method directly instead",
+      deprecator: Alchemy::Deprecation
 
     # Renders the +Esssence+ partial for given +Content+.
     #
@@ -62,6 +71,7 @@ module Alchemy
     #   for_view: {}
     #   for_editor: {}
     #
+    # @deprecated Use Rails' `render(content)` method directly instead
     def render_essence(content, part = :view, options = {}, html_options = {})
       options = {for_view: {}, for_editor: {}}.update(options)
       if content.nil?
@@ -69,12 +79,22 @@ module Alchemy
       elsif content.essence.nil?
         return part == :view ? "" : warning('Essence is nil', Alchemy.t(:content_essence_not_found))
       end
-      render partial: "alchemy/essences/#{content.essence_partial_name}_#{part}", locals: {
-        content: content,
-        options: options["for_#{part}".to_sym],
-        html_options: html_options
-      }
+      if part == :view
+        render content, {
+          content: content,
+          options: options[:for_view],
+          html_options: html_options
+        }
+      else
+        render "alchemy/essences/#{content.essence_partial_name}_editor", {
+          content: content,
+          options: options,
+          html_options: html_options
+        }
+      end
     end
+    deprecate render_essence: "Use Rails' `render(content)` method directly instead",
+      deprecator: Alchemy::Deprecation
 
     # Renders the +Esssence+ view partial for given +Content+.
     #
@@ -85,8 +105,15 @@ module Alchemy
     #   :show_caption => false                         # Pass Boolean to show/hide the caption of an EssencePicture. [Default true]
     #   :disable_link => true                          # You can surpress the link of an EssencePicture. Default false
     #
+    # @deprecated Use Rails' `render(content)` method directly instead
     def render_essence_view(content, options = {}, html_options = {})
-      render_essence(content, :view, {for_view: options}, html_options)
+      render content, {
+        content: content,
+        options: options,
+        html_options: html_options
+      }
     end
+    deprecate render_essence_view: "Use Rails' `render(content)` method directly instead",
+      deprecator: Alchemy::Deprecation
   end
 end

data/app/helpers/alchemy/pages_helper.rb

@@ -73,6 +73,7 @@ module Alchemy
     end
 
     # Renders the navigation.
+    # @deprecated
     #
     # It produces a html <ul><li></li></ul> structure with all necessary classes so you can produce every navigation the web uses today.
     # I.E. dropdown-navigations, simple mainnavigations or even complex nested ones.
@@ -177,6 +178,33 @@ module Alchemy
         pages: pages,
         html_options: html_options
     end
+    deprecate render_navigation: 'Create a menu and use render_menu instead', deprecator: Alchemy::Deprecation
+
+    # Renders a menu partial
+    #
+    # Menu partials are placed in the `app/views/alchemy/menus` folder
+    # Use the `rails g alchemy:menus` generator to create the partials
+    #
+    # @param [String] - Name of the menu
+    # @param [Hash] - A set of options available in your menu partials
+    def render_menu(name, options = {})
+      root_node = Alchemy::Node.roots.find_by(name: name)
+      if root_node.nil?
+        warning("Menu with name #{name} not found!")
+        return
+      end
+
+      options = {
+        node_partial_name: "#{root_node.view_folder_name}/node"
+      }.merge(options)
+
+      render(root_node, menu: root_node, node: root_node, options: options)
+    rescue ActionView::MissingTemplate => e
+      warning <<~WARN
+        Menu partial not found for #{name}.
+        #{e}
+      WARN
+    end
 
     # Renders navigation the children and all siblings of the given page (standard is the current page).
     #
@@ -206,6 +234,7 @@ module Alchemy
         return nil
       end
     end
+    deprecate :render_subnavigation, deprecator: Alchemy::Deprecation
 
     # Returns true if page is in the active branch
     def page_active?(page)

data/app/models/alchemy/content.rb

@@ -24,7 +24,7 @@ module Alchemy
     # Concerns
     include Alchemy::Content::Factory
 
-    belongs_to :essence, polymorphic: true, dependent: :destroy
+    belongs_to :essence, polymorphic: true, dependent: :destroy, inverse_of: :content
     belongs_to :element, touch: true, inverse_of: :contents
     has_one :page, through: :element
 

data/app/models/alchemy/element.rb

@@ -33,7 +33,8 @@ module Alchemy
       "contents",
       "hint",
       "taggable",
-      "compact"
+      "compact",
+      "message"
     ].freeze
 
     SKIPPED_ATTRIBUTES_ON_COPY = [
@@ -61,10 +62,10 @@ module Alchemy
 
     # Content positions are scoped by their essence_type, so positions can be the same for different contents.
     # In order to get contents in creation order we also order them by id.
-    has_many :contents, -> { order(:position, :id) }, dependent: :destroy
+    has_many :contents, -> { order(:position, :id) }, dependent: :destroy, inverse_of: :element
 
     has_many :all_nested_elements,
-      -> { order(:position) },
+      -> { order(:position).not_trashed },
       class_name: 'Alchemy::Element',
       foreign_key: :parent_element_id,
       dependent: :destroy
@@ -73,15 +74,17 @@ module Alchemy
       -> { order(:position).available },
       class_name: 'Alchemy::Element',
       foreign_key: :parent_element_id,
-      dependent: :destroy
+      dependent: :destroy,
+      inverse_of: :parent_element
 
-    belongs_to :page, touch: true, inverse_of: :all_elements
+    belongs_to :page, touch: true, inverse_of: :elements
 
     # A nested element belongs to a parent element.
     belongs_to :parent_element,
       class_name: 'Alchemy::Element',
       optional: true,
-      touch: true
+      touch: true,
+      inverse_of: :nested_elements
 
     has_and_belongs_to_many :touchable_pages, -> { distinct },
       class_name: 'Alchemy::Page',
@@ -216,7 +219,6 @@ module Alchemy
       return true if page.nil?
       unless touchable_pages.include? page
         touchable_pages << page
-        save
       end
     end
 
@@ -261,7 +263,17 @@ module Alchemy
     # Element partials live in +app/views/alchemy/elements+
     #
     def to_partial_path
-      "alchemy/elements/#{name}_view"
+      if Alchemy::LOOKUP_CONTEXT.exists?("#{name}_view", ["elements"], true)
+        Alchemy::Deprecation.warn <<~WARN
+          Having the `_view` suffix on your element view partials is deprecated
+          and will not be supported in Alchemy 5.0 anymore. You can safely remove the suffix now.
+
+          Please also rename the local `element` or `#{name}_view` variable into `#{name}`.
+        WARN
+        "alchemy/elements/#{name}_view"
+      else
+        "alchemy/elements/#{name}"
+      end
     end
 
     # Returns the key that's taken for cache path.

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

@@ -16,13 +16,15 @@ module Alchemy
 
     # All contents from element by given name.
     def contents_by_name(name)
-      contents.where(name: name)
+      contents.select { |content| content.name == name.to_s }
     end
     alias_method :all_contents_by_name, :contents_by_name
 
     # All contents from element by given essence type.
     def contents_by_type(essence_type)
-      contents.where(essence_type: Content.normalize_essence_type(essence_type))
+      contents.select do |content|
+        content.essence_type == Content.normalize_essence_type(essence_type)
+      end
     end
     alias_method :all_contents_by_type, :contents_by_type
 
@@ -99,7 +101,7 @@ module Alchemy
         log_warning "Element #{name} is missing the content definition for #{content_name}"
         nil
       else
-        content_definitions.detect { |d| d['name'] == content_name }
+        content_definitions.detect { |d| d['name'] == content_name.to_s }
       end
     end
 
@@ -134,7 +136,7 @@ module Alchemy
     def content_for_rss_meta(type)
       definition = content_definitions.detect { |c| c["rss_#{type}"] }
       return if definition.blank?
-      contents.find_by(name: definition['name'])
+      contents.detect { |content| content.name == definition['name'] }
     end
 
     # creates the contents for this element as described in the elements.yml

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

@@ -96,8 +96,8 @@ module Alchemy
     private
 
     def preview_text_from_nested_elements(maxlength)
-      return unless nested_elements.present?
-      nested_elements.first.preview_text(maxlength)
+      return if all_nested_elements.empty?
+      all_nested_elements.first.preview_text(maxlength)
     end
 
     def preview_text_from_preview_content(maxlength)

data/app/models/alchemy/essence_page.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class EssencePage < BaseRecord
+    PAGE_ID = /\A\d+\z/
+
+    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
+      }
+    )
+
+    def ingredient=(page)
+      case page
+      when PAGE_ID
+        self.page = Alchemy::Page.new(id: page)
+      when Alchemy::Page
+        self.page = page
+      else
+        super
+      end
+    end
+  end
+end