alchemy_cms 4.4.3 → 5.0.0.beta1

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, 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

data/app/helpers/alchemy/url_helper.rb

@@ -18,7 +18,8 @@ module Alchemy
 
     # Returns the correct params-hash for passing to show_page_path
     def show_page_path_params(page, optional_params = {})
-      raise ArgumentError, 'Page is nil' if page.nil?
+      raise ArgumentError, "Page is nil" if page.nil?
+
       url_params = {urlname: page.urlname}.update(optional_params)
       prefix_locale? ? url_params.update(locale: page.language_code) : url_params
     end

data/app/mailers/alchemy/base_mailer.rb

@@ -2,7 +2,7 @@
 
 module Alchemy
   begin
-    base_class = Object.const_get('::ApplicationMailer')
+    base_class = Object.const_get("::ApplicationMailer")
   rescue NameError
     base_class = ActionMailer::Base
   end

data/app/mailers/alchemy/messages_mailer.rb

@@ -8,7 +8,7 @@ module Alchemy
         from: mail_from,
         to: mail_to,
         reply_to: message.try(:email),
-        subject: subject
+        subject: subject,
       )
     end
   end

data/app/models/alchemy/attachment.rb

@@ -22,7 +22,7 @@ module Alchemy
     include Alchemy::Filetypes
     include Alchemy::NameConversions
     include Alchemy::Taggable
-    include Alchemy::ContentTouching
+    include Alchemy::TouchElements
 
     dragonfly_accessor :file, app: :alchemy_attachments do
       after_assign { |f| write_attribute(:file_mime_type, f.mime_type) }
@@ -30,7 +30,7 @@ module Alchemy
 
     stampable stamper_class_name: Alchemy.user_class_name
 
-    has_many :essence_files, class_name: 'Alchemy::EssenceFile', foreign_key: 'attachment_id'
+    has_many :essence_files, class_name: "Alchemy::EssenceFile", foreign_key: "attachment_id"
     has_many :contents, through: :essence_files
     has_many :elements, through: :contents
     has_many :pages, through: :elements
@@ -42,24 +42,25 @@ module Alchemy
       end
 
       def allowed_filetypes
-        Config.get(:uploader).fetch('allowed_filetypes', {}).fetch('alchemy/attachments', [])
+        Config.get(:uploader).fetch("allowed_filetypes", {}).fetch("alchemy/attachments", [])
       end
 
       def file_types_for_select
         file_types = Alchemy::Attachment.pluck(:file_mime_type).uniq.map do |type|
-          [Alchemy.t(type, scope: 'mime_types'), type]
+          [Alchemy.t(type, scope: "mime_types"), type]
         end
         file_types.sort_by(&:first)
       end
     end
 
     validates_presence_of :file
-    validates_size_of :file, maximum: Config.get(:uploader)['file_size_limit'].megabytes
-    validates_property :ext, of: :file,
+    validates_size_of :file, maximum: Config.get(:uploader)["file_size_limit"].megabytes
+    validates_property :ext,
+      of: :file,
       in: allowed_filetypes,
       case_sensitive: false,
       message: Alchemy.t("not a valid file"),
-      unless: -> { self.class.allowed_filetypes.include?('*') }
+      unless: -> { self.class.allowed_filetypes.include?("*") }
 
     before_save :set_name, if: :file_name_changed?
 
@@ -71,13 +72,13 @@ module Alchemy
       {
         "name" => read_attribute(:file_name),
         "size" => read_attribute(:file_size),
-        'error' => errors[:file].join
+        "error" => errors[:file].join,
       }
     end
 
     # An url save filename without format suffix
     def urlname
-      CGI.escape(file_name.gsub(/\.#{extension}$/, '').tr('.', ' '))
+      CGI.escape(file_name.gsub(/\.#{extension}$/, "").tr(".", " "))
     end
 
     # Checks if the attachment is restricted, because it is attached on restricted pages only
@@ -89,6 +90,7 @@ module Alchemy
     def extension
       file_name.split(".").last
     end
+
     alias_method :suffix, :extension
 
     # Returns a css class name for kind of file
@@ -96,23 +98,23 @@ module Alchemy
     def icon_css_class
       case file_mime_type
       when "application/pdf"
-        then "file-pdf"
+        "file-pdf"
       when "application/msword"
-        then "file-word"
+        "file-word"
       when *TEXT_FILE_TYPES
-        then "file-alt"
+        "file-alt"
       when *EXCEL_FILE_TYPES
-        then "file-excel"
+        "file-excel"
       when *VCARD_FILE_TYPES
-        then "address-card"
+        "address-card"
       when *ARCHIVE_FILE_TYPES
-        then "file-archive"
+        "file-archive"
       when *AUDIO_FILE_TYPES
-        then "file-audio"
+        "file-audio"
       when *IMAGE_FILE_TYPES
-        then "file-image"
+        "file-image"
       when *VIDEO_FILE_TYPES
-        then "file-video"
+        "file-video"
       else
         "file"
       end

data/app/models/alchemy/base_record.rb

@@ -1,13 +1,10 @@
+# frozen_string_literal: true
 module Alchemy
   def self.table_name_prefix
-    'alchemy_'
+    "alchemy_"
   end
 
   class BaseRecord < ActiveRecord::Base
     self.abstract_class = true
-
-    def active_record_5_1?
-      ActiveRecord.gem_version >= Gem::Version.new('5.1.0')
-    end
   end
 end

data/app/models/alchemy/content.rb

@@ -28,29 +28,25 @@ module Alchemy
     belongs_to :element, touch: true, inverse_of: :contents
     has_one :page, through: :element
 
-    stampable stamper_class_name: Alchemy.user_class_name
-
-    acts_as_list scope: [:element_id]
-
     # 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_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.not_trashed }
-    scope :published,         -> { joins(:element).merge(Element.published) }
-    scope :not_trashed,       -> { joins(:element).merge(Element.not_trashed) }
-    scope :not_restricted,    -> { joins(:element).merge(Element.not_restricted) }
-
-    delegate :restricted?, to: :page,    allow_nil: true
-    delegate :trashed?,    to: :element, allow_nil: true
-    delegate :public?,     to: :element, allow_nil: true
+    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.not_trashed }
+    scope :published, -> { joins(:element).merge(Element.published) }
+    scope :not_trashed, -> { joins(:element).merge(Element.not_trashed) }
+    scope :not_restricted, -> { joins(:element).merge(Element.not_restricted) }
+
+    delegate :restricted?, to: :page, allow_nil: true
+    delegate :trashed?, to: :element, allow_nil: true
+    delegate :public?, to: :element, allow_nil: true
 
     class << self
       # Returns the translated label for a content name.
@@ -72,7 +68,7 @@ module Alchemy
         Alchemy.t(
           content_name,
           scope: "content_names.#{element_name}",
-          default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize)
+          default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize),
         )
       end
     end
@@ -99,6 +95,7 @@ module Alchemy
     # Settings from the elements.yml definition
     def settings
       return {} if definition.blank?
+
       @settings ||= definition.fetch(:settings, {})
     end
 
@@ -114,12 +111,14 @@ module Alchemy
 
     def siblings
       return [] if !element
+
       element.contents
     end
 
     # Gets the ingredient from essence
     def ingredient
       return nil if essence.nil?
+
       essence.ingredient
     end
 
@@ -129,7 +128,7 @@ module Alchemy
       {
         name: name,
         value: serialized_ingredient,
-        link: essence.try(:link)
+        link: essence.try(:link),
       }.delete_if { |_k, v| v.blank? }
     end
 
@@ -145,6 +144,7 @@ module Alchemy
     # Sets the ingredient from essence
     def ingredient=(value)
       raise EssenceMissingError if essence.nil?
+
       essence.ingredient = value
     end
 
@@ -156,11 +156,12 @@ module Alchemy
     #
     def update_essence(params = {})
       raise EssenceMissingError if essence.nil?
+
       if essence.update(params)
-        return true
+        true
       else
         errors.add(:essence, :validation_failed)
-        return false
+        false
       end
     end
 
@@ -169,34 +170,13 @@ module Alchemy
     end
 
     def has_validations?
-      definition['validate'].present?
-    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.form_field_name, content.ingredient %>
-    #
-    # === Options:
-    #
-    # You can pass an Essence column_name. Default is 'ingredient'
-    #
-    # ==== Example:
-    #
-    #   <%= text_field_tag content.form_field_name(:link), content.ingredient %>
-    #
-    def form_field_name(essence_column = 'ingredient')
-      "contents[#{id}][#{essence_column}]"
-    end
-
-    def form_field_id(essence_column = 'ingredient')
-      "contents_#{id}_#{essence_column}"
+      definition["validate"].present?
     end
 
     # Returns a string used as dom id on html elements.
     def dom_id
-      return '' if essence.nil?
+      return "" if essence.nil?
+
       "#{essence_partial_name}_#{id}"
     end
 
@@ -211,7 +191,7 @@ module Alchemy
 
     # Returns true if this content should be taken for element preview.
     def preview_content?
-      !!definition['as_element_title']
+      !!definition["as_element_title"]
     end
 
     # Proxy method that returns the preview text from essence.
@@ -221,7 +201,8 @@ module Alchemy
     end
 
     def essence_partial_name
-      return '' if essence.nil?
+      return "" if essence.nil?
+
       essence.partial_name
     end
 
@@ -249,7 +230,7 @@ module Alchemy
     #
     # If the value is a symbol it gets passed through i18n
     # inside the +alchemy.default_content_texts+ scope
-    def default_text(default)
+    def default_value(default = definition[:default])
       case default
       when Symbol
         Alchemy.t(default, scope: :default_content_texts)