Class: Volt::Model

Inherits:
Object show all
Includes:
ModelHashBehaviour, ModelHelpers, ModelState, ModelWrapper, Validations
Defined in:
lib/volt/models/model.rb

Direct Known Subclasses

User

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ModelState

#change_state_to, #loaded?, #state

Methods included from Validations

#errors, included, #mark_field!, #marked_errors, #marked_fields

Methods included from ModelHashBehaviour

#clear, #delete, #each_with_object, #empty?, #false?, #nil?, #to_h, #true?

Methods included from ModelHelpers

#class_at_path, #deep_unwrap, #event_added, #event_removed

Methods included from ModelWrapper

#wrap_value, #wrap_values

Constructor Details

#initialize(attributes = {}, options = {}, initial_state = nil) ⇒ Model

Returns a new instance of Model.



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/volt/models/model.rb', line 24

def initialize(attributes = {}, options = {}, initial_state = nil)
  @deps        = HashDependency.new
  self.options = options

  send(:attributes=, attributes, true)

  # Models start in a loaded state since they are normally setup from an
  # ArrayModel, which will have the data when they get added.
  @state = :loaded

  @persistor.loaded(initial_state) if @persistor
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/volt/models/model.rb', line 114

def method_missing(method_name, *args, &block)
  if method_name[0] == '_'
    if method_name[-1] == '='
      # Assigning an attribute with =
      assign_attribute(method_name, *args, &block)
    else
      read_attribute(method_name)
    end
  else
    # Call on parent
    super
  end
end

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



21
22
23
 
# File 'lib/volt/models/model.rb', line 21

def attributes
  @attributes
end

#options ⇒ Object

Returns the value of attribute options.



22
23
24
 
# File 'lib/volt/models/model.rb', line 22

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



22
23
24
 
# File 'lib/volt/models/model.rb', line 22

def parent
  @parent
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



22
23
24
 
# File 'lib/volt/models/model.rb', line 22

def path
  @path
end

#persistor ⇒ Object (readonly)

Returns the value of attribute persistor.



22
23
24
 
# File 'lib/volt/models/model.rb', line 22

def persistor
  @persistor
end

Instance Method Details

#! ⇒ Object

Pass through needed



109
110
111
 
# File 'lib/volt/models/model.rb', line 109

def !
  !attributes
end

#<<(value) ⇒ Object

Initialize an empty array and append to it



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/volt/models/model.rb', line 243

def <<(value)
  if @parent
    @parent.expand!
  else
    raise "Model data should be stored in sub collections."
  end

  # Grab the last section of the path, so we can do the assign on the parent
  path   = @path.last
  result = @parent.send(path)

  if result.nil?
    # If this isn't a model yet, instantiate it
    @parent.send(:"#{path}=", new_array_model([], @options))
    result = @parent.send(path)
  end

  # Add the new item
  result << value

  nil
end

#==(val) ⇒ Object

Pass the comparison through



98
99
100
101
102
103
104
105
106
 
# File 'lib/volt/models/model.rb', line 98

def ==(val)
  if val.is_a?(Model)
    # Use normal comparison for a model
    super
  else
    # Compare to attributes otherwise
    attributes == val
  end
end

#_id ⇒ Object

the id is stored in a field named _id, so we setup _id to proxy to this



38
39
40
 
# File 'lib/volt/models/model.rb', line 38

def _id
  @attributes && @attributes[:_id]
end

#_id=(val) ⇒ Object 



42
43
44
 
# File 'lib/volt/models/model.rb', line 42

def _id=(val)
  self.__id = val
end

#assign_attribute(method_name, *args, &block) ⇒ Object

Do the assignment to a model and trigger a changed event



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/volt/models/model.rb', line 129

def assign_attribute(method_name, *args, &block)
  self.expand!
  # Assign, without the =
  attribute_name = method_name[1..-2].to_sym

  value = args[0]

  @attributes[attribute_name] = wrap_value(value, [attribute_name])

  @deps.changed!(attribute_name)

  # Let the persistor know something changed
  @persistor.changed(attribute_name) if @persistor
end

#buffer ⇒ Object

Returns a buffered version of the model



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/volt/models/model.rb', line 309

def buffer
  model_path = options[:path]

  # When we grab a buffer off of a plual class (subcollection), we get it as a model.
  if model_path.last.plural? && model_path[-1] != :[]
    model_klass = class_at_path(model_path + [:[]])
  else
    model_klass = class_at_path(model_path)
  end

  new_options = options.merge(path: model_path, save_to: self).reject { |k, _| k.to_sym == :persistor }
  model       = model_klass.new({}, new_options, :loading)

  if state == :loaded
    setup_buffer(model)
  else
    self.parent.then do
      setup_buffer(model)
    end
  end

  model
end

#expand! ⇒ Object

If this model is nil, it makes it into a hash model, then sets it up to track from the parent.



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/volt/models/model.rb', line 231

def expand!
  if attributes.nil?
    @attributes = {}
    if @parent
      @parent.expand!

      @parent.send(:"_#{@path.last}=", self)
    end
  end
end

#inspect ⇒ Object 



266
267
268
269
270
 
# File 'lib/volt/models/model.rb', line 266

def inspect
  Computation.run_without_tracking do
    "<#{self.class.to_s}:#{object_id} #{attributes.inspect}>"
  end
end

#new_array_model(attributes, options) ⇒ Object 



208
209
210
211
212
213
214
 
# File 'lib/volt/models/model.rb', line 208

def new_array_model(attributes, options)
  # Start with an empty query
  options         = options.dup
  options[:query] = {}

  ArrayModel.new(attributes, options)
end

#new_model(attributes, options) ⇒ Object 



204
205
206
 
# File 'lib/volt/models/model.rb', line 204

def new_model(attributes, options)
  class_at_path(options[:path]).new(attributes, options)
end

#read_attribute(method_name) ⇒ Object

When reading an attribute, we need to handle reading on: 1) a nil model, which returns a wrapped error 2) reading directly from attributes 3) trying to read a key that doesn’t exist.



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
 
# File 'lib/volt/models/model.rb', line 148

def read_attribute(method_name)
  # Reading an attribute, we may get back a nil model.
  method_name = method_name.to_sym

  if method_name[0] != '_' && @attributes == nil
    # The method we are calling is on a nil model, return a wrapped
    # exception.
    return_undefined_method(method_name)
  else
    attr_name = method_name[1..-1].to_sym
    # See if the value is in attributes
    value     = (@attributes && @attributes[attr_name])

    # Track dependency
    @deps.depend(attr_name)

    if value
      # key was in attributes or cache
      value
    else
      new_model              = read_new_model(attr_name)
      @attributes            ||= {}
      @attributes[attr_name] = new_model
      new_model
    end
  end
end

#read_new_model(method_name) ⇒ Object

Get a new model, make it easy to override



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/volt/models/model.rb', line 177

def read_new_model(method_name)
  if @persistor && @persistor.respond_to?(:read_new_model)
    return @persistor.read_new_model(method_name)
  else
    opts = @options.merge(parent: self, path: path + [method_name])
    if method_name.plural?
      return new_array_model([], opts)
    else
      return new_model(nil, opts)
    end
  end
end

#return_undefined_method(method_name) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/volt/models/model.rb', line 190

def return_undefined_method(method_name)
  # Methods called on nil capture an error so the user can know where
  # their nil calls are.  This error can be re-raised at a later point.
  begin
    raise NilMethodCall.new("undefined method `#{method_name}' for #{self.to_s}")
  rescue => e
    result = e

    # Cleanup backtrace
    # TODO: this could be better
    result.backtrace.reject! { |line| line['lib/models/model.rb'] || line['lib/models/live_value.rb'] }
  end
end

#save! ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/volt/models/model.rb', line 272

def save!
  # Compute the erros once
  errors = self.errors

  if errors.size == 0
    save_to = options[:save_to]
    if save_to
      if save_to.is_a?(ArrayModel)
        # Add to the collection
        new_model             = save_to << self.attributes

        # Set the buffer's id to track the main model's id
        self.attributes[:_id] = new_model._id
        options[:save_to]     = new_model

        # TODO: return a promise that resolves if the append works
      else
        # We have a saved model
        return save_to.assign_attributes(self.attributes)
      end
    else
      raise "Model is not a buffer, can not be saved, modifications should be persisted as they are made."
    end

    Promise.new.resolve({})
  else
    # Some errors, mark all fields
    self.class.validations.keys.each do |key|
      mark_field!(key.to_sym)
    end

    Promise.new.reject(errors)
  end
end

#trigger_by_attribute!(event_name, attribute, *passed_args) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/volt/models/model.rb', line 216

def trigger_by_attribute!(event_name, attribute, *passed_args)
  trigger_by_scope!(event_name, *passed_args) do |scope|
    method_name, *args, block = scope

    # TODO: Opal bug
    args                      ||= []

    # Any methods without _ are not directly related to one attribute, so
    # they should all trigger
    !method_name || method_name[0] != '_' || (method_name == attribute.to_sym && args.size == 0)
  end
end