status-im/NimYAML
2
0
Fork 0
mirror of https://github.com/status-im/NimYAML.git synced 2025-02-02 22:44:19 +00:00
Code Issues Projects Releases Wiki Activity
NimYAML/test/tpresenter.nim

151 lines
6.8 KiB
Nim
Raw Permalink Normal View History

Reworked loading API * moved load procs to yaml/loading.nim * moved input YamlStream into ConstructionContext * made ConstructionContext a non-ref object * harmonized code style & comments * renamed yaml/serialization.nim to yaml/native.nim
2023-08-29 23:23:15 +02:00
# NimYAML - YAML implementation in Nim
# (c) Copyright 2015-2023 Felix Krause
#
# See the file "copying.txt", included in this
# distribution, for details about the copyright.
Presenter improvements and new features * Presenter now tries to write style given in event * Can write single quoted * several fixes to line length handling * sever other presenter fixes * updated server deps * updated server code to use new presenter features (or rather, not use, as the server *should* alter the input style instead of outputting it as-is)
2023-11-11 13:20:56 +01:00
import std/[ options, strutils ]
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
import ../yaml/[ presenter, data, stream ]
import unittest
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
import commonTestUtils
proc inputSingle(events: varargs[Event]): BufferYamlStream =
result = newBufferYamlStream()
result.put(startStreamEvent())
result.put(startDocEvent())
for event in events: result.put(event)
result.put(endDocEvent())
result.put(endStreamEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
let minimalOptions = PresentationOptions(outputVersion: ovNone)
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
proc assertOutput(
input: YamlStream, expected: string,
options: PresentationOptions = minimalOptions) =
var output = present(input, options)
assertStringEqual expected, output
suite "Presenter":
test "Scalar with tag":
var input = inputSingle(scalarEvent("droggeljug", yTagString))
assertOutput(input, "--- !!str\ndroggeljug\n")
test "Scalar without tag":
var input = inputSingle(scalarEvent("droggeljug"))
assertOutput(input, "droggeljug\n")
Presenter improvements and new features * Presenter now tries to write style given in event * Can write single quoted * several fixes to line length handling * sever other presenter fixes * updated server deps * updated server code to use new presenter features (or rather, not use, as the server *should* alter the input style instead of outputting it as-is)
2023-11-11 13:20:56 +01:00
test "Root block scalar":
var input = inputSingle(scalarEvent("I am a dwarf and I'm digging a hole\n diggy diggy hole\n diggy diggy hole\n"))
assertOutput(input,
"--- |\n" &
"I am a dwarf and I'm digging a hole\n" &
" diggy diggy hole\n" &
" diggy diggy hole\n",
PresentationOptions(maxLineLength: some(40)))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Compact flow sequence":
var input = inputSingle(startSeqEvent(), scalarEvent("1"), scalarEvent("2"), endSeqEvent())
assertOutput(input, "[1, 2]\n")
test "Forced block sequence":
var input = inputSingle(startSeqEvent(), scalarEvent("1"), scalarEvent("2"), endSeqEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "- 1\n- 2\n", PresentationOptions(outputVersion: ovNone, containers: cBlock))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Forced multiline flow sequence":
var input = inputSingle(startSeqEvent(), scalarEvent("1"), scalarEvent("2"), endSeqEvent())
Fixed presenter regarding new style annotations * fixed presentation of flow mappings inside block collections * improved logic checking whether a collection can be written on a single line * fixed tests
2023-11-14 15:30:43 +01:00
assertOutput(input, "[\n 1,\n 2\n]\n", PresentationOptions(outputVersion: ovNone, condenseFlow: false, containers: cFlow))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Compact flow mapping":
var input = inputSingle(startMapEvent(), scalarEvent("1"), scalarEvent("2"), endMapEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "{1: 2}\n", PresentationOptions(outputVersion: ovNone, containers: cFlow))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Simple block mapping":
var input = inputSingle(startMapEvent(), scalarEvent("1"), scalarEvent("2"), endMapEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "1: 2\n", PresentationOptions(outputVersion: ovNone))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Forced multiline flow mapping":
var input = inputSingle(startMapEvent(), scalarEvent("1"), scalarEvent("2"), endMapEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "{\n 1: 2\n}\n", PresentationOptions(outputVersion: ovNone, condenseFlow: false, containers: cFlow))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Forced JSON mapping":
var input = inputSingle(startMapEvent(), scalarEvent("1"), scalarEvent("2"), endMapEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "{\n \"1\": 2\n}\n", PresentationOptions(outputVersion: ovNone, condenseFlow: false, containers: cFlow, quoting: sqJson))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Nested flow sequence":
var input = inputSingle(startMapEvent(), scalarEvent("a"), startSeqEvent(), scalarEvent("1"), scalarEvent("2"), endSeqEvent(), endMapEvent())
assertOutput(input, "a: [1, 2]\n")
test "Nested block sequence":
var input = inputSingle(startMapEvent(), scalarEvent("a"), startSeqEvent(), scalarEvent("1"), scalarEvent("2"), endSeqEvent(), endMapEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "a:\n - 1\n - 2\n", PresentationOptions(outputVersion: ovNone, containers: cBlock))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Compact notation: mapping in sequence":
var input = inputSingle(startSeqEvent(), scalarEvent("a"), startMapEvent(), scalarEvent("1"), scalarEvent("2"),
scalarEvent("3"), scalarEvent("4"), endMapEvent(), endSeqEvent())
assertOutput(input, "- a\n- 1: 2\n 3: 4\n")
test "No compact notation: sequence in mapping":
var input = inputSingle(startMapEvent(), scalarEvent("a"), startSeqEvent(), scalarEvent("1"), endSeqEvent(), endMapEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "a:\n - 1\n", PresentationOptions(outputVersion: ovNone, containers: cBlock))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Compact notation with 4 spaces indentation":
var input = inputSingle(startSeqEvent(), scalarEvent("a"), startMapEvent(), scalarEvent("1"), scalarEvent("2"),
scalarEvent("3"), scalarEvent("4"), endMapEvent(), endSeqEvent())
Reworked dumping API * removed default value objects, use Nim2 default vaules for fields instead. * moved dump procs to yaml/dumping and introduced Dumper * modified serialization procs to use ctx as first argument, so that prefix calls can be used * changed defaults for presentation to be more like other YAML implementations, e.g. no directives by default. * Removed deprecated procs in DOM API * Removed PresentationStyle – use the setXStyle procs of Dumper instead. * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
assertOutput(input, "- a\n- 1: 2\n 3: 4\n", PresentationOptions(outputVersion: ovNone, indentationStep: 4))
Rewrote large parts of presenter * PresentationOptions has gained more fine-tuning options: * directivesEnd: specifies when `---` is written. ref #135 * containers: specifies whether containers use block or flow style * suppressAddrs: if set, suppresses output of attributes * quoting: specifies how strings should be quoted * condenseFlow: specifies whether flow sequences should be on a single line * explicitKeys: specifies whether mapping keys should always have '?' * PresentationStyle is now a list of presets that set multiple options in PresentationOptions. * Does not output trailing spaces anymore. ref #135 * Writes compact notation, i.e. a mapping in a sequence starts on the line with the sequence's `-`, unless attributes are written * Added tests for the presenter * Existing code might change behavior because of whitespace, `---` and compact notation. The API has been extended so that existing code is affected as little as possible.
2023-07-31 19:16:24 +02:00
test "Compact notation with 4 spaces indentation, more complex input":
var input = inputSingle(startMapEvent(), scalarEvent("root"), startSeqEvent(), scalarEvent("a"),
startMapEvent(), scalarEvent("1"), scalarEvent("2"), scalarEvent("3"), scalarEvent("4"), endMapEvent(),
endSeqEvent(), endMapEvent())
Presenter improvements and new features * Presenter now tries to write style given in event * Can write single quoted * several fixes to line length handling * sever other presenter fixes * updated server deps * updated server code to use new presenter features (or rather, not use, as the server *should* alter the input style instead of outputting it as-is)
2023-11-11 13:20:56 +01:00
assertOutput(input, "root:\n - a\n - 1: 2\n 3: 4\n", PresentationOptions(outputVersion: ovNone, indentationStep: 4))
test "Scalar output with explicit style set":
var input = inputSingle(
startSeqEvent(), scalarEvent("plain", style = ssPlain),
scalarEvent("@noplain", style = ssPlain),
scalarEvent("literal\n", style = ssLiteral),
scalarEvent("nofolded ", style = ssFolded),
scalarEvent("folded scalar", style = ssFolded),
scalarEvent("single'", style = ssSingleQuoted),
endSeqEvent()
)
assertOutput(input, "- plain\n" &
"- \"@noplain\"\n" &
"- |\n" &
" literal\n" &
"- \"nofolded \"\n" &
"- >-\n" &
" folded scalar\n" &
"- 'single'''\n")
test "Collection output with explicit style set":
var input = inputSingle(
startMapEvent(), scalarEvent("a", style = ssDoubleQuoted),
startSeqEvent(style = csFlow), scalarEvent("b"), scalarEvent("c"), scalarEvent("d"), endSeqEvent(),
scalarEvent("? e"), startSeqEvent(style = csBlock), scalarEvent("f"), endSeqEvent(),
scalarEvent("g"), startMapEvent(), scalarEvent("h"), scalarEvent("i"), endMapEvent(),
scalarEvent("j"), startMapEvent(), scalarEvent("k", style = ssLiteral), scalarEvent("l"), endMapEvent(),
endMapEvent()
)
assertOutput(input, "\"a\": [b, c, d]\n" &
"\"? e\":\n" &
" - f\n" &
"g: {h: i}\n" &
"j:\n" &
" ? |-\n" &
" k\n" &
" : l\n")
test "Block mapping with multiline keys":
var input = inputSingle(
startMapEvent(), scalarEvent(repeat("a", 18)), scalarEvent("b"),
scalarEvent(repeat("\"", 8)), scalarEvent("c"),
scalarEvent(repeat("d", 17)), scalarEvent("e"), endMapEvent())
assertOutput(input, "? \"aaaaaaaaaaaaaaa\\\n" &
" aaa\"\n" &
": b\n" &
"? \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\n" &
" \\\"\"\n" &
": c\n" &
"ddddddddddddddddd:\n" &
" e\n", PresentationOptions(maxLineLength: some(19)))
Reference in New Issue Copy Permalink