Class: Model

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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 = {}) ⇒ Model

Returns a new instance of Model.



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

def initialize(attributes={}, options={})
  @options = options
  @parent = options[:parent]
  @path = options[:path] || []
  @class_paths = options[:class_paths]
  @persistor = setup_persistor(options[:persistor])

  self.attributes = wrap_values(attributes)
  
  @persistor.loaded if @persistor
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/volt/models/model.rb', line 88

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.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



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

def parent
  @parent
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



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

def path
  @path
end

#persistor ⇒ Object (readonly)

Returns the value of attribute persistor.



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

def persistor
  @persistor
end

Instance Method Details

#! ⇒ Object

Pass through needed



59
60
61
 
# File 'lib/volt/models/model.rb', line 59

def !
  !attributes
end

#<<(value) ⇒ Object

Initialize an empty array and append to it



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/volt/models/model.rb', line 200

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
  
  return result
end

#==(val) ⇒ Object

Pass the comparison through



48
49
50
51
52
53
54
55
56
 
# File 'lib/volt/models/model.rb', line 48

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/volt/models/model.rb', line 104

def assign_attribute(method_name, *args, &block)
  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

#delete(*args) ⇒ Object 



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

def delete(*args)
  __clear_element(args[0])
  attributes.delete(*args)
  trigger_by_attribute!('changed', args[0])
end

#event_added(event, scope_provider, first) ⇒ Object

Pass to the persisotr



64
65
66
 
# File 'lib/volt/models/model.rb', line 64

def event_added(event, scope_provider, first)
  @persistor.event_added(event, scope_provider, first) if @persistor
end

#event_removed(event, no_more_events) ⇒ Object

Pass to the persistor



69
70
71
 
# File 'lib/volt/models/model.rb', line 69

def event_removed(event, no_more_events)
  @persistor.event_removed(event, no_more_events) if @persistor
end

#expand! ⇒ Object

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



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/volt/models/model.rb', line 185

def expand!
  if attributes.nil?
    self.attributes = {}
    if @parent
      @parent.expand!
    
      @parent.attributes[@path.last] = self
    end
  end
end

#false? ⇒ Boolean

Returns:



27
28
29
 
# File 'lib/volt/models/model.rb', line 27

def false?
  attributes.false?
end

#inspect ⇒ Object 



223
224
225
 
# File 'lib/volt/models/model.rb', line 223

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

#new_array_model(*args) ⇒ Object 



166
167
168
 
# File 'lib/volt/models/model.rb', line 166

def new_array_model(*args)
  ArrayModel.new(*args)
end

#new_model(*args) ⇒ Object 



162
163
164
 
# File 'lib/volt/models/model.rb', line 162

def new_model(*args)
  Model.new(*args)
end

#nil? ⇒ Boolean

Returns:



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

def nil?
  attributes.nil?
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.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/volt/models/model.rb', line 123

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)
  elsif attributes && attributes.has_key?(method_name)
    # Method has the key, look it up directly
    return attributes[method_name]
  else
    return read_new_model(method_name)
  end
end

#read_new_model(method_name) ⇒ Object

Get a new model, make it easy to override



140
141
142
143
144
145
146
 
# File 'lib/volt/models/model.rb', line 140

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 



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/volt/models/model.rb', line 148

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

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



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

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

#true? ⇒ Boolean

Returns:



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

def true?
  attributes.true?
end