alchemy_cms 6.0.12 → 6.1.1

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

@@ -8,19 +8,33 @@ module Alchemy
       extend ActiveSupport::Concern
 
       module ClassMethods
+        # Register a custom element definitions repository
+        #
+        # The default repository is Alchemy::ElementDefinition
+        #
+        def definitions_repository=(klass)
+          @_definitions_repository = klass
+        end
+
         # Returns the definitions from elements.yml file.
         #
         # Place a +elements.yml+ file inside your apps +config/alchemy+ folder to define
         # your own set of elements
         #
         def definitions
-          ElementDefinition.all
+          definitions_repository.all
         end
 
         # Returns one element definition by given name.
         #
         def definition_by_name(name)
-          ElementDefinition.get(name)
+          definitions_repository.get(name)
+        end
+
+        private
+
+        def definitions_repository
+          @_definitions_repository ||= ElementDefinition
         end
       end
 

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Returns a dom id used for elements html id tag.
+  #
+  # Uses the elements name and its position on the page.
+  # If the element is nested in a parent element it prefixes
+  # the id with the parent elements dom_id.
+  #
+  # Register your own dom id class with
+  #
+  #  Alchemy::Element.dom_id_class = MyDomIdClass
+  #
+  class Element < BaseRecord
+    class DomId
+      def initialize(element)
+        @element = element
+        @parent_element = element.parent_element
+      end
+
+      def call
+        [parent_element&.dom_id, element.name, element.position].compact.join("-")
+      end
+
+      private
+
+      attr_reader :element, :parent_element
+    end
+  end
+end

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

@@ -6,29 +6,41 @@ module Alchemy
     #
     module ElementContents
       # Find first content from element by given name.
+      # @deprecated
       def content_by_name(name)
         contents_by_name(name).first
       end
 
+      deprecate content_by_name: :ingredient_by_role, deprecator: Alchemy::Deprecation
+
       # Find first content from element by given essence type.
+      # @deprecated
       def content_by_type(essence_type)
         contents_by_type(essence_type).first
       end
 
+      deprecate content_by_type: :ingredient_by_type, deprecator: Alchemy::Deprecation
+
       # All contents from element by given name.
+      # @deprecated
       def contents_by_name(name)
         contents.select { |content| content.name == name.to_s }
       end
 
+      deprecate contents_by_name: :ingredients_by_role, deprecator: Alchemy::Deprecation
+
       alias_method :all_contents_by_name, :contents_by_name
 
       # All contents from element by given essence type.
+      # @deprecated
       def contents_by_type(essence_type)
         contents.select do |content|
           content.essence_type == Content.normalize_essence_type(essence_type)
         end
       end
 
+      deprecate contents_by_type: :ingredients_by_type, deprecator: Alchemy::Deprecation
+
       alias_method :all_contents_by_type, :contents_by_type
 
       # Updates all related contents by calling +update_essence+ on each of them.
@@ -48,6 +60,7 @@ module Alchemy
       #     "2" => {link: "https://google.com"}
       #   )
       #
+      # @deprecated
       def update_contents(contents_attributes)
         return true if contents_attributes.nil?
 
@@ -58,13 +71,18 @@ module Alchemy
         errors.blank?
       end
 
+      deprecate :update_contents, deprecator: Alchemy::Deprecation
+
       # Copy current content's contents to given target element
+      # @deprecated
       def copy_contents_to(element)
         contents.map do |content|
           Content.copy(content, element_id: element.id)
         end
       end
 
+      deprecate :copy_contents_to, deprecator: Alchemy::Deprecation
+
       # Returns the content that is marked as rss title.
       #
       # Mark a content as rss title in your +elements.yml+ file:
@@ -75,10 +93,13 @@ module Alchemy
       #       type: EssenceText
       #       rss_title: true
       #
+      # @deprecated
       def content_for_rss_title
         content_for_rss_meta("title")
       end
 
+      deprecate :content_for_rss_title, deprecator: Alchemy::Deprecation
+
       # Returns the content that is marked as rss description.
       #
       # Mark a content as rss description in your +elements.yml+ file:
@@ -89,18 +110,25 @@ module Alchemy
       #       type: EssenceRichtext
       #       rss_description: true
       #
+      # @deprecated
       def content_for_rss_description
         content_for_rss_meta("description")
       end
 
+      deprecate :content_for_rss_description, deprecator: Alchemy::Deprecation
+
       # Returns the array with the hashes for all element contents in the elements.yml file
+      # @deprecated
       def content_definitions
         return nil if definition.blank?
 
         definition["contents"]
       end
 
+      deprecate content_definitions: :ingredient_definitions, deprecator: Alchemy::Deprecation
+
       # Returns the definition for given content_name
+      # @deprecated
       def content_definition_for(content_name)
         if content_definitions.blank?
           log_warning "Element #{name} is missing the content definition for #{content_name}"
@@ -110,10 +138,13 @@ module Alchemy
         end
       end
 
+      deprecate content_definition_for: :ingredient_definition_for, deprecator: Alchemy::Deprecation
+
       # Returns an array of all EssenceRichtext contents ids from elements
       #
       # This is used to re-initialize the TinyMCE editor in the element editor.
       #
+      # @deprecated
       def richtext_contents_ids
         # This is not very efficient SQL wise I know, but we need to iterate
         # recursivly through all descendent elements and I don't know how to do this
@@ -126,16 +157,24 @@ module Alchemy
         ids.flatten
       end
 
+      deprecate richtext_contents_ids: :richtext_ingredients_ids, deprecator: Alchemy::Deprecation
+
       # True, if any of the element's contents has essence validations defined.
+      # @deprecated
       def has_validations?
         !contents.detect(&:has_validations?).blank?
       end
 
+      deprecate :has_validations?, deprecator: Alchemy::Deprecation
+
       # All element contents where the essence validation has failed.
+      # @deprecated
       def contents_with_errors
         contents.select(&:essence_validation_failed?)
       end
 
+      deprecate contents_with_errors: :ingredients_with_errors, deprecator: Alchemy::Deprecation
+
       private
 
       def content_for_rss_meta(type)

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

@@ -7,7 +7,7 @@ module Alchemy
       def ingredient(name)
         ing = ingredient_by_role(name)
         if ing
-          Alchemy::Deprecation.warn <<~WARN
+          Alchemy::Deprecation.warn(<<~WARN)
             Using `element.ingredient` to get the value of an ingredient is deprecated and will change in Alchemy 6.1
             If you want to read the value of an elements ingredient please use `element.value_for(:ingredient_role)` instead.
             The next version of Alchemy will return a `Alchemy::Ingredient` record instead.
@@ -23,9 +23,11 @@ module Alchemy
 
       # True if the element has a content for given name,
       # that has an essence value (aka. ingredient) that is not blank.
+      # @deprecated
       def has_ingredient?(name)
         ingredient(name).present?
       end
+
       deprecate has_ingredient?: :has_value_for?, deprecator: Alchemy::Deprecation
 
       # Returns all essence errors in the format of:
@@ -39,6 +41,7 @@ module Alchemy
       #
       # Get translated error messages with +Element#essence_error_messages+
       #
+      # @deprecated
       def essence_errors
         essence_errors = {}
         contents.each do |content|
@@ -49,6 +52,8 @@ module Alchemy
         essence_errors
       end
 
+      deprecate :essence_errors, deprecator: Alchemy::Deprecation
+
       # Essence validation errors
       #
       # == Error messages are translated via I18n
@@ -103,6 +108,7 @@ module Alchemy
       #           invalid: %{field} has wrong format
       #           blank: %{field} can't be blank
       #
+      # @deprecated
       def essence_error_messages
         messages = []
         essence_errors.each do |content_name, errors|
@@ -120,6 +126,8 @@ module Alchemy
         end
         messages
       end
+
+      deprecate essence_error_messages: :ingredient_error_messages, deprecator: Alchemy::Deprecation
     end
   end
 end

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

@@ -37,6 +37,13 @@ module Alchemy
         ingredients_by_type(type).first
       end
 
+      # All ingredients from element by given role.
+      def ingredients_by_role(role)
+        ingredients.select do |ingredient|
+          ingredient.role == Ingredient.normalize_type(role)
+        end
+      end
+
       # All ingredients from element by given type.
       def ingredients_by_type(type)
         ingredients.select do |ingredient|

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

@@ -82,7 +82,7 @@ module Alchemy
       # Returns a dom id used for elements html id tag.
       #
       def dom_id
-        [parent_element&.dom_id, name, position].compact.join("-")
+        self.class.dom_id_class.new(self).call
       end
 
       # The content that's used for element's preview text.

data/app/models/alchemy/element.rb

@@ -61,6 +61,8 @@ module Alchemy
 
     has_many :contents, dependent: :destroy, inverse_of: :element
 
+    deprecate contents: :ingredients, deprecator: Alchemy::Deprecation
+
     before_destroy :delete_all_nested_elements
 
     has_many :all_nested_elements,
@@ -143,6 +145,18 @@ module Alchemy
         super(element_definition.merge(element_attributes).except(*FORBIDDEN_DEFINITION_ATTRIBUTES))
       end
 
+      # The class responsible for the +dom_id+ of elements.
+      # Defaults to +Alchemy::Element::DomId+.
+      def dom_id_class
+        @_dom_id_class || DomId
+      end
+
+      # Register a custom +DomId+ class responsible for the +dom_id+ of elements.
+      # Defaults to +Alchemy::Element::DomId+.
+      def dom_id_class=(klass)
+        @_dom_id_class = klass
+      end
+
       # This methods does a copy of source and all depending contents and all of their depending essences.
       #
       # == Options

data/app/models/alchemy/ingredients/headline.rb

@@ -5,7 +5,10 @@ module Alchemy
     # A text headline
     #
     class Headline < Alchemy::Ingredient
+      include DomIds
+
       store_accessor :data,
+        :dom_id,
         :level,
         :size
 
@@ -20,7 +23,7 @@ module Alchemy
       end
 
       def size_options
-        sizes.map { |size| ["H#{size}", size] }
+        sizes.map { |size| [".h#{size}", size] }
       end
 
       private

data/app/models/alchemy/ingredients/text.rb

@@ -7,7 +7,10 @@ module Alchemy
     # Optionally it can have a link
     #
     class Text < Alchemy::Ingredient
+      include DomIds
+
       store_accessor :data,
+        :dom_id,
         :link,
         :link_target,
         :link_title,

data/app/models/alchemy/page/page_layouts.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Page < BaseRecord
+    # Module concerning page layouts
+    #
+    module PageLayouts
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Register a custom page layouts repository
+        #
+        # The default repository is Alchemy::PageLayout
+        #
+        def layouts_repository=(klass)
+          @_layouts_repository = klass
+        end
+
+        # Returns page layouts ready for Rails' select form helper.
+        #
+        def layouts_for_select(language_id, layoutpages: false)
+          @map_array = []
+          mapped_layouts_for_select(selectable_layouts(language_id, layoutpages: layoutpages))
+        end
+
+        # Returns page layouts including given layout ready for Rails' select form helper.
+        #
+        def layouts_with_own_for_select(page_layout_name, language_id, layoutpages: false)
+          layouts = selectable_layouts(language_id, layoutpages: layoutpages)
+          if layouts.detect { |l| l["name"] == page_layout_name }.nil?
+            @map_array = [[human_layout_name(page_layout_name), page_layout_name]]
+          else
+            @map_array = []
+          end
+          mapped_layouts_for_select(layouts)
+        end
+
+        deprecate :layouts_with_own_for_select, deprecator: Alchemy::Deprecation
+
+        # Returns all layouts that can be used for creating a new page.
+        #
+        # It removes all layouts from available layouts that are unique and already taken and that are marked as hide.
+        #
+        # @param [Fixnum]
+        #   language_id of current used Language.
+        # @param [Boolean] (false)
+        #   Pass true to only select layouts for global/layout pages.
+        #
+        def selectable_layouts(language_id, layoutpages: false)
+          @language_id = language_id
+          layouts_repository.all.select do |layout|
+            if layoutpages
+              layout["layoutpage"] && layout_available?(layout)
+            else
+              !layout["layoutpage"] && layout_available?(layout)
+            end
+          end
+        end
+
+        # Translates name for given layout
+        #
+        # === Translation example
+        #
+        #   en:
+        #     alchemy:
+        #       page_layout_names:
+        #         products_overview: Products Overview
+        #
+        # @param [String]
+        #   The layout name
+        #
+        def human_layout_name(layout)
+          Alchemy.t(layout, scope: "page_layout_names", default: layout.to_s.humanize)
+        end
+
+        private
+
+        def layouts_repository
+          @_layouts_repository ||= PageLayout
+        end
+
+        # Maps given layouts for Rails select form helper.
+        #
+        def mapped_layouts_for_select(layouts)
+          layouts.each do |layout|
+            @map_array << [human_layout_name(layout["name"]), layout["name"]]
+          end
+          @map_array
+        end
+
+        # Returns true if the given layout is unique and not already taken or it should be hidden.
+        #
+        def layout_available?(layout)
+          !layout["hide"] && !already_taken?(layout) && available_on_site?(layout)
+        end
+
+        # Returns true if this layout is unique and already taken by another page.
+        #
+        def already_taken?(layout)
+          layout["unique"] && page_with_layout_existing?(layout["name"])
+        end
+
+        # Returns true if one page already has the given layout
+        #
+        def page_with_layout_existing?(layout)
+          Alchemy::Page.where(page_layout: layout, language_id: @language_id).pluck(:id).any?
+        end
+
+        # Returns true if given layout is available for current site.
+        #
+        # If no site layouts are defined it always returns true.
+        #
+        # == Example
+        #
+        #   # config/alchemy/site_layouts.yml
+        #   - name: default_site
+        #     page_layouts: [default_intro]
+        #
+        def available_on_site?(layout)
+          return false unless Alchemy::Site.current
+
+          Alchemy::Site.current.definition.blank? ||
+            Alchemy::Site.current.definition.fetch("page_layouts", []).include?(layout["name"])
+        end
+      end
+    end
+  end
+end

data/app/models/alchemy/page.rb

@@ -36,6 +36,7 @@
 #
 
 require_dependency "alchemy/page/fixed_attributes"
+require_dependency "alchemy/page/page_layouts"
 require_dependency "alchemy/page/page_scopes"
 require_dependency "alchemy/page/page_natures"
 require_dependency "alchemy/page/page_naming"
@@ -78,6 +79,7 @@ module Alchemy
       :restricted,
       :robot_index,
       :robot_follow,
+      :searchable,
       :sitemap,
       :tag_list,
       :title,
@@ -152,6 +154,7 @@ module Alchemy
     after_update :touch_nodes
 
     # Concerns
+    include PageLayouts
     include PageScopes
     include PageNatures
     include PageNaming
@@ -267,11 +270,11 @@ module Alchemy
         where(id: clipboard.collect { |p| p["id"] })
       end
 
-      def all_from_clipboard_for_select(clipboard, language_id, layoutpage = false)
+      def all_from_clipboard_for_select(clipboard, language_id, layoutpages: false)
         return [] if clipboard.blank?
 
         clipboard_pages = all_from_clipboard(clipboard)
-        allowed_page_layouts = Alchemy::PageLayout.selectable_layouts(language_id, layoutpage)
+        allowed_page_layouts = Alchemy::Page.selectable_layouts(language_id, layoutpages: layoutpages)
         allowed_page_layout_names = allowed_page_layouts.collect { |p| p["name"] }
         clipboard_pages.select { |cp| allowed_page_layout_names.include?(cp.page_layout) }
       end

data/app/models/alchemy/picture_thumb/create.rb

@@ -15,13 +15,25 @@ module Alchemy
         # @return [Alchemy::PictureThumb] The persisted thumbnail record
         #
         def call(variant, signature, uid)
-          image = variant.image
-          image.to_file(server_path(uid)).close
-          variant.picture.thumbs.create!(
+          return if !variant.picture.valid?
+
+          # create the thumb before storing
+          # to prevent db race conditions
+          thumb = Alchemy::PictureThumb.create!(
             picture: variant.picture,
             signature: signature,
             uid: uid,
           )
+          begin
+            # process the image
+            image = variant.image
+            # store the processed image
+            image.to_file(server_path(uid)).close
+          rescue RuntimeError => e
+            ErrorTracking.notification_handler.call(e)
+            # destroy the thumb if processing or storing fails
+            thumb&.destroy
+          end
         end
 
         private

data/app/models/concerns/alchemy/dom_ids.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module DomIds
+    extend ActiveSupport::Concern
+
+    RESERVED_ANCHOR_SETTING_VALUES = %w[false from_value true]
+
+    included do
+      before_validation :parameterize_dom_id,
+        if: -> { settings[:anchor].to_s == "true" }
+      before_validation :set_dom_id_from_value,
+        if: -> { settings[:anchor].to_s == "from_value" }
+      before_validation :set_dom_id_to_fixed_value,
+        if: -> { !RESERVED_ANCHOR_SETTING_VALUES.include? settings[:anchor].to_s }
+    end
+
+    private
+
+    def parameterize_dom_id
+      self.dom_id = dom_id&.parameterize
+    end
+
+    def set_dom_id_from_value
+      self.dom_id = value&.parameterize
+    end
+
+    def set_dom_id_to_fixed_value
+      self.dom_id = settings[:anchor]&.parameterize
+    end
+  end
+end

data/app/serializers/alchemy/ingredient_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class IngredientSerializer < ActiveModel::Serializer
+    attributes :id,
+      :role,
+      :value,
+      :element_id,
+      :data
+  end
+end

data/app/views/alchemy/admin/elements/update.js.erb

@@ -7,6 +7,9 @@
 
   $errors.hide();
   $el.trigger('SaveElement.Alchemy', {previewText: '<%= j sanitize(@element.preview_text) %>'});
+  <% @element.ingredients.select { |i| i.settings[:anchor] }.each do |ingredient| %>
+    Alchemy.IngredientAnchorLink.updateIcon(<%= ingredient.id %>, <%= ingredient.dom_id.present? %>);
+  <% end %>
   Alchemy.growl('<%= Alchemy.t(:element_saved) %>');
   Alchemy.PreviewWindow.refresh(function() {
     Alchemy.ElementEditors.focusElementPreview(<%= @element.id %>);

data/app/views/alchemy/admin/ingredients/_dom_id_fields.html.erb

@@ -0,0 +1,4 @@
+<% disabled = ingredient.settings[:anchor].to_s != "true" %>
+<%= f.input :dom_id,
+  disabled: disabled,
+  hint: disabled && Alchemy.t(:automatic_anchor_notice) %>

data/app/views/alchemy/admin/ingredients/_headline_fields.html.erb

@@ -0,0 +1,3 @@
+<% if ingredient.settings[:anchor] %>
+  <%= render "dom_id_fields", f: f, ingredient: ingredient %>
+<% end %>

data/app/views/alchemy/admin/ingredients/_text_fields.html.erb

@@ -0,0 +1,3 @@
+<% if ingredient.settings[:anchor] %>
+  <%= render "dom_id_fields", f: f, ingredient: ingredient %>
+<% end %>

data/app/views/alchemy/admin/ingredients/update.js.erb

@@ -0,0 +1,7 @@
+Alchemy.closeCurrentDialog(
+<% if @ingredient.settings[:anchor] %>
+  function() {
+    Alchemy.IngredientAnchorLink.updateIcon(<%= @ingredient.id %>, <%= @ingredient.dom_id.present? %>);
+  }
+<% end %>
+);

data/app/views/alchemy/admin/languages/_form.html.erb

@@ -14,7 +14,7 @@
   <%= f.input :frontpage_name %>
   <%= f.input :page_layout,
     collection: Alchemy::PageLayout.all,
-    label_method: ->(p) { Alchemy::PageLayout.human_layout_name(p['name']) },
+    label_method: ->(p) { Alchemy::Page.human_layout_name(p['name']) },
     value_method: ->(p) { p['name'] },
     input_html: {class: 'alchemy_selectbox'} %>
   <%= f.input :public %>

data/app/views/alchemy/admin/languages/_language.html.erb

@@ -18,7 +18,7 @@
     <%= language.frontpage_name %>
   </td>
   <td>
-    <%= Alchemy::PageLayout.human_layout_name(language.page_layout) %>
+    <%= Alchemy::Page.human_layout_name(language.page_layout) %>
   </td>
   <td class="center">
     <%= language.public? ? render_icon(:check) : nil %>

data/app/views/alchemy/admin/pages/_form.html.erb

@@ -19,6 +19,15 @@
   <%= f.input :title,
     input_html: {'data-alchemy-char-counter' => 60} %>
 
+  <% if Alchemy.enable_searchable %>
+    <div class="input check_boxes">
+      <label class="control-label"><%= Alchemy.t(:fulltext_search) %></label>
+      <div class="control_group">
+        <%= page_status_checkbox(@page, :searchable) %>
+      </div>
+    </div>
+  <% end %>
+
   <div class="input check_boxes">
     <label class="control-label"><%= Alchemy.t(:search_engines) %></label>
     <div class="control_group">

data/app/views/alchemy/admin/pages/_page_layout_filter.html.erb

@@ -6,7 +6,7 @@
       options_for_select(
         @current_language.site.page_layout_names.map do |layout|
           [
-            Alchemy::PageLayout.human_layout_name(layout),
+            Alchemy::Page.human_layout_name(layout),
             layout
           ]
         end,