alchemy_cms 6.0.4 → 6.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9bfd92678d3b4ae867e8c3938a0277d7698fb6fbcfb80a0210f0c4371990486
-  data.tar.gz: ce854781846eadaecdbe717ab435a38d357cda54863707b2c62a61cf4730884b
+  metadata.gz: b0fce84117963b495d370420cf9284024ee5f64b9016c19d711611e73ab7c37b
+  data.tar.gz: 693fbc3e13673bb75eef4defb7c660b20840b27fee01730f73ab7946fa7cb823
 SHA512:
-  metadata.gz: 51391e56da530c900189d8c16b756d9084fac351cfc50ebc2ee9b7181d7148c826daf39bdd284100261aa6e4ae5c1a4f28eb266c1a31d9fd1ad31f21e2cda398
-  data.tar.gz: 244eb43ca4783a572c5885c69571264a50d4154a5ccfc8b5af806f1343497cc38a8157a1b8c039262d60ea8f4cd6a3a19777943ca9b1c0654a6cd473d3f9f025
+  metadata.gz: 77b35133d99ad3458fe8c1c37abb70dc120841844f7dfeabde471fbc3740d551d726057b1f306c1890dcc39c1e89fe0e16d6fb18ebfda23888da8b3c5d4178f4
+  data.tar.gz: 0e34ec1637dcfe6a580f3f846b4237859efbdd0c415b0d7dda109a1eac4d0553cd7206a52c31b5396834334931a862879e49fe52f69424a69ec8891b2c98fc02

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 6.0.7 (2022-06-04)
+
+- Eagerly generate thumbs for srcset images in task as well [#2344](https://github.com/AlchemyCMS/alchemy_cms/pull/2344) ([tvdeyen](https://github.com/tvdeyen))
+- Use HashWithIndifferentAccess for Page definition.  Key hint translation by page_layout [#2343](https://github.com/AlchemyCMS/alchemy_cms/pull/2343) ([dbwinger](https://github.com/dbwinger))
+
+## 6.0.6 (2022-05-30)
+
+- Add task to eagerly generate ingredients pictures thumbnails [#2342](https://github.com/AlchemyCMS/alchemy_cms/pull/2342) ([tvdeyen](https://github.com/tvdeyen))
+- Add spec for ingredients migrator; fix preloading in Rails 6.1+ [#2340](https://github.com/AlchemyCMS/alchemy_cms/pull/2340) ([mamhoff](https://github.com/mamhoff))
+- Extract element ingredient migrator [#2337](https://github.com/AlchemyCMS/alchemy_cms/pull/2337) ([tvdeyen](https://github.com/tvdeyen))
+- Update published_at only after page has been published. [#2331](https://github.com/AlchemyCMS/alchemy_cms/pull/2331) ([pascalbetz](https://github.com/pascalbetz))
+- Add element groups functionality for cleaning up editors [#2124](https://github.com/AlchemyCMS/alchemy_cms/pull/2124) ([dbwinger](https://github.com/dbwinger))
+- Eagerload at the controller or job layer [#2313](https://github.com/AlchemyCMS/alchemy_cms/pull/2313) ([mamhoff](https://github.com/mamhoff))
+
+## 6.0.5 (2022-05-11)
+
+- Extract element ingredient migrator [#2337](https://github.com/AlchemyCMS/alchemy_cms/pull/2337) ([tvdeyen](https://github.com/tvdeyen))
+
 ## 6.0.4 (2022-05-06)
 
 - Add support for Rails' recycable cache keys [#2334](https://github.com/AlchemyCMS/alchemy_cms/pull/2334) ([tvdeyen](https://github.com/tvdeyen))

data/app/assets/javascripts/alchemy/alchemy.element_editors.js.coffee

@@ -15,6 +15,7 @@ Alchemy.ElementEditors =
   init: ->
     @element_area = $("#element_area")
     @bindEvents()
+    @expandContentGroups()
     return
 
   # Binds click events on several DOM elements from element editors
@@ -36,12 +37,20 @@ Alchemy.ElementEditors =
     # Binds the custom SaveElement event
     @element_area.on "SaveElement.Alchemy", '.element-editor', (e, data) =>
       @onSaveElement(e, data)
+    @element_area.on "click", '[data-toggle-content-group]', (e) =>
+      @onToggleContentGroup(e)
     # Listen to postMessage messages from the preview frame
     window.addEventListener 'message', (e) =>
       @onMessage(e.data)
       true
     return
 
+  # Expands content groups that are stored in sessionStorage as expanded
+  expandContentGroups: ->
+    if $expanded_content_groups = sessionStorage.getItem('Alchemy.expanded_content_groups')
+      for header_id in JSON.parse($expanded_content_groups) then do (header_id) =>
+        $('#' + header_id).closest('.content-group').addClass('expanded');
+
   # Selects and scrolls to element with given id in the preview window.
   #
   focusElementPreview: (element_id) ->
@@ -170,6 +179,23 @@ Alchemy.ElementEditors =
       Alchemy.Buttons.enable($element)
     true
 
+  # Toggle visibility of the content fields in the group
+  onToggleContentGroup: (event) ->
+    $group_div = $(event.currentTarget).closest('.content-group');
+    $group_div.toggleClass('expanded');
+
+    $expanded_content_groups = JSON.parse(sessionStorage.getItem('Alchemy.expanded_content_groups') || '[]');
+    # Add or remove depending on whether this content group is expanded
+    if $group_div.hasClass('expanded')
+      if $expanded_content_groups.indexOf(event.currentTarget.id) == -1
+        $expanded_content_groups.push(event.currentTarget.id);
+    else
+      $expanded_content_groups = $expanded_content_groups.filter (value) ->
+        value != event.currentTarget.id
+
+    sessionStorage.setItem('Alchemy.expanded_content_groups', JSON.stringify($expanded_content_groups))
+    false
+
   # Event handlers
 
   onMessage: (data) ->

data/app/assets/stylesheets/alchemy/elements.scss

@@ -414,6 +414,41 @@
   }
 }
 
+.content-group {
+  width: 100%;
+  padding: $default-padding 0;
+  position: relative;
+  border-bottom: 1px solid $medium-gray;
+
+  &:last-child {
+    border-bottom: none;
+    padding-bottom: 0;
+  }
+
+  .content-group-header {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    font-weight: bold;
+    text-decoration: none;
+    padding: $default-padding 1px;
+  }
+
+  .content-group-contents {
+    display: none;
+  }
+
+  &.expanded {
+    .content-group-contents {
+      display: block;
+    }
+
+    .content-group-expand {
+      @extend .fa-angle-up;
+    }
+  }
+}
+
 .element-content-editors,
 .element-ingredient-editors {
   display: flex;

data/app/controllers/alchemy/admin/pages_controller.rb

@@ -324,7 +324,7 @@ module Alchemy
       end
 
       def load_resource
-        @page = Page.find(params[:id])
+        @page = Page.includes(page_includes).find(params[:id])
       end
 
       def pages_from_raw_request
@@ -402,6 +402,10 @@ module Alchemy
       def set_preview_mode
         @preview_mode = true
       end
+
+      def page_includes
+        Alchemy::EagerLoading.page_includes(version: :draft_version)
+      end
     end
   end
 end

data/app/controllers/alchemy/pages_controller.rb

@@ -104,7 +104,14 @@ module Alchemy
     # If no index page and no admin users are present we show the "Welcome to Alchemy" page.
     #
     def load_index_page
-      @page ||= Language.current_root_page
+      @page ||= begin
+        Alchemy::Page.
+          contentpages.
+          language_roots.
+          where(language: Language.current).
+          includes(page_includes).
+          first
+      end
       render template: "alchemy/welcome", layout: false if signup_required?
     end
 
@@ -120,10 +127,13 @@ module Alchemy
     def load_page
       page_not_found! unless Language.current
 
-      @page ||= Language.current.pages.contentpages.find_by(
-        urlname: params[:urlname],
-        language_code: params[:locale] || Language.current.code,
-      )
+      @page ||= begin
+        Alchemy::Page.
+          contentpages.
+          where(language: Language.current).
+          includes(page_includes).
+          find_by(urlname: params[:urlname])
+      end
     end
 
     def enforce_locale
@@ -234,5 +244,9 @@ module Alchemy
     def page_not_found!
       not_found_error!("Alchemy::Page not found \"#{request.fullpath}\"")
     end
+
+    def page_includes
+      Alchemy::EagerLoading.page_includes(version: :public_version)
+    end
   end
 end

data/app/decorators/alchemy/element_editor.rb

@@ -36,6 +36,29 @@ module Alchemy
       element.definition.fetch(:ingredients, []).any?
     end
 
+    # Returns the translated content/ingredient group for displaying in admin editor group headings
+    #
+    # Translate it in your locale yml file:
+    #
+    #   alchemy:
+    #     element_groups:
+    #       foo: Bar
+    #
+    # Optionally you can scope your ingredient role to an element:
+    #
+    #   alchemy:
+    #     element_groups:
+    #       article:
+    #         foo: Baz
+    #
+    def translated_group(group)
+      Alchemy.t(
+        group,
+        scope: "element_groups.#{element.name}",
+        default: Alchemy.t("element_groups.#{group}", default: group.humanize),
+      )
+    end
+
     # CSS classes for the element editor partial.
     def css_classes
       [

data/app/jobs/alchemy/publish_page_job.rb

@@ -4,7 +4,10 @@ module Alchemy
   class PublishPageJob < BaseJob
     queue_as :default
 
-    def perform(page, public_on:)
+    def perform(page_id, public_on:)
+      page = Alchemy::Page.includes(
+        Alchemy::EagerLoading.page_includes(version: :draft_version)
+      ).find(page_id)
       Alchemy::Page::Publisher.new(page).publish!(public_on: public_on)
     end
   end

data/app/models/alchemy/eager_loading.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Eager loading parameters for loading pages
+  class EagerLoading
+    PAGE_VERSIONS = %i[draft_version public_version]
+
+    class << self
+      # Eager loading parameters for {ActiveRecord::Base.includes}
+      #
+      # Pass this to +includes+ whereever you load an {Alchemy::Page}
+      #
+      #     Alchemy::Page.includes(Alchemy::EagerLoading.page_includes).find_by(urlname: "my-page")
+      #
+      # @param version [Symbol] Type of page version to eager load
+      # @return [Array]
+      def page_includes(version: :public_version)
+        raise UnsupportedPageVersion unless version.in? PAGE_VERSIONS
+
+        [
+          :tags,
+          {
+            language: :site,
+            version => {
+              elements: [
+                :page,
+                :touchable_pages,
+                {
+                  ingredients: :related_object,
+                  contents: :essence,
+                },
+              ],
+            },
+          },
+        ]
+      end
+    end
+  end
+end

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

@@ -12,7 +12,9 @@ module Alchemy
 
       # Copies all currently visible elements to the public version of page
       #
-      # Creates a new published version if none exists yet.
+      # Creates a new published version if none exists yet and updates
+      # the `published_at` timestamp of the page.
+      # `published_at` is used as a cache key.
       #
       # Sends a publish notification to all registered publish targets
       #
@@ -32,6 +34,7 @@ module Alchemy
               end
             end
           end
+          page.update(published_at: public_on)
         end
 
         Alchemy.publish_targets.each { |p| p.perform_later(page) }

data/app/models/alchemy/page.rb

@@ -457,15 +457,10 @@ module Alchemy
       end
     end
 
-    # Creates a public version of the page.
-    #
-    # Sets the +published_at+ value to current time
-    #
-    # The +published_at+ attribute is used as +cache_key+.
+    # Creates a public version of the page in the background.
     #
     def publish!(current_time = Time.current)
-      update(published_at: current_time)
-      PublishPageJob.perform_later(self, public_on: current_time)
+      PublishPageJob.perform_later(id, public_on: current_time)
     end
 
     # Sets the public_on date on the published version
@@ -570,6 +565,12 @@ module Alchemy
       locker.try(:name) || Alchemy.t("unknown")
     end
 
+    # Key hint translations by page layout, rather than the default name.
+    #
+    def hint_translation_attribute
+      page_layout
+    end
+
     # Menus (aka. root nodes) this page is attached to
     #
     def menus

data/app/models/alchemy/page_version.rb

@@ -46,7 +46,7 @@ module Alchemy
     end
 
     def element_repository
-      ElementsRepository.new(elements.includes({ contents: :essence }, :tags))
+      ElementsRepository.new(elements)
     end
 
     private

data/app/views/alchemy/admin/elements/_element.html.erb

@@ -23,15 +23,44 @@
         html: {id: "element_#{element.id}_form".html_safe, class: 'element-content'} do |f| %>
 
         <div id="element_<%= element.id %>_errors" class="element_errors"></div>
+
+        <!-- Ingredients -->
         <% if element.has_ingredients_defined? %>
           <div class="element-ingredient-editors">
-            <%= render element.ingredients, element_form: f %>
-          </div>
-        <% else %>
-          <div id="element_<%= element.id %>_content" class="element-content-editors">
-            <%= render element.contents %>
+            <%= render element.ingredients.select { |i| !i.definition[:group] }, element_form: f %>
+
+            <!-- Each ingredient group -->
+            <% element.ingredients.select { |i| i.definition[:group] }.group_by { |i| i.definition[:group] }.each do |group, ingredients| %>
+              <div class="content-group">
+                <%= link_to '#', id: "element_#{element.id}_content_group_#{group.parameterize.underscore}_header", class: 'content-group-header', data: { toggle_content_group: true } do %>
+                  <%= element.translated_group group %>
+                  <i class="content-group-expand icon fa-fw fa-angle-down fas"></i>
+                <% end %>
+                <%= content_tag :div, id: "element_#{element.id}_content_group_#{group.parameterize.underscore}", class: 'content-group-contents' do %>
+                  <%= render ingredients, element_form: f %>
+                <% end %>
+              </div>
+            <% end %>
           </div>
         <% end %>
+        <!-- Contents -->
+        <div id="element_<%= element.id %>_content" class="element-content-editors">
+          <%= render element.contents.select { |c| !c.definition[:group] } %>
+
+          <!-- Each content group -->
+          <% element.contents.select { |c| c.definition[:group] }.group_by { |c| c.definition[:group] }.each do |group, contents| %>
+            <div class="content-group">
+              <%= link_to '#', id: "element_#{element.id}_content_group_#{group.parameterize.underscore}_header", class: 'content-group-header', data: { toggle_content_group: true } do %>
+                <%= element.translated_group group %>
+                <i class="content-group-expand icon fa-fw fa-angle-down fas"></i>
+              <% end %>
+              <%= content_tag :div, id: "element_#{element.id}_content_group_#{group.parameterize.underscore}", class: 'content-group-contents' do %>
+                <%= render contents, element_form: f %>
+              <% end %>
+            </div>
+          <% end %>
+        </div>
+
         <% if element.taggable? %>
           <div class="autocomplete_tag_list">
             <%= f.label :tag_list %>

data/lib/alchemy/errors.rb

@@ -11,7 +11,7 @@ module Alchemy
     # Raised if no default language configuration can be found.
     def message
       "No default language configuration found!" \
-        " Please ensure that you have a 'default_language' defined in Alchemy configuration file."
+      " Please ensure that you have a 'default_language' defined in Alchemy configuration file."
     end
   end
 
@@ -19,7 +19,7 @@ module Alchemy
     # Raised if no default site configuration can be found.
     def message
       "No default site configuration found!" \
-        " Please ensure that you have a 'default_site' defined in Alchemy configuration file."
+      " Please ensure that you have a 'default_site' defined in Alchemy configuration file."
     end
   end
 
@@ -90,4 +90,10 @@ module Alchemy
       "You need to provide a current_user method in your ApplicationController that returns the current authenticated user."
     end
   end
+
+  class UnsupportedPageVersion < StandardError
+    def message
+      "Unknown Version! Please use one of #{Alchemy::EagerLoading::PAGE_VERSIONS.join(", ")}"
+    end
+  end
 end

data/lib/alchemy/page_layout.rb

@@ -8,7 +8,7 @@ module Alchemy
       # They are defined in +config/alchemy/page_layout.yml+ file.
       #
       def all
-        @definitions ||= read_definitions_file
+        @definitions ||= read_definitions_file.map(&:with_indifferent_access)
       end
 
       # Add additional page definitions to collection.
@@ -151,11 +151,13 @@ module Alchemy
       #
       def read_definitions_file
         if File.exist?(layouts_file_path)
-          YAML.safe_load(
-            ERB.new(File.read(layouts_file_path)).result,
-            permitted_classes: YAML_PERMITTED_CLASSES,
-            aliases: true,
-          ) || []
+          Array.wrap(
+            YAML.safe_load(
+              ERB.new(File.read(layouts_file_path)).result,
+              permitted_classes: YAML_PERMITTED_CLASSES,
+              aliases: true,
+            ) || []
+          )
         else
           raise LoadError, "Could not find page_layouts.yml file! Please run `rails generate alchemy:install`"
         end

data/lib/alchemy/upgrader/tasks/ingredients_migrator.rb

@@ -16,7 +16,7 @@ module Alchemy::Upgrader::Tasks
           # eager load all elements that have ingredients defined but no ingredient records yet.
           all_elements = Alchemy::Element
             .named(elements_with_ingredients.map { |d| d[:name] })
-            .includes(contents: :essence)
+            .preload(contents: :essence)
             .left_outer_joins(:ingredients).where(alchemy_ingredients: { id: nil })
             .to_a
           elements_with_ingredients.map do |element_definition|
@@ -24,31 +24,8 @@ module Alchemy::Upgrader::Tasks
             if elements.any?
               puts "-- Creating ingredients for #{elements.count} #{element_definition[:name]}(s)"
               elements.each do |element|
-                Alchemy::Element.transaction do
-                  element_definition[:ingredients].each do |ingredient_definition|
-                    content = element.content_by_name(ingredient_definition[:role])
-                    next unless content
-
-                    essence = content.essence
-                    ingredient = element.ingredients.build(
-                      role: ingredient_definition[:role],
-                      type: Alchemy::Ingredient.normalize_type(ingredient_definition[:type]),
-                    )
-                    belongs_to_associations = essence.class.reflect_on_all_associations(:belongs_to)
-                    if belongs_to_associations.any?
-                      ingredient.related_object = essence.public_send(belongs_to_associations.first.name)
-                    else
-                      ingredient.value = content.ingredient
-                    end
-                    data = ingredient.class.stored_attributes.fetch(:data, []).each_with_object({}) do |attr, d|
-                      d[attr] = essence.public_send(attr)
-                    end
-                    ingredient.data = data
-                    print "."
-                    ingredient.save!
-                    content.destroy!
-                  end
-                end
+                MigrateElementIngredients.call(element)
+                print "."
               end
               puts "\n"
             else
@@ -58,5 +35,38 @@ module Alchemy::Upgrader::Tasks
         end
       end
     end
+
+    class MigrateElementIngredients
+      def self.call(element)
+        Alchemy::Element.transaction do
+          element.definition[:ingredients].each do |ingredient_definition|
+            ingredient = element.ingredients.build(
+              role: ingredient_definition[:role],
+              type: Alchemy::Ingredient.normalize_type(ingredient_definition[:type]),
+            )
+
+            content = element.content_by_name(ingredient_definition[:role])
+            if content
+              essence = content.essence
+              if essence
+                belongs_to_associations = essence.class.reflect_on_all_associations(:belongs_to)
+                if belongs_to_associations.any?
+                  ingredient.related_object = essence.public_send(belongs_to_associations.first.name)
+                else
+                  ingredient.value = content.ingredient
+                end
+                data = ingredient.class.stored_attributes.fetch(:data, []).each_with_object({}) do |attr, d|
+                  d[attr] = essence.public_send(attr)
+                end
+                ingredient.data = data
+              end
+              content.destroy!
+            end
+
+            ingredient.save!
+          end
+        end
+      end
+    end
   end
 end

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "6.0.4"
+  VERSION = "6.0.7"
 
   def self.version
     VERSION

data/lib/tasks/alchemy/thumbnails.rake

@@ -6,6 +6,7 @@ namespace :alchemy do
     task thumbnails: [
       "alchemy:generate:picture_thumbnails",
       "alchemy:generate:essence_picture_thumbnails",
+      "alchemy:generate:ingredient_picture_thumbnails",
     ]
 
     desc "Generates thumbnails for Alchemy Pictures."
@@ -31,6 +32,38 @@ namespace :alchemy do
       essence_pictures.find_each do |essence_picture|
         puts essence_picture.picture_url
         puts essence_picture.thumbnail_url
+
+        essence_picture.settings.fetch(:srcset, []).each do |src|
+          puts essence_picture.picture_url(src)
+        end
+      end
+
+      puts "Done!"
+    end
+
+    desc "Generates thumbnails for Alchemy Picture Ingredients (set ELEMENTS=element1,element2 to only generate thumbnails for a subset of elements)."
+    task ingredient_picture_thumbnails: :environment do
+      ingredient_pictures = Alchemy::Ingredients::Picture.
+        joins(:element).
+        preload({ related_object: :thumbs }).
+        merge(Alchemy::Element.available)
+
+      if ENV["ELEMENTS"].present?
+        ingredient_pictures = ingredient_pictures.merge(
+          Alchemy::Element.named(ENV["ELEMENTS"].split(","))
+        )
+      end
+
+      puts "Regenerate #{ingredient_pictures.count} ingredient picture thumbnails."
+      puts "Please wait..."
+
+      ingredient_pictures.find_each do |ingredient_picture|
+        puts ingredient_picture.picture_url
+        puts ingredient_picture.thumbnail_url
+
+        ingredient_picture.settings.fetch(:srcset, []).each do |src|
+          puts ingredient_picture.picture_url(src)
+        end
       end
 
       puts "Done!"

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alchemy_cms/admin",
-  "version": "6.0.4",
+  "version": "6.0.7",
   "description": "AlchemyCMS",
   "browser": "package/admin.js",
   "files": [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy_cms
 version: !ruby/object:Gem::Version
-  version: 6.0.4
+  version: 6.0.7
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -916,6 +916,7 @@ files:
 - app/models/alchemy/base_record.rb
 - app/models/alchemy/content.rb
 - app/models/alchemy/content/factory.rb
+- app/models/alchemy/eager_loading.rb
 - app/models/alchemy/element.rb
 - app/models/alchemy/element/definitions.rb
 - app/models/alchemy/element/element_contents.rb