Module: Ruwi::Dom::PatchDom

Defined in:
lib/ruwi/runtime/dom/patch_dom.rb

Class Method Summary collapse

Class Method Details

.execute(old_vdom, new_vdom, parent_el, host_component = nil) ⇒ Ruwi::Vdom

Parameters:

Returns:



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 9

def execute(old_vdom, new_vdom, parent_el, host_component = nil)
  if !NodesEqual.equal?(old_vdom, new_vdom)
    index = find_index_in_parent(parent_el, old_vdom.el)
    Ruwi::Dom::DestroyDom.execute(old_vdom)
    Ruwi::Dom::MountDom.execute(new_vdom, parent_el, index, host_component)

    return new_vdom
  end

  # when old_vdom and new_vdom is same type
  new_vdom.el = old_vdom.el

  case new_vdom.type
  when Ruwi::Vdom::DOM_TYPES[:TEXT]
    patch_text(old_vdom, new_vdom)
    return new_vdom # return early and skip children patch
  when Ruwi::Vdom::DOM_TYPES[:ELEMENT]
    patch_element(old_vdom, new_vdom, host_component)
  when Ruwi::Vdom::DOM_TYPES[:COMPONENT]
    patch_component(old_vdom, new_vdom)
  else
    # noop
  end

  patch_children(old_vdom, new_vdom, host_component)

  new_vdom
end

.find_index_in_parent(parent_el, el) ⇒ Integer?

Parameters:

  • parent_el (JS::Object)
  • el (JS::Object)

Returns:

  • (Integer, nil)


45
46
47
48
49
50
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 45

def self.find_index_in_parent(parent_el, el)
  index = parent_el[:childNodes].to_a.index(el)
  return nil if index < 0

  index
end

.patch_attrs(el, old_attrs, new_attrs) ⇒ Object

Parameters:

  • el (JS::Object)
  • old_attrs (Hash)
  • new_attrs (Hash)


96
97
98
99
100
101
102
103
104
105
106
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 96

def self.patch_attrs(el, old_attrs, new_attrs)
  diff = Ruwi::Utils::Objects.diff(old_attrs, new_attrs)

  diff[:removed].each do |key|
    Ruwi::Dom::Attributes.remove_attribute(el, key)
  end

  (diff[:added] + diff[:updated]).each do |key|
    Ruwi::Dom::Attributes.set_attribute(el, key, new_attrs[key])
  end
end

.patch_children(old_vdom, new_vdom, host_component) ⇒ void

This method returns an undefined value.

Parameters:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 178

def self.patch_children(old_vdom, new_vdom, host_component)
  old_children = Ruwi::Vdom.extract_children(old_vdom)
  new_children = Ruwi::Vdom.extract_children(new_vdom)
  parent_el = old_vdom.el

  equal_proc = ->(a, b) { NodesEqual.equal?(a, b) }

  diff_seq = Ruwi::Utils::Arrays.diff_sequence(old_children, new_children, equal_proc)
  offset = host_component&.offset || 0

  diff_seq.each do |operation|
    original_index = operation[:original_index]
    index = operation[:index]
    item = operation[:item]

    case operation[:op]
    when 'add'
      Ruwi::Dom::MountDom.execute(item, parent_el, index + offset, host_component)
    when 'remove'
      Ruwi::Dom::DestroyDom.execute(item)
    when 'move'
      old_child = old_children[original_index]
      new_child = new_children[index]
      el = old_child.el
      el_at_target_index = parent_el[:childNodes][index + offset]

      parent_el.insertBefore(el, el_at_target_index)
      Ruwi::Dom::PatchDom.execute(old_child, new_child, parent_el, host_component)
    when 'noop'
      Ruwi::Dom::PatchDom.execute(old_children[original_index], new_children[index], parent_el, host_component)
    end
  end
end

.patch_classes(el, old_class, new_class) ⇒ Object

Parameters:

  • el (JS::Object)
  • old_class (String, Array)
  • new_class (String, Array)


111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 111

def self.patch_classes(el, old_class, new_class)
  old_classes = to_class_list(old_class)
  new_classes = to_class_list(new_class)

  diff = Ruwi::Utils::Arrays.diff(old_classes, new_classes)

  diff[:removed].each do |key|
    el[:classList].remove(key)
  end

  diff[:added].each do |key|
    el[:classList].add(key)
  end
end

.patch_component(old_vdom, new_vdom) ⇒ void

This method returns an undefined value.

Parameters:



226
227
228
229
230
231
232
233
234
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 226

def self.patch_component(old_vdom, new_vdom)
  component = old_vdom.component
  props = Ruwi::Utils::Props.extract_props_and_events(new_vdom)[:props]

  component.update_props(props)

  new_vdom.component = component
  new_vdom.el = component.first_element
end

.patch_element(old_vdom, new_vdom, host_component) ⇒ Object

Parameters:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 67

def self.patch_element(old_vdom, new_vdom, host_component)
  el = old_vdom.el

  # Extract attributes from oldVdom.props (equivalent to JavaScript destructuring)
  old_props = old_vdom.props || {}
  old_class = old_props[:class]
  old_style = old_props[:style]
  old_events = old_props[:on]
  old_attrs = old_props.reject { |key, _| [:class, :style, :on].include?(key) }

  # Extract attributes from newVdom.props
  new_props = new_vdom.props || {}
  new_class = new_props[:class]
  new_style = new_props[:style]
  new_events = new_props[:on]
  new_attrs = new_props.reject { |key, _| [:class, :style, :on].include?(key) }

  # Get listeners from oldVdom
  old_listeners = old_vdom.listeners

  patch_attrs(el, old_attrs, new_attrs)
  patch_classes(el, old_class, new_class)
  patch_styles(el, old_style, new_style)
  new_vdom.listeners = patch_events(el, old_listeners, old_events, new_events, host_component)
end

.patch_events(el, old_listeners = {}, old_events = {}, new_events = {}, host_component = nil) ⇒ Hash

Parameters:

  • el (JS::Object)
  • old_listeners (Hash) (defaults to: {})
  • old_events (Hash) (defaults to: {})
  • new_events (Hash) (defaults to: {})

Returns:

  • (Hash)


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 148

def self.patch_events(el, old_listeners = {}, old_events = {}, new_events = {}, host_component = nil)
  diff = Ruwi::Utils::Objects.diff(old_events || {}, new_events || {})

  # Remove old event listeners for removed and updated events
  (diff[:removed] + diff[:updated]).each do |event_name|
    if old_listeners[event_name]
      el.call(:removeEventListener, event_name.to_s, old_listeners[event_name])
    end
  end

  added_listeners = {}

  # Add new event listeners for added and updated events
  (diff[:added] + diff[:updated]).each do |event_name|
    listener = Ruwi::Dom::Events.add_event_listener(
      event_name,
      new_events[event_name],
      el,
      host_component
    )
    added_listeners[event_name] = listener
  end

  added_listeners
end

.patch_styles(el, old_style = {}, new_style = {}) ⇒ Object

Parameters:

  • el (JS::Object)
  • old_style (Hash, String) (defaults to: {})
  • new_style (Hash, String) (defaults to: {})


129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 129

def self.patch_styles(el, old_style = {}, new_style = {})
  parsed_old_style = Ruwi::Dom::Attributes.parse_style(old_style)
  parsed_new_style = Ruwi::Dom::Attributes.parse_style(new_style)
  diff = Ruwi::Utils::Objects.diff(parsed_old_style || {}, parsed_new_style || {})

  diff[:removed].each do |key|
    Ruwi::Dom::Attributes.remove_style(el, key)
  end

  (diff[:added] + diff[:updated]).each do |key|
    Ruwi::Dom::Attributes.set_style(el, key, new_style[key])
  end
end

.patch_text(old_vdom, new_vdom) ⇒ Object

Parameters:



54
55
56
57
58
59
60
61
62
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 54

def self.patch_text(old_vdom, new_vdom)
  el = old_vdom.el
  old_text = old_vdom.value
  new_text = new_vdom.value

  if old_text != new_text
    el.nodeValue = new_text
  end
end

.to_class_list(classes = '') ⇒ Array

Parameters:

  • classes (String, Array) (defaults to: '')

Returns:

  • (Array)


214
215
216
217
218
219
220
221
# File 'lib/ruwi/runtime/dom/patch_dom.rb', line 214

def self.to_class_list(classes = '')
  if classes.is_a?(Array)
    classes.select { |c| Ruwi::Utils::Strings.is_not_blank_or_empty_string(c) }
  else
    # string case
    classes.to_s.split(/\s+/).select { |c| Ruwi::Utils::Strings.is_not_empty_string(c) }
  end
end