Module: Canon::TreeDiff::OperationConverterHelpers::UpdateChangeHandler

Defined in:
lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb

Overview

Handles UPDATE operation conversion Processes different change types (attributes, attribute_order, value, label)

Class Method Summary collapse

Class Method Details

.convert(operation, metadata, is_metadata, normative_determiner) ⇒ Array<DiffNode>

Convert UPDATE operation to DiffNode(s)

May return multiple DiffNodes if multiple dimensions changed

Parameters:

  • operation (Operation) —

    Update operation

  • metadata (Hash) —

    Enriched metadata from MetadataEnricher

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc/object to determine normative status

Returns:

  • (Array<DiffNode>) —

    Diff nodes representing updates



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 18

def self.convert(operation, metadata, is_metadata, normative_determiner)
  tree_node1 = operation[:node1] # TreeNode from adapter
  tree_node2 = operation[:node2] # TreeNode from adapter
  node1 = tree_node1.is_a?(Core::TreeNode) ? tree_node1.source_node : tree_node1
  node2 = tree_node2.is_a?(Core::TreeNode) ? tree_node2.source_node : tree_node2
  changes = operation[:changes]

  # Handle case where changes is a boolean or non-hash value
  changes = {} unless changes.is_a?(Hash)

  diff_nodes = []

  # Create separate DiffNode for each change dimension
  # This ensures each dimension can be classified independently

  if changes.key?(:attributes)
    diff_nodes << create_attribute_value_diff(
      node1, node2, changes[:attributes], metadata, is_metadata, normative_determiner
    )
  end

  if changes.key?(:attribute_order)
    diff_nodes << create_attribute_order_diff(
      node1, node2, changes[:attribute_order], metadata, is_metadata, normative_determiner
    )
  end

  if changes.key?(:value)
    diff_nodes << create_value_diff(
      node1, node2, changes[:value], metadata, is_metadata, normative_determiner, tree_node1, tree_node2
    )
  end

  if changes.key?(:label)
    diff_nodes << create_element_name_diff(
      node1, node2, changes[:label], metadata, is_metadata, normative_determiner
    )
  end

  # If no specific changes detected, create a generic update
  if diff_nodes.empty?
    diff_nodes << create_generic_update_diff(
      node1, node2, metadata, is_metadata, normative_determiner
    )
  end

  diff_nodes
end

.create_attribute_order_diff(node1, node2, changes, metadata, is_metadata, normative_determiner) ⇒ DiffNode

Create DiffNode for attribute order differences

Parameters:

  • node1 (Object) —

    First node

  • node2 (Object) —

    Second node

  • changes (Object) —

    Attribute order changes

  • metadata (Hash) —

    Enriched metadata

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc to determine normative status

Returns:

  • (DiffNode) —

    Diff node for attribute order differences



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 100

def self.create_attribute_order_diff(node1, node2, changes, metadata,
is_metadata, normative_determiner)
  reason = ReasonBuilder.build_attribute_order_reason(changes)

  diff_node = Canon::Diff::DiffNode.new(
    node1: node1,
    node2: node2,
    dimension: :attribute_order,
    reason: reason,
    **metadata,
  )
  diff_node.normative = is_metadata ? false : normative_determiner.call(:attribute_order)
  diff_node
end

.create_attribute_value_diff(node1, node2, changes, metadata, is_metadata, normative_determiner) ⇒ DiffNode

Create DiffNode for attribute value differences

Parameters:

  • node1 (Object) —

    First node

  • node2 (Object) —

    Second node

  • changes (Object) —

    Attribute changes

  • metadata (Hash) —

    Enriched metadata

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc to determine normative status

Returns:

  • (DiffNode) —

    Diff node for attribute value differences



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 76

def self.create_attribute_value_diff(node1, node2, changes, metadata,
is_metadata, normative_determiner)
  diff_details = ReasonBuilder.build_attribute_value_reason(changes)

  diff_node = Canon::Diff::DiffNode.new(
    node1: node1,
    node2: node2,
    dimension: :attribute_values,
    reason: diff_details,
    **metadata,
  )
  diff_node.normative = is_metadata ? false : normative_determiner.call(:attribute_values)
  diff_node
end

.create_element_name_diff(node1, node2, changes, metadata, is_metadata, normative_determiner) ⇒ DiffNode

Create DiffNode for element name differences

Parameters:

  • node1 (Object) —

    First node

  • node2 (Object) —

    Second node

  • changes (Object) —

    Label changes

  • metadata (Hash) —

    Enriched metadata

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc to determine normative status

Returns:

  • (DiffNode) —

    Diff node for element name differences



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 193

def self.create_element_name_diff(node1, node2, changes, metadata,
is_metadata, normative_determiner)
  reason = ReasonBuilder.build_element_name_reason(changes)

  diff_node = Canon::Diff::DiffNode.new(
    node1: node1,
    node2: node2,
    dimension: :element_structure,
    reason: reason,
    **metadata,
  )
  diff_node.normative = is_metadata ? false : normative_determiner.call(:element_structure)
  diff_node
end

.create_generic_update_diff(node1, node2, metadata, is_metadata, normative_determiner) ⇒ DiffNode

Create generic update DiffNode

Parameters:

  • node1 (Object) —

    First node

  • node2 (Object) —

    Second node

  • metadata (Hash) —

    Enriched metadata

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc to determine normative status

Returns:

  • (DiffNode) —

    Generic update diff node



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 216

def self.create_generic_update_diff(node1, node2, metadata,
is_metadata, normative_determiner)
  diff_node = Canon::Diff::DiffNode.new(
    node1: node1,
    node2: node2,
    dimension: :text_content,
    reason: "content differs",
    **metadata,
  )
  diff_node.normative = is_metadata ? false : normative_determiner.call(:text_content)
  diff_node
end

.create_text_content_diff(node1, node2, changes, metadata, is_metadata, normative_determiner) ⇒ DiffNode

Create DiffNode for text content differences

Parameters:

  • node1 (Object) —

    First node

  • node2 (Object) —

    Second node

  • changes (Object) —

    Value changes

  • metadata (Hash) —

    Enriched metadata

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc to determine normative status

Returns:

  • (DiffNode) —

    Diff node for text content differences



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 169

def self.create_text_content_diff(node1, node2, changes, metadata,
is_metadata, normative_determiner)
  reason = ReasonBuilder.build_text_content_reason(changes)

  diff_node = Canon::Diff::DiffNode.new(
    node1: node1,
    node2: node2,
    dimension: :text_content,
    reason: reason,
    **metadata,
  )
  diff_node.normative = is_metadata ? false : normative_determiner.call(:text_content)
  diff_node
end

.create_value_diff(node1, node2, changes, metadata, is_metadata, normative_determiner, tree_node1, tree_node2) ⇒ DiffNode

Create DiffNode for value differences (text content or comments)

Parameters:

  • node1 (Object) —

    First node

  • node2 (Object) —

    Second node

  • changes (Object) —

    Value changes

  • metadata (Hash) —

    Enriched metadata

  • is_metadata (Boolean) —

    Whether nodes are metadata elements

  • normative_determiner (#call) —

    Proc to determine normative status

  • tree_node1 (Object) —

    First tree node for label check

  • tree_node2 (Object) —

    Second tree node for label check

Returns:

  • (DiffNode) —

    Diff node for value differences



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 126

def self.create_value_diff(node1, node2, changes, metadata,
is_metadata, normative_determiner, tree_node1, tree_node2)
  reason = ReasonBuilder.build_text_content_reason(changes)

  # Determine dimension based on node type - comments use :comments dimension
  dimension = dimension_for_value_change(tree_node1, tree_node2)

  diff_node = Canon::Diff::DiffNode.new(
    node1: node1,
    node2: node2,
    dimension: dimension,
    reason: reason,
    **metadata,
  )
  diff_node.normative = is_metadata ? false : normative_determiner.call(dimension)
  diff_node
end

.dimension_for_value_change(tree_node1, tree_node2) ⇒ Symbol

Determine dimension for value changes based on node type Comment nodes should use :comments dimension instead of :text_content

Parameters:

  • tree_node1 (Object) —

    First tree node

  • tree_node2 (Object) —

    Second tree node

Returns:

  • (Symbol) —

    The dimension to use (:text_content or :comments)



150
151
152
153
154
155
156
157
158
 
# File 'lib/canon/tree_diff/operation_converter_helpers/update_change_handler.rb', line 150

def self.dimension_for_value_change(tree_node1, tree_node2)
  label1 = tree_node1.is_a?(Core::TreeNode) ? tree_node1.label : nil
  label2 = tree_node2.is_a?(Core::TreeNode) ? tree_node2.label : nil

  # If either node is a comment, use :comments dimension
  return :comments if label1 == "comment" || label2 == "comment"

  :text_content
end