Module: Glimmer::DataBinding::Observer

Included in:
ModelBinding, Glimmer::DataBinding::ObservableHash::Notifier, Glimmer::DataBinding::ObservableModel::Notifier, Proc
Defined in:
lib/glimmer/data_binding/observer.rb

Overview

Mixin representing Observer trait from Observer Design Pattern Allows classes to include without interfering with their inheritance hierarchy.

Includes a default implementation that can receive an observer block Example: Observer.proc {|new_value| puts new_value} Subclasses may override

Defined Under Namespace

Classes: Proc, Registration

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.proc(&observer_block) ⇒ Object 



58
59
60
 
# File 'lib/glimmer/data_binding/observer.rb', line 58

def proc(&observer_block)
  Proc.new(&observer_block)
end

Instance Method Details

#add_dependent(parent_to_dependent_hash) ⇒ Object

add dependent observer to unregister when unregistering observer



134
135
136
137
138
 
# File 'lib/glimmer/data_binding/observer.rb', line 134

def add_dependent(parent_to_dependent_hash)
  registration = parent_to_dependent_hash.keys.first
  dependent = parent_to_dependent_hash.values.first
  dependents_for(registration) << dependent
end

#call(new_value = nil, *extra_args) ⇒ Object

Raises:



146
147
148
 
# File 'lib/glimmer/data_binding/observer.rb', line 146

def call(new_value = nil, *extra_args)
  raise Error, 'Not implemented!'
end

#dependents ⇒ Object

mapping of registrations to dependents property] => [[dependent, dependent_observable, dependent_property], …]



73
74
75
 
# File 'lib/glimmer/data_binding/observer.rb', line 73

def dependents
  @dependents ||= Hash.new
end

#dependents_for(registration) ⇒ Object 



77
78
79
 
# File 'lib/glimmer/data_binding/observer.rb', line 77

def dependents_for(registration)
  dependents[registration] ||= Concurrent::Set.new
end

#register(observable, property = nil) ⇒ Object Also known as: observe

registers observer in an observable on a property (optional) observer maintains registration list to unregister later



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/glimmer/data_binding/observer.rb', line 83

def register(observable, property = nil)
  return if observable.nil?
  unless observable.is_a?(Observable)
    # TODO refactor code to be more smart/polymorphic/automated and honor open/closed principle
    if observable.is_a?(Array)
      observable.extend(ObservableArray)
    elsif observable.is_a?(Hash)
      observable.extend(ObservableHash)
    else
      observable.extend(ObservableModel)
    end
  end
  observable.add_observer(*[self, property].compact)
  registration_for(observable, property).tap do |registration|
    self.registrations << registration
  end
end

#registration_for(observable, property = nil) ⇒ Object 



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

def registration_for(observable, property = nil)
  Registration.new(observer: self, observable: observable, property: property)
end

#registrations ⇒ Object 



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

def registrations
  @registrations ||= Concurrent::Set.new
end

#remove_dependent(parent_to_dependent_hash) ⇒ Object 



140
141
142
143
144
 
# File 'lib/glimmer/data_binding/observer.rb', line 140

def remove_dependent(parent_to_dependent_hash)
  registration = parent_to_dependent_hash.keys.first
  dependent = parent_to_dependent_hash.values.first
  dependents_for(registration).delete(dependent)
end

#unregister(observable, property = nil) ⇒ Object Also known as: unobserve, deregister 



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/glimmer/data_binding/observer.rb', line 102

def unregister(observable, property = nil)
  return unless observable.is_a?(Observable)
  # TODO optimize performance in the future via indexing and/or making a registration official object/class
  registration = registration_for(observable, property)
  dependents_for(registration).each do |dependent|
    dependent.unregister
    remove_dependent(registration => dependent)
  end
  registrations.delete(registration).tap do |registration|
    observable.remove_observer(*[self, property].compact)
  end
end

#unregister_all_observables ⇒ Object Also known as: unobserve_all_observables, deregister_all_observables

cleans up all registrations in observables



127
128
129
 
# File 'lib/glimmer/data_binding/observer.rb', line 127

def unregister_all_observables
  registrations.each(&:unregister)
end

#unregister_dependents_with_observable(registration, dependent_observable) ⇒ Object Also known as: unobserve_dependents_with_observable, deregister_dependents_with_observable 



117
118
119
120
121
122
 
# File 'lib/glimmer/data_binding/observer.rb', line 117

def unregister_dependents_with_observable(registration, dependent_observable)
  thedependents = dependents_for(registration).select do |thedependent|
    thedependent.observable == dependent_observable
  end
  thedependents.each(&:unregister)
end