alchemy_cms 6.0.0.b2 → 6.0.0.b3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e6a89657c457ab3061bdc6d2cff1eba7ab25856249071e1bbe8c7684e18055
-  data.tar.gz: 282dd5e51249513e14309c4d98a09822b2fd7d038f8494f3313e00bc1026f8df
+  metadata.gz: c8fcd022eba5fdba4ce96cfe4971344ced0191b6d12d9cbd7bad923b07b7359a
+  data.tar.gz: 9dfbf5f590c6c2e8d562bf81daeb8faf3a1358f5f46aeb8857adef4d48fd6181
 SHA512:
-  metadata.gz: 54fc70c8b8ba0305d79d3e6309d4dab7a0a050a3aad1d06014fd3f38f9af34f81970a68358a7c3c222d2d740896dccb905920e6a67ee43bfb226d925916b67e6
-  data.tar.gz: 5d5c5ea2794e1f3c2e84a6b99f4eeb07fe284e98dca598c93361ed5f977b3b4b0e966372f2bba1c32f6b5bf21f8f94ec6cb68bd7b375f6bfb899b295bc724e11
+  metadata.gz: 82cc3e7f0c3b0e8fb8a4d2219d8237d66db02275b878951be1fcc0d12f9a7fdd750415ad45b5af03a05e6abce298c718551541dc80774c689b395d758d39d942
+  data.tar.gz: 665d8a15204e872ab41867e1466c4611fec7c46f83d862669c89d3e5c3038f30fa1dfb45fb56d227a71b92c945a9c45de9a5d887bbb726af9d49b5c87121d2c9

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 6.0.0.b3 (2021-08-12)
+
+### Fixes
+
+- Simplify ingredient creation [#2171](https://github.com/AlchemyCMS/alchemy_cms/pull/2171) ([tvdeyen](https://github.com/tvdeyen))
+- Return ingredients value if element asked for ingredient [#2170](https://github.com/AlchemyCMS/alchemy_cms/pull/2170) ([tvdeyen](https://github.com/tvdeyen))
+- Fix ingredient form field DOM ids [#2167](https://github.com/AlchemyCMS/alchemy_cms/pull/2167) ([tvdeyen](https://github.com/tvdeyen))
+- Ensure resource table ends before the filter/tag sidebar [#2166](https://github.com/AlchemyCMS/alchemy_cms/pull/2166) ([robinboening](https://github.com/robinboening))
+- Return fully namespaced ingredient constant [#2164](https://github.com/AlchemyCMS/alchemy_cms/pull/2164) ([tvdeyen](https://github.com/tvdeyen))
+- (Re)-init Tinymce for elements with ingredients [#2163](https://github.com/AlchemyCMS/alchemy_cms/pull/2163) ([tvdeyen](https://github.com/tvdeyen))
+
 ## 6.0.0.b2 (2021-08-05)
 
 ### Features

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

@@ -31,15 +31,28 @@
   line-height: $form-field-line-height;
   transition: $transition-duration;
 
-  &:focus {
+  &:focus:not(.readonly) {
     @include default-focus-style($box-shadow: 0 0 0 1px $focus-color);
   }
 
-  &[disabled], .disabled {
+  &[disabled],
+  &.disabled,
+  &[readonly],
+  &.readonly {
     color: $form-field-disabled-text-color;
     background-color: $form-field-disabled-bg-color;
+    cursor: default;
+  }
+
+  &[disabled],
+  &.disabled {
     cursor: not-allowed;
   }
+
+  &[readonly],
+  &.readonly {
+    pointer-events: none;
+  }
 }
 
 %gradiated-toolbar {

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

@@ -20,7 +20,8 @@
   padding-bottom: 60px;
 
   &.with_tag_filter {
-    padding-right: 242px;
+    width: calc(100% - 235px);
+    overflow-x: auto;
   }
 }
 

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

@@ -65,6 +65,7 @@ module Alchemy
       end
 
       def destroy
+        @richtext_ids = @element.richtext_contents_ids + @element.richtext_ingredients_ids
         @element.destroy
         @notice = Alchemy.t("Successfully deleted element") % { element: @element.display_name }
       end

data/app/decorators/alchemy/element_editor.rb

@@ -26,7 +26,7 @@ module Alchemy
     # @return Array<Alchemy::IngredientEditor>
     def ingredients
       element.definition.fetch(:ingredients, []).map do |ingredient|
-        Alchemy::IngredientEditor.new(find_or_create_ingredient(ingredient[:role]))
+        Alchemy::IngredientEditor.new(find_or_create_ingredient(ingredient))
       end
     end
 
@@ -121,9 +121,12 @@ module Alchemy
       Alchemy::Content.create(element: element, name: name)
     end
 
-    def find_or_create_ingredient(role)
-      element.ingredients.find { |i| i.role == role } ||
-        Ingredient.create(element: element, role: role)
+    def find_or_create_ingredient(definition)
+      element.ingredients.detect { |i| i.role == definition[:role] } ||
+        element.ingredients.create!(
+          role: definition[:role],
+          type: Alchemy::Ingredient.normalize_type(definition[:type]),
+        )
     end
   end
 end

data/app/decorators/alchemy/ingredient_editor.rb

@@ -64,8 +64,12 @@ module Alchemy
       "element[ingredients_attributes][#{form_field_counter}][#{column}]"
     end
 
+    # Returns a unique string to be passed to a form field id.
+    #
+    # @param column [String] A Ingredient column_name. Default is 'value'
+    #
     def form_field_id(column = "value")
-      "element_ingredients_attributes_#{form_field_counter}_#{column}"
+      "element_#{element.id}_ingredient_#{id}_#{column}"
     end
 
     # Fixes Rails partial renderer calling to_model on the object

data/app/helpers/alchemy/elements_block_helper.rb

@@ -51,21 +51,23 @@ module Alchemy
       # If the element uses +ingredients+ it returns the +value+ of the ingredient record.
       #
       def ingredient(name)
-        element.ingredient(name).presence || element.ingredient_by_role(name)&.value
+        element.ingredient(name)
       end
 
-      deprecate ingredient: :value, deprecator: Alchemy::Deprecation
-
       # Returns the value of one of the element's ingredients.
       #
       def value(name)
-        element.ingredient_by_role(name)&.value
+        element.value_for(name)
       end
 
-      # Returns true if the given content or ingredient has been filled by the user.
+      # Returns true if the given content or ingredient has a value.
       #
       def has?(name)
-        element.has_ingredient?(name) || element.has_value_for?(name)
+        if element.ingredient_definitions.any?
+          element.has_value_for?(name)
+        else
+          element.has_ingredient?(name)
+        end
       end
 
       # Return's the given content's essence.

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

@@ -5,10 +5,20 @@ module Alchemy
     module ElementEssences
       # Returns the contents essence value (aka. ingredient) for passed content name.
       def ingredient(name)
-        content = content_by_name(name)
-        return nil if content.blank?
+        ing = ingredient_by_role(name)
+        if ing
+          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.
+          WARN
+          ing.value
+        else
+          content = content_by_name(name)
+          return nil if content.blank?
 
-        content.ingredient
+          content.ingredient
+        end
       end
 
       # True if the element has a content for given name,
@@ -16,6 +26,7 @@ module Alchemy
       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:
       #

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

@@ -22,6 +22,11 @@ module Alchemy
         validates_associated :ingredients, on: :update
       end
 
+      # The value of an ingredient of the element by role
+      def value_for(role)
+        ingredient_by_role(role)&.value
+      end
+
       # Find first ingredient from element by given role.
       def ingredient_by_role(role)
         ingredients.detect { |ingredient| ingredient.role == role.to_s }
@@ -87,7 +92,7 @@ module Alchemy
       # True if the element has a ingredient for given name
       # that has a non blank value.
       def has_value_for?(role)
-        ingredient_by_role(role)&.value.present?
+        value_for(role).present?
       end
 
       # Ingredient validation error messages
@@ -167,8 +172,11 @@ module Alchemy
 
       # Builds ingredients for this element as described in the +elements.yml+
       def build_ingredients
-        self.ingredients = ingredient_definitions.map do |attributes|
-          Ingredient.build(role: attributes[:role], element: self)
+        ingredient_definitions.each do |attributes|
+          ingredients.build(
+            role: attributes[:role],
+            type: Alchemy::Ingredient.normalize_type(attributes[:type]),
+          )
         end
       end
     end

data/app/models/alchemy/ingredient.rb

@@ -6,12 +6,13 @@ module Alchemy
 
     include Hints
 
-    self.abstract_class = true
     self.table_name = "alchemy_ingredients"
 
     belongs_to :element, touch: true, class_name: "Alchemy::Element", inverse_of: :ingredients
     belongs_to :related_object, polymorphic: true, optional: true
 
+    before_validation(on: :create) { self.value ||= default_value }
+
     validates :type, presence: true
     validates :role, presence: true
 
@@ -33,32 +34,6 @@ module Alchemy
     scope :videos, -> { where(type: "Alchemy::Ingredients::Video") }
 
     class << self
-      # Builds concrete ingredient class as described in the +elements.yml+
-      def build(attributes = {})
-        element = attributes[:element]
-        raise ArgumentError, "No element given. Please pass element in attributes." if element.nil?
-        raise ArgumentError, "No role given. Please pass role in attributes." if attributes[:role].nil?
-
-        definition = element.ingredient_definition_for(attributes[:role])
-        if definition.nil?
-          raise DefinitionError,
-            "No definition found for #{attributes[:role]}. Please define #{attributes[:role]} on #{element[:name]}."
-        end
-
-        ingredient_class = Ingredient.ingredient_class_by_type(definition[:type])
-        ingredient_class.new(
-          type: Ingredient.normalize_type(definition[:type]),
-          value: default_value(definition),
-          role: definition[:role],
-          element: element,
-        )
-      end
-
-      # Creates concrete ingredient class as described in the +elements.yml+
-      def create(attributes = {})
-        build(attributes).tap(&:save)
-      end
-
       # Defines getter and setter method aliases for related object
       #
       # @param [String|Symbol] The name of the alias
@@ -78,20 +53,6 @@ module Alchemy
         end
       end
 
-      # Returns an ingredient class by type
-      #
-      # Raises ArgumentError if there is no such class in the
-      # +Alchemy::Ingredients+ module namespace.
-      #
-      # If you add custom ingredient class,
-      # put them in the +Alchemy::Ingredients+ module namespace
-      #
-      # @param [String] The ingredient class name to constantize
-      # @return [Class]
-      def ingredient_class_by_type(ingredient_type)
-        Alchemy::Ingredients.const_get(ingredient_type.to_s.classify.demodulize)
-      end
-
       # Modulize ingredient type
       #
       # Makes sure the passed ingredient type is in the +Alchemy::Ingredients+
@@ -112,22 +73,6 @@ module Alchemy
           default: Alchemy.t("ingredient_roles.#{role}", default: role.humanize),
         )
       end
-
-      private
-
-      # Returns the default value from ingredient definition
-      #
-      # If the value is a symbol it gets passed through i18n
-      # inside the +alchemy.default_ingredient_texts+ scope
-      def default_value(definition)
-        default = definition[:default]
-        case default
-        when Symbol
-          Alchemy.t(default, scope: :default_ingredient_texts)
-        else
-          default
-        end
-      end
     end
 
     # Compatibility method for access from element
@@ -220,5 +165,19 @@ module Alchemy
     def hint_translation_attribute
       role
     end
+
+    # Returns the default value from ingredient definition
+    #
+    # If the value is a symbol it gets passed through i18n
+    # inside the +alchemy.default_ingredient_texts+ scope
+    def default_value
+      default = definition[:default]
+      case default
+      when Symbol
+        Alchemy.t(default, scope: :default_ingredient_texts)
+      else
+        default
+      end
+    end
   end
 end

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

@@ -34,7 +34,7 @@
 
   Alchemy.growl('<%= Alchemy.t(:successfully_added_element) %>');
   Alchemy.closeCurrentDialog();
-  Alchemy.Tinymce.init(<%= @element.richtext_contents_ids.to_json %>);
+  Alchemy.Tinymce.init(<%= (@element.richtext_contents_ids + @element.richtext_ingredients_ids).to_json %>);
   Alchemy.PreviewWindow.refresh(function() {
     Alchemy.ElementEditors.focusElementPreview(<%= @element.id %>);
   });

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

@@ -3,9 +3,7 @@ $('#element_<%= @element.id %>').hide(200, function() {
   Alchemy.growl('<%= j @notice %>');
   $('#element_area .sortable-elements').sortable('refresh');
   Alchemy.PreviewWindow.refresh();
-  <% @element.richtext_contents_ids.each do |id| %>
-  tinymce.get('tinymce_<%= id %>').remove();
-  <% end %>
+  Alchemy.Tinymce.remove(<%= @richtext_ids.to_json %>);
   <% if @element.fixed? %>
   Alchemy.FixedElements.removeTab(<%= @element.id %>);
   <% end %>

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

@@ -14,12 +14,12 @@
 
   <% if @element.folded? -%>
 
-  Alchemy.Tinymce.remove(<%= @element.richtext_contents_ids.to_json %>);
+  Alchemy.Tinymce.remove(<%= (@element.richtext_contents_ids + @element.richtext_ingredients_ids).to_json %>);
 
   <% else -%>
 
   $el.trigger('FocusElementEditor.Alchemy');
-  Alchemy.Tinymce.init(<%= @element.richtext_contents_ids.to_json %>);
+  Alchemy.Tinymce.init(<%= (@element.richtext_contents_ids + @element.richtext_ingredients_ids).to_json %>);
   Alchemy.GUI.initElement($el);
   Alchemy.SortableElements(
     <%= @page.id %>,

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

@@ -3,7 +3,7 @@
   data: boolean_editor.data_attributes do %>
   <%= element_form.fields_for(:ingredients, boolean_editor.ingredient) do |f| %>
     <%= f.label :value, style: "display: inline-block" do %>
-      <%= f.check_box :value %>
+      <%= f.check_box :value, id: nil %>
       <%= render_ingredient_role(boolean_editor) %>
     <% end %>
     <%= render_hint_for(boolean_editor) %>

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

@@ -44,7 +44,9 @@
           },
           title: Alchemy.t(:edit_file_properties) %>
       </div>
-      <%= f.hidden_field :attachment_id, value: file_editor.attachment&.id %>
+      <%= f.hidden_field :attachment_id,
+        value: file_editor.attachment&.id,
+        id: file_editor.form_field_id(:attachment_id) %>
     </div>
   <% end %>
 <% end %>

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

@@ -3,7 +3,7 @@
   data: headline_editor.data_attributes do %>
   <%= element_form.fields_for(:ingredients, headline_editor.ingredient) do |f| %>
     <%= ingredient_label(headline_editor) %>
-    <%= f.text_field :value %>
+    <%= f.text_field :value, id: nil %>
 
     <div class="input-row">
       <% if headline_editor.level_options.length > 1 %>

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

@@ -3,6 +3,6 @@
   data: html_editor.data_attributes do %>
   <%= element_form.fields_for(:ingredients, html_editor.ingredient) do |f| %>
     <%= ingredient_label(html_editor) %>
-    <%= f.text_area :value %>
+    <%= f.text_area :value, id: nil %>
   <% end %>
 <% end %>

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

@@ -4,15 +4,15 @@
   <%= element_form.fields_for(:ingredients, link_editor.ingredient) do |f| %>
     <%= ingredient_label(link_editor) %>
     <%= f.text_field :value,
-      class: "thin_border text_with_icon disabled",
-      name: nil,
-      id: nil,
-      disabled: true
+      class: "thin_border text_with_icon readonly",
+      id: link_editor.form_field_id,
+      "data-link-value": true,
+      readonly: true,
+      tabindex: -1
     %>
-    <%= f.hidden_field :value, "data-link-value": true %>
-    <%= f.hidden_field :link_title, "data-link-title": true %>
-    <%= f.hidden_field :link_class_name, "data-link-class": true %>
-    <%= f.hidden_field :link_target, "data-link-target": true %>
+    <%= f.hidden_field :link_title, "data-link-title": true, id: nil %>
+    <%= f.hidden_field :link_class_name, "data-link-class": true, id: nil %>
+    <%= f.hidden_field :link_target, "data-link-target": true, id: nil %>
   <% end %>
   <%= render "alchemy/ingredients/shared/link_tools", ingredient_editor: link_editor %>
 <% end %>

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

@@ -5,6 +5,7 @@
     <%= ingredient_label(node_editor, :node_id) %>
     <%= f.text_field :node_id,
       value: node_editor.node&.id,
+      id: node_editor.form_field_id(:node_id),
       class: 'alchemy_selectbox full_width' %>
   <% end %>
 <% end %>

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

@@ -5,6 +5,7 @@
     <%= ingredient_label(page_editor, :page_id) %>
     <%= f.text_field :page_id,
       value: page_editor.page&.id,
+      id: page_editor.form_field_id(:page_id),
       class: 'alchemy_selectbox full_width' %>
   <% end %>
 <% end %>

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

@@ -44,16 +44,17 @@
       </div>
     <% end %>
     <%= f.hidden_field :picture_id, value: picture_editor.picture&.id,
+      id: picture_editor.form_field_id(:picture_id),
       data: {
         picture_id: true,
         image_file_width: picture_editor.image_file_width,
         image_file_height: picture_editor.image_file_height
       } %>
-    <%= f.hidden_field :link, data: { link_value: true } %>
-    <%= f.hidden_field :link_title, data: { link_title: true } %>
-    <%= f.hidden_field :link_class_name, data: { link_class: true } %>
-    <%= f.hidden_field :link_target, data: { link_target: true } %>
-    <%= f.hidden_field :crop_from, data: { crop_from: true } %>
-    <%= f.hidden_field :crop_size, data: { crop_size: true } %>
+    <%= f.hidden_field :link, data: { link_value: true }, id: nil %>
+    <%= f.hidden_field :link_title, data: { link_title: true }, id: nil %>
+    <%= f.hidden_field :link_class_name, data: { link_class: true }, id: nil %>
+    <%= f.hidden_field :link_target, data: { link_target: true }, id: nil %>
+    <%= f.hidden_field :crop_from, data: { crop_from: true }, id: nil %>
+    <%= f.hidden_field :crop_size, data: { crop_size: true }, id: nil %>
   <% end %>
 <% end %>

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

@@ -22,6 +22,7 @@
         options_tags = options_for_select(select_values, select_editor.value)
       end %>
       <%= f.select :value, options_tags, {}, {
+        id: nil,
         class: ["alchemy_selectbox", "ingredient-editor-select"]
       } %>
     <% end %>

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

@@ -7,12 +7,13 @@
     <%= ingredient_label(text_editor) %>
     <%= f.text_field :value,
       class: text_editor.settings[:linkable] ? "text_with_icon" : "",
+      id: nil,
       type: text_editor.settings[:input_type] || "text" %>
     <% if text_editor.settings[:linkable] %>
-      <%= f.hidden_field :link, "data-link-value": true %>
-      <%= f.hidden_field :link_title, "data-link-title": true %>
-      <%= f.hidden_field :link_class_name, "data-link-class": true%>
-      <%= f.hidden_field :link_target, "data-link-target": true %>
+      <%= f.hidden_field :link, "data-link-value": true, id: nil %>
+      <%= f.hidden_field :link_title, "data-link-title": true, id: nil %>
+      <%= f.hidden_field :link_class_name, "data-link-class": true, id: nil %>
+      <%= f.hidden_field :link_target, "data-link-target": true, id: nil %>
       <%= render "alchemy/ingredients/shared/link_tools", ingredient_editor: text_editor %>
     <% end %>
   <% end %>

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

@@ -30,7 +30,10 @@ module Alchemy::Upgrader::Tasks
                     next unless content
 
                     essence = content.essence
-                    ingredient = Alchemy::Ingredient.build(role: ingredient_definition[:role], element: element)
+                    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)

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "6.0.0.b2"
+  VERSION = "6.0.0.b3"
 
   def self.version
     VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy_cms
 version: !ruby/object:Gem::Version
-  version: 6.0.0.b2
+  version: 6.0.0.b3
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer