Module: Alchemy::Element::ElementIngredients

Extended by:
ActiveSupport::Concern
Included in:
Alchemy::Element
Defined in:
app/models/alchemy/element/element_ingredients.rb

Overview

Methods concerning ingredients for elements

Instance Method Summary collapse

Instance Method Details

#copy_ingredients_to(element) ⇒ Object

Copy current ingredient’s ingredients to given target element



48
49
50
51
52
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 48

def copy_ingredients_to(element)
  ingredients.map do |ingredient|
    Ingredient.copy(ingredient, element_id: element.id)
  end
end

#has_validations? ⇒ Boolean

Has any of the ingredients validations defined?

Returns:

  • (Boolean) 


95
96
97
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 95

def has_validations?
  ingredients.any?(&:has_validations?)
end

#has_value_for?(role) ⇒ Boolean

True if the element has a ingredient for given name that has a non blank value.

Returns:

  • (Boolean) 


106
107
108
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 106

def has_value_for?(role)
  value_for(role).present?
end

#ingredient_by_role(role) ⇒ Object

Find first ingredient from element by given role.



31
32
33
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 31

def ingredient_by_role(role)
  ingredients.detect { |ingredient| ingredient.role == role.to_s }
end

#ingredient_by_type(type) ⇒ Object

Find first ingredient from element by given type.



36
37
38
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 36

def ingredient_by_type(type)
  ingredients_by_type(type).first
end

#ingredient_definition_for(role) ⇒ Object

Returns the definition for given ingredient role



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 60

def ingredient_definition_for(role)
  if ingredient_definitions.blank?
    nil
  else
    definition = ingredient_definitions.find { _1.role == role.to_s }
    return definition if definition.present?

    Logger.warn <<-WARN.strip_heredoc
      Element '#{name}' is missing the ingredient definition for '#{role}'! Please check your element definitions.
    WARN
  end
end

#ingredient_definitions ⇒ Object

Returns all element ingredient definitions from the elements.yml file



55
56
57
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 55

def ingredient_definitions
  definition.ingredients
end

#ingredients_by_type(type) ⇒ Object

All ingredients from element by given type.



41
42
43
44
45
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 41

def ingredients_by_type(type)
  ingredients.select do |ingredient|
    ingredient.type == Ingredient.normalize_type(type)
  end
end

#ingredients_with_errors ⇒ Object

All element ingredients where the validation has failed.



100
101
102
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 100

def ingredients_with_errors
  ingredients.select { |i| i.errors.any? }
end

#richtext_ingredients_ids ⇒ Object

Returns an array of all Richtext ingredients ids from elements

This is used to re-initialize the TinyMCE editor in the element editor.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 77

def richtext_ingredients_ids
  ids = ingredients.filter_map { |i| i.id if i.has_tinymce? }

  # Use preloaded association if available, otherwise query
  expanded_nested_elements = if association(:all_nested_elements).loaded?
    all_nested_elements.select(&:expanded?)
  else
    nested_elements.expanded
  end

  if expanded_nested_elements.present?
    ids += expanded_nested_elements.map(&:richtext_ingredients_ids)
  end

  ids.flatten
end

#value_for(role) ⇒ Object

The value of an ingredient of the element by role



26
27
28
 
# File 'app/models/alchemy/element/element_ingredients.rb', line 26

def value_for(role)
  ingredient_by_role(role)&.value
end