Module: Alchemy::Content::Factory::ClassMethods

Defined in:
app/models/alchemy/content/factory.rb

Constant Summary collapse

SKIPPED_ATTRIBUTES_ON_COPY = 
%w(position created_at updated_at creator_id updater_id id)

Instance Method Summary collapse

Instance Method Details

#build(element, essence_hash) ⇒ Object

Builds a new content as descriped in the elements.yml file.

Parameters:

  • The (Alchemy::Element) —

    element the content is for

  • The (Hash) —

    content definition used for finding the content in elements.yml file



19
20
21
22
23
24
25
26
 
# File 'app/models/alchemy/content/factory.rb', line 19

def build(element, essence_hash)
  definition = content_definition(element, essence_hash)
  if definition.blank?
    raise ContentDefinitionError, "No definition found in elements.yml for #{essence_hash.inspect} and #{element.inspect}"
  else
    new(name: definition['name'], element_id: element.id)
  end
end

#content_definition(element, essence_hash) ⇒ Object

Returns the content definition for building a content.

  1. It looks in the element’s contents definition

  2. It builds a definition hash from essence type, if the the name key is not present



69
70
71
72
73
74
75
76
 
# File 'app/models/alchemy/content/factory.rb', line 69

def content_definition(element, essence_hash)
  # No name given. We build the content from essence type.
  if essence_hash[:name].blank? && essence_hash[:essence_type].present?
    content_definition_from_essence_type(element, essence_hash[:essence_type])
  else
    element.content_definition_for(essence_hash[:name])
  end
end

#content_definition_from_essence_type(element, essence_type) ⇒ Object

Returns a hash for building a content from essence type.

Parameters:

  • The (Alchemy::Element) —

    element the content is for.

  • The (String) —

    essence type the content is from



85
86
87
88
89
90
 
# File 'app/models/alchemy/content/factory.rb', line 85

def content_definition_from_essence_type(element, essence_type)
  {
    'type' => essence_type,
    'name' => content_name_from_element_and_essence_type(element, essence_type)
  }
end

#content_name_from_element_and_essence_type(element, essence_type) ⇒ Object

A name for content from its essence type and amount of same essences in element.

Example:

essence_picture_1



98
99
100
101
 
# File 'app/models/alchemy/content/factory.rb', line 98

def content_name_from_element_and_essence_type(element, essence_type)
  essences_of_same_type = element.contents.where(essence_type: normalize_essence_type(essence_type))
  "#{essence_type.classify.demodulize.underscore}_#{essences_of_same_type.count + 1}"
end

#copy(source, differences = {}) ⇒ Object

Creates a copy of source and also copies the associated essence.

You can pass a differences hash to update the attributes of the copy.

Example

@copy = Alchemy::Content.copy(@content, {element_id: 3})
@copy.element_id # => 3



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'app/models/alchemy/content/factory.rb', line 51

def copy(source, differences = {})
  new_content = Content.new(
    source.attributes.except(*SKIPPED_ATTRIBUTES_ON_COPY).merge(differences)
  )

  new_essence = new_content.essence.class.create!(
    new_content.essence.attributes.except(*SKIPPED_ATTRIBUTES_ON_COPY)
  )

  new_content.update!(essence_id: new_essence.id)
  new_content
end

#create_from_scratch(element, essence_hash) ⇒ Alchemy::Content

Creates a new content from elements definition in the elements.yml file.

  1. It builds the content

  2. It creates the essence record (content object gets saved)

Returns:



35
36
37
38
39
40
 
# File 'app/models/alchemy/content/factory.rb', line 35

def create_from_scratch(element, essence_hash)
  if content = build(element, essence_hash)
    content.create_essence!(essence_hash[:essence_type])
  end
  content
end

#definitions ⇒ Object

Returns all content definitions from elements.yml



105
106
107
 
# File 'app/models/alchemy/content/factory.rb', line 105

def definitions
  Element.definitions.collect { |e| e['contents'] }.flatten.compact
end

#normalize_essence_type(essence_type) ⇒ Object

Returns a normalized Essence type

Adds Alchemy module name in front of given essence type unless there is a Class with the specified name that is an essence.

Parameters:

  • the (String) —

    essence type to normalize



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

def normalize_essence_type(essence_type)
  essence_type = essence_type.classify
  return essence_type if is_an_essence?(essence_type)

  "Alchemy::#{essence_type}"
end