Class: Olfactory::Template

Inherits:
Hash
  • Object
show all
Defined in:
lib/olfactory/template.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(definition, options = {}) ⇒ Template

Returns a new instance of Template.



13
14
15
16
17
18
19
20
21
 
# File 'lib/olfactory/template.rb', line 13

def initialize(definition, options = {})
  self.definition = definition
  self.transients = options[:transients] ? options[:transients].clone : {}
  self.sequences = options[:sequences] ? options[:sequences].clone : {}
  self.dictionaries = options[:dictionaries] ? options[:dictionaries].clone : {}
  self.default_populated = {}
  self.default_populated_transients = {}
  self.block_invocations = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args, &block) ⇒ Object 



52
53
54
55
56
57
58
59
 
# File 'lib/olfactory/template.rb', line 52

def method_missing(meth, *args, &block)
  # Explicit fields
  if field_definition = self.definition.find_field_definition(meth)
    populate_field(field_definition, meth, args, block)
  else
    super # Unknown method
  end
end

Instance Attribute Details

#block_invocations ⇒ Object

Returns the value of attribute block_invocations.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def block_invocations
  @block_invocations
end

#default_mode ⇒ Object

Returns the value of attribute default_mode.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def default_mode
  @default_mode
end

#default_populated ⇒ Object

Returns the value of attribute default_populated.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def default_populated
  @default_populated
end

#default_populated_transients ⇒ Object

Returns the value of attribute default_populated_transients.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def default_populated_transients
  @default_populated_transients
end

#definition ⇒ Object

Returns the value of attribute definition.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def definition
  @definition
end

#dictionaries ⇒ Object

Returns the value of attribute dictionaries.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def dictionaries
  @dictionaries
end

#sequences ⇒ Object

Returns the value of attribute sequences.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def sequences
  @sequences
end

#transients ⇒ Object

Returns the value of attribute transients.



4
5
6
 
# File 'lib/olfactory/template.rb', line 4

def transients
  @transients
end

Instance Method Details

#add_defaults(mode) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/olfactory/template.rb', line 258

def add_defaults(mode)
  # Prevents overwrites of custom values by defaults
  self.default_mode = true # Hackish for sure, but its efficient...

  case mode
  when :before
    default_definitions = definition.t_befores[:all]
  when :after
    default_definitions = definition.t_afters[:all]
  when :before_embedded
    default_definitions = definition.t_befores[:embedded]
  when :after_embedded
    default_definitions = definition.t_afters[:embedded]
  end
  default_definitions ||= []
  default_definitions.reject! { |dfn| dfn[:run] == :once && self.block_invocations.include?(dfn.object_id) }
  
  default_definitions.each do |default_definition|
    if default_definition[:evaluator]
      default_definition[:evaluator].call(self)
    elsif default_definition[:preset]
      preset_definition = definition.find_preset_definition(default_definition[:preset])
      preset_definition[:evaluator].call(self)
    end
    self.block_invocations << default_definition.object_id if default_definition[:run] # Mark block as invoked
  end

  self.default_mode = false
end

#build(name, *args) ⇒ Object 



242
243
244
245
246
 
# File 'lib/olfactory/template.rb', line 242

def build(name, *args)
  if instantiator_definition = self.definition.t_instantiators[name]
    instantiator_definition[:evaluator].call(self, *args)
  end
end

#can_set_field?(name) ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/olfactory/template.rb', line 60

def can_set_field?(name)
  !(self.default_mode && self.has_key?(name)) || (self.default_mode && (self.default_populated[name] == true))
end

#construct(block, options = {}) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/olfactory/template.rb', line 23

def construct(block, options = {})
  self.add_defaults(:before) if options[:defaults].nil? || options[:defaults]
  if block # Block can be nil (when we want only defaults)
    if options[:value]
      block.call(self, options[:value])
    else
      block.call(self)
    end
  end
  self.add_defaults(:after) if options[:defaults].nil? || options[:defaults]
  self
end

#construct_macro(macro_definition, args, block) ⇒ Object 



287
288
289
290
291
 
# File 'lib/olfactory/template.rb', line 287

def construct_macro(macro_definition, args, block)
  if macro_definition[:evaluator]
    macro_definition[:evaluator].call(self, *args)
  end
end

#construct_many_items(item_definition, quantity, arr, args, block) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/olfactory/template.rb', line 327

def construct_many_items(item_definition, quantity, arr, args, block)
  # Integer, Block
  if quantity && block
    Array.new(quantity) { block.call }
  # Array
  elsif arr
    arr
  # Object, Object...
  else
    args
  end
end

#construct_many_subtemplates(subtemplate_definition, quantity, preset_name, block) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/olfactory/template.rb', line 304

def construct_many_subtemplates(subtemplate_definition, quantity, preset_name, block)
  # Integer, Block
  if quantity && block
    Array.new(quantity) { subtemplate_definition.construct(block, :transients => self.transients) }
  # Integer, Preset Name
  elsif quantity && preset_name
    subtemplate_definition.construct_preset(preset_name, quantity, :transients => self.transients)
  # Integer
  elsif quantity
    Array.new(quantity) { subtemplate_definition.construct(nil, :transients => self.transients) }
  else
    nil
  end
end

#construct_one_item(item_definition, obj, block) ⇒ Object 



318
319
320
321
322
323
324
325
326
 
# File 'lib/olfactory/template.rb', line 318

def construct_one_item(item_definition, obj, block)
  if block
    block.call
  elsif obj
    obj
  else
    nil
  end
end

#construct_one_subtemplate(subtemplate_definition, preset_name, block) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/olfactory/template.rb', line 292

def construct_one_subtemplate(subtemplate_definition, preset_name, block)
  # Block
  if block
    subtemplate_definition.construct(block, :transients => self.transients)
  # Preset Name
  elsif preset_name
    subtemplate_definition.construct_preset(preset_name, 1, :transients => self.transients)
  # Default (nothing)
  else
    subtemplate_definition.construct(nil, :transients => self.transients)
  end
end

#create(name, *args) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/olfactory/template.rb', line 247

def create(name, *args)
  obj = self.build(name, *args)
  if obj.class <= Array
    obj.each { |o| o.save! if o.respond_to?(:save!) }
  elsif obj.class <= Hash
    obj.values.each { |o| o.save! if o.respond_to?(:save!) }
  elsif obj.respond_to?(:save!)
    obj.save!
  end
  obj
end

#extract_variable_name(args) ⇒ Object 



63
64
65
66
67
 
# File 'lib/olfactory/template.rb', line 63

def extract_variable_name(args)
  variable_name = args.first
  raise "Must provide a name when adding to a named field!" if variable_name.nil?
  variable_name
end

#generate(name, options = {}, &block) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/olfactory/template.rb', line 227

def generate(name, options = {}, &block)
  sequence = self.definition.t_sequences[name]
  # Template scope
  if sequence && sequence[:scope] == :template
    value = sequence.generate(options, block)
  # Instance scope
  elsif sequence && sequence[:scope] == :instance
    self.sequences[name] ||= sequence.dup.reset
    value = self.sequences[name].generate(options, block)
    # self.sequences[name][:current_seed] += 1 if !options.has_key?(:seed)
  else
    raise "Unknown sequence '#{name}'!"
  end
  value
end

#populate_field(field_definition, meth, args, block) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/olfactory/template.rb', line 68

def populate_field(field_definition, meth, args, block)
  if field_definition[:type] == :macro
    field_value = construct_macro(field_definition, args, block)
    do_not_set_value = true
  elsif field_definition[:type] == :subtemplate && can_set_field?(field_definition[:name])
    subtemplate_name = field_definition.has_key?(:template) ? field_definition[:template] : field_definition[:name]
    subtemplate_definition = Olfactory.templates[subtemplate_name]
    subtemplate_definition ||= Olfactory.templates[field_definition[:singular]]
    if subtemplate_definition
      # Invoke before clauses
      self.add_defaults(:before_embedded)
      # self.default_mode = true
      # before_block = field_definition[:evaluator]
      # before_block.call(self) if before_block
      # self.default_mode = false

      if field_definition[:collection] && field_definition[:collection] <= Array
        # Embeds many
        if meth == field_definition[:singular]
          # Singular
          grammar = :singular
          preset_name = args.first

          field_value = construct_one_subtemplate(subtemplate_definition, preset_name, block)
        else
          # Plural
          grammar = :plural
          quantity = args.detect { |value| value.class <= Integer }
          preset_name = args.detect { |value| value != quantity }

          field_value = construct_many_subtemplates(subtemplate_definition, quantity, preset_name, block)
          do_not_set_value if field_value.nil?
        end
      elsif field_definition[:collection] && field_definition[:collection] <= Hash
        # Embeds many named
        if meth == field_definition[:singular]
          # Singular
          grammar = :singular
          variable_name = extract_variable_name(args)
          args = args[1..(args.size-1)]
          preset_name = args.first
          
          field_value = construct_one_subtemplate(subtemplate_definition, preset_name, block)
          do_not_set_value if field_value.nil? # || field_value.empty?
        else
          # Plural
          grammar = :plural
          do_not_set_value = true
          # UNSUPPORTED
        end
      else
        # Embeds one
        preset_name = args.first

        field_value = construct_one_subtemplate(subtemplate_definition, preset_name, block)
        do_not_set_value if field_value.nil?
      end

      # Invoke after clauses
      self.add_defaults(:after_embedded)
    else
      raise "Could not find a template matching '#{subtemplate_name}'!"
    end
  elsif field_definition[:type] == :item && can_set_field?(field_definition[:name])
    if field_definition[:collection] && field_definition[:collection] <= Array
      # Has many
      if meth == field_definition[:singular]
        # Singular
        grammar = :singular
        obj = args.count == 1 ? args.first : args
        
        field_value = construct_one_item(field_definition, obj, block)
        do_not_set_value = true if field_value.nil?
      else
        # Plural
        grammar = :plural
        quantity = args.first if block && args.first.class <= Integer
        arr = args.first if args.count == 1 && args.first.class <= Array

        field_value = construct_many_items(field_definition, quantity, arr, args, block)
        do_not_set_value = true if field_value.empty?
      end
    elsif field_definition[:collection] && field_definition[:collection] <= Hash
      # Has many named
      if meth == field_definition[:singular]
        # Singular
        grammar = :singular
        variable_name = extract_variable_name(args)
        args = args[1..(args.size-1)]
        obj = args.first

        field_value = construct_one_item(field_definition, obj, block)
        do_not_set_value = true if field_value.nil?
      else
        # Plural
        grammar = :plural
        hash = args.first if args.first.class <= Hash

        # Hash
        if hash
          field_value = hash
        end
        do_not_set_value = true if field_value.nil? || field_value.empty?
      end
    else
      # Has one
      obj = args.first
        
      field_value = construct_one_item(field_definition, obj, block)
    end
  elsif field_definition.class == Olfactory::Dictionary
    if field_definition.scope == :template
      return_value = field_definition
    elsif field_definition.scope == :instance
      return_value = (self.dictionaries[meth] ||= {})
    end
    do_not_set_value = true
  else
    do_not_set_value = true
  end

  # Add field value to template
  if !do_not_set_value
    if field_definition[:collection]
      self[field_definition[:name]] ||= field_definition[:collection].new
      if field_definition[:collection] <= Array
        if grammar == :plural
          return_value = self[field_definition[:name]].concat(field_value)
        elsif grammar == :singular
          return_value = self[field_definition[:name]] << field_value
        end
      elsif field_definition[:collection] <= Hash
        if grammar == :plural
          return_value = self[field_definition[:name]].merge!(field_value)
        elsif grammar == :singular
          return_value = self[field_definition[:name]][variable_name] = field_value
        end
      end
    else
      return_value = self[field_definition[:name]] = field_value
    end
    if self.default_mode && (self.default_populated[field_definition[:name]] != false)
      self.default_populated[field_definition[:name]] = true
    else
      self.default_populated[field_definition[:name]] = false
    end
  end
  return_value
end

#reset_dictionaries(*names) ⇒ Object 



343
344
345
346
 
# File 'lib/olfactory/template.rb', line 343

def reset_dictionaries(*names)
  names = self.dictionaries.keys if names.empty?
  names.each { |name| self.dictionaries[name].reset }
end

#reset_sequences(*names) ⇒ Object 



339
340
341
342
 
# File 'lib/olfactory/template.rb', line 339

def reset_sequences(*names)
  names = self.sequences.keys if names.empty?
  names.each { |name| self.sequences[name].reset }
end

#save! ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/olfactory/template.rb', line 35

def save!
  # Items, then subtemplates
  [self.definition.t_items, self.definition.t_subtemplates].each do |field_group_definitions|
    field_group_definitions.each do |field_name, field_definition|
      if field_value = self[field_name]
        if field_definition[:collection] && field_definition[:collection] <= Array
          field_value.each { |value| value.save! if value.respond_to?(:save!) }
        elsif field_definition[:collection] && field_definition[:collection] <= Hash
          field_value.values.each { |value| value.save! if value.respond_to?(:save!) }
        else
          field_value.save! if field_value.respond_to?(:save!)
        end
      end
    end
  end
end

#transient(name, value = nil, &block) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/olfactory/template.rb', line 217

def transient(name, value = nil, &block)
  if !(self.default_mode && self.transients.has_key?(name)) || (self.default_mode && (self.default_populated_transients[name] == true))
    self.transients[name] = (block ? block.call : value)
    if self.default_mode && (self.default_populated_transients[name] != false)
      self.default_populated_transients[name] = true
    else
      self.default_populated_transients[name] = false
    end
  end
end