Class: Glimmer::DataBinding::ModelBinding

Inherits:
Object
  • Object
show all
Includes:
Observable, Observer
Defined in:
lib/glimmer/data_binding/model_binding.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Observer

#add_dependent, #dependents, #dependents_for, proc, #register, #registration_for, #registrations, #remove_dependent, #unregister, #unregister_all_observables, #unregister_dependents_with_observable

Methods included from Observable

#inspect

Constructor Details

#initialize(base_model, property_name_expression, binding_options = nil) ⇒ ModelBinding

Returns a new instance of ModelBinding.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 33

def initialize(base_model, property_name_expression, binding_options = nil)
  @base_model = base_model
  @property_name_expression = property_name_expression
  @binding_options = binding_options || {}
  if computed?
    @computed_model_bindings = computed_by.map do |computed_by_property_expression|
      self.class.new(base_model, computed_by_property_expression)
    end
  end
end

Instance Attribute Details

#binding_options ⇒ Object (readonly)

Returns the value of attribute binding_options.



31
32
33
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 31

def binding_options
  @binding_options
end

#property_name_expression ⇒ Object (readonly)

Returns the value of attribute property_name_expression.



31
32
33
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 31

def property_name_expression
  @property_name_expression
end

Instance Method Details

#add_computed_observers(observer) ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 176

def add_computed_observers(observer)
  @computed_model_bindings.each do |computed_model_binding|
    observer_registration = computed_observer_for(observer).observe(computed_model_binding)
    my_registration = observer.registration_for(self)
    observer.add_dependent(my_registration => observer_registration)
  end
end

#add_nested_observers(observer) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 184

def add_nested_observers(observer)
  nested_property_observers = nested_property_observers_for(observer)
  nested_models.zip(nested_property_names).each_with_index do |zip, i|
    model, property_name = zip
    nested_property_observer = nested_property_observers[property_name]
    previous_index = i - 1
    if previous_index.negative?
      parent_model = self
      parent_property_name = nil
      parent_observer = observer
    else
      parent_model = nested_models[previous_index]
      parent_property_name = nested_property_names[previous_index]
      parent_observer = nested_property_observers[parent_property_name]
    end
    parent_property_name = nil if parent_property_name.to_s.start_with?('[')
    unless model.nil?
      # TODO figure out a way to deal with this more uniformly
      observer_registration = property_indexed?(property_name) ? nested_property_observer.observe(model) : nested_property_observer.observe(model, property_name)
      parent_registration = parent_observer.registration_for(parent_model, parent_property_name)
      parent_observer.add_dependent(parent_registration => observer_registration)
    end
  end
end

#add_observer(observer) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 138

def add_observer(observer)
  if computed?
    add_computed_observers(observer)
  elsif nested_property?
    add_nested_observers(observer)
  else
    model_binding_observer = Observer.proc do |new_value|
      observer.call(evaluate_property)
    end
    observer_registration = model_binding_observer.observe(model, property_name)
    my_registration = observer.registration_for(self)
    observer.add_dependent(my_registration => observer_registration)
  end
end

#apply_converter(converter, value) ⇒ Object

Raises:



83
84
85
86
87
88
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 83

def apply_converter(converter, value)
  return value if converter.nil?          
  return value.send(converter) if (converter.is_a?(String) || converter.is_a?(Symbol)) && value.respond_to?(converter)          
  return converter.call(value) if converter.respond_to?(:call, value)          
  raise Glimmer::Error, "Unsupported bind converter: #{converter.inspect}"
end

#base_model ⇒ Object 



67
68
69
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 67

def base_model
  @base_model
end

#call(value) ⇒ Object 



209
210
211
212
213
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 209

def call(value)
  return if model.nil?
  converted_value = value
  invoke_property_writer(model, "#{property_name}=", converted_value) unless evaluate_property == converted_value
end

#computed? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 114

def computed?
  !computed_by.empty?
end

#computed_by ⇒ Object 



118
119
120
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 118

def computed_by
  [@binding_options[:computed_by]].flatten.compact
end

#computed_observer_for(observer) ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 166

def computed_observer_for(observer)
  @computed_observer_collection ||= {}
  unless @computed_observer_collection.has_key?(observer)
    @computed_observer_collection[observer] = Observer.proc do |new_value|
      observer.call(evaluate_property)
    end
  end
  @computed_observer_collection[observer]
end

#convert_on_read(value) ⇒ Object 



75
76
77
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 75

def convert_on_read(value)
  apply_converter(@binding_options[:on_read], value)
end

#convert_on_write(value) ⇒ Object 



79
80
81
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 79

def convert_on_write(value)
  apply_converter(@binding_options[:on_write], value)
end

#evaluate_options_property ⇒ Object 



221
222
223
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 221

def evaluate_options_property
  model.send(options_property_name) unless model.nil?
end

#evaluate_property ⇒ Object 



215
216
217
218
219
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 215

def evaluate_property
  value = nil        
  value = invoke_property_reader(model, property_name) unless model.nil?
  convert_on_read(value)
end

#invoke_property_reader(object, property_expression) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 233

def invoke_property_reader(object, property_expression)
  if property_indexed?(property_expression)
    property_method = '[]'
    property_argument = property_expression[1...-1]
    property_argument = property_argument.to_i if property_argument.match(/\d+/)
    object.send(property_method, property_argument)
  else
    object.send(property_expression)
  end
end

#invoke_property_writer(object, property_expression, value) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 244

def invoke_property_writer(object, property_expression, value)
  return if @binding_options[:read_only]
  value = convert_on_write(value)
  if property_indexed?(property_expression)
    property_method = '[]='
    property_argument = property_expression[1...-2]
    property_argument = property_argument.to_i if property_argument.match(/\d+/)
    object.send(property_method, property_argument, value)
  else
    object.send(property_expression, value)
  end
end

#model ⇒ Object 



44
45
46
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 44

def model
  nested_property? ? nested_model : base_model
end

#model_property_names ⇒ Object

Model representing nested property names e.g. property name expression “address.state” gives [:address]



106
107
108
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 106

def model_property_names
  nested_property_names[0...-1]
end

#nested_model ⇒ Object 



63
64
65
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 63

def nested_model
  nested_models.last
end

#nested_models ⇒ Object

e.g. person.address.state returns [person, person.address]



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 49

def nested_models
  @nested_models = [base_model]
  model_property_names.reduce(base_model) do |reduced_model, nested_model_property_name|
    if reduced_model.nil?
      nil
    else
      invoke_property_reader(reduced_model, nested_model_property_name).tap do |new_reduced_model|
        @nested_models << new_reduced_model
      end
    end
  end
  @nested_models
end

#nested_property? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 110

def nested_property?
  property_name_expression.match(/[.\[]/)
end

#nested_property_name ⇒ Object

Final nested property name e.g. property name expression “address.state” gives :state



100
101
102
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 100

def nested_property_name
  nested_property_names.last
end

#nested_property_names ⇒ Object

All nested property names e.g. property name expression “address.state” gives [‘address’, ‘state’] If there are any indexed property names, this returns indexes as properties. e.g. property name expression “addresses.state” gives [‘addresses’, ‘[1]’, ‘state’]



94
95
96
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 94

def nested_property_names
  @nested_property_names ||= property_name_expression.split(".").map {|pne| pne.match(/([^\[]+)(\[[^\]]+\])?/).to_a.drop(1)}.flatten.compact
end

#nested_property_observers_for(observer) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 122

def nested_property_observers_for(observer)
  @nested_property_observers_collection ||= {}
  unless @nested_property_observers_collection.has_key?(observer)
    @nested_property_observers_collection[observer] = nested_property_names.reduce({}) do |output, property_name|
      output.merge(
        property_name => Observer.proc do |new_value|
          # Ensure reattaching observers when a higher level nested property is updated (e.g. person.address changes reattaches person.address.street observer)
          add_observer(observer)
          observer.call(evaluate_property)
        end
      )
    end
  end
  @nested_property_observers_collection[observer]
end

#options_property_name ⇒ Object 



225
226
227
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 225

def options_property_name
  self.property_name + "_options"
end

#property_indexed?(property_expression) ⇒ Boolean

Returns:

  • (Boolean) 


229
230
231
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 229

def property_indexed?(property_expression)
  property_expression.to_s.start_with?('[')
end

#property_name ⇒ Object 



71
72
73
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 71

def property_name
  nested_property? ? nested_property_name : property_name_expression
end

#remove_observer(observer) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/glimmer/data_binding/model_binding.rb', line 153

def remove_observer(observer)
  if computed?
    @computed_model_bindings.each do |computed_model_binding|
      computed_observer_for(observer).unobserve(computed_model_binding)
    end
    @computed_observer_collection.delete(observer)
  elsif nested_property?
    nested_property_observers_for(observer).clear
  else
    observer.unobserve(model, property_name)
  end
end