alchemy_cms 4.6.1 → 5.0.0

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

@@ -4,12 +4,10 @@ module Alchemy
   module Admin
     module PicturesHelper
       def preview_size(size)
-        case size
-        when 'small' then '80x60'
-        when 'large' then '240x180'
-        else
-          '160x120'
-        end
+        Alchemy::Picture::THUMBNAIL_SIZES.fetch(
+          size,
+          Alchemy::Picture::THUMBNAIL_SIZES[:medium]
+        )
       end
     end
   end

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

@@ -12,17 +12,18 @@ module Alchemy
       #   A HTML string containing <tt><li></tt> tags
       #
       def render_tag_list(class_name)
-        raise ArgumentError, 'Please provide a String as class_name' if class_name.nil?
+        raise ArgumentError, "Please provide a String as class_name" if class_name.nil?
+
         sorted_tags_from(class_name: class_name).map do |tag|
-          content_tag('li', name: tag.name, class: filtered_by_tag?(tag) ? 'active' : nil) do
+          content_tag("li", name: tag.name, class: filtered_by_tag?(tag) ? "active" : nil) do
             link_to(
               "#{tag.name} (#{tag.taggings_count})",
               url_for(
                 search_filter_params.except(:page, :tagged_with).merge(
-                  tagged_with: tags_for_filter(current: tag).presence
-                )
+                  tagged_with: tags_for_filter(current: tag).presence,
+                ),
               ),
-              remote: request.xhr?
+              remote: request.xhr?,
             )
           end
         end.join.html_safe
@@ -43,13 +44,13 @@ module Alchemy
           tags_from_params - Array(current.name)
         else
           tags_from_params.push(current.name)
-        end.uniq.join(',')
+        end.uniq.join(",")
       end
 
       # Returns tags from params
       # @returns [Array]
       def tags_from_params
-        search_filter_params[:tagged_with].to_s.split(',')
+        search_filter_params[:tagged_with].to_s.split(",")
       end
 
       def sorted_tags_from(class_name:)

data/app/helpers/alchemy/base_helper.rb

@@ -27,16 +27,16 @@ module Alchemy
     #
     # @return [String]
     def render_icon(icon_class, options = {})
-      options = {style: 'solid'}.merge(options)
+      options = {style: "solid"}.merge(options)
       classes = [
         "icon fa-fw",
         "fa-#{icon_class}",
         "fa#{options[:style].first}",
         options[:size] ? "fa-#{options[:size]}" : nil,
         options[:transform] ? "fa-#{options[:transform]}" : nil,
-        options[:class]
+        options[:class],
       ].compact
-      content_tag('i', nil, class: classes)
+      content_tag("i", nil, class: classes)
     end
 
     # Returns a div with an icon and the passed content
@@ -64,19 +64,24 @@ module Alchemy
     # @param [Symbol] style The style of this flash. Valid values are +:notice+ (default), +:warn+ and +:error+
     #
     def render_flash_notice(notice, style = :notice)
-      render('alchemy/admin/partials/flash', flash_type: style, message: notice)
+      render("alchemy/admin/partials/flash", flash_type: style, message: notice)
     end
 
     # Checks if the given argument is a String or a Page object.
     # If a String is given, it tries to find the page via page_layout
     # Logs a warning if no page is given.
     def page_or_find(page)
+      unless Language.current
+        warning("No default language set up")
+        return nil
+      end
+
       if page.is_a?(String)
         page = Language.current.pages.find_by(page_layout: page)
       end
       if page.blank?
         warning("No Page found for #{page.inspect}")
-        return
+        nil
       else
         page
       end
@@ -88,9 +93,9 @@ module Alchemy
     # @return [String] The FontAwesome icon name
     def message_icon_class(message_type)
       case message_type.to_s
-      when 'warning', 'warn', 'alert' then 'exclamation'
-      when 'notice' then 'check'
-      when 'error' then 'bug'
+      when "warning", "warn", "alert" then "exclamation"
+      when "notice" then "check"
+      when "error" then "bug"
       else
         message_type
       end

data/app/helpers/alchemy/elements_block_helper.rb

@@ -33,7 +33,7 @@ module Alchemy
         helpers.render(content, {
           content: content,
           options: options,
-          html_options: html_options
+          html_options: html_options,
         })
       end
 
@@ -62,15 +62,6 @@ module Alchemy
       end
     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
     # your content element and provides a block helper object you can use for
     # concise access to Alchemy's various helpers.
@@ -116,7 +107,7 @@ module Alchemy
         tag: :div,
         id: element_dom_id(element),
         class: element.name,
-        tags_formatter: ->(tags) { tags.join(" ") }
+        tags_formatter: ->(tags) { tags.join(" ") },
       }.merge(options)
 
       # capture inner template block
@@ -140,25 +131,5 @@ module Alchemy
       # that's it!
       output
     end
-
-    # Block-level helper for element editors. Provides a block helper object
-    # you can use for concise access to Alchemy's various helpers.
-    #
-    # === Example:
-    #
-    #   <%= element_editor_for(element) do |el| %>
-    #     <%= el.edit :title %>
-    #     <%= el.edit :body %>
-    #     <%= el.edit :target_url %>
-    #   <% end %>
-    #
-    # @param [Alchemy::Element] element
-    #   The element to display.
-    #
-    def element_editor_for(element)
-      capture do
-        yield ElementEditorHelper.new(self, element: element) if block_given?
-      end
-    end
   end
 end

data/app/helpers/alchemy/elements_helper.rb

@@ -6,7 +6,6 @@ module Alchemy
   # The most important helper for frontend developers is the {#render_elements} helper.
   #
   module ElementsHelper
-    include Alchemy::EssencesHelper
     include Alchemy::UrlHelper
     include Alchemy::ElementsBlockHelper
 
@@ -92,19 +91,9 @@ module Alchemy
     def render_elements(options = {})
       options = {
         from_page: @page,
-        render_format: 'html'
+        render_format: "html",
       }.update(options)
 
-      if options[:sort_by]
-        Alchemy::Deprecation.warn "options[:sort_by] has been removed without replacement. " \
-          "Please implement your own element sorting by passing a custom finder instance to options[:finder]."
-      end
-
-      if options[:from_cell]
-        Alchemy::Deprecation.warn "options[:from_cell] has been removed without replacement. " \
-          "Please `render element.nested_elements` instead."
-      end
-
       finder = options[:finder] || Alchemy::ElementsFinder.new(options)
       elements = finder.elements(page: options[:from_page])
 
@@ -159,21 +148,10 @@ module Alchemy
     # @note If the view partial is not found
     #   <tt>alchemy/elements/_view_not_found.html.erb</tt> gets rendered.
     #
-    def render_element(*args)
-      if args.length == 4
-        element, _part, options, counter = *args
-        Alchemy::Deprecation.warn "passing a `part` parameter as second argument to `render_element` has been removed without replacement. " \
-          "You can safely remove it."
-      else
-        element, options, counter = *args
-      end
-
-      options ||= {}
-      counter ||= 1
-
+    def render_element(element, options = {}, counter = 1)
       if element.nil?
-        warning('Element is nil')
-        render "alchemy/elements/view_not_found", {name: 'nil'}
+        warning("Element is nil")
+        render "alchemy/elements/view_not_found", {name: "nil"}
         return
       end
 
@@ -182,7 +160,7 @@ module Alchemy
       render element, {
         element: element,
         counter: counter,
-        options: options
+        options: options,
       }.merge(options.delete(:locals) || {})
     rescue ActionView::MissingTemplate => e
       warning(%(
@@ -195,23 +173,20 @@ module Alchemy
     # Returns a string for the id attribute of a html element for the given element
     def element_dom_id(element)
       return "" if element.nil?
+
       "#{element.name}_#{element.id}".html_safe
     end
 
     # Renders the HTML tag attributes required for preview mode.
     def element_preview_code(element)
-      if respond_to?(:tag_options)
-        tag_options(element_preview_code_attributes(element))
-      else
-        # Rails 5.1 uses TagBuilder
-        tag_builder.tag_options(element_preview_code_attributes(element))
-      end
+      tag_builder.tag_options(element_preview_code_attributes(element))
     end
 
     # Returns a hash containing the HTML tag attributes required for preview mode.
     def element_preview_code_attributes(element)
       return {} unless element.present? && @preview_mode && element.page == @page
-      { 'data-alchemy-element' => element.id }
+
+      { "data-alchemy-element" => element.id }
     end
 
     # Returns the element's tags information as a string. Parameters and options
@@ -223,12 +198,7 @@ module Alchemy
     #   HTML tag attributes containing the element's tag information.
     #
     def element_tags(element, options = {})
-      if respond_to?(:tag_options)
-        tag_options(element_tags_attributes(element, options))
-      else
-        # Rails 5.1 uses TagBuilder
-        tag_builder.tag_options(element_tags_attributes(element, options))
-      end
+      tag_builder.tag_options(element_tags_attributes(element, options))
     end
 
     # Returns the element's tags information as an attribute hash.
@@ -244,28 +214,12 @@ module Alchemy
     #
     def element_tags_attributes(element, options = {})
       options = {
-        formatter: lambda { |tags| tags.join(' ') }
+        formatter: lambda { |tags| tags.join(" ") },
       }.merge(options)
 
       return {} if !element.taggable? || element.tag_list.blank?
-      { 'data-element-tags' => options[:formatter].call(element.tag_list) }
-    end
-
-    # Sort given elements by content.
-    # @deprecated
-    # @param [Array] elements - The elements you want to sort
-    # @param [String] content_name - The name of the content you want to sort by
-    # @param [Boolean] reverse - Reverse the sorted elements order
-    #
-    # @return [Array]
-    def sort_elements_by_content(elements, content_name, reverse = false)
-      Alchemy::Deprecation.warn "options[:sort_by] is deprecated. Please implement your own element sorting."
-      sorted_elements = elements.sort_by do |element|
-        content = element.content_by_name(content_name)
-        content ? content.ingredient.to_s : ''
-      end
 
-      reverse ? sorted_elements.reverse : sorted_elements
+      { "data-element-tags" => options[:formatter].call(element.tag_list) }
     end
   end
 end

data/app/helpers/alchemy/pages_helper.rb

@@ -25,18 +25,19 @@ module Alchemy
     #
     def language_links(options = {})
       options = {
-        linkname: 'name',
+        linkname: "name",
         show_title: true,
-        spacer: '',
-        reverse: false
+        spacer: "",
+        reverse: false,
       }.merge(options)
-      languages = Language.on_current_site.published.with_root_page.order("name #{options[:reverse] ? 'DESC' : 'ASC'}")
+      languages = Language.on_current_site.published.with_root_page.order("name #{options[:reverse] ? "DESC" : "ASC"}")
       return nil if languages.count < 2
+
       render(
         partial: "alchemy/language_links/language",
         collection: languages,
         spacer_template: "alchemy/language_links/spacer",
-        locals: {languages: languages, options: options}
+        locals: { languages: languages, options: options },
       )
     end
 
@@ -50,7 +51,7 @@ module Alchemy
       render @page, page: @page
     rescue ActionView::MissingTemplate
       warning("PageLayout: '#{@page.page_layout}' not found. Rendering standard page_layout.")
-      render 'alchemy/page_layouts/standard', page: @page
+      render "alchemy/page_layouts/standard", page: @page
     end
 
     # Renders a partial for current site
@@ -72,182 +73,37 @@ 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.
-    #
-    # === HTML output:
-    #
-    #   <ul class="navigation level_1">
-    #     <li class="first home"><a href="/home" class="active" title="Homepage" lang="en" data-page-id="1">Homepage</a></li>
-    #     <li class="contact"><a href="/contact" title="Contact" lang="en" data-page-id="2">Contact</a></li>
-    #     <li class="last imprint"><a href="/imprint" title="Imprint" lang="en" data-page-id="3">Imprint</a></li>
-    #   </ul>
-    #
-    # As you can see: Everything you need.
-    #
-    # Not pleased with the way Alchemy produces the navigation structure?
-    #
-    # Then feel free to overwrite the partials (_renderer.html.erb and _link.html.erb) found in +views/navigation/+ or pass different partials via the options +:navigation_partial+ and +:navigation_link_partial+.
-    #
-    # === Passing HTML classes and ids to the renderer
-    #
-    # A second hash can be passed as html_options to the navigation renderer partial.
-    #
-    # ==== Example:
-    #
-    #   <%= render_navigation({from_page: 'subnavi'}, {class: 'navigation', id: 'subnavigation'}) %>
-    #
-    #
-    # @option options submenu [Boolean] (false)
-    #   Do you want a nested <ul> <li> structure for the deeper levels of your navigation, or not?
-    #   Used to display the subnavigation within the mainnaviagtion. I.e. for dropdown menues.
-    #
-    # @option options all_sub_menues [Boolean] (false)
-    #   Renders the whole page tree.
-    #
-    # @option options from_page [Alchemy::Page] (@root_page)
-    #   Do you want to render a navigation from a different page then the current page?
-    #   Then pass an Page instance or a Alchemy::PageLayout name as string.
-    #
-    # @option options spacer [String] (nil)
-    #   A spacer for the entries can be passed.
-    #   Simple string, or even a complex html structure.
-    #   I.e: "<span class='spacer'>|</spacer>".
-    #
-    # @option options navigation_partial [String] ("navigation/renderer")
-    #   Pass a different partial to be taken for the navigation rendering.
-    #   Alternatively you could override the +app/views/alchemy/navigation/renderer+ partial in your app.
-    #
-    # @option options navigation_link_partial [String] ("navigation/link")
-    #   Alchemy places an <a> html link in <li> tags.
-    #   The tag automatically has an active css class if necessary.
-    #   So styling is everything. But maybe you don't want this.
-    #   So feel free to make you own partial and pass the filename here.
-    #   Alternatively you could override the +app/views/alchemy/navigation/link+ partial in your app.
-    #
-    # @option options show_nonactive [Boolean] (false)
-    #   Commonly Alchemy only displays the submenu of the active page (if submenu: true).
-    #   If you want to display all child pages then pass true (together with submenu: true of course).
-    #   I.e. for css-driven drop down menues.
-    #
-    # @option options show_title [Boolean] (true)
-    #   For our beloved SEOs :)
-    #   Appends a title attribute to all links and places the +page.title+ content into it.
-    #
-    # @option options restricted_only [Boolean] (false)
-    #   Render only restricted pages. I.E for members only navigations.
-    #
-    # @option options reverse [Boolean] (false)
-    #   Reverse the output of the pages
-    #
-    # @option options reverse_children [Boolean] (false)
-    #   Like reverse option, but only reverse the children of the first level
-    #
-    # @option options deepness [Fixnum] (nil)
-    #   Show only pages up to this depth.
-    #
-    def render_navigation(options = {}, html_options = {})
-      options = {
-        submenu: false,
-        all_sub_menues: false,
-        from_page: @root_page || Language.current_root_page,
-        spacer: nil,
-        navigation_partial: 'alchemy/navigation/renderer',
-        navigation_link_partial: 'alchemy/navigation/link',
-        show_nonactive: false,
-        restricted_only: false,
-        show_title: true,
-        reverse: false,
-        reverse_children: false
-      }.merge(options)
-      page = page_or_find(options[:from_page])
-      return nil if page.blank?
-      pages = page.children.accessible_by(current_ability, :see)
-      pages = pages.restricted if options.delete(:restricted_only)
-      if depth = options[:deepness]
-        pages = pages.where('depth <= ?', depth)
-      end
-      if options[:reverse]
-        pages.reverse!
-      end
-      render options[:navigation_partial],
-        options: options,
-        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 [String] - Type 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, site: Alchemy::Site.current)
+    def render_menu(menu_type, options = {})
+      root_node = Alchemy::Node.roots.find_by(
+        menu_type: menu_type,
+        language: Alchemy::Language.current,
+      )
       if root_node.nil?
-        warning("Menu with name #{name} not found!")
+        warning("Menu with type #{menu_type} not found!")
         return
       end
 
-      options = {
-        node_partial_name: "#{root_node.view_folder_name}/node"
-      }.merge(options)
-
-      render(root_node.to_partial_path, menu: root_node, node: root_node, options: options)
+      render("alchemy/menus/#{menu_type}/wrapper", menu: root_node, options: options)
     rescue ActionView::MissingTemplate => e
       warning <<~WARN
-        Menu partial not found for #{name}.
+        Menu partial not found for #{menu_type}.
         #{e}
       WARN
     end
 
-    # Renders navigation the children and all siblings of the given page (standard is the current page).
-    #
-    # Use this helper if you want to render the subnavigation independent from the mainnavigation. I.E. to place it in a different area on your website.
-    #
-    # This helper passes all its options to the the render_navigation helper.
-    #
-    # === Options:
-    #
-    #   from_page: @page                              # The page to render the navigation from
-    #   submenu: true                                 # Shows the nested children
-    #   level: 2                                      # Normally there is no need to change the level parameter, just in a few special cases
-    #
-    def render_subnavigation(options = {}, html_options = {})
-      default_options = {
-        from_page: @page,
-        submenu: true,
-        level: 2
-      }
-      options = default_options.merge(options)
-      if !options[:from_page].nil?
-        while options[:from_page].level > options[:level]
-          options[:from_page] = options[:from_page].parent
-        end
-        render_navigation(options, html_options)
-      else
-        return nil
-      end
-    end
-    deprecate :render_subnavigation, deprecator: Alchemy::Deprecation
-
     # Returns true if page is in the active branch
     def page_active?(page)
       @_page_ancestors ||= Page.ancestors_for(@page)
       @_page_ancestors.include?(page)
     end
 
-    # Returns +'active'+ if the given external page is in the current url path or +nil+.
-    def external_page_css_class(page)
-      return nil if !page.definition['redirects_to_external']
-      request.path.split('/').delete_if(&:blank?).first == page.urlname.gsub(/^\//, '') ? 'active' : nil
-    end
-
     # Returns page links in a breadcrumb beginning from root to current page.
     #
     # === Options:
@@ -264,11 +120,11 @@ module Alchemy
         page: @page,
         restricted_only: false,
         reverse: false,
-        link_active_page: false
+        link_active_page: false,
       }.merge(options)
 
-      pages = Page.
-        ancestors_for(options[:page]).
+      pages = options[:page].
+        self_and_ancestors.contentpages.
         accessible_by(current_ability, :see)
 
       if options.delete(:restricted_only)
@@ -276,7 +132,7 @@ module Alchemy
       end
 
       if options.delete(:reverse)
-        pages = pages.reorder('lft DESC')
+        pages = pages.reorder("lft DESC")
       end
 
       if options[:without].present?
@@ -284,7 +140,7 @@ module Alchemy
         pages = pages.where.not(id: without.try(:collect, &:id) || without.id)
       end
 
-      render 'alchemy/breadcrumb/wrapper', pages: pages, options: options
+      render "alchemy/breadcrumb/wrapper", pages: pages, options: options
     end
 
     # Returns current page title
@@ -296,10 +152,11 @@ module Alchemy
     #
     def page_title(options = {})
       return "" if @page.title.blank?
+
       options = {
         prefix: "",
         suffix: "",
-        separator: ""
+        separator: "",
       }.update(options)
       title_parts = [options[:prefix]]
       if response.status == 200
@@ -320,14 +177,7 @@ module Alchemy
     end
 
     def meta_robots
-      "#{@page.robot_index? ? '' : 'no'}index, #{@page.robot_follow? ? '' : 'no'}follow"
-    end
-
-    # @deprecated
-    def render_cell(name, _options = {})
-      render_elements(only: name, fixed: true)
+      "#{@page.robot_index? ? "" : "no"}index, #{@page.robot_follow? ? "" : "no"}follow"
     end
-    deprecate render_cell: 'Use render_elements(only: <cell-name>, fixed: true) instead',
-      deprecator: Alchemy::Deprecation
   end
 end