Module: Toon::Encoders

Defined in:
lib/toon/encoders.rb

Class Method Summary collapse

Class Method Details

.detect_tabular_header(rows) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/toon/encoders.rb', line 134

def detect_tabular_header(rows)
  return nil if rows.empty?

  first_row = rows[0]
  first_keys = first_row.keys
  return nil if first_keys.empty?

  if tabular_array?(rows, first_keys)
    first_keys
  else
    nil
  end
end

.encode_array(key, value, writer, depth, options) ⇒ Object

Array encoding



59
60
61
62
63
64
65
66
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
92
93
94
 
# File 'lib/toon/encoders.rb', line 59

def encode_array(key, value, writer, depth, options)
  if value.empty?
    header = Primitives.format_header(0, key: key, delimiter: options[:delimiter], length_marker: options[:length_marker])
    writer.push(depth, header)
    return
  end

  # Primitive array
  if Normalizer.array_of_primitives?(value)
    encode_inline_primitive_array(key, value, writer, depth, options)
    return
  end

  # Array of arrays (all primitives)
  if Normalizer.array_of_arrays?(value)
    all_primitive_arrays = value.all? { |arr| Normalizer.array_of_primitives?(arr) }
    if all_primitive_arrays
      encode_array_of_arrays_as_list_items(key, value, writer, depth, options)
      return
    end
  end

  # Array of objects
  if Normalizer.array_of_objects?(value)
    header = detect_tabular_header(value)
    if header
      encode_array_of_objects_as_tabular(key, value, header, writer, depth, options)
    else
      encode_mixed_array_as_list_items(key, value, writer, depth, options)
    end
    return
  end

  # Mixed array: fallback to expanded format
  encode_mixed_array_as_list_items(key, value, writer, depth, options)
end

.encode_array_of_arrays_as_list_items(key, values, writer, depth, options) ⇒ Object

Array of arrays (expanded format)



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/toon/encoders.rb', line 103

def encode_array_of_arrays_as_list_items(key, values, writer, depth, options)
  header = Primitives.format_header(values.length, key: key, delimiter: options[:delimiter], length_marker: options[:length_marker])
  writer.push(depth, header)

  values.each do |arr|
    if Normalizer.array_of_primitives?(arr)
      inline = format_inline_array(arr, options[:delimiter], nil, options[:length_marker])
      writer.push(depth + 1, "#{LIST_ITEM_PREFIX}#{inline}")
    end
  end
end

.encode_array_of_objects_as_tabular(key, rows, header, writer, depth, options) ⇒ Object

Array of objects (tabular format)



127
128
129
130
131
132
 
# File 'lib/toon/encoders.rb', line 127

def encode_array_of_objects_as_tabular(key, rows, header, writer, depth, options)
  header_str = Primitives.format_header(rows.length, key: key, fields: header, delimiter: options[:delimiter], length_marker: options[:length_marker])
  writer.push(depth, header_str)

  write_tabular_rows(rows, header, writer, depth + 1, options)
end

.encode_inline_primitive_array(key, values, writer, depth, options) ⇒ Object

Primitive array encoding (inline)



97
98
99
100
 
# File 'lib/toon/encoders.rb', line 97

def encode_inline_primitive_array(key, values, writer, depth, options)
  formatted = format_inline_array(values, options[:delimiter], key, options[:length_marker])
  writer.push(depth, formatted)
end

.encode_key_value_pair(key, value, writer, depth, options) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/toon/encoders.rb', line 39

def encode_key_value_pair(key, value, writer, depth, options)
  encoded_key = Primitives.encode_key(key)

  if Normalizer.json_primitive?(value)
    writer.push(depth, "#{encoded_key}: #{Primitives.encode_primitive(value, options[:delimiter])}")
  elsif Normalizer.json_array?(value)
    encode_array(key, value, writer, depth, options)
  elsif Normalizer.json_object?(value)
    nested_keys = value.keys
    if nested_keys.empty?
      # Empty object
      writer.push(depth, "#{encoded_key}:")
    else
      writer.push(depth, "#{encoded_key}:")
      encode_object(value, writer, depth + 1, options)
    end
  end
end

.encode_mixed_array_as_list_items(key, items, writer, depth, options) ⇒ Object

Array of objects (expanded format)



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/toon/encoders.rb', line 171

def encode_mixed_array_as_list_items(key, items, writer, depth, options)
  header = Primitives.format_header(items.length, key: key, delimiter: options[:delimiter], length_marker: options[:length_marker])
  writer.push(depth, header)

  items.each do |item|
    if Normalizer.json_primitive?(item)
      # Direct primitive as list item
      writer.push(depth + 1, "#{LIST_ITEM_PREFIX}#{Primitives.encode_primitive(item, options[:delimiter])}")
    elsif Normalizer.json_array?(item)
      # Direct array as list item
      if Normalizer.array_of_primitives?(item)
        inline = format_inline_array(item, options[:delimiter], nil, options[:length_marker])
        writer.push(depth + 1, "#{LIST_ITEM_PREFIX}#{inline}")
      end
    elsif Normalizer.json_object?(item)
      # Object as list item
      encode_object_as_list_item(item, writer, depth + 1, options)
    end
  end
end

.encode_object(value, writer, depth, options) ⇒ Object

Object encoding



31
32
33
34
35
36
37
 
# File 'lib/toon/encoders.rb', line 31

def encode_object(value, writer, depth, options)
  keys = value.keys

  keys.each do |key|
    encode_key_value_pair(key, value[key], writer, depth, options)
  end
end

.encode_object_as_list_item(obj, writer, depth, options) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/toon/encoders.rb', line 192

def encode_object_as_list_item(obj, writer, depth, options)
  keys = obj.keys
  if keys.empty?
    writer.push(depth, LIST_ITEM_MARKER)
    return
  end

  # First key-value on the same line as "- "
  first_key = keys[0]
  encoded_key = Primitives.encode_key(first_key)
  first_value = obj[first_key]

  if Normalizer.json_primitive?(first_value)
    writer.push(depth, "#{LIST_ITEM_PREFIX}#{encoded_key}: #{Primitives.encode_primitive(first_value, options[:delimiter])}")
  elsif Normalizer.json_array?(first_value)
    if Normalizer.array_of_primitives?(first_value)
      # Inline format for primitive arrays
      formatted = format_inline_array(first_value, options[:delimiter], first_key, options[:length_marker])
      writer.push(depth, "#{LIST_ITEM_PREFIX}#{formatted}")
    elsif Normalizer.array_of_objects?(first_value)
      # Check if array of objects can use tabular format
      header = detect_tabular_header(first_value)
      if header
        # Tabular format for uniform arrays of objects
        header_str = Primitives.format_header(first_value.length, key: first_key, fields: header, delimiter: options[:delimiter], length_marker: options[:length_marker])
        writer.push(depth, "#{LIST_ITEM_PREFIX}#{header_str}")
        write_tabular_rows(first_value, header, writer, depth + 1, options)
      else
        # Fall back to list format for non-uniform arrays of objects
        writer.push(depth, "#{LIST_ITEM_PREFIX}#{encoded_key}[#{first_value.length}]:")
        first_value.each do |item|
          encode_object_as_list_item(item, writer, depth + 1, options)
        end
      end
    else
      # Complex arrays on separate lines (array of arrays, etc.)
      writer.push(depth, "#{LIST_ITEM_PREFIX}#{encoded_key}[#{first_value.length}]:")

      # Encode array contents at depth + 1
      first_value.each do |item|
        if Normalizer.json_primitive?(item)
          writer.push(depth + 1, "#{LIST_ITEM_PREFIX}#{Primitives.encode_primitive(item, options[:delimiter])}")
        elsif Normalizer.json_array?(item) && Normalizer.array_of_primitives?(item)
          inline = format_inline_array(item, options[:delimiter], nil, options[:length_marker])
          writer.push(depth + 1, "#{LIST_ITEM_PREFIX}#{inline}")
        elsif Normalizer.json_object?(item)
          encode_object_as_list_item(item, writer, depth + 1, options)
        end
      end
    end
  elsif Normalizer.json_object?(first_value)
    nested_keys = first_value.keys
    if nested_keys.empty?
      writer.push(depth, "#{LIST_ITEM_PREFIX}#{encoded_key}:")
    else
      writer.push(depth, "#{LIST_ITEM_PREFIX}#{encoded_key}:")
      encode_object(first_value, writer, depth + 2, options)
    end
  end

  # Remaining keys on indented lines
  (1...keys.length).each do |i|
    key = keys[i]
    encode_key_value_pair(key, obj[key], writer, depth + 1, options)
  end
end

.encode_value(value, options) ⇒ Object

Encode normalized value



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/toon/encoders.rb', line 14

def encode_value(value, options)
  if Normalizer.json_primitive?(value)
    return Primitives.encode_primitive(value, options[:delimiter])
  end

  writer = LineWriter.new(options[:indent])

  if Normalizer.json_array?(value)
    encode_array(nil, value, writer, 0, options)
  elsif Normalizer.json_object?(value)
    encode_object(value, writer, 0, options)
  end

  writer.to_s
end

.format_inline_array(values, delimiter, key = nil, length_marker = false) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/toon/encoders.rb', line 115

def format_inline_array(values, delimiter, key = nil, length_marker = false)
  header = Primitives.format_header(values.length, key: key, delimiter: delimiter, length_marker: length_marker)
  joined_value = Primitives.join_encoded_values(values, delimiter)
  # Only add space if there are values
  if values.empty?
    header
  else
    "#{header} #{joined_value}"
  end
end

.tabular_array?(rows, header) ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/toon/encoders.rb', line 148

def tabular_array?(rows, header)
  rows.all? do |row|
    keys = row.keys

    # All objects must have the same keys (but order can differ)
    return false if keys.length != header.length

    # Check that all header keys exist in the row and all values are primitives
    header.all? do |key|
      row.key?(key) && Normalizer.json_primitive?(row[key])
    end
  end
end

.write_tabular_rows(rows, header, writer, depth, options) ⇒ Object 



162
163
164
165
166
167
168
 
# File 'lib/toon/encoders.rb', line 162

def write_tabular_rows(rows, header, writer, depth, options)
  rows.each do |row|
    values = header.map { |key| row[key] }
    joined_value = Primitives.join_encoded_values(values, options[:delimiter])
    writer.push(depth, joined_value)
  end
end