2 test: Sequence of scalars
9 array('Mark McGwire', 'Sammy Sosa', 'Ken Griffey')
11 test: Mapping of scalars to scalars
18 array('hr' => 65, 'avg' => 0.278, 'rbi' => 147)
20 test: Mapping of scalars to sequences
33 array( 'Boston Red Sox', 'Detroit Tigers',
36 array( 'New York Mets', 'Chicago Cubs',
40 test: Sequence of mappings
53 array('name' => 'Mark McGwire', 'hr' => 65, 'avg' => 0.278),
54 array('name' => 'Sammy Sosa', 'hr' => 63, 'avg' => 0.288)
74 YAML.pm will be able to emulate this behavior soon. In this regard
75 it may be somewhat more correct than Python's native behaviour which
76 can only use tuples as mapping keys. PyYAML will also need to figure
77 out some clever way to roundtrip structured keys.
81 ('New York Yankees', 'Atlanta Braves'):
82 [yaml.timestamp('2001-07-02'),
83 yaml.timestamp('2001-08-12'),
84 yaml.timestamp('2001-08-14')],
85 ('Detroit Tigers', 'Chicago Cubs'):
86 [yaml.timestamp('2001-07-23')]
91 [ 'New York Yankees', 'Atlanta Braves' ] =>
92 [ Date.new( 2001, 7, 2 ), Date.new( 2001, 8, 12 ), Date.new( 2001, 8, 14 ) ],
93 [ 'Detroit Tigers', 'Chicago Cubs' ] =>
94 [ Date.new( 2001, 7, 23 ) ]
97 struct test_node seq1[] = {
98 { T_STR, 0, "New York Yankees" },
99 { T_STR, 0, "Atlanta Braves" },
102 struct test_node seq2[] = {
103 { T_STR, 0, "2001-07-02" },
104 { T_STR, 0, "2001-08-12" },
105 { T_STR, 0, "2001-08-14" },
108 struct test_node seq3[] = {
109 { T_STR, 0, "Detroit Tigers" },
110 { T_STR, 0, "Chicago Cubs" },
113 struct test_node seq4[] = {
114 { T_STR, 0, "2001-07-23" },
117 struct test_node map[] = {
118 { T_SEQ, 0, 0, seq1 },
119 { T_SEQ, 0, 0, seq2 },
120 { T_SEQ, 0, 0, seq3 },
121 { T_SEQ, 0, 0, seq4 },
124 struct test_node stream[] = {
125 { T_MAP, 0, 0, map },
130 test: Sequence of sequences
133 - [ name , hr , avg ]
134 - [ Mark McGwire , 65 , 0.278 ]
135 - [ Sammy Sosa , 63 , 0.288 ]
138 array( 'name', 'hr', 'avg' ),
139 array( 'Mark McGwire', 65, 0.278 ),
140 array( 'Sammy Sosa', 63, 0.288 )
143 test: Mapping of mappings
147 Mark McGwire: {hr: 65, avg: 0.278}
155 array( 'hr' => 65, 'avg' => 0.278 ),
157 array( 'hr' => 63, 'avg' => 0.288 )
160 test: Two documents in a stream each with a leading comment
164 # Ranking of 1998 home runs
176 y.add( [ 'Mark McGwire', 'Sammy Sosa', 'Ken Griffey' ] )
177 y.add( [ 'Chicago Cubs', 'St Louis Cardinals' ] )
181 test: Play by play feed from a game
188 action: strike (miss)
196 [ 'Mark McGwire', 'Sammy Sosa', 'Ken Griffey' ]
200 test: Single document with two comments
203 hr: # 1998 hr ranking
212 'hr' => array( 'Mark McGwire', 'Sammy Sosa' ),
213 'rbi' => array( 'Sammy Sosa', 'Ken Griffey' )
216 test: Node for Sammy Sosa appears twice in this document
222 # Following node labeled SS
225 - *SS # Subsequent occurrence
230 array('Mark McGwire', 'Sammy Sosa'),
232 array('Sammy Sosa', 'Ken Griffey')
235 test: Mapping between sequences
245 ? [ New York Yankees,
247 : [ 2001-07-02, 2001-08-12,
251 [ 'Detroit Tigers', 'Chicago Cubs' ] => [ Date.new( 2001, 7, 23 ) ],
252 [ 'New York Yankees', 'Atlanta Braves' ] => [ Date.new( 2001, 7, 2 ), Date.new( 2001, 8, 12 ), Date.new( 2001, 8, 14 ) ]
255 struct test_node seq1[] = {
256 { T_STR, 0, "New York Yankees" },
257 { T_STR, 0, "Atlanta Braves" },
260 struct test_node seq2[] = {
261 { T_STR, 0, "2001-07-02" },
262 { T_STR, 0, "2001-08-12" },
263 { T_STR, 0, "2001-08-14" },
266 struct test_node seq3[] = {
267 { T_STR, 0, "Detroit Tigers" },
268 { T_STR, 0, "Chicago Cubs" },
271 struct test_node seq4[] = {
272 { T_STR, 0, "2001-07-23" },
275 struct test_node map[] = {
276 { T_SEQ, 0, 0, seq3 },
277 { T_SEQ, 0, 0, seq4 },
278 { T_SEQ, 0, 0, seq1 },
279 { T_SEQ, 0, 0, seq2 },
282 struct test_node stream[] = {
283 { T_MAP, 0, 0, map },
288 test: Sequence key shortcut
302 'item' => 'Super Hoop',
306 'item' => 'Basketball',
310 'item' => 'Big Shoes',
316 { item => 'Super Hoop', quantity => 1 },
317 { item => 'Basketball', quantity => 4 },
318 { item => 'Big Shoes', quantity => 1 }
323 { 'item' => 'Super Hoop', 'quantity' => 1 },
324 { 'item' => 'Basketball', 'quantity' => 4 },
325 { 'item' => 'Big Shoes', 'quantity' => 1 }
329 { 'item': 'Super Hoop', 'quantity': 1 },
330 { 'item': 'Basketball', 'quantity': 4 },
331 { 'item': 'Big Shoes', 'quantity': 1 }
334 struct test_node map1[] = {
335 { T_STR, 0, "item" },
336 { T_STR, 0, "Super Hoop" },
337 { T_STR, 0, "quantity" },
341 struct test_node map2[] = {
342 { T_STR, 0, "item" },
343 { T_STR, 0, "Basketball" },
344 { T_STR, 0, "quantity" },
348 struct test_node map3[] = {
349 { T_STR, 0, "item" },
350 { T_STR, 0, "Big Shoes" },
351 { T_STR, 0, "quantity" },
355 struct test_node seq[] = {
356 { T_MAP, 0, 0, map1 },
357 { T_MAP, 0, 0, map2 },
358 { T_MAP, 0, 0, map3 },
361 struct test_node stream[] = {
362 { T_SEQ, 0, 0, seq },
368 test: Literal perserves newlines
377 "\\//||\\/||\n// || ||_\n"
379 "\\//||\\/||\n// || ||_\n"
390 struct test_node stream[] = {
391 { T_STR, 0, "\\//||\\/||\n// || ||_\n" },
396 test: Folded treats newlines as a space
405 "Mark McGwire's year was crippled by a knee injury."
407 "Mark McGwire's year was crippled by a knee injury."
409 [ "Mark McGwire's year was crippled by a knee injury." ]
411 struct test_node stream[] = {
412 { T_STR, 0, "Mark McGwire's year was crippled by a knee injury." },
417 test: Newlines preserved for indented and blank lines
422 Sammy Sosa completed another
423 fine season with great stats.
426 0.288 Batting Average
430 "Sammy Sosa completed another fine season with great stats.\n\n 63 Home Runs\n 0.288 Batting Average\n\nWhat a year!\n"
432 "Sammy Sosa completed another fine season with great stats.\n\n 63 Home Runs\n 0.288 Batting Average\n\nWhat a year!\n"
437 Sammy Sosa completed another fine season with great stats.
440 0.288 Batting Average
447 struct test_node stream[] = {
448 { T_STR, 0, "Sammy Sosa completed another fine season with great stats.\n\n 63 Home Runs\n 0.288 Batting Average\n\nWhat a year!\n" },
454 test: Indentation determines scope
459 Mark set a major league
460 home run record in 1998.
463 0.278 Batting Average
466 'name' => 'Mark McGwire',
467 'accomplishment' => "Mark set a major league home run record in 1998.\n",
468 'stats' => "65 Home Runs\n0.278 Batting Average\n"
475 unicode: "Sosa did fine.\u263A"
476 control: "\b1998\t1999\t2000\n"
477 hexesc: "\x0D\x0A is \r\n"
479 single: '"Howdy!" he cried.'
480 quoted: ' # not a ''comment''.'
481 tie-fighter: '|\-*-/|'
484 "tie-fighter" => "|\\-*-/|",
485 "control"=>"\0101998\t1999\t2000\n",
486 "unicode"=>"Sosa did fine." + ["263A".hex ].pack('U*'),
487 "quoted"=>" # not a 'comment'.",
488 "single"=>"\"Howdy!\" he cried.",
489 "hexesc"=>"\r\n is \r\n"
492 test: Multiline flow scalars
500 quoted: "So does this
504 'plain' => 'This unquoted scalar spans many lines.',
505 'quoted' => "So does this quoted scalar.\n"
516 'canonical' => 12345,
521 test: Decimal Integer
528 'decimal' => 12345.0,
531 # FIX: spec shows parens around -inf and NaN
535 canonical: 1.23015e+3
536 exponential: 12.3015e+02
537 negative infinity: -.inf
539 float as whole number: !!float 1
542 'canonical' => 1230.15,
543 'exponential' => 1230.15,
544 'negative infinity' => log(0),
545 'not a number' => -log(0),
546 'float as whole number' => (float) 1
549 test: Fixed Floating point
578 canonical: 2001-12-15T02:59:43.1Z
579 iso8601: 2001-12-14t21:59:43.10-05:00
580 spaced: 2001-12-14 21:59:43.10 -05:00
581 date: 2002-12-14 # Time is noon UTC
584 'canonical' => YAML::mktime( 2001, 12, 15, 2, 59, 43, 0.10 ),
585 'iso8601' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
586 'spaced' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
587 'date' => Date.new( 2002, 12, 14 )
590 test: legacy Timestamps test
594 canonical: 2001-12-15T02:59:43.00Z
595 iso8601: 2001-02-28t21:59:43.00-05:00
596 spaced: 2001-12-14 21:59:43.00 -05:00
600 'canonical' => Time::utc( 2001, 12, 15, 2, 59, 43, 0 ),
601 'iso8601' => YAML::mktime( 2001, 2, 28, 21, 59, 43, 0, "-05:00" ),
602 'spaced' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0, "-05:00" ),
603 'date' => Date.new( 2002, 12, 14 )
606 test: Various explicit families
610 not-date: !str 2002-04-28
612 R0lGODlhDAAMAIQAAP//9/X
613 17unp5WZmZgAAAOfn515eXv
614 Pz7Y6OjuDg4J+fn5OTk6enp
617 application specific tag: !!something |
618 The semantics of the tag
619 above may be different for
623 YAML.add_private_type( "something" ) do |type, val|
628 'not-date' => '2002-04-28',
629 'picture' => "GIF89a\f\000\f\000\204\000\000\377\377\367\365\365\356\351\351\345fff\000\000\000\347\347\347^^^\363\363\355\216\216\216\340\340\340\237\237\237\223\223\223\247\247\247\236\236\236i^\020' \202\n\001\000;",
630 'application specific tag' => "SOMETHING: The semantics of the tag\nabove may be different for\ndifferent documents.\n"
633 test: Application specific family
637 # Establish a tag prefix
638 --- !clarkevans.com,2002/graph/^shape
639 # Use the prefix: shorthand for
640 # !clarkevans.com,2002/graph/circle
642 center: &ORIGIN {x: 73, 'y': 129}
644 - !^line # !clarkevans.com,2002/graph/line
646 finish: { x: 89, 'y': 102 }
650 value: Pretty vector drawing.
652 YAML.add_domain_type( "clarkevans.com,2002", 'graph/shape' ) { |type, val|
654 val << "Shape Container"
657 raise YAML::Error, "Invalid graph of class #{ val.class }: " + val.inspect
660 one_shape_proc = Proc.new { |type, val|
661 scheme, domain, type = type.split( /:/, 3 )
663 val['TYPE'] = "Shape: #{type}"
666 raise YAML::Error, "Invalid graph of class #{ val.class }: " + val.inspect
669 YAML.add_domain_type( "clarkevans.com,2002", 'graph/circle', &one_shape_proc )
670 YAML.add_domain_type( "clarkevans.com,2002", 'graph/line', &one_shape_proc )
671 YAML.add_domain_type( "clarkevans.com,2002", 'graph/label', &one_shape_proc )
681 "TYPE" => "Shape: graph/circle"
688 "TYPE" => "Shape: graph/line",
695 "TYPE" => "Shape: graph/label",
696 "value" => "Pretty vector drawing.",
707 # test: Unordered set
710 # # sets are represented as a
711 # # mapping where each key is
712 # # associated with the empty string
718 test: Ordered mappings
722 # ordered maps are represented as
723 # a sequence of mappings, with
724 # each mapping having one key
740 --- !clarkevans.com,2002/^invoice
758 description : Basketball
763 description : Super Hoop
768 Late afternoon is best.
769 Backup contact is Nancy
773 'invoice' => 34843, 'date' => gmmktime(0, 0, 0, 1, 23, 2001),
775 array( 'given' => 'Chris', 'family' => 'Dumars', 'address' => array( 'lines' => "458 Walkman Dr.\nSuite #292\n", 'city' => 'Royal Oak', 'state' => 'MI', 'postal' => 48046 ) )
777 array( 'given' => 'Chris', 'family' => 'Dumars', 'address' => array( 'lines' => "458 Walkman Dr.\nSuite #292\n", 'city' => 'Royal Oak', 'state' => 'MI', 'postal' => 48046 ) )
780 array( 'sku' => 'BL394D', 'quantity' => 4, 'description' => 'Basketball', 'price' => 450.00 ),
781 array( 'sku' => 'BL4438H', 'quantity' => 1, 'description' => 'Super Hoop', 'price' => 2392.00 )
783 'tax' => 251.42, 'total' => 4443.52,
784 'comments' => "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.\n"
792 Time: 2001-11-23 15:01:42 -05:00
795 This is an error message
798 Time: 2001-11-23 15:02:31 -05:00
801 A slightly different error
804 Date: 2001-11-23 15:03:17 -05:00
807 Unknown variable "bar"
812 x = MoreObject("345\n")
819 y.add( { 'Time' => YAML::mktime( 2001, 11, 23, 15, 01, 42, 00, "-05:00" ),
820 'User' => 'ed', 'Warning' => "This is an error message for the log file\n" } )
821 y.add( { 'Time' => YAML::mktime( 2001, 11, 23, 15, 02, 31, 00, "-05:00" ),
822 'User' => 'ed', 'Warning' => "A slightly different error message.\n" } )
823 y.add( { 'Date' => YAML::mktime( 2001, 11, 23, 15, 03, 17, 00, "-05:00" ),
824 'User' => 'ed', 'Fatal' => "Unknown variable \"bar\"\n",
826 { 'file' => 'TopClass.py', 'line' => 23, 'code' => "x = MoreObject(\"345\\n\")\n" },
827 { 'file' => 'MoreClass.py', 'line' => 58, 'code' => "foo = bar" } ] } )
831 test: Throwaway comments
833 ### These are four throwaway comment ###
835 ### lines (the second line is empty). ###
836 this: | # Comments may trail lines.
837 contains three lines of text.
838 The third one starts with a
839 # character. This isn't a comment.
841 # These are three throwaway comment
842 # lines (the first line is empty).
845 'this' => "contains three lines of text.\nThe third one starts with a\n# character. This isn't a comment.\n"
848 test: Document with a single value
852 This YAML stream contains a single text value.
853 The next stream is a log file - a sequence of
854 log entries. Adding an entry to the log is a
855 simple matter of appending it at the end.
857 "This YAML stream contains a single text value. The next stream is a log file - a sequence of log entries. Adding an entry to the log is a simple matter of appending it at the end.\n"
859 test: Document stream
863 at: 2001-08-12 09:25:00.00 Z
868 at: 2001-08-12 09:25:10.00 Z
875 'at' => Time::utc( 2001, 8, 12, 9, 25, 00 ),
878 'url' => '/index.html'
881 'at' => Time::utc( 2001, 8, 12, 9, 25, 10 ),
889 test: Top level mapping
891 # This stream is an example of a top-level mapping.
898 'date' => gmmktime(0, 0, 0, 1, 23, 2001),
902 test: Single-line documents
905 # The following is a sequence of three documents.
906 # The first contains an empty mapping, the second
907 # an empty sequence, and the last an empty string.
919 test: Document with pause
922 # A communication channel based on a YAML stream.
924 sent at: 2002-06-06 11:46:25.10 Z
926 # Receiver can process this as soon as the following is sent:
928 # Even if the next message is sent long after:
930 sent at: 2002-06-06 12:05:53.47 Z
936 { 'sent at' => YAML::mktime( 2002, 6, 6, 11, 46, 25, 0.10 ),
937 'payload' => 'Whatever' }
940 { "payload" => "Whatever", "sent at" => YAML::mktime( 2002, 6, 6, 12, 5, 53, 0.47 ) }
945 test: Explicit typing
951 array( 'integer' => 12, 'also int' => 12, 'string' => '12' )
956 # Both examples below make use of the 'x-private:ball'
957 # type family URI, but with different semantics.
968 YAML::PrivateType.new( 'ball',
969 { 'number' => 8, 'color' => 'black' } ) }
971 y.add( { 'bearing' =>
972 YAML::PrivateType.new( 'ball',
973 { 'material' => 'steel' } ) }
978 test: Type family under yaml.org
980 # The URI is 'tag:yaml.org,2002:str'
981 - !str a Unicode string
983 array( 'a Unicode string' )
985 test: Type family under perl.yaml.org
988 # The URI is 'tag:perl.yaml.org,2002:Text::Tabs'
989 - !perl/Text::Tabs {}
991 [ YAML::DomainType.new( 'perl.yaml.org,2002', 'Text::Tabs', {} ) ]
993 test: Type family under clarkevans.com
996 # The URI is 'tag:clarkevans.com,2003-02:timesheet'
997 - !clarkevans.com,2003-02/timesheet {}
999 [ YAML::DomainType.new( 'clarkevans.com,2003-02', 'timesheet', {} ) ]
1005 - !domain.tld,2002/type\x30 value
1006 - !domain.tld,2002/type0 value
1007 different: # As far as the YAML parser is concerned
1008 - !domain.tld,2002/type%30 value
1009 - !domain.tld,2002/type0 value
1011 YAML.add_domain_type( "domain.tld,2002", "type0" ) { |type, val|
1014 YAML.add_domain_type( "domain.tld,2002", "type%30" ) { |type, val|
1018 { 'same' => [ 'ONE: value', 'ONE: value' ], 'different' => [ 'TWO: value', 'ONE: value' ] }
1023 # 'tag:domain.tld,2002:invoice' is some type family.
1024 invoice: !domain.tld,2002/^invoice
1025 # 'seq' is shorthand for 'tag:yaml.org,2002:seq'.
1026 # This does not effect '^customer' below
1027 # because it is does not specify a prefix.
1029 # '^customer' is shorthand for the full
1030 # notation 'tag:domain.tld,2002:customer'.
1035 YAML.add_domain_type( "domain.tld,2002", /(invoice|customer)/ ) { |type, val|
1037 scheme, domain, type = type.split( /:/, 3 )
1038 val['type'] = "domain #{type}"
1041 raise YAML::Error, "Not a Hash in domain.tld/invoice: " + val.inspect
1045 { "invoice"=> { "customers"=> [ { "given"=>"Chris", "type"=>"domain customer", "family"=>"Dumars" } ], "type"=>"domain invoice" } }
1048 test: Overriding anchors
1050 anchor : &A001 This scalar has an anchor.
1052 The alias node below is a
1053 repeated use of this value.
1056 array( 'anchor' => 'This scalar has an anchor.',
1057 'override' => "The alias node below is a repeated use of this value.\n",
1058 'alias' => "The alias node below is a repeated use of this value.\n" )
1060 test: Flow and block formatting
1064 flow: [ one, two, three # May span lines,
1065 , four, # indentation is
1066 five ] # mostly ignored.
1068 - First item in top sequence
1070 - Subordinate sequence entry
1072 A folded sequence entry
1073 - Sixth item in top sequence
1075 { 'empty' => [], 'flow' => [ 'one', 'two', 'three', 'four', 'five' ],
1076 'block' => [ 'First item in top sequence', [ 'Subordinate sequence entry' ],
1077 "A folded sequence entry\n", 'Sixth item in top sequence' ] }
1079 test: Complete mapping test
1083 flow: { one: 1, two: 2 }
1089 key: Subordinate mapping
1091 - Subordinate sequence
1093 - Previous mapping is empty.
1094 - A key: value pair in a sequence.
1095 A second: key:value pair.
1096 - The previous entry is equal to the following one.
1098 A key: value pair in a sequence.
1099 A second: key:value pair.
1100 !float 12 : This key is a float.
1103 : This key had to be protected.
1104 "\a" : This key had to be escaped.
1111 ? this also works as a key
1112 : with a value at the next line.
1117 - With a sequence value.
1122 with a: mapping value.
1124 { 'empty' => {}, 'flow' => { 'one' => 1, 'two' => 2 },
1125 'spanning' => { 'one' => 1, 'two' => 2 },
1126 'block' => { 'first' => 'First entry', 'second' =>
1127 { 'key' => 'Subordinate mapping' }, 'third' =>
1128 [ 'Subordinate sequence', {}, 'Previous mapping is empty.',
1129 { 'A key' => 'value pair in a sequence.', 'A second' => 'key:value pair.' },
1130 'The previous entry is equal to the following one.',
1131 { 'A key' => 'value pair in a sequence.', 'A second' => 'key:value pair.' } ],
1132 12.0 => 'This key is a float.', "?\n" => 'This key had to be protected.',
1133 "\a" => 'This key had to be escaped.',
1134 "This is a multi-line folded key\n" => "Whose value is also multi-line.",
1135 'this also works as a key' => 'with a value at the next line.',
1136 [ 'This key', 'is a sequence' ] => [ 'With a sequence value.' ] } }
1137 # Couldn't recreate map exactly, so we'll do a detailed check to be sure it's entact
1138 obj_y['block'].keys.each { |k|
1140 v = obj_y['block'][k]
1141 if k['This'] == 'key' and k['is a'] == 'mapping' and v['with a'] == 'mapping value.'
1142 obj_r['block'][k] = v
1147 test: Literal explicit indentation
1149 # Explicit indentation must
1150 # be given in all the three
1153 This value starts with four spaces.
1155 leading line break: |2
1157 This value starts with a line break.
1159 leading comment indicator: |2
1160 # first line starts with a
1163 # Explicit indentation may
1164 # also be given when it is
1167 This value is indented 2 spaces.
1170 'leading spaces' => " This value starts with four spaces.\n",
1171 'leading line break' => "\nThis value starts with a line break.\n",
1172 'leading comment indicator' => "# first line starts with a\n# character.\n",
1173 'redundant' => "This value is indented 2 spaces.\n"
1176 test: Chomping and keep modifiers
1179 This has one newline.
1181 same as "clipped" above: "This has one newline.\n"
1184 This has no newline.
1186 same as "stripped" above: "This has no newline."
1189 This has two newlines.
1191 same as "kept" above: "This has two newlines.\n\n"
1194 'clipped' => "This has one newline.\n",
1195 'same as "clipped" above' => "This has one newline.\n",
1196 'stripped' => 'This has no newline.',
1197 'same as "stripped" above' => 'This has no newline.',
1198 'kept' => "This has two newlines.\n\n",
1199 'same as "kept" above' => "This has two newlines.\n\n"
1202 test: Literal combinations
1208 The \ ' " characters may be
1209 freely used. Leading white
1210 space is significant.
1212 Line breaks are significant.
1213 Thus this value contains one
1214 empty line and ends with a
1215 single line break, but does
1218 is equal to: "The \\ ' \" characters may \
1219 be\nfreely used. Leading white\n space \
1220 is significant.\n\nLine breaks are \
1221 significant.\nThus this value contains \
1222 one\nempty line and ends with a\nsingle \
1223 line break, but does\nnot start with one.\n"
1225 # Comments may follow a block
1226 # scalar value. They must be
1229 # Modifiers may be combined in any order.
1230 indented and chomped: |2-
1231 This has no newline.
1233 also written as: |-2
1234 This has no newline.
1236 both are equal to: " This has no newline."
1240 'literal' => "The \\ ' \" characters may be\nfreely used. Leading white\n space " +
1241 "is significant.\n\nLine breaks are significant.\nThus this value contains one\n" +
1242 "empty line and ends with a\nsingle line break, but does\nnot start with one.\n",
1243 'is equal to' => "The \\ ' \" characters may be\nfreely used. Leading white\n space " +
1244 "is significant.\n\nLine breaks are significant.\nThus this value contains one\n" +
1245 "empty line and ends with a\nsingle line break, but does\nnot start with one.\n",
1246 'indented and chomped' => ' This has no newline.',
1247 'also written as' => ' This has no newline.',
1248 'both are equal to' => ' This has no newline.'
1251 test: Folded combinations
1257 Line feeds are converted
1258 to spaces, so this value
1259 contains no line breaks
1260 except for the final one.
1262 multiple paragraphs: >2
1264 An empty line, either
1269 line break. Thus this
1270 value contains three
1290 above is equal to: |
1291 This is a folded paragraph followed by a list:
1294 Followed by another folded paragraph, another list:
1300 And a final folded paragraph.
1302 # Explicit comments may follow
1303 # but must be less indented.
1307 'one paragraph' => 'Line feeds are converted to spaces, so this value'.
1308 " contains no line breaks except for the final one.\n",
1309 'multiple paragraphs' => "\nAn empty line, either at the start or in the value:\n".
1310 "Is interpreted as a line break. Thus this value contains three line breaks.\n",
1311 'indented text' => "This is a folded paragraph followed by a list:\n".
1312 " * first entry\n * second entry\nFollowed by another folded paragraph, ".
1313 "another list:\n\n * first entry\n\n * second entry\n\nAnd a final folded paragraph.\n",
1314 'above is equal to' => "This is a folded paragraph followed by a list:\n".
1315 " * first entry\n * second entry\nFollowed by another folded paragraph, ".
1316 "another list:\n\n * first entry\n\n * second entry\n\nAnd a final folded paragraph.\n"
1323 second: '! : \ etc. can be used freely.'
1324 third: 'a single quote '' must be escaped.'
1325 span: 'this contains
1330 is same as: "this contains six spaces\nand one line break"
1334 'second' => '! : \\ etc. can be used freely.',
1335 'third' => "a single quote ' must be escaped.",
1336 'span' => "this contains six spaces\nand one line break",
1337 'is same as' => "this contains six spaces\nand one line break"
1344 second: "! : etc. can be used freely."
1345 third: "a \" or a \\ must be escaped."
1346 fourth: "this value ends with an LF.\n"
1347 span: "this contains
1350 is equal to: "this contains four spaces"
1354 'second' => '! : etc. can be used freely.',
1355 'third' => 'a " or a \\ must be escaped.',
1356 'fourth' => "this value ends with an LF.\n",
1357 'span' => "this contains four spaces",
1358 'is equal to' => "this contains four spaces"
1361 test: Unquoted strings
1364 first: There is no unquoted empty string.
1366 second: 12 ## This is an integer.
1368 third: !str 12 ## This is a string.
1376 indicators: this has no comments.
1385 note: { one-line keys: but multi-line values }
1389 'first' => 'There is no unquoted empty string.',
1392 'span' => "this contains six spaces\nand one line break",
1393 'indicators' => "this has no comments. #:foo and bar# are both text.",
1394 'flow' => [ 'can span lines', 'like this' ],
1395 'note' => { 'one-line keys' => 'but multi-line values' }
1398 test: Spanning sequences
1401 # The following are equal seqs
1402 # with different identities.
1411 'flow' => [ 'one', 'two' ],
1412 'spanning' => [ 'one', 'two' ],
1413 'block' => [ 'one', 'two' ]
1418 # The following are equal maps
1419 # with different identities.
1420 flow: { one: 1, two: 2 }
1426 'flow' => array( 'one' => 1, 'two' => 2 ),
1427 'block' => array( 'one' => 1, 'two' => 2 )
1430 test: Representations of 12
1434 # The following scalars
1436 # string value '1' '2'.
1444 # Strings containing paths and regexps can be unquoted:
1450 array( 12, '12', '12', '12', '12', '/foo/bar', 'd:/foo/bar', 'foo/bar', '/a.*b/' )
1459 # This sequence has five
1460 # entries, two with values.
1468 four: This mapping has five keys,
1469 only two with values.
1473 'canonical' => null,
1475 'sparse' => array( null, '2nd entry', null, '4th entry', null ]),
1476 'four' => 'This mapping has five keys, only two with values.'
1482 # Explicitly typed dictionary.
1484 - aardvark: African pig-like ant eater. Ugly.
1485 - anteater: South-American ant eater. Two species.
1486 - anaconda: South-American constrictor snake. Scary.
1490 'Bestiary' => YAML::Omap[
1491 'aardvark', 'African pig-like ant eater. Ugly.',
1492 'anteater', 'South-American ant eater. Two species.',
1493 'anaconda', 'South-American constrictor snake. Scary.'
1501 # Explicitly typed pairs.
1503 - meeting: with team.
1504 - meeting: with boss.
1506 - meeting: with client.
1509 'tasks' => YAML::Pairs[
1510 'meeting', 'with team.',
1511 'meeting', 'with boss.',
1513 'meeting', 'with client.'
1521 # Explicitly typed set.
1522 baseball players: !set
1528 'baseball players' => YAML::Set[
1529 'Mark McGwire', nil,
1543 false => 'used as key',
1555 'canonical' => 12345,
1566 'decimal' => 12345.0,
1580 canonical: 1.23015e+3
1581 exponential: 12.3015e+02
1582 negative infinity: -.inf
1586 'canonical' => 1230.15,
1587 'exponential' => 1230.15,
1588 'negative infinity' => log(0),
1589 'not a number' => -log(0)
1595 canonical: 2001-12-15T02:59:43.1Z
1596 valid iso8601: 2001-12-14t21:59:43.10-05:00
1597 space separated: 2001-12-14 21:59:43.10 -05:00
1598 date (noon UTC): 2002-12-14
1601 'canonical' => YAML::mktime( 2001, 12, 15, 2, 59, 43, 0.10 ),
1602 'valid iso8601' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
1603 'space separated' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
1604 'date (noon UTC)' => Date.new( 2002, 12, 14 )
1610 canonical: !binary "\
1611 R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5\
1612 OTk6enp56enmlpaWNjY6Ojo4SEhP/++f/++f/++f/++f/++f/++f/++f/++f/+\
1613 +f/++f/++f/++f/++f/++SH+Dk1hZGUgd2l0aCBHSU1QACwAAAAADAAMAAAFLC\
1614 AgjoEwnuNAFOhpEMTRiggcz4BNJHrv/zCFcLiwMWYNG84BwwEeECcgggoBADs="
1616 R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5
1617 OTk6enp56enmlpaWNjY6Ojo4SEhP/++f/++f/++f/++f/++f/++f/++f/++f/+
1618 +f/++f/++f/++f/++f/++SH+Dk1hZGUgd2l0aCBHSU1QACwAAAAADAAMAAAFLC
1619 AgjoEwnuNAFOhpEMTRiggcz4BNJHrv/zCFcLiwMWYNG84BwwEeECcgggoBADs=
1621 The binary value above is a tiny arrow
1622 encoded as a gif image.
1624 arrow_gif = "GIF89a\f\000\f\000\204\000\000\377\377\367\365\365\356\351\351\345fff\000\000\000\347\347\347^^^\363\363\355\216\216\216\340\340\340\237\237\237\223\223\223\247\247\247\236\236\236iiiccc\243\243\243\204\204\204\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371!\376\016Made with GIMP\000,\000\000\000\000\f\000\f\000\000\005, \216\2010\236\343@\024\350i\020\304\321\212\010\034\317\200M$z\357\3770\205p\270\2601f\r\e\316\001\303\001\036\020' \202\n\001\000;"
1627 'canonical' => arrow_gif,
1628 'base64' => arrow_gif,
1629 'description' => "The binary value above is a tiny arrow encoded as a gif image.\n"
1637 - &CENTER { x: 1, y: 2 }
1638 - &LEFT { x: 0, y: 2 }
1642 # All the following maps are equal:
1655 - # Merge multiple maps
1656 << : [ *CENTER, *BIG ]
1660 << : [ *BIG, *LEFT, *SMALL ]
1665 center = { 'x' => 1, 'y' => 2 }
1666 left = { 'x' => 0, 'y' => 2 }
1668 small = { 'r' => 1 }
1669 node1 = { 'x' => 1, 'y' => 2, 'r' => 10, 'label' => 'center/big' }
1671 node2.update( { 'r' => 10, 'label' => 'center/big' } )
1673 node3.update( center )
1674 node3.update( { 'label' => 'center/big' } )
1676 node4.update( left )
1678 node4.update( { 'x' => 1, 'label' => 'center/big' } )
1682 center, left, big, small, node1, node2, node3, node4
1700 y = YAML::Stream.new
1701 y.add( { 'link with' => [ 'library1.dll', 'library2.dll' ] } )
1702 obj_h = Hash[ 'version' => 1.2 ]
1703 obj_h.default = 'library1.dll'
1704 obj_h2 = Hash[ 'version' => 2.3 ]
1705 obj_h2.default = 'library2.dll'
1706 y.add( { 'link with' => [ obj_h, obj_h2 ] } )
1713 "!": These three keys
1714 "&": had to be quoted
1715 "=": and are normal strings.
1716 # NOTE: the following node should NOT be serialized this way.
1718 !special '!' : '!type'
1719 !special|canonical '&' : 12
1721 # The proper way to serialize the above node is as follows:
1722 node : !!type &12 value
1724 { '!' => 'These three keys', '&' => 'had to be quoted',
1725 '=' => 'and are normal strings.',
1726 'encoded node' => YAML::PrivateType.new( 'type', 'value' ),
1727 'node' => YAML::PrivateType.new( 'type', 'value' ) }