alchemy_cms 4.6.1 → 5.0.0

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

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

@@ -19,7 +19,7 @@ module Alchemy
         options[:remote] = request.xhr?
         options[:html] = {
           id: options.delete(:id),
-          class: ["alchemy", options.delete(:class)].compact.join(' ')
+          class: ["alchemy", options.delete(:class)].compact.join(" "),
         }
         simple_form_for(object, *(args << options), &block)
       end

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

@@ -12,9 +12,9 @@ module Alchemy
       #
       def alchemy_main_navigation_entry(alchemy_module)
         render(
-          'alchemy/admin/partials/main_navigation_entry',
+          "alchemy/admin/partials/main_navigation_entry",
           alchemy_module: alchemy_module,
-          navigation: alchemy_module['navigation']
+          navigation: alchemy_module["navigation"],
         )
       end
 
@@ -36,8 +36,8 @@ module Alchemy
       #
       def navigate_module(navigation)
         [
-          navigation['action'].to_sym,
-          navigation['controller'].to_s.gsub(/\A\//, '').gsub(/\//, '_').to_sym
+          navigation["action"].to_sym,
+          navigation["controller"].to_s.gsub(/\A\//, "").gsub(/\//, "_").to_sym,
         ]
       end
 
@@ -45,9 +45,9 @@ module Alchemy
       #
       def main_navigation_css_classes(navigation)
         [
-          'main_navi_entry',
-          admin_mainnavi_active?(navigation) ? 'active' : nil,
-          navigation.key?('sub_navigation') ? 'has_sub_navigation' : nil
+          "main_navi_entry",
+          admin_mainnavi_active?(navigation) ? "active" : nil,
+          navigation.key?("sub_navigation") ? "has_sub_navigation" : nil,
         ].compact
       end
 
@@ -74,8 +74,8 @@ module Alchemy
       #
       def url_for_module(alchemy_module)
         route_from_engine_or_main_app(
-          alchemy_module['engine_name'],
-          url_options_for_module(alchemy_module)
+          alchemy_module["engine_name"],
+          url_options_for_module(alchemy_module),
         )
       end
 
@@ -91,9 +91,10 @@ module Alchemy
       def url_for_module_sub_navigation(navigation)
         alchemy_module = module_definition_for(navigation)
         return if alchemy_module.nil?
+
         route_from_engine_or_main_app(
-          alchemy_module['engine_name'],
-          url_options_for_navigation_entry(navigation)
+          alchemy_module["engine_name"],
+          url_options_for_navigation_entry(navigation),
         )
       end
 
@@ -105,13 +106,13 @@ module Alchemy
         sorted = []
         not_sorted = []
         alchemy_modules.map do |m|
-          if m['position'].blank?
+          if m["position"].blank?
             not_sorted << m
           else
             sorted << m
           end
         end
-        sorted.sort_by { |m| m['position'] } + not_sorted
+        sorted.sort_by { |m| m["position"] } + not_sorted
       end
 
       private
@@ -137,7 +138,7 @@ module Alchemy
       #   A Alchemy module definition
       #
       def url_options_for_module(alchemy_module)
-        url_options_for_navigation_entry(alchemy_module['navigation'] || {})
+        url_options_for_navigation_entry(alchemy_module["navigation"] || {})
       end
 
       # Returns a url options hash for given navigation entry.
@@ -147,26 +148,26 @@ module Alchemy
       #
       def url_options_for_navigation_entry(entry)
         {
-          controller: entry['controller'],
-          action: entry['action'],
+          controller: entry["controller"],
+          action: entry["action"],
           only_path: true,
-          params: entry['params']
+          params: entry["params"],
         }.delete_if { |_k, v| v.nil? }
       end
 
       # Retrieves the current Alchemy module from controller and index action.
       #
       def current_alchemy_module
-        module_definition_for(controller: params[:controller], action: 'index')
+        module_definition_for(controller: params[:controller], action: "index")
       end
 
       # Returns true if the current controller and action is in a modules navigation definition.
       #
       def admin_mainnavi_active?(navigation)
         # Has the given navigation entry a active sub navigation?
-        has_active_entry?(navigation['sub_navigation'] || []) ||
+        has_active_entry?(navigation["sub_navigation"] || []) ||
           # Has the given navigation entry a active nested navigation?
-          has_active_entry?(navigation['nested'] || []) ||
+          has_active_entry?(navigation["nested"] || []) ||
           # Is the navigation entry active?
           entry_active?(navigation || {})
       end
@@ -174,7 +175,7 @@ module Alchemy
       # Returns true if the given entry's controller is current controller
       #
       def is_entry_controller_active?(entry)
-        entry['controller'].gsub(/\A\//, '') == params[:controller]
+        entry["controller"].gsub(/\A\//, "") == params[:controller]
       end
 
       # Returns true if the given entry's action is current controllers action
@@ -182,8 +183,8 @@ module Alchemy
       # Also checks if given entry has a +nested_actions+ key, if so it checks if one of them is current controller's action
       #
       def is_entry_action_active?(entry)
-        entry['action'] == params[:action] ||
-          entry.fetch('nested_actions', []).include?(params[:action])
+        entry["action"] == params[:action] ||
+          entry.fetch("nested_actions", []).include?(params[:action])
       end
 
       # Returns true if an entry of given entries is active.

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

@@ -34,8 +34,8 @@ module Alchemy
         end
       end
 
-      def page_status_checkbox(page, attribute, label: nil)
-        label_text = label || page.class.human_attribute_name(attribute)
+      def page_status_checkbox(page, attribute)
+        label = page.class.human_attribute_name(attribute)
 
         if page.attribute_fixed?(attribute)
           checkbox = check_box(:page, attribute, disabled: true)
@@ -43,11 +43,11 @@ module Alchemy
             Alchemy.t(:attribute_fixed, attribute: attribute)
           end
           content = content_tag(:span, class: "with-hint") do
-            "#{checkbox}\n#{label_text}\n#{hint}".html_safe
+            "#{checkbox}\n#{label}\n#{hint}".html_safe
           end
         else
           checkbox = check_box(:page, attribute)
-          content = "#{checkbox}\n#{label_text}".html_safe
+          content = "#{checkbox}\n#{label}".html_safe
         end
 
         content_tag(:label, class: "checkbox") { content }