alchemy_cms 6.0.14 → 6.1.0

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

@@ -103,7 +103,6 @@ module Alchemy
     scope :published, -> { where(public: true) }
     scope :hidden, -> { where(public: false) }
     scope :not_restricted, -> { joins(:page).merge(Page.not_restricted) }
-    scope :available, -> { published }
     scope :named, ->(names) { where(name: names) }
     scope :excluded, ->(names) { where.not(name: names) }
     scope :fixed, -> { where(fixed: true) }
@@ -143,6 +142,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
@@ -178,8 +189,6 @@ module Alchemy
 
         all_from_clipboard(clipboard).where(name: parent_element.definition["nestable_elements"])
       end
-
-      deprecate available: :published, deprecator: Alchemy::Deprecation
     end
 
     # Returns next public element from same page.

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"
@@ -152,6 +153,7 @@ module Alchemy
     after_update :touch_nodes
 
     # Concerns
+    include PageLayouts
     include PageScopes
     include PageNatures
     include PageNaming
@@ -267,11 +269,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

@@ -30,7 +30,7 @@ module Alchemy
             # store the processed image
             image.to_file(server_path(uid)).close
           rescue RuntimeError => e
-            Rails.logger.warn(e)
+            ErrorTracking.notification_handler.call(e)
             # destroy the thumb if processing or storing fails
             thumb&.destroy
           end

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

data/app/views/alchemy/admin/partials/_routes.html.erb

@@ -34,6 +34,7 @@
     order_admin_elements_path: '<%= alchemy.order_admin_elements_path %>',
     link_admin_pages_path: '<%= alchemy.link_admin_pages_path %>',
     api_pages_path: '<%= alchemy.api_pages_path %>',
-    api_elements_path: '<%= alchemy.api_elements_path %>'
+    api_elements_path: '<%= alchemy.api_elements_path %>',
+    api_ingredients_path: '<%= alchemy.api_ingredients_path %>'
   };
 </script>

data/app/views/alchemy/ingredients/_headline_editor.html.erb

@@ -1,3 +1,6 @@
+<% has_level_select = headline_editor.level_options.many? %>
+<% has_size_select = headline_editor.size_options.many? %>
+
 <%= content_tag :div,
   class: headline_editor.css_classes,
   data: headline_editor.data_attributes do %>
@@ -5,26 +8,25 @@
     <%= ingredient_label(headline_editor) %>
     <%= f.text_field :value, id: nil %>
 
-    <div class="input-row">
-      <% if headline_editor.level_options.length > 1 %>
-        <div class="input-column">
-          <%= f.label :level %>
-          <%= f.select :level,
-            options_for_select(headline_editor.level_options, headline_editor.level),
-            {},
-            { class: "alchemy_selectbox full_width" } %>
-        </div>
-      <% end %>
+    <% if headline_editor.settings[:anchor] %>
+      <%= render "alchemy/ingredients/shared/anchor", ingredient_editor: headline_editor %>
+    <% end %>
+
+    <% if has_level_select %>
+      <div class="input-addon right<%= " second" if has_size_select %>">
+        <%= f.select :level,
+          options_for_select(headline_editor.level_options, headline_editor.level),
+          {},
+          { class: "custom-select", title: f.object.class.human_attribute_name(:level) } %>
+      </div>
+    <% end %>
 
-      <% if headline_editor.size_options.length > 1 %>
-        <div class="input-column">
-          <%= f.label :size %>
-          <%= f.select :size,
-            options_for_select(headline_editor.size_options, headline_editor.size),
-            {},
-            { class: "alchemy_selectbox full_width" } %>
-        </div>
-      <% end %>
-    </div>
+    <% if has_size_select %>
+      <div class="input-addon right">
+        <%= f.select :size, options_for_select(headline_editor.size_options, headline_editor.size),
+          {},
+          { class: "custom-select", title: f.object.class.human_attribute_name(:size) } %>
+      </div>
+    <% end %>
   <% end %>
 <% end %>

data/app/views/alchemy/ingredients/_headline_view.html.erb

@@ -2,6 +2,7 @@
 
 <%= content_tag "h#{headline_view.level}",
     headline_view.value,
+    id: headline_view.dom_id.presence,
     class: [
       headline_view.size ? "h#{headline_view.size}" : nil,
       html_options[:class]

data/app/views/alchemy/ingredients/_text_editor.html.erb

@@ -9,6 +9,9 @@
       class: text_editor.settings[:linkable] ? "text_with_icon" : "",
       id: nil,
       type: text_editor.settings[:input_type] || "text" %>
+    <% if text_editor.settings[:anchor] %>
+      <%= render "alchemy/ingredients/shared/anchor", ingredient_editor: text_editor %>
+    <% end %>
     <% if text_editor.settings[:linkable] %>
       <%= f.hidden_field :link, "data-link-value": true, id: nil %>
       <%= f.hidden_field :link_title, "data-link-title": true, id: nil %>

data/app/views/alchemy/ingredients/_text_view.html.erb

@@ -1,13 +1,17 @@
 <%- options = local_assigns.fetch(:options, {}) -%>
 <%- html_options = local_assigns.fetch(:html_options, {}) -%>
-<%- if text_view.link.blank? ||
-    text_view.settings_value(:disable_link, options) -%>
-<%= text_view.value -%>
+<%- if text_view.link.blank? || text_view.settings_value(:disable_link, options) -%>
+  <%- if text_view.dom_id.present? -%>
+    <%= content_tag :a, text_view.value, id: text_view.dom_id %>
+  <% else %>
+    <%= text_view.value -%>
+  <%- end -%>
 <%- else -%>
   <%= link_to(
     text_view.value,
     url_for(text_view.link),
     {
+      id: text_view.dom_id.presence,
       title: text_view.link_title,
       target: (text_view.link_target == "blank" ? "_blank" : nil),
       'data-link-target' => text_view.link_target

data/app/views/alchemy/ingredients/shared/_anchor.html.erb

@@ -0,0 +1,9 @@
+<span class="edit-ingredient-anchor-link">
+  <%= link_to_dialog render_icon(:bookmark, { style: ingredient_editor.dom_id.present? ? "solid" : "regular" }),
+    alchemy.edit_admin_ingredient_path(id: ingredient_editor.id),
+    {
+      title: Alchemy.t(:edit_anchor),
+      size: "380x125"
+    },
+    title: Alchemy.t(:edit_anchor) %>
+</span>

data/app/views/alchemy/messages_mailer/contact_form_mail.de.text.erb

@@ -1,3 +1,5 @@
+<!-- Diese Vorlage stimmt mit den config Mailer-Feldern überein. Wenn Sie die Konfiguration ändern, erstellen Sie bitte eine eigene Datei -->
+
 <%= @message.message %>
 
 --

data/app/views/alchemy/messages_mailer/contact_form_mail.en.text.erb

@@ -1,3 +1,5 @@
+<!-- This template matches the config mailer fields. If you change the config, please create your own file: app/views/alchemy/messages_mailer/contact_form_mail.text.erb -->
+
 <%= @message.message %>
 
 --

data/app/views/alchemy/messages_mailer/contact_form_mail.es.text.erb

@@ -1,3 +1,5 @@
+<!-- Esta plantilla coincide con los campos de correo config. Si cambia la configuración, cree su propio archivo -->
+
 <%= @message.message %>
 
 --

data/config/locales/alchemy.en.yml

@@ -228,7 +228,8 @@ en:
 
     add_nested_element: "Add %{name}"
     anchor: 'Anchor'
-    anchor_link_headline: "You can link to an element anchor from the actual page."
+    anchor_link_headline: You can link to an anchor from the current page.
+    automatic_anchor_notice: The anchor is generated automatically.
     attribute_fixed: Value can't be changed for this page type
     back: 'back'
     locked_pages: "Active pages"
@@ -467,7 +468,7 @@ en:
     image_name: "Name: %{name}"
     image_title: "Title-tag"
     internal_link_headline: "Search for a page to link to by entering its name into the Page select."
-    internal_link_page_elements_explanation: "Additionally you can choose an anchor to an element from selected page."
+    internal_link_page_elements_explanation: "Additionally you can choose an anchor to link to from selected page."
     "item copied to clipboard": "Copied %{name} to clipboard"
     "item moved to clipboard": "Moved %{name} to clipboard"
     "item removed from clipboard": "Removed %{name} from clipboard"
@@ -845,6 +846,8 @@ en:
         crop_from: Crop from
         crop_size: Crop size
         picture_id: Bild
+      alchemy/ingredient:
+        dom_id: Anchor
       alchemy/language:
         country_code: "Country code"
         language_code: "Language code"

data/config/routes.rb

@@ -126,6 +126,7 @@ Alchemy::Engine.routes.draw do
 
   namespace :api, defaults: { format: "json" } do
     resources :contents, only: [:index, :show]
+    resources :ingredients, only: [:index]
 
     resources :elements, only: [:index, :show] do
       get "/contents" => "contents#index", as: "contents"

data/lib/alchemy/error_tracking/error_logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module ErrorTracking
+    class ErrorLogger < BaseHandler
+      def self.call(exception)
+        ::Rails.logger.tagged("alchemy_cms") do
+          ::Rails.logger.error("#{exception.class.name}: #{exception.message} in #{exception.backtrace.first}")
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/error_tracking.rb

@@ -9,6 +9,8 @@ module Alchemy
     end
 
     mattr_accessor :notification_handler
-    @@notification_handler = BaseHandler
   end
 end
+
+require "alchemy/error_tracking/error_logger"
+Alchemy::ErrorTracking.notification_handler = Alchemy::ErrorTracking::ErrorLogger

data/lib/alchemy/install/tasks.rb

@@ -31,13 +31,7 @@ module Alchemy
         end
 
         def inject_seeder
-          seed_file = Rails.root.join("db", "seeds.rb")
-          args = [seed_file, "Alchemy::Seeder.seed!\n"]
-          if File.exist?(seed_file)
-            append_file(*args)
-          else
-            add_file(*args)
-          end
+          append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
         end
       end
     end