Class: Alchemy::Content

Inherits:
BaseRecord
  • Object
show all
Includes:
Factory, Hints, Logger
Defined in:
app/models/alchemy/content.rb

Defined Under Namespace

Modules: Factory

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Factory

#build_essence, #create_essence!, #definition

Methods included from Hints

#has_hint?, #hint

Methods included from Logger

#log_warning, warn

Class Method Details

.translated_label_for(content_name, element_name = nil) ⇒ Object

Returns the translated label for a content name.

Translate it in your locale yml file:

alchemy:
  content_names:
    foo: Bar

Optionally you can scope your content name to an element:

alchemy:
  content_names:
    article:
      foo: Baz

67
68
69
70
71
72
73
# File 'app/models/alchemy/content.rb', line 67

def translated_label_for(content_name, element_name = nil)
  Alchemy.t(
    content_name,
    scope: "content_names.#{element_name}",
    default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize),
  )
end

Instance Method Details

#default_value(default = definition[:default]) ⇒ Object

Returns the default value from content definition

If the value is a symbol it gets passed through i18n inside the alchemy.default_content_texts scope


233
234
235
236
237
238
239
240
# File 'app/models/alchemy/content.rb', line 233

def default_value(default = definition[:default])
  case default
  when Symbol
    Alchemy.t(default, scope: :default_content_texts)
  else
    default
  end
end

#dom_idObject

Returns a string used as dom id on html elements.


177
178
179
180
181
# File 'app/models/alchemy/content.rb', line 177

def dom_id
  return "" if essence.nil?

  "#{essence_partial_name}_#{id}"
end

#essence_partial_nameObject


203
204
205
206
207
# File 'app/models/alchemy/content.rb', line 203

def essence_partial_name
  return "" if essence.nil?

  essence.partial_name
end

#essence_validation_failed?Boolean

Returns:

  • (Boolean)

168
169
170
# File 'app/models/alchemy/content.rb', line 168

def essence_validation_failed?
  essence.errors.any?
end

#has_custom_tinymce_config?Boolean

Returns true if there is a tinymce setting defined that contains settings.

Returns:

  • (Boolean)

220
221
222
# File 'app/models/alchemy/content.rb', line 220

def has_custom_tinymce_config?
  settings[:tinymce].is_a?(Hash)
end

#has_tinymce?Boolean

Returns true if there is a tinymce setting defined on the content definiton or if the essence.has_tinymce? returns true.

Returns:

  • (Boolean)

215
216
217
# File 'app/models/alchemy/content.rb', line 215

def has_tinymce?
  settings[:tinymce].present? || (essence.present? && essence.has_tinymce?)
end

#has_validations?Boolean

Returns:

  • (Boolean)

172
173
174
# File 'app/models/alchemy/content.rb', line 172

def has_validations?
  definition["validate"].present?
end

#ingredientObject

Gets the ingredient from essence


119
120
121
122
123
# File 'app/models/alchemy/content.rb', line 119

def ingredient
  return nil if essence.nil?

  essence.ingredient
end

#ingredient=(value) ⇒ Object

Sets the ingredient from essence


145
146
147
148
149
# File 'app/models/alchemy/content.rb', line 145

def ingredient=(value)
  raise EssenceMissingError if essence.nil?

  essence.ingredient = value
end

#linked?Boolean

Returns:

  • (Boolean)

188
189
190
# File 'app/models/alchemy/content.rb', line 188

def linked?
  essence && !essence.link.blank?
end

#name_for_labelObject

Returns the translated name for displaying in labels, etc.


184
185
186
# File 'app/models/alchemy/content.rb', line 184

def name_for_label
  self.class.translated_label_for(name, element.name)
end

#normalized_essence_typeObject


209
210
211
# File 'app/models/alchemy/content.rb', line 209

def normalized_essence_type
  self.class.normalize_essence_type(essence_type)
end

#preview_content?Boolean

Returns true if this content should be taken for element preview.

Returns:

  • (Boolean)

193
194
195
# File 'app/models/alchemy/content.rb', line 193

def preview_content?
  !!definition["as_element_title"]
end

#preview_text(maxlength = 30) ⇒ Object

Proxy method that returns the preview text from essence.


199
200
201
# File 'app/models/alchemy/content.rb', line 199

def preview_text(maxlength = 30)
  essence.preview_text(maxlength)
end

#serializeObject

Serialized object representation for json api


127
128
129
130
131
132
133
# File 'app/models/alchemy/content.rb', line 127

def serialize
  {
    name: name,
    value: serialized_ingredient,
    link: essence.try(:link),
  }.delete_if { |_k, v| v.blank? }
end

#serialized_ingredientObject

Ingredient value from essence for json api

If the essence responds to serialized_ingredient method it takes this otherwise it uses the ingredient column.


140
141
142
# File 'app/models/alchemy/content.rb', line 140

def serialized_ingredient
  essence.try(:serialized_ingredient) || ingredient
end

#settingsObject

Settings from the elements.yml definition


96
97
98
99
100
# File 'app/models/alchemy/content.rb', line 96

def settings
  return {} if definition.blank?

  @settings ||= definition.fetch(:settings, {})
end

#settings_value(key, options = {}) ⇒ Object

Fetches value from settings

Parameters:

  • key (Symbol)
    • The hash key you want to fetch the value from

  • options (Hash) (defaults to: {})
    • An optional Hash that can override the settings.

    Normally passed as options hash into the content editor view.


108
109
110
# File 'app/models/alchemy/content.rb', line 108

def settings_value(key, options = {})
  settings.update(options || {}).symbolize_keys[key.to_sym]
end

#siblingsObject


112
113
114
115
116
# File 'app/models/alchemy/content.rb', line 112

def siblings
  return [] if !element

  element.contents
end

#tinymce_class_nameObject

Returns css class names for the content textarea.


225
226
227
# File 'app/models/alchemy/content.rb', line 225

def tinymce_class_name
  "has_tinymce" + (has_custom_tinymce_config? ? " #{element.name}_#{name}" : "")
end

#to_partial_pathObject

The content's view partial is dependent from its name

Define contents

Contents are defined in the config/alchemy/elements.yml file

- name: article
  contents:
  - name: headline
    type: EssenceText

Override the view

Content partials live in app/views/alchemy/essences


91
92
93
# File 'app/models/alchemy/content.rb', line 91

def to_partial_path
  "alchemy/essences/#{essence_partial_name}_view"
end

#update_essence(params = {}) ⇒ Object

Updates the essence.

Called from Alchemy::Element#update_contents

Adds errors to self.base if essence validation fails.


157
158
159
160
161
162
163
164
165
166
# File 'app/models/alchemy/content.rb', line 157

def update_essence(params = {})
  raise EssenceMissingError if essence.nil?

  if essence.update(params)
    true
  else
    errors.add(:essence, :validation_failed)
    false
  end
end