alchemy_cms 4.4.3 → 5.0.0.beta1

data/app/decorators/alchemy/element_editor.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class ElementEditor < SimpleDelegator
+    alias_method :element, :__getobj__
+
+    def to_partial_path
+      "alchemy/admin/elements/element"
+    end
+
+    # CSS classes for the element editor partial.
+    def css_classes
+      [
+        "element-editor",
+        content_definitions.present? ? "with-contents" : "without-contents",
+        nestable_elements.any? ? "nestable" : "not-nestable",
+        taggable? ? "taggable" : "not-taggable",
+        folded ? "folded" : "expanded",
+        compact? ? "compact" : nil,
+        fixed? ? "is-fixed" : "not-fixed",
+      ].join(" ")
+    end
+
+    # Tells us, if we should show the element footer and form inputs.
+    def editable?
+      return false if folded?
+
+      content_definitions.present? || taggable?
+    end
+
+    # Fixes Rails partial renderer calling to_model on the object
+    # which reveals the delegated element instead of this decorator.
+    def respond_to?(method_name)
+      return false if method_name == :to_model
+
+      super
+    end
+  end
+end

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

@@ -6,17 +6,17 @@ module Alchemy
       include Alchemy::Admin::BaseHelper
 
       def mime_to_human(mime)
-        Alchemy.t(mime, scope: 'mime_types', default: Alchemy.t(:document))
+        Alchemy.t(mime, scope: "mime_types", default: Alchemy.t(:document))
       end
 
       def attachment_preview_size(attachment)
         case attachment.icon_css_class
-        when 'image' then '600x475'
-        when 'audio' then '600x190'
-        when 'video' then '600x485'
-        when 'pdf'   then '600x500'
+        when "image" then "600x475"
+        when "audio" then "600x190"
+        when "video" then "600x485"
+        when "pdf"   then "600x500"
         else
-          '600x145'
+          "600x145"
         end
       end
     end

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

@@ -23,7 +23,7 @@ module Alchemy
       def current_alchemy_user_name
         name = current_alchemy_user.try(:alchemy_display_name)
         if name.present?
-          content_tag :span, "#{Alchemy.t('Logged in as')} #{name}", class: 'current-user-name'
+          content_tag :span, "#{Alchemy.t("Logged in as")} #{name}", class: "current-user-name"
         end
       end
 
@@ -55,7 +55,7 @@ module Alchemy
         default_options = {modal: true}
         options = default_options.merge(options)
         link_to content, url,
-          html_options.merge('data-alchemy-dialog' => options.to_json)
+          html_options.merge("data-alchemy-dialog" => options.to_json)
       end
 
       # Used for translations selector in Alchemy cockpit user settings.
@@ -99,13 +99,13 @@ module Alchemy
       #
       def js_filter_field(items, options = {})
         options = {
-          class: 'js_filter_field',
-          data: {'alchemy-list-filter' => items}
+          class: "js_filter_field",
+          data: {"alchemy-list-filter" => items},
         }.merge(options)
-        content_tag(:div, class: 'js_filter_field_box') do
+        content_tag(:div, class: "js_filter_field_box") do
           concat text_field_tag(nil, nil, options)
           concat render_icon(:search)
-          concat link_to(render_icon(:times, size: 'xs'), '', class: 'js_filter_field_clear', title: Alchemy.t(:click_to_show_all))
+          concat link_to(render_icon(:times, size: "xs"), "", class: "js_filter_field_clear", title: Alchemy.t(:click_to_show_all))
         end
       end
 
@@ -136,12 +136,12 @@ module Alchemy
       def link_to_confirm_dialog(link_string = "", message = "", url = "", html_options = {})
         link_to(link_string, url,
           html_options.merge(
-            'data-alchemy-confirm-delete' => {
+            "data-alchemy-confirm-delete" => {
               title: Alchemy.t(:please_confirm),
               message: message,
               ok_label: Alchemy.t("Yes"),
-              cancel_label: Alchemy.t("No")
-            }.to_json
+              cancel_label: Alchemy.t("No"),
+            }.to_json,
           )
         )
       end
@@ -170,10 +170,10 @@ module Alchemy
           message: Alchemy.t(:confirm_to_proceed),
           ok_label: Alchemy.t("Yes"),
           title: Alchemy.t(:please_confirm),
-          cancel_label: Alchemy.t("No")
+          cancel_label: Alchemy.t("No"),
         }.merge(options)
-        form_tag url, {method: html_options.delete(:method), class: 'button-with-confirm'} do
-          button_tag value, html_options.merge('data-alchemy-confirm' => options.to_json)
+        form_tag url, {method: html_options.delete(:method), class: "button-with-confirm"} do
+          button_tag value, html_options.merge("data-alchemy-confirm" => options.to_json)
         end
       end
 
@@ -188,18 +188,18 @@ module Alchemy
       #
       def delete_button(url, options = {}, html_options = {})
         options = {
-          title: Alchemy.t('Delete'),
-          message: Alchemy.t('Are you sure?'),
-          icon: :minus
+          title: Alchemy.t("Delete"),
+          message: Alchemy.t("Are you sure?"),
+          icon: :minus,
         }.merge(options)
         button_with_confirm(
           render_icon(options[:icon]),
           url, {
-            message: options[:message]
+            message: options[:message],
           }, {
-            method: 'delete',
+            method: "delete",
             title: options[:title],
-            class: "icon_button #{html_options.delete(:class)}".strip
+            class: "icon_button #{html_options.delete(:class)}".strip,
           }.merge(html_options)
         )
       end
@@ -259,11 +259,11 @@ module Alchemy
           active: false,
           link_options: {},
           dialog_options: {},
-          loading_indicator: false
+          loading_indicator: false,
         }.merge(options.symbolize_keys)
         button = render(
-          'alchemy/admin/partials/toolbar_button',
-          options: options
+          "alchemy/admin/partials/toolbar_button",
+          options: options,
         )
         if options[:skip_permission_check] || can?(*permission_from_options(options))
           button
@@ -302,13 +302,13 @@ module Alchemy
       def toolbar(options = {})
         defaults = {
           buttons: [],
-          search: true
+          search: true,
         }
         options = defaults.merge(options)
         content_for(:toolbar) do
           content = <<-CONTENT.strip_heredoc
             #{options[:buttons].map { |button_options| toolbar_button(button_options) }.join}
-            #{render('alchemy/admin/partials/search_form', url: options[:search_url]) if options[:search]}
+            #{render("alchemy/admin/partials/search_form", url: options[:search_url]) if options[:search]}
           CONTENT
           content.html_safe
         end
@@ -360,7 +360,7 @@ module Alchemy
       #   The value the input displays. If you pass a String its parsed with +Time.parse+
       #
       def alchemy_datepicker(object, method, html_options = {})
-        type = html_options.delete(:type) || 'date'
+        type = html_options.delete(:type) || "date"
         date = html_options.delete(:value) || object.send(method.to_sym).presence
         date = Time.zone.parse(date) if date.is_a?(String)
         value = date ? date.iso8601 : nil
@@ -373,9 +373,10 @@ module Alchemy
       # The model class needs to include the hints module
       def render_hint_for(element)
         return unless element.has_hint?
-        content_tag :span, class: 'hint-with-icon' do
-          render_icon('question-circle') +
-            content_tag(:span, element.hint.html_safe, class: 'hint-bubble')
+
+        content_tag :span, class: "hint-with-icon" do
+          render_icon("question-circle") +
+            content_tag(:span, element.hint.html_safe, class: "hint-bubble")
         end
       end
 
@@ -385,7 +386,7 @@ module Alchemy
           controller_name,
           action_name,
           content_for(:main_menu_style),
-          content_for(:alchemy_body_class)
+          content_for(:alchemy_body_class),
         ].compact
       end
 
@@ -404,7 +405,7 @@ module Alchemy
 
       # Returns the regular expression used for external url validation in link dialog.
       def link_url_regexp
-        Alchemy::Config.get(:format_matchers)['link_url'] || /^(mailto:|\/|[a-z]+:\/\/)/
+        Alchemy::Config.get(:format_matchers)["link_url"] || /^(mailto:|\/|[a-z]+:\/\/)/
       end
 
       # Renders a hint with tooltip
@@ -417,9 +418,9 @@ module Alchemy
       # @param icon: 'exclamation-triangle' [String] - Icon name
       #
       # @return [String]
-      def hint_with_tooltip(text, icon: 'exclamation-triangle')
-        content_tag :span, class: 'hint-with-icon' do
-          render_icon(icon) + content_tag(:span, text, class: 'hint-bubble')
+      def hint_with_tooltip(text, icon: "exclamation-triangle")
+        content_tag :span, class: "hint-with-icon" do
+          render_icon(icon) + content_tag(:span, text, class: "hint-bubble")
         end
       end
 
@@ -427,7 +428,7 @@ module Alchemy
       # that explains the user that the page layout is missing
       def page_layout_missing_warning
         hint_with_tooltip(
-          Alchemy.t(:page_definition_missing)
+          Alchemy.t(:page_definition_missing),
         )
       end
 
@@ -442,10 +443,10 @@ module Alchemy
       end
 
       def permission_array_from_url(options)
-        action_controller = options[:url].gsub(/\A\//, '').split('/')
+        action_controller = options[:url].gsub(/\A\//, "").split("/")
         [
           action_controller.last.to_sym,
-          action_controller[0..action_controller.length - 2].join('_').to_sym
+          action_controller[0..action_controller.length - 2].join("_").to_sym,
         ]
       end
     end

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

@@ -13,7 +13,7 @@ module Alchemy
       #
       def render_content_name(content)
         if content.blank?
-          warning('Content is nil')
+          warning("Content is nil")
           return
         end
 
@@ -23,7 +23,7 @@ module Alchemy
           warning("Content #{content.name} is missing its definition")
 
           icon = hint_with_tooltip(
-            Alchemy.t(:content_definition_missing)
+            Alchemy.t(:content_definition_missing),
           )
 
           content_name = "#{icon} #{content_name}".html_safe
@@ -39,7 +39,7 @@ module Alchemy
       # Renders the label and a remove link for a content.
       def content_label(content)
         content_tag :label, for: content.form_field_id do
-          [render_hint_for(content), render_content_name(content)].compact.join(' ').html_safe
+          [render_hint_for(content), render_content_name(content)].compact.join(" ").html_safe
         end
       end
     end

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

@@ -3,76 +3,9 @@
 module Alchemy
   module Admin
     module ElementsHelper
-      include Alchemy::ElementsBlockHelper
-      include Alchemy::Admin::BaseHelper
       include Alchemy::Admin::ContentsHelper
       include Alchemy::Admin::EssencesHelper
 
-      # Renders a {Alchemy::Element} editor partial.
-      #
-      # A element editor partial is the form presented to the content author in page edit mode.
-      #
-      # The partial is located in <tt>app/views/alchemy/elements</tt>.
-      #
-      # == Partial naming
-      #
-      # The partials have 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>_editor</tt>.
-      #
-      # === Example
-      #
-      # Given a headline element
-      #
-      #   # elements.yml
-      #   - name: headline
-      #     contents:
-      #     - name: text
-      #       type: EssenceText
-      #
-      # Then your element editor partial has to be named:
-      #
-      #   app/views/alchemy/elements/_headline_editor.html.{erb|haml|slim}
-      #
-      # === Element partials generator
-      #
-      # You can use this handy generator to let Alchemy generate the partials for you:
-      #
-      #   $ rails generate alchemy:elements --skip
-      #
-      # == Usage
-      #
-      #   <%= render_editor(Alchemy::Element.published.named(:headline).first) %>
-      #
-      # @param [Alchemy::Element] element
-      #   The element you want to render the editor for
-      #
-      # @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
-        warning(%(
-          Element editor partial not found for #{element.name}.\n
-          #{e}
-        ))
-        render "alchemy/elements/editor_not_found", {
-          name: element.name,
-          error: "Element editor partial not found.<br>Use <code>rails generate alchemy:elements</code> to generate it."
-        }
-      end
-
       # Returns an elements array for select helper.
       #
       # @param [Array] elements definitions
@@ -80,32 +13,14 @@ module Alchemy
       #
       def elements_for_select(elements)
         return [] if elements.nil?
+
         elements.collect do |e|
           [
-            Element.display_name_for(e['name']),
-            e['name']
+            Element.display_name_for(e["name"]),
+            e["name"],
           ]
         end
       end
-
-      # CSS classes for the element editor partial.
-      def element_editor_classes(element)
-        [
-          'element-editor',
-          element.content_definitions.present? ? 'with-contents' : 'without-contents',
-          element.nestable_elements.any? ? 'nestable' : 'not-nestable',
-          element.taggable? ? 'taggable' : 'not-taggable',
-          element.folded ? 'folded' : 'expanded',
-          element.compact? ? 'compact' : nil,
-          element.fixed? ? 'is-fixed' : 'not-fixed'
-        ].join(' ')
-      end
-
-      # Tells us, if we should show the element footer and form inputs.
-      def element_editable?(element)
-        return false if element.folded?
-        element.content_definitions.present? || element.taggable?
-      end
     end
   end
 end

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

@@ -3,138 +3,29 @@
 module Alchemy
   module Admin
     module EssencesHelper
-      include Alchemy::EssencesHelper
-      include Alchemy::Admin::ContentsHelper
-
-      # 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
-      #
-      # 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))
-        end
-        content = element.content_by_name(name)
-        if content.nil?
-          render_missing_content(element, name, options)
-        else
-          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.
-      #
-      # @param [Array]
-      #   A collection of pages so it only returns these pages and does not query the database.
-      # @param [String]
-      #   Pass a +Page#name+ or +Page#id+ as selected item to the +options_for_select+ helper.
-      # @param [String]
-      #   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
-          nested = true
-          Language.current.pages.published.order(:lft)
-        end
-        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 = {})
+      def essence_picture_thumbnail(content)
         picture = content.ingredient
         essence = content.essence
 
         return if picture.nil?
 
         image_tag(
-          essence.thumbnail_url(options),
+          essence.thumbnail_url,
           alt: picture.name,
-          class: 'img_paddingtop',
-          title: Alchemy.t(:image_name) + ": #{picture.name}"
+          class: "img_paddingtop",
+          title: Alchemy.t(:image_name) + ": #{picture.name}",
         )
       end
 
       # Size value for edit picture dialog
-      def edit_picture_dialog_size(content, options = {})
-        if content.settings_value(:caption_as_textarea, options)
-          content.settings_value(:sizes, options) ? '380x320' : '380x300'
-        else
-          content.settings_value(:sizes, options) ? '380x290' : '380x255'
-        end
-      end
-
-      private
-
-      # Returns an Array with page attributes for select options
-      #
-      # @param [Array]
-      #   The pages
-      # @param [String || Symbol]
-      #   The attribute that is used as value
-      # @param [Boolean] (false)
-      #   Should the name be indented or not
-      #
-      def pages_attributes_for_select(pages, page_attribute, indent = false)
-        pages.map do |page|
-          [
-            page_name_attribute_for_select(page, indent),
-            page.send(page_attribute).to_s
-          ]
-        end
-      end
-      deprecate :pages_attributes_for_select, deprecator: Alchemy::Deprecation
-
-      # Returns the page name for pages_for_select helper
-      #
-      # @param [Alchemy::Page]
-      #   The page
-      # @param [Boolean] (false)
-      #   Should the page be indented or not
-      #
-      def page_name_attribute_for_select(page, indent = false)
-        if indent
-          ("&nbsp;&nbsp;" * (page.depth - 1) + page.name).html_safe
+      def edit_picture_dialog_size(content)
+        if content.settings[:caption_as_textarea]
+          content.settings[:sizes] ? "380x320" : "380x300"
         else
-          page.name
+          content.settings[:sizes] ? "380x290" : "380x255"
         end
       end
-      deprecate :page_name_attribute_for_select, deprecator: Alchemy::Deprecation
     end
   end
 end