Module: Odin::Transform::FormatExporters

Defined in:
lib/odin/transform/format_exporters.rb

Class Method Summary collapse

Class Method Details

.format_modifier_prefix(mods) ⇒ Object 



643
644
645
646
647
648
649
650
651
 
# File 'lib/odin/transform/format_exporters.rb', line 643

def self.format_modifier_prefix(mods)
  return "" if mods.nil? || mods.empty?

  prefix = +""
  prefix << "!" if mods[:required]
  prefix << "-" if mods[:deprecated]
  prefix << "*" if mods[:confidential]
  prefix
end

.to_csv(value, delimiter: ",", header: true) ⇒ Object

── CSV Export ──



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/odin/transform/format_exporters.rb', line 88

def self.to_csv(value, delimiter: ",", header: true)
  return "" unless value.array?

  items = value.value
  return "" if items.empty?

  # Collect all column names from all rows
  columns = []
  items.each do |item|
    next unless item.object?

    item.value.each_key do |k|
      columns << k unless columns.include?(k)
    end
  end

  return "" if columns.empty?

  lines = []
  # Header row (unless suppressed)
  if header
    lines << columns.map { |c| csv_escape(c, delimiter) }.join(delimiter)
  end

  # Data rows
  items.each do |item|
    next unless item.object?

    row = columns.map do |col|
      v = item.value[col]
      v ? csv_escape(dynvalue_to_string(v), delimiter) : ""
    end
    lines << row.join(delimiter)
  end

  lines.join("\n") + "\n"
end

.to_fixed_width(value, columns:, line_width: nil) ⇒ Object

── Fixed-Width Export ──



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/odin/transform/format_exporters.rb', line 128

def self.to_fixed_width(value, columns:, line_width: nil)
  rows = if value.array?
           value.value
         else
           [value]
         end

  total_width = line_width || columns.map { |c| (c[:pos] || 0) + (c[:len] || 0) }.max || 80

  lines = rows.map do |row|
    line = " " * total_width
    columns.each do |col|
      pos = col[:pos] || 0
      len = col[:len] || 0
      pad_char = col[:pad] || " "
      align = col[:align] || :left
      name = col[:name]

      raw_val = if row.object?
                  v = row.value[name]
                  v ? dynvalue_to_string(v) : ""
                else
                  ""
                end

      # Truncate if needed
      raw_val = raw_val[0...len] if raw_val.length > len

      padded = if align == :right
                 raw_val.rjust(len, pad_char)
               else
                 raw_val.ljust(len, pad_char)
               end

      # Write into line at position
      padded.chars.each_with_index do |ch, i|
        line[pos + i] = ch if pos + i < total_width
      end
    end
    line.rstrip
  end

  lines.join("\n") + "\n"
end

.to_flat_kvp(value) ⇒ Object

── Flat KVP Export ──



231
232
233
234
235
236
237
238
 
# File 'lib/odin/transform/format_exporters.rb', line 231

def self.to_flat_kvp(value)
  return "" unless value.object?

  lines = []
  flatten_for_kvp(value.value, "", lines)
  lines.sort!
  lines.join("\n") + "\n"
end

.to_flat_yaml(value) ⇒ Object

── Flat YAML Export ──



242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/odin/transform/format_exporters.rb', line 242

def self.to_flat_yaml(value)
  return "" unless value.object?

  sb = +""
  # Sort top-level keys alphabetically
  sorted_keys = value.value.keys.sort
  sorted_keys.each do |key|
    val = value.value[key]
    write_yaml_value(sb, key, val, 0)
  end
  sb
end

.to_json(value, pretty: true, indent: 2, nulls: nil, empty_arrays: nil) ⇒ Object

── JSON Export ──



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/odin/transform/format_exporters.rb', line 12

def self.to_json(value, pretty: true, indent: 2, nulls: nil, empty_arrays: nil)
  ruby_obj = dynvalue_to_json_obj(value)
  ruby_obj = omit_nulls(ruby_obj) if nulls == "omit"
  ruby_obj = omit_empty_arrays(ruby_obj) if empty_arrays == "omit"
  if indent == 0
    JSON.generate(ruby_obj)
  elsif pretty
    JSON.pretty_generate(ruby_obj, indent: " " * indent)
  else
    JSON.generate(ruby_obj)
  end
end

.to_odin(value, header: true, modifiers: {}) ⇒ Object

── ODIN Export ──



175
176
177
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/odin/transform/format_exporters.rb', line 175

def self.to_odin(value, header: true, modifiers: {})
  sb = +""

  if header
    sb << "{$}\n"
    sb << "odin = \"1.0.0\"\n"
  end

  if value.object?
    entries = value.value
    has_sections = entries.any? { |_k, v| v.object? || v.array? }

    if has_sections
      # Check if there are any top-level fields (non-section entries or leaf chains)
      has_top_level = entries.any? { |_k, v| !v.object? && !v.array? } ||
                     entries.any? { |_k, v| v.object? && pure_leaf_chain?(v) }

      # Emit {} root section marker when header is present and there are top-level fields
      sb << "{}\n" if header && has_top_level

      # First pass: flat top-level fields and leaf chains
      entries.each do |key, val|
        if val.object?
          collect_leaf_paths(sb, key, val, key, modifiers)
        elsif !val.array?
          write_assignment(sb, key, val, key, modifiers)
        end
      end

      # Second pass: sections and arrays
      last_ctx = +""
      entries.each do |key, val|
        if val.object? && !pure_leaf_chain?(val)
          write_section(sb, key, key, nil, val, modifiers, last_ctx_holder = [last_ctx])
          last_ctx = last_ctx_holder[0]
        elsif val.array?
          write_array_section(sb, key, nil, val.value, modifiers)
          last_ctx = ""
        end
      end
    else
      entries.each do |key, val|
        write_assignment(sb, key, val, key, modifiers)
      end
    end
  elsif value.array?
    sb << "items = #{format_odin_value(value)}\n"
  else
    sb << "value = #{format_odin_value(value)}\n"
  end

  sb
end

.to_xml(value, root: "root", declaration: true, indent: 2) ⇒ Object

── XML Export ──



55
56
57
58
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
 
# File 'lib/odin/transform/format_exporters.rb', line 55

def self.to_xml(value, root: "root", declaration: true, indent: 2)
  xml = +""
  xml << %{<?xml version="1.0" encoding="UTF-8"?>\n} if declaration
  indent_str = " " * indent
  include_ns = needs_odin_namespace?(value)
  ns_attr = include_ns ? ' xmlns:odin="https://odin.foundation/ns"' : ""
  if value.object?
    # If the object has exactly one key, use that as root
    keys = value.value.keys
    if keys.size == 1 && value.value[keys[0]].object?
      xml << render_xml_element(keys[0], value.value[keys[0]], 0, indent_str: indent_str, include_ns: include_ns, is_root: true)
    else
      xml << "<#{root}#{ns_attr}>\n"
      value.value.each do |k, v|
        xml << render_xml_element(k, v, 1, indent_str: indent_str, include_ns: include_ns)
      end
      xml << "</#{root}>\n"
    end
  elsif value.array?
    xml << "<#{root}#{ns_attr}>\n"
    value.value.each do |item|
      xml << render_xml_element("item", item, 1, indent_str: indent_str, include_ns: include_ns)
    end
    xml << "</#{root}>\n"
  else
    type_attr = include_ns ? dv_xml_type_attr(value) : ""
    xml << "<#{root}#{ns_attr}#{type_attr}>#{xml_escape(dynvalue_to_string(value))}</#{root}>\n"
  end
  xml
end