Class: Alchemy::Ingredient
- Inherits:
-
BaseRecord
- Object
- ActiveRecord::Base
- BaseRecord
- Alchemy::Ingredient
- Includes:
- Hints
- Defined in:
- app/models/alchemy/ingredient.rb
Direct Known Subclasses
Alchemy::Ingredients::Audio, Alchemy::Ingredients::Boolean, Alchemy::Ingredients::Datetime, Alchemy::Ingredients::File, Alchemy::Ingredients::Headline, Alchemy::Ingredients::Html, Alchemy::Ingredients::Link, Alchemy::Ingredients::Node, Alchemy::Ingredients::Page, Alchemy::Ingredients::Picture, Alchemy::Ingredients::Richtext, Alchemy::Ingredients::Select, Alchemy::Ingredients::Text, Alchemy::Ingredients::Video
Defined Under Namespace
Classes: DefinitionError
Class Method Summary collapse
-
.normalize_type(ingredient_type) ⇒ String
Modulize ingredient type.
-
.related_object_alias(name, class_name:) ⇒ Object
Defines getter and setter method aliases for related object.
- .translated_label_for(role, element_name = nil) ⇒ Object
Instance Method Summary collapse
-
#definition ⇒ Object
Definition hash for this ingredient from
elements.yml
file. - #deprecated? ⇒ Boolean
-
#essence ⇒ Object
Compatibility method for access from element.
- #has_hint? ⇒ Boolean
- #has_tinymce? ⇒ Boolean
- #has_validations? ⇒ Boolean
-
#partial_name ⇒ String
The demodulized underscored class name of the ingredient.
- #preview_ingredient? ⇒ Boolean
-
#preview_text(maxlength = 30) ⇒ Object
The first 30 characters of the value.
-
#settings ⇒ Object
Settings for this ingredient from the
elements.yml
definition. -
#settings_value(key, options = {}) ⇒ Object
Fetches value from settings.
-
#to_partial_path ⇒ String
The path to the view partial of the ingredient.
-
#value ⇒ Object
The value or the related object if present.
Methods included from Hints
Class Method Details
.normalize_type(ingredient_type) ⇒ String
Modulize ingredient type
Makes sure the passed ingredient type is in the Alchemy::Ingredients
module namespace.
If you add custom ingredient class, put them in the Alchemy::Ingredients
module namespace
68 69 70 |
# File 'app/models/alchemy/ingredient.rb', line 68 def normalize_type(ingredient_type) "Alchemy::Ingredients::#{ingredient_type.to_s.classify.demodulize}" end |
.related_object_alias(name, class_name:) ⇒ Object
Defines getter and setter method aliases for related object
44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'app/models/alchemy/ingredient.rb', line 44 def (name, class_name:) alias_method name, :related_object alias_method "#{name}=", :related_object= # Somehow Rails STI does not allow us to use `alias_method` for the related_object_id define_method "#{name}_id" do end define_method "#{name}_id=" do |id| self. = id self. = class_name end end |
.translated_label_for(role, element_name = nil) ⇒ Object
72 73 74 75 76 77 78 |
# File 'app/models/alchemy/ingredient.rb', line 72 def translated_label_for(role, element_name = nil) Alchemy.t( role, scope: "ingredient_roles.#{element_name}", default: Alchemy.t("ingredient_roles.#{role}", default: role.humanize), ) end |
Instance Method Details
#definition ⇒ Object
Definition hash for this ingredient from elements.yml
file.
108 109 110 111 112 |
# File 'app/models/alchemy/ingredient.rb', line 108 def definition return {} unless element element.ingredient_definition_for(role) || {} end |
#deprecated? ⇒ Boolean
147 148 149 |
# File 'app/models/alchemy/ingredient.rb', line 147 def deprecated? !!definition[:deprecated] end |
#essence ⇒ Object
Compatibility method for access from element
82 83 84 |
# File 'app/models/alchemy/ingredient.rb', line 82 def essence self end |
#has_hint? ⇒ Boolean
142 143 144 |
# File 'app/models/alchemy/ingredient.rb', line 142 def has_hint? !!definition[:hint] end |
#has_tinymce? ⇒ Boolean
152 153 154 |
# File 'app/models/alchemy/ingredient.rb', line 152 def has_tinymce? false end |
#has_validations? ⇒ Boolean
137 138 139 |
# File 'app/models/alchemy/ingredient.rb', line 137 def has_validations? !!definition[:validate] end |
#partial_name ⇒ String
The demodulized underscored class name of the ingredient
132 133 134 |
# File 'app/models/alchemy/ingredient.rb', line 132 def partial_name self.class.name.demodulize.underscore end |
#preview_ingredient? ⇒ Boolean
157 158 159 |
# File 'app/models/alchemy/ingredient.rb', line 157 def preview_ingredient? !!definition[:as_element_title] end |
#preview_text(maxlength = 30) ⇒ Object
The first 30 characters of the value
Used by the Element#preview_text method.
120 121 122 |
# File 'app/models/alchemy/ingredient.rb', line 120 def preview_text(maxlength = 30) value.to_s[0..maxlength - 1] end |
#settings ⇒ Object
Settings for this ingredient from the elements.yml
definition.
92 93 94 |
# File 'app/models/alchemy/ingredient.rb', line 92 def settings definition[:settings] || {} end |
#settings_value(key, options = {}) ⇒ Object
Fetches value from settings
102 103 104 |
# File 'app/models/alchemy/ingredient.rb', line 102 def settings_value(key, = {}) settings.merge( || {})[key.to_sym] end |
#to_partial_path ⇒ String
The path to the view partial of the ingredient
126 127 128 |
# File 'app/models/alchemy/ingredient.rb', line 126 def to_partial_path "alchemy/ingredients/#{partial_name}_view" end |
#value ⇒ Object
The value or the related object if present
87 88 89 |
# File 'app/models/alchemy/ingredient.rb', line 87 def value || self[:value] end |