Convert ElementDefinition into ActiveModel

Like with the PageDefinition model we
want a strong contract

Author: tvdeyen

app/decorators/alchemy/element_editor.rb

@@ -14,15 +14,15 @@ def to_partial_path
     #
     # @return Array<Alchemy::IngredientEditor>
     def ingredients
-      element.definition.fetch(:ingredients, []).map do |ingredient|
+      ingredient_definitions.map do |ingredient|
         Alchemy::IngredientEditor.new(find_or_create_ingredient(ingredient))
       end
     end
 
     # Are any ingredients defined?
     # @return [Boolean]
     def has_ingredients_defined?
-      element.definition.fetch(:ingredients, []).any?
+      ingredient_definitions.any?
     end
 
     # Returns the translated ingredient group for displaying in admin editor group headings
@@ -108,9 +108,9 @@ def respond_to?(*args, **kwargs)
     #       deprecated: This element will be removed soon.
     #
     def deprecation_notice
-      case definition["deprecated"]
+      case definition.deprecated
       when String
-        definition["deprecated"]
+        definition.deprecated
       when TrueClass
         Alchemy.t(
           name,

app/decorators/alchemy/ingredient_editor.rb

@@ -173,7 +173,7 @@ def presence_validation?
     private
 
     def form_field_counter
-      element.definition.fetch(:ingredients, []).index { |i| i[:role] == role }
+      element.ingredient_definitions.index { |i| i[:role] == role }
     end
   end
 end

app/helpers/alchemy/admin/elements_helper.rb

@@ -13,12 +13,12 @@ module ElementsHelper
       def elements_for_select(elements)
         return [] if elements.nil?
 
-        elements.collect do |e|
+        elements.map do |e|
           [
-            Element.display_name_for(e["name"]),
-            e["name"]
+            Element.display_name_for(e.name),
+            e.name
           ]
-        end.sort
+        end.tap(&:sort!)
       end
     end
   end

app/models/alchemy/element.rb

@@ -30,7 +30,6 @@ class Element < BaseRecord
 
     include Alchemy::Logger
     include Alchemy::Taggable
-    include Alchemy::Hints
 
     FORBIDDEN_DEFINITION_ATTRIBUTES = [
       "amount",
@@ -107,6 +106,7 @@ class Element < BaseRecord
     scope :not_nested, -> { where(parent_element_id: nil) }
 
     delegate :restricted?, to: :page, allow_nil: true
+    delegate :has_hint?, :hint, to: :definition
 
     # Concerns
     include Definitions
@@ -131,7 +131,7 @@ def new(attributes = {})
           raise(ElementDefinitionError, attributes)
         end
 
-        super(element_definition.merge(element_attributes).except(*FORBIDDEN_DEFINITION_ATTRIBUTES))
+        super(element_definition.attributes.merge(element_attributes).except(*FORBIDDEN_DEFINITION_ATTRIBUTES))
       end
 
       # This methods does a copy of source and all its ingredients.
@@ -167,7 +167,7 @@ def all_from_clipboard_for_page(clipboard, page)
       def all_from_clipboard_for_parent_element(clipboard, parent_element)
         return none if clipboard.nil? || parent_element.nil?
 
-        all_from_clipboard(clipboard).where(name: parent_element.definition["nestable_elements"])
+        all_from_clipboard(clipboard).where(name: parent_element.definition.nestable_elements)
       end
     end
 
@@ -211,7 +211,7 @@ def store_page(page)
 
     # Returns true if the definition of this element has a taggable true value.
     def taggable?
-      definition["taggable"] == true
+      definition.taggable == true
     end
 
     # The opposite of folded?
@@ -221,7 +221,7 @@ def expanded?
 
     # Defined as compact element?
     def compact?
-      definition["compact"] == true
+      definition.compact
     end
 
     # Defined as deprecated element?
@@ -253,7 +253,7 @@ def compact?
     #
     # @return Boolean
     def deprecated?
-      !!definition["deprecated"]
+      !!definition.deprecated
     end
 
     # The element's view partial is dependent from its name
@@ -276,13 +276,13 @@ def to_partial_path
 
     # A collection of element names that can be nested inside this element.
     def nestable_elements
-      definition.fetch("nestable_elements", [])
+      definition.nestable_elements
     end
 
     private
 
     def generate_nested_elements
-      definition.fetch("autogenerate", []).each do |nestable_element|
+      definition.autogenerate.each do |nestable_element|
         if nestable_elements.include?(nestable_element)
           Element.create(page_version: page_version, parent_element_id: id, name: nestable_element)
         else

app/models/alchemy/element/definitions.rb

@@ -46,7 +46,7 @@ def definition
         else
           log_warning "Could not find element definition for #{name}. " \
                       "Please check your elements.yml file!"
-          {}
+          ElementDefinition.new
         end
       end
     end

app/models/alchemy/element/element_ingredients.rb

@@ -53,7 +53,7 @@ def copy_ingredients_to(element)
 
       # Returns all element ingredient definitions from the +elements.yml+ file
       def ingredient_definitions
-        definition.fetch(:ingredients, [])
+        definition.ingredients
       end
 
       # Returns the definition for given ingredient role

app/models/alchemy/element/presenters.rb

@@ -33,7 +33,7 @@ def display_name_for(name)
       # @see Alchemy::Element::Presenters#display_name_for
       #
       def display_name
-        self.class.display_name_for(definition["name"] || name)
+        self.class.display_name_for(definition.name || name)
       end
 
       # Returns a preview text for element.

lib/alchemy/element_definition.rb app/models/alchemy/element_definition.rblib/alchemy/element_definition.rb renamed to app/models/alchemy/element_definition.rb

@@ -2,14 +2,36 @@
 
 module Alchemy
   class ElementDefinition
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include Alchemy::Hints
+
+    extend ActiveModel::Translation
+
+    attribute :name, :string
+    attribute :unique, :boolean, default: false
+    attribute :amount, :integer, default: Float::INFINITY
+    attribute :taggable, :boolean, default: false
+    attribute :compact, :boolean, default: false
+    attribute :fixed, :boolean, default: false
+    attribute :ingredients, default: []
+    attribute :nestable_elements, default: []
+    attribute :autogenerate, default: []
+    attribute :deprecated
+    attribute :message
+    attribute :warning
+    attribute :hint
+
+    delegate :blank?, to: :name
+
     class << self
       # 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 all
-        @definitions ||= read_definitions_file.map(&:with_indifferent_access)
+        @definitions ||= read_definitions_file.map { new(**_1) }
       end
 
       # Add additional page definitions to collection.
@@ -23,23 +45,17 @@ def all
       # @param [Array || Hash]
       #   You can pass a single element definition as Hash, or a collection of elements as Array.
       #
-      def add(element)
+      def add(definition)
         all
-        if element.is_a?(Array)
-          @definitions += element
-        elsif element.is_a?(Hash)
-          @definitions << element
-        else
-          raise TypeError
-        end
+        @definitions += Array.wrap(definition).map { new(**_1) }
       end
 
       # Returns one element definition by given name.
       #
       def get(name)
-        return {} if name.blank?
+        return new if name.blank?
 
-        all.detect { |a| a["name"] == name }
+        all.detect { _1.name.casecmp(name).zero? }
       end
 
       def reset!
@@ -54,12 +70,20 @@ def definitions_file_path
 
       private
 
+      def definitions_file
+        File.read(definitions_file_path)
+      end
+
+      def definitions_file_exist?
+        File.exist?(definitions_file_path)
+      end
+
       # Reads the element definitions from +config/alchemy/elements.yml+.
       #
       def read_definitions_file
-        if File.exist?(definitions_file_path)
+        if definitions_file_exist?
           YAML.safe_load(
-            ERB.new(File.read(definitions_file_path)).result,
+            ERB.new(definitions_file).result,
             permitted_classes: YAML_PERMITTED_CLASSES,
             aliases: true
           ) || []
@@ -69,5 +93,20 @@ def read_definitions_file
         end
       end
     end
+
+    def attributes
+      super.with_indifferent_access
+    end
+    alias_method :definition, :attributes
+
+    def ingredients
+      super.map(&:with_indifferent_access)
+    end
+
+    private
+
+    def hint_translation_scope
+      :element_hints
+    end
   end
 end

app/models/alchemy/page/page_elements.rb

@@ -82,7 +82,7 @@ def duplicate_elements(elements, repository, page_version)
       def available_element_definitions(only_element_named = nil)
         @_available_element_definitions ||= if only_element_named
           element_definition = Element.definition_by_name(only_element_named)
-          element_definitions_by_name(element_definition["nestable_elements"])
+          element_definitions_by_name(element_definition.nestable_elements)
         else
           element_definitions.dup
         end
@@ -100,7 +100,7 @@ def available_element_definitions(only_element_named = nil)
       # All names of elements that can actually be placed on current page.
       #
       def available_element_names
-        @_available_element_names ||= available_element_definitions.map { |e| e["name"] }
+        @_available_element_names ||= available_element_definitions.map(&:name)
       end
 
       # Available element definitions excluding nested unique elements.
@@ -109,7 +109,7 @@ def available_elements_within_current_scope(parent)
         @_available_elements = if parent
           parents_unique_nested_elements = parent.nested_elements.where(unique: true).pluck(:name)
           available_element_definitions(parent.name).reject do |e|
-            parents_unique_nested_elements.include? e["name"]
+            parents_unique_nested_elements.include?(e.name)
           end
         else
           available_element_definitions
@@ -129,10 +129,9 @@ def element_definitions
       #
       def descendent_element_definitions
         definitions = element_definitions_by_name(element_definition_names)
-        definitions.select { |d| d.key?("nestable_elements") }.each do |d|
-          definitions += element_definitions_by_name(d["nestable_elements"])
-        end
-        definitions.uniq { _1["name"] }
+        definitions.select { _1.nestable_elements.any? }.flat_map do |d|
+          element_definitions_by_name(d.nestable_elements)
+        end.uniq(&:name)
       end
 
       # All names of elements that are defined in the page definition.
@@ -161,7 +160,7 @@ def element_definitions_by_name(names)
         if names.to_s == "all"
           Element.definitions
         else
-          Element.definitions.select { |e| names.include? e["name"] }
+          Element.definitions.select { names.include?(_1.name) }
         end
       end
 
@@ -190,16 +189,16 @@ def generate_elements
       #
       def delete_unique_element_definitions!
         @_available_element_definitions.delete_if do |element|
-          element["unique"] && @_existing_element_names.include?(element["name"])
+          element.unique && @_existing_element_names.include?(element.name)
         end
       end
 
       # Deletes limited and outnumbered definitions from @_available_element_definitions.
       #
       def delete_outnumbered_element_definitions!
         @_available_element_definitions.delete_if do |element|
-          outnumbered = @_existing_element_names.select { |name| name == element["name"] }
-          element["amount"] && outnumbered.count >= element["amount"].to_i
+          outnumbered = @_existing_element_names.select { |name| name == element.name }
+          element.amount && outnumbered.count >= element.amount
         end
       end
     end

app/views/alchemy/admin/clipboard/_update_nested_element_button.turbo_stream.erb

@@ -2,7 +2,7 @@
 <% if @item.class == Alchemy::Element %>
   <%
     @item.page.draft_version.elements.expanded.select do |element|
-      element.definition["nestable_elements"] == [@item.name]
+      element.nestable_elements == [@item.name]
     end.each do |element|
   %>
     <%= turbo_stream.replace_all ".add-nested-element[data-element-id='#{element.id}']",