Class: ArrayModel

Inherits:
ReactiveArray show all
Includes:
ModelHelpers, ModelState, ModelWrapper
Defined in:
lib/volt/models/array_model.rb

Direct Known Subclasses

Cursor

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ModelState

#change_state_to, #loaded?, #state

Methods included from ModelHelpers

#class_at_path, #deep_unwrap, #event_added, #event_removed

Methods included from ModelWrapper

#wrap_value, #wrap_values

Methods inherited from ReactiveArray

#==, #[], #[]=, #clear, #count, #delete, #delete_at, #each, #insert, #method_missing, #size

Methods included from Eventable

#on, #remove_listener, #trigger!

Constructor Details

#initialize(array = [], options = {}) ⇒ ArrayModel

Returns a new instance of ArrayModel.



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/volt/models/array_model.rb', line 27

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

  array = wrap_values(array)

  super(array)

  @persistor.loaded if @persistor
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ReactiveArray

Instance Attribute Details

#array ⇒ Object (readonly)

Returns the value of attribute array.



11
12
13
 
# File 'lib/volt/models/array_model.rb', line 11

def array
  @array
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



11
12
13
 
# File 'lib/volt/models/array_model.rb', line 11

def options
  @options
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



11
12
13
 
# File 'lib/volt/models/array_model.rb', line 11

def parent
  @parent
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



11
12
13
 
# File 'lib/volt/models/array_model.rb', line 11

def path
  @path
end

#persistor ⇒ Object (readonly)

Returns the value of attribute persistor.



11
12
13
 
# File 'lib/volt/models/array_model.rb', line 11

def persistor
  @persistor
end

Class Method Details

.proxy_with_load_data(*method_names) ⇒ Object

For many methods, we want to call load data as soon as the model is interacted with, so we proxy the method, then call super.



16
17
18
19
20
21
22
23
 
# File 'lib/volt/models/array_model.rb', line 16

def self.proxy_with_load_data(*method_names)
  method_names.each do |method_name|
    define_method(method_name) do |*args|
      load_data
      super(*args)
    end
  end
end

Instance Method Details

#+(*args) ⇒ Object

Make sure it gets wrapped



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

def +(*args)
  args = wrap_values(args)
  super(*args)
end

#<<(model) ⇒ Object Also known as: append

Make sure it gets wrapped



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/volt/models/array_model.rb', line 61

def <<(model)
  if model.is_a?(Model)
    # Set the new path
    model.options = @options.merge(path: @options[:path] + [:[]])
  else
    model = wrap_values([model]).first
  end

  super(model)

  @persistor.added(model, @array.size-1) if @persistor

  return model
end

#attributes ⇒ Object 



56
57
58
 
# File 'lib/volt/models/array_model.rb', line 56

def attributes
  self
end

#buffer ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/volt/models/array_model.rb', line 117

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)

  return model
end

#find(*args, &block) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/volt/models/array_model.rb', line 40

def find(*args, &block)
  if @persistor
    return @persistor.find(*args, &block)
  else
    raise "this model's persistance layer does not support find, try using store"
  end
end

#inject(*args) ⇒ Object

Make sure it gets wrapped



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

def inject(*args)
  args = wrap_values(args)
  super(*args)
end

#inspect ⇒ Object 



107
108
109
110
111
112
113
114
115
 
# File 'lib/volt/models/array_model.rb', line 107

def inspect
  if @persistor && @persistor.is_a?(Persistors::ArrayStore) && state == :not_loaded
    # Show a special message letting users know it is not loaded yet.
    return "#<#{self.class.to_s}:not loaded, access with [] or size to load>"
  end

  # Otherwise inspect normally
  return super
end

#new_array_model(*args) ⇒ Object 



93
94
95
 
# File 'lib/volt/models/array_model.rb', line 93

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

#new_model(*args) ⇒ Object 



89
90
91
 
# File 'lib/volt/models/array_model.rb', line 89

def new_model(*args)
  class_at_path(options[:path]).new(*args)
end

#then(*args, &block) ⇒ Object 



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

def then(*args, &block)
  if @persistor
    return @persistor.then(*args, &block)
  else
    raise "this model's persistance layer does not support then, try using store"
  end
end

#to_a ⇒ Object

Convert the model to an array all of the way down



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

def to_a
  array = []
  attributes.each do |value|
    array << deep_unwrap(value)
  end

  return array
end