Class: Alchemy::Element

Inherits:
BaseRecord
  • Object
show all
Includes:
Definitions, ElementContents, ElementEssences, Presenters, Hints, Logger, Taggable
Defined in:
app/models/alchemy/element.rb,
app/models/alchemy/element/presenters.rb,
app/models/alchemy/element/definitions.rb,
app/models/alchemy/element/element_contents.rb,
app/models/alchemy/element/element_essences.rb

Defined Under Namespace

Modules: Definitions, ElementContents, ElementEssences, Presenters

Constant Summary collapse

NAME_REGEXP =
/\A[a-z0-9_-]+\z/
FORBIDDEN_DEFINITION_ATTRIBUTES =
[
  "amount",
  "autogenerate",
  "nestable_elements",
  "contents",
  "hint",
  "taggable",
  "compact",
  "message",
  "deprecated",
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Presenters

#display_name, #display_name_with_preview_text, #dom_id, #preview_content, #preview_text

Methods included from ElementEssences

#essence_error_messages, #essence_errors, #has_ingredient?, #ingredient

Methods included from ElementContents

#content_by_name, #content_by_type, #content_definition_for, #content_definitions, #content_for_rss_description, #content_for_rss_title, #contents_by_name, #contents_by_type, #contents_with_errors, #copy_contents_to, #has_validations?, #richtext_contents_ids, #update_contents

Methods included from Definitions

#definition

Methods included from Hints

#has_hint?, #hint

Methods included from Taggable

included, #tag_list=

Methods included from Logger

#log_warning, warn

Instance Attribute Details

#autogenerate_contentsObject

Returns the value of attribute autogenerate_contents


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

def autogenerate_contents
  @autogenerate_contents
end

#autogenerate_nested_elementsObject

Returns the value of attribute autogenerate_nested_elements


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

def autogenerate_nested_elements
  @autogenerate_nested_elements
end

Class Method Details

.all_from_clipboard(clipboard) ⇒ Object


158
159
160
161
162
# File 'app/models/alchemy/element.rb', line 158

def all_from_clipboard(clipboard)
  return [] if clipboard.nil?

  where(id: clipboard.collect { |e| e["id"] })
end

.all_from_clipboard_for_page(clipboard, page) ⇒ Object

All elements in clipboard that could be placed on page


166
167
168
169
170
171
172
# File 'app/models/alchemy/element.rb', line 166

def all_from_clipboard_for_page(clipboard, page)
  return [] if clipboard.nil? || page.nil?

  all_from_clipboard(clipboard).select { |ce|
    page.available_element_names.include?(ce.name)
  }
end

.copy(source_element, differences = {}) ⇒ Object

This methods does a copy of source and all depending contents and all of their depending essences.

Options

You can pass a differences Hash as second option to update attributes for the copy.

Example

@copy = Alchemy::Element.copy(@element, {public: false})
@copy.public? # => false

154
155
156
# File 'app/models/alchemy/element.rb', line 154

def copy(source_element, differences = {})
  Alchemy::DuplicateElement.new(source_element).call(differences)
end

.new(attributes = {}) ⇒ Object

Builds a new element as described in /config/alchemy/elements.yml

  • Returns a new Alchemy::Element object if no name is given in attributes, because the definition can not be found w/o name

  • Raises Alchemy::ElementDefinitionError if no definition for given attributes could be found


131
132
133
134
135
136
137
138
139
140
141
# File 'app/models/alchemy/element.rb', line 131

def new(attributes = {})
  return super if attributes[:name].blank?

  element_attributes = attributes.to_h.merge(name: attributes[:name].split("#").first)
  element_definition = Element.definition_by_name(element_attributes[:name])
  if element_definition.nil?
    raise(ElementDefinitionError, attributes)
  end

  super(element_definition.merge(element_attributes).except(*FORBIDDEN_DEFINITION_ATTRIBUTES))
end

Instance Method Details

#cache_keyObject

Returns the key that's taken for cache path.

Uses the page's published_at value that's updated when the user publishes the page.

If the page is the current preview it uses the element's updated_at value as cache key.


273
274
275
276
277
278
279
# File 'app/models/alchemy/element.rb', line 273

def cache_key
  if Page.current_preview == page
    "alchemy/elements/#{id}-#{updated_at}"
  else
    "alchemy/elements/#{id}-#{page.published_at}"
  end
end

#compact?Boolean

Defined as compact element?

Returns:

  • (Boolean)

213
214
215
# File 'app/models/alchemy/element.rb', line 213

def compact?
  definition["compact"] == true
end

#deprecated?Boolean

Defined as deprecated element?

You can either set true or a String on your elements definition.

Passing true

- name: old_element
  deprecated: true

The deprecation notice can be translated. Either as global notice for all deprecated elements.

en:
  alchemy:
    element_deprecation_notice: Foo baz widget is deprecated

Or add a translation to your locale file for a per element notice.

en:
  alchemy:
    element_deprecation_notices:
      old_element: Foo baz widget is deprecated

Pass a String

- name: old_element
  deprecated: This element will be removed soon.

Returns:

  • (Boolean)

    Boolean


245
246
247
# File 'app/models/alchemy/element.rb', line 245

def deprecated?
  !!definition["deprecated"]
end

#expanded?Boolean

The opposite of folded?

Returns:

  • (Boolean)

208
209
210
# File 'app/models/alchemy/element.rb', line 208

def expanded?
  !folded?
end

#nestable_elementsObject

A collection of element names that can be nested inside this element.


282
283
284
# File 'app/models/alchemy/element.rb', line 282

def nestable_elements
  definition.fetch("nestable_elements", [])
end

#next(name = nil) ⇒ Object

Returns next public element from same page.

Pass an element name to get next of this kind.


179
180
181
182
# File 'app/models/alchemy/element.rb', line 179

def next(name = nil)
  elements = page.elements.published.where("position > ?", position)
  select_element(elements, name, :asc)
end

#prev(name = nil) ⇒ Object

Returns previous public element from same page.

Pass an element name to get previous of this kind.


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

def prev(name = nil)
  elements = page.elements.published.where("position < ?", position)
  select_element(elements, name, :desc)
end

#store_page(page) ⇒ Object

Stores the page into touchable_pages (Pages that have to be touched after updating the element).


194
195
196
197
198
199
200
# File 'app/models/alchemy/element.rb', line 194

def store_page(page)
  return true if page.nil?

  unless touchable_pages.include? page
    touchable_pages << page
  end
end

#taggable?Boolean

Returns true if the definition of this element has a taggable true value.

Returns:

  • (Boolean)

203
204
205
# File 'app/models/alchemy/element.rb', line 203

def taggable?
  definition["taggable"] == true
end

#to_partial_pathObject

The element's view partial is dependent from its name

Define elements

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

- name: article
  contents:
  ...

Override the view

Element partials live in app/views/alchemy/elements


263
264
265
# File 'app/models/alchemy/element.rb', line 263

def to_partial_path
  "alchemy/elements/#{name}"
end