Class: React::State

Inherits:
Object show all
Defined in:
lib/react/state.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.current_observer ⇒ Object (readonly)

Returns the value of attribute current_observer.



41
42
43
 
# File 'lib/react/state.rb', line 41

def current_observer
  @current_observer
end

Class Method Details

.bulk_update ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/react/state.rb', line 47

def bulk_update
  saved_bulk_update_flag = @bulk_update_flag
  @bulk_update_flag = true
  yield
ensure
  @bulk_update_flag = saved_bulk_update_flag
end

.get_state(object, name, current_observer = @current_observer) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/react/state.rb', line 71

def get_state(object, name, current_observer = @current_observer)
  # get current value of name for object, remember that the current object depends on this state,
  # current observer can be overriden with last param
  if current_observer && !new_observers[current_observer][object].include?(name)
    new_observers[current_observer][object] << name
  end
  if @delayed_updates && @delayed_updates[object][name]
    @delayed_updates[object][name][1] << current_observer
  end
  states[object][name]
end

.has_observers?(object, name) ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/react/state.rb', line 43

def has_observers?(object, name)
  !observers_by_name[object][name].empty?
end

.initialize_states(object, initial_values) ⇒ Object

initialize objects’ name/value pairs



67
68
69
 
# File 'lib/react/state.rb', line 67

def initialize_states(object, initial_values) # initialize objects' name/value pairs
  states[object].merge!(initial_values || {})
end

.is_observing?(object, name, current_observer) ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/react/state.rb', line 131

def is_observing?(object, name, current_observer)
  current_observer && observers_by_name[object][name].include?(current_observer)
end

.notify_observers(object, name, value) ⇒ Object 



108
109
110
111
112
113
114
115
 
# File 'lib/react/state.rb', line 108

def notify_observers(object, name, value)
  object_needs_notification = object.respond_to? :update_react_js_state
  observers_by_name[object][name].dup.each do |observer|
    observer.update_react_js_state(object, name, value)
    object_needs_notification = false if object == observer
  end
  object.update_react_js_state(nil, name, value) if object_needs_notification
end

.notify_observers_after_thread_completes(object, name, value) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/react/state.rb', line 117

def notify_observers_after_thread_completes(object, name, value)
  (@delayed_updates ||= []) << [object, name, value]
  @delayed_updater ||= after(0) do
    delayed_updates = @delayed_updates
    @delayed_updates = []
    @delayed_updater = nil
    delayed_updates.each { |args| notify_observers(*args) }
  end
end

.remove ⇒ Object

call after component is unmounted



151
152
153
154
155
156
157
158
159
 
# File 'lib/react/state.rb', line 151

def remove # call after component is unmounted
  raise "remove called outside of watch block" unless @current_observer
  current_observers[@current_observer].each do |object, names|
    names.each do |name|
      observers_by_name[object][name].delete(@current_observer)
    end
  end
  current_observers.delete(@current_observer)
end

.set_state(object, name, value, delay = nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/react/state.rb', line 83

def set_state(object, name, value, delay=nil)
  states[object][name] = value
  if delay || @bulk_update_flag
    @delayed_updates ||= Hash.new { |h, k| h[k] = {} }
    @delayed_updates[object][name] = [value, Set.new]
    @delayed_updater ||= after(0.001) do
      delayed_updates = @delayed_updates
      @delayed_updates = Hash.new { |h, k| h[k] = {} } # could this be nil???
      @delayed_updater = nil
      updates = Hash.new { |hash, key| hash[key] = Array.new }
      delayed_updates.each do |object, name_hash|
        name_hash.each do |name, value_and_set|
          set_state2(object, name, value_and_set[0], updates, value_and_set[1])
        end
      end
      updates.each { |observer, args| observer.update_react_js_state(*args) }
    end
  elsif @rendering_level == 0
    updates = Hash.new { |hash, key| hash[key] = Array.new }
    set_state2(object, name, value, updates)
    updates.each { |observer, args| observer.update_react_js_state(*args) }
  end
  value
end

.set_state2(object, name, value, updates, exclusions = nil) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/react/state.rb', line 55

def set_state2(object, name, value, updates, exclusions = nil)
  # set object's name state to value, tell all observers it has changed.
  # Observers must implement update_react_js_state
  object_needs_notification = object.respond_to? :update_react_js_state
  observers_by_name[object][name].dup.each do |observer|
    next if exclusions && exclusions.include?(observer)
    updates[observer] += [object, name, value]
    object_needs_notification = false if object == observer
  end
  updates[object] += [nil, name, value] if object_needs_notification
end

.set_state_context_to(observer, rendering = nil) ⇒ Object

wrap all execution that may set or get states in a block so we know which observer is executing



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/react/state.rb', line 161

def set_state_context_to(observer, rendering = nil) # wrap all execution that may set or get states in a block so we know which observer is executing
  if `typeof Opal.global.reactive_ruby_timing !== 'undefined'`
    @nesting_level = (@nesting_level || 0) + 1
    start_time = Time.now.to_f
    observer_name = (observer.class.respond_to?(:name) ? observer.class.name : observer.to_s) rescue "object:#{observer.object_id}"
  end
  saved_current_observer = @current_observer
  @current_observer = observer
  @rendering_level += 1 if rendering
  return_value = yield
  return_value
ensure
  @current_observer = saved_current_observer
  @rendering_level -= 1 if rendering
  @nesting_level = [0, @nesting_level - 1].max if `typeof Opal.global.reactive_ruby_timing !== 'undefined'`
  return_value
end

.states ⇒ Object 



179
180
181
 
# File 'lib/react/state.rb', line 179

def states
  @states ||= Hash.new { |h, k| h[k] = {} }
end

.update_states_to_observe(current_observer = @current_observer) ⇒ Object

should be called after the last after_render callback, currently called after components render method



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/react/state.rb', line 135

def update_states_to_observe(current_observer = @current_observer)  # should be called after the last after_render callback, currently called after components render method
  raise "update_states_to_observer called outside of watch block" unless current_observer
  current_observers[current_observer].each do |object, names|
    names.each do |name|
      observers_by_name[object][name].delete(current_observer)
    end
  end
  observers = current_observers[current_observer] = new_observers[current_observer]
  new_observers.delete(current_observer)
  observers.each do |object, names|
    names.each do |name|
      observers_by_name[object][name] << current_observer
    end
  end
end

.will_be_observing?(object, name, current_observer) ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/react/state.rb', line 127

def will_be_observing?(object, name, current_observer)
  current_observer && new_observers[current_observer][object].include?(name)
end