Class: Model

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ModelState

#change_state_to, #loaded?, #state

Methods included from Validations

#errors, #exclude_from_errors!, included, #mark_field!, #marked_errors

Methods included from ModelHashBehaviour

#clear, #delete, #false?, included, #nil?, #to_h, #true?

Methods included from ModelHelpers

#class_at_path, #deep_unwrap, #event_added, #event_removed

Methods included from ObjectTracking

#__setup_tracking

Methods included from ModelWrapper

#wrap_value, #wrap_values

Methods included from ReactiveTags

included, #reactive_method_tag

Constructor Details

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

Returns a new instance of Model.



32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/volt/models/model.rb', line 32

def initialize(attributes={}, options={}, initial_state=nil)
  self.options = options

  self.send(:attributes=, attributes, true)

  @cache = {}

  # Models stat 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 



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

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 method directly on attributes.  (since they are
    # not using _ )
    attributes.send(method_name, *args, &block)
  end
end

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



29
30
31
 
# File 'lib/volt/models/model.rb', line 29

def attributes
  @attributes
end

#options ⇒ Object

Returns the value of attribute options.



30
31
32
 
# File 'lib/volt/models/model.rb', line 30

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



30
31
32
 
# File 'lib/volt/models/model.rb', line 30

def parent
  @parent
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



30
31
32
 
# File 'lib/volt/models/model.rb', line 30

def path
  @path
end

#persistor ⇒ Object (readonly)

Returns the value of attribute persistor.



30
31
32
 
# File 'lib/volt/models/model.rb', line 30

def persistor
  @persistor
end

Instance Method Details

#! ⇒ Object

Pass through needed



84
85
86
 
# File 'lib/volt/models/model.rb', line 84

def !
  !attributes
end

#<<(value) ⇒ Object

Initialize an empty array and append to it



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/volt/models/model.rb', line 232

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

  trigger!('added', nil, 0)
  trigger!('changed')

  return nil
end

#==(val) ⇒ Object

Pass the comparison through



73
74
75
76
77
78
79
80
81
 
# File 'lib/volt/models/model.rb', line 73

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

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

Do the assignment to a model and trigger a changed event



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

def assign_attribute(method_name, *args, &block)
  # Free any cached value
  free(method_name)

  self.expand!
  # Assign, without the =
  attribute_name = method_name[0..-2].to_sym

  value = args[0]
  __assign_element(attribute_name, value)

  attributes[attribute_name] = wrap_value(value, [attribute_name])
  trigger_by_attribute!('changed', attribute_name)

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

#buffer ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/volt/models/model.rb', line 308

def buffer
  model_path = options[:path]
  model_klass = class_at_path(model_path)

  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

  return ReactiveValue.new(model)
end

#deep_cur ⇒ Object 



262
263
264
 
# File 'lib/volt/models/model.rb', line 262

def deep_cur
  attributes
end

#expand! ⇒ Object

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



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

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

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

#free(name) ⇒ Object

Removes an item from the cache



211
212
213
 
# File 'lib/volt/models/model.rb', line 211

def free(name)
  @cache.delete(name)
end

#inspect ⇒ Object 



258
259
260
 
# File 'lib/volt/models/model.rb', line 258

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

#new_array_model(attributes, options) ⇒ Object 



189
190
191
192
193
194
195
 
# File 'lib/volt/models/model.rb', line 189

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 



185
186
187
 
# File 'lib/volt/models/model.rb', line 185

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.



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

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 return_undefined_method(method_name)
  else
    # See if the value is in attributes
    value = (attributes && attributes[method_name])

    # Also check @cache
    value ||= (@cache && @cache[method_name])

    if value
      # key was in attributes or cache
      return value
    else
      # Cache the value, will be removed when expanded or something
      # is assigned over it.
      # TODO: implement a timed out cache flusing
      new_model = read_new_model(method_name)
      @cache[method_name] = new_model

      return new_model
    end
  end
end

#read_new_model(method_name) ⇒ Object

Get a new model, make it easy to override



163
164
165
166
167
168
169
 
# File 'lib/volt/models/model.rb', line 163

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

#return_undefined_method(method_name) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/volt/models/model.rb', line 171

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 around ReactiveValue's
    # TODO: this could be better
    result.backtrace.reject! {|line| line['lib/models/model.rb'] || line['lib/models/live_value.rb'] }
  end
end

#save! ⇒ Object 



267
268
269
270
271
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
 
# File 'lib/volt/models/model.rb', line 267

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.append(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

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

    return Promise.new.reject(errors)
  end
end

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



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/volt/models/model.rb', line 197

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