1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
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
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
125
126
127
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
172
173
174
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
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
|
# frozen_string_literal: true
require_relative "helper"
Gem.load_yaml
class TestGemSafeYAML < Gem::TestCase
def yaml_load(input, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES,
permitted_symbols: Gem::SafeYAML::PERMITTED_SYMBOLS,
aliases: true)
if Gem.use_psych?
Psych.safe_load(input, permitted_classes: permitted_classes,
permitted_symbols: permitted_symbols,
aliases: aliases)
else
Gem::YAMLSerializer.load(input, permitted_classes: permitted_classes,
permitted_symbols: permitted_symbols,
aliases: aliases)
end
end
def yaml_dump(obj)
if Gem.use_psych?
obj.to_yaml
else
Gem::YAMLSerializer.dump(obj)
end
end
def test_aliases_enabled_by_default
assert_predicate Gem::SafeYAML, :aliases_enabled?
assert_equal({ "a" => "a", "b" => "a" }, Gem::SafeYAML.safe_load("a: &a a\nb: *a\n"))
end
def test_aliases_disabled
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = false
refute_predicate Gem::SafeYAML, :aliases_enabled?
expected_error = defined?(Psych::AliasesNotEnabled) ? Psych::AliasesNotEnabled : Psych::BadAlias
assert_raise expected_error do
Gem::SafeYAML.safe_load("a: &a\nb: *a\n")
end
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_specification_version_is_integer
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test
version: !ruby/object:Gem::Version
version: 1.0.0
specification_version: 4
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Integer, spec.specification_version
assert_equal 4, spec.specification_version
end
def test_disallowed_class_rejected
yaml = <<~YAML
--- !ruby/object:SomeDisallowedClass
foo: bar
YAML
exception = assert_raise(Psych::DisallowedClass) do
Gem::SafeYAML.safe_load(yaml)
end
assert_match(/unspecified class/, exception.message)
end
def test_disallowed_symbol_rejected
yaml = <<~YAML
--- !ruby/object:Gem::Dependency
name: test
requirement: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: 0
type: :invalid_type
prerelease: false
version_requirements: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: 0
YAML
exception = assert_raise(Psych::DisallowedClass) do
Gem::SafeYAML.safe_load(yaml)
end
assert_match(/unspecified class/, exception.message)
end
def test_yaml_serializer_aliases_disabled
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = false
refute_predicate Gem::SafeYAML, :aliases_enabled?
yaml = "a: &anchor value\nb: *anchor\n"
assert_raise(Psych::AliasesNotEnabled) do
Gem::SafeYAML.safe_load(yaml)
end
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_real_gemspec_fileutils
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: fileutils
version: !ruby/object:Gem::Version
version: 1.8.0
platform: ruby
authors:
- Minero Aoki
bindir: bin
cert_chain: []
date: 1980-01-02 00:00:00.000000000 Z
dependencies: []
description: Several file utility methods for copying, moving, removing, etc.
email:
-
executables: []
extensions: []
extra_rdoc_files: []
files:
- BSDL
- COPYING
- README.md
- Rakefile
- fileutils.gemspec
- lib/fileutils.rb
homepage: https://github.com/ruby/fileutils
licenses:
- Ruby
- BSD-2-Clause
metadata:
source_code_uri: https://github.com/ruby/fileutils
rdoc_options: []
require_paths:
- lib
required_ruby_version: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: 2.5.0
required_rubygems_version: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: '0'
requirements: []
rubygems_version: 3.6.9
specification_version: 4
summary: Several file utility methods for copying, moving, removing, etc.
test_files: []
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "fileutils", spec.name
assert_equal Gem::Version.new("1.8.0"), spec.version
assert_kind_of Integer, spec.specification_version
assert_equal 4, spec.specification_version
end
def test_yaml_anchor_and_alias_enabled
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = true
yaml = <<~YAML
dependencies:
- &req !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: '0'
- *req
YAML
result = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Hash, result
assert_kind_of Array, result["dependencies"]
assert_equal 2, result["dependencies"].size
assert_kind_of Gem::Requirement, result["dependencies"][0]
assert_kind_of Gem::Requirement, result["dependencies"][1]
assert_equal result["dependencies"][0].requirements, result["dependencies"][1].requirements
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_real_gemspec_rubygems_bundler
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: rubygems-bundler
version: !ruby/object:Gem::Version
version: 1.4.5
platform: ruby
authors:
- Josh Hull
- Michal Papis
autorequire:
bindir: bin
cert_chain: []
date: 2018-06-24 00:00:00.000000000 Z
dependencies:
- !ruby/object:Gem::Dependency
name: bundler-unload
requirement: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: 1.0.2
type: :runtime
prerelease: false
version_requirements: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: 1.0.2
description: Stop using bundle exec.
email:
- joshbuddy@gmail.com
- mpapis@gmail.com
executables: []
extensions: []
extra_rdoc_files: []
files:
- ".gem.config"
homepage: http://mpapis.github.com/rubygems-bundler
licenses:
- Apache-2.0
metadata: {}
post_install_message:
rdoc_options: []
require_paths:
- lib
required_ruby_version: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: '0'
rubyforge_project:
rubygems_version: 2.7.6
signing_key:
specification_version: 4
summary: Stop using bundle exec
test_files: []
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "rubygems-bundler", spec.name
assert_equal Gem::Version.new("1.4.5"), spec.version
assert_equal 1, spec.dependencies.size
dep = spec.dependencies.first
assert_equal "bundler-unload", dep.name
assert_kind_of Gem::Requirement, dep.requirement
assert_kind_of Gem::Requirement, dep.instance_variable_get(:@version_requirements)
assert_equal dep.requirement.requirements, [[">=", Gem::Version.new("1.0.2")]]
# Empty fields should be nil
assert_nil spec.autorequire
assert_nil spec.post_install_message
# Metadata should be empty hash
assert_equal({}, spec.metadata)
# specification_version should be Integer
assert_kind_of Integer, spec.specification_version
assert_equal 4, spec.specification_version
end
def test_empty_requirements_array
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test
dependencies:
- !ruby/object:Gem::Dependency
name: foo
requirement: !ruby/object:Gem::Requirement
requirements:
type: :runtime
version_requirements: !ruby/object:Gem::Requirement
requirements:
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "test", spec.name
assert_equal 1, spec.dependencies.size
dep = spec.dependencies.first
assert_equal "foo", dep.name
assert_kind_of Gem::Requirement, dep.requirement
reqs = dep.requirement.instance_variable_get(:@requirements)
assert_nil reqs
end
def test_requirements_hash_converted_to_array
# Malformed YAML where requirements is a Hash instead of Array
yaml = <<~YAML
!ruby/object:Gem::Requirement
requirements:
foo: bar
YAML
req = yaml_load(yaml, permitted_classes: ["Gem::Requirement"])
assert_kind_of Gem::Requirement, req
reqs = req.instance_variable_get(:@requirements)
assert_kind_of Hash, reqs
end
def test_requirement_quote
yaml = <<~YAML
requirements:
- "system: arrow-glib>=25.0.0: amazon_linux: arrow-glib-devel"
- 'system: arrow-glib>=25.0.0: fedora: libarrow-glib-devel'
YAML
expected = [
"system: arrow-glib>=25.0.0: amazon_linux: arrow-glib-devel",
"system: arrow-glib>=25.0.0: fedora: libarrow-glib-devel",
]
assert_equal expected, yaml_load(yaml)["requirements"]
end
def test_rdoc_options_hash_converted_to_array
# Some gemspecs incorrectly have rdoc_options: {} instead of rdoc_options: []
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test-gem
version: !ruby/object:Gem::Version
version: 1.0.0
rdoc_options: {}
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "test-gem", spec.name
assert_equal [], spec.rdoc_options
end
def test_load_returns_nil_for_comment_only_yaml
# Bundler config files may contain only comments after deleting all keys
result = yaml_load("---\n# BUNDLE_FOO: \"bar\"\n")
assert_nil result
end
def test_load_returns_nil_for_empty_document
assert_nil yaml_load("---\n")
assert_nil yaml_load("")
assert_raise(TypeError) { yaml_load(nil) }
end
def test_load_returns_hash_for_flow_empty_hash
# yaml_dump({}) produces "--- {}\n"
result = yaml_load("--- {}\n")
assert_kind_of Hash, result
assert_empty result
end
def test_load_parses_flow_empty_hash_as_value
result = yaml_load("metadata: {}\n")
assert_kind_of Hash, result
assert_kind_of Hash, result["metadata"]
assert_empty result["metadata"]
end
def test_yaml_non_specific_tag_stripped
# Legacy RubyGems (1.x) generated YAML with ! non-specific tags like:
# - ! '>='
# The ! prefix should be ignored.
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: legacy-gem
version: !ruby/object:Gem::Version
version: 0.1.0
required_ruby_version: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: '0'
required_rubygems_version: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: 1.3.5
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "legacy-gem", spec.name
assert_equal Gem::Requirement.new(">= 0"), spec.required_ruby_version
assert_equal Gem::Requirement.new(">= 1.3.5"), spec.required_rubygems_version
end
def test_legacy_gemspec_with_anchors_and_non_specific_tags
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = true
# Real-world pattern from gems like vegas-0.1.11 that combine
# YAML anchors/aliases with ! non-specific tags
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: legacy-gem
version: !ruby/object:Gem::Version
version: 0.1.11
dependencies:
- !ruby/object:Gem::Dependency
name: rack
requirement: &id001 !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: 1.0.0
type: :runtime
prerelease: false
version_requirements: *id001
- !ruby/object:Gem::Dependency
name: mocha
requirement: &id002 !ruby/object:Gem::Requirement
none: false
requirements:
- - ~>
- !ruby/object:Gem::Version
version: 0.9.8
type: :development
prerelease: false
version_requirements: *id002
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "legacy-gem", spec.name
assert_equal 2, spec.dependencies.size
rack_dep = spec.dependencies.find {|d| d.name == "rack" }
assert_kind_of Gem::Dependency, rack_dep
assert_equal :runtime, rack_dep.type
assert_equal Gem::Requirement.new(">= 1.0.0"), rack_dep.requirement
mocha_dep = spec.dependencies.find {|d| d.name == "mocha" }
assert_kind_of Gem::Dependency, mocha_dep
assert_equal :development, mocha_dep.type
assert_equal Gem::Requirement.new("~> 0.9.8"), mocha_dep.requirement
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_non_specific_tag_on_plain_value
# ! tag on a bracketed value like rubyforge_project: ! '[none]'
result = yaml_load("key: ! '[none]'\n")
assert_equal({ "key" => "[none]" }, result)
end
def test_dump_quotes_dollar_sign_values
# Values starting with $ should be quoted to preserve them as strings
yaml = yaml_dump({ "BUNDLE_FOO" => "$BUILD_DIR", "BUNDLE_BAR" => "baz" })
assert_include yaml, 'BUNDLE_FOO: "$BUILD_DIR"'
assert_include yaml, "BUNDLE_BAR: baz"
# Round-trip: ensure the quoted value is parsed back correctly
result = yaml_load(yaml)
assert_equal "$BUILD_DIR", result["BUNDLE_FOO"]
assert_equal "baz", result["BUNDLE_BAR"]
end
def test_dump_quotes_special_characters
# Various special characters that should trigger quoting
special_values = {
"dollar" => "$HOME",
"exclamation" => "!important",
"ampersand" => "&anchor",
"asterisk" => "*ref",
"colon_prefix" => ":symbol",
"at_sign" => "@mention",
"percent" => "%encoded",
}
yaml = yaml_dump(special_values)
special_values.each do |key, value|
assert_include yaml, "#{key}: #{value.inspect}", "Value #{value.inspect} for key #{key} should be quoted"
end
# Round-trip
result = yaml_load(yaml)
special_values.each do |key, value|
assert_equal value, result[key], "Round-trip failed for key #{key}"
end
end
def test_load_ambiguous_value_with_colon
# "invalid: yaml: hah" is ambiguous YAML - our parser treats it as
# {"invalid" => "yaml: hah"}, but the value looks like a nested mapping.
# config_file.rb's load_file should detect this and reject it.
if Gem.use_psych?
# Psych raises a syntax error for this ambiguous YAML
assert_raise(Psych::SyntaxError) do
yaml_load("invalid: yaml: hah")
end
else
result = yaml_load("invalid: yaml: hah")
assert_kind_of Hash, result
assert_equal "yaml: hah", result["invalid"]
end
end
def test_nested_anchor_in_array_item
# Ensure aliases are enabled for this test
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = true
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test-gem
version: !ruby/object:Gem::Version
version: 1.0.0
dependencies:
- !ruby/object:Gem::Dependency
name: foo
requirement: !ruby/object:Gem::Requirement
requirements:
- &id002
- ">="
- !ruby/object:Gem::Version
version: "0"
type: :runtime
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
assert_equal "test-gem", spec.name
dep = spec.dependencies.first
assert_kind_of Gem::Dependency, dep
# Requirements should be parsed as nested arrays, not strings
assert_kind_of Array, dep.requirement.requirements
assert_equal 1, dep.requirement.requirements.size
req_item = dep.requirement.requirements.first
assert_kind_of Array, req_item
assert_equal ">=", req_item[0]
assert_kind_of Gem::Version, req_item[1]
assert_equal "0", req_item[1].version
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_roundtrip_specification
spec = Gem::Specification.new do |s|
s.name = "round-trip-test"
s.version = "2.3.4"
s.platform = "ruby"
s.authors = ["Test Author"]
s.summary = "A test gem for round-trip"
s.description = "Longer description of the test gem"
s.files = ["lib/foo.rb", "README.md"]
s.require_paths = ["lib"]
s.homepage = "https://example.com"
s.licenses = ["MIT"]
s.metadata = { "source_code_uri" => "https://example.com/src" }
s.add_dependency "rake", ">= 1.0"
end
yaml = yaml_dump(spec)
loaded = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, loaded
assert_equal "round-trip-test", loaded.name
assert_equal Gem::Version.new("2.3.4"), loaded.version
assert_equal ["Test Author"], loaded.authors
assert_equal "A test gem for round-trip", loaded.summary
assert_equal ["README.md", "lib/foo.rb"], loaded.files
assert_equal ["lib"], loaded.require_paths
assert_equal "https://example.com", loaded.homepage
assert_equal ["MIT"], loaded.licenses
assert_equal({ "source_code_uri" => "https://example.com/src" }, loaded.metadata)
assert_equal 1, loaded.dependencies.size
dep = loaded.dependencies.first
assert_equal "rake", dep.name
assert_equal :runtime, dep.type
end
def test_roundtrip_specification_with_extensions
spec = Gem::Specification.new do |s|
s.name = "native-ext-test"
s.version = "1.0.0"
s.authors = ["Test"]
s.summary = "A gem with native extensions"
s.files = ["lib/native.rb", "ext/native/extconf.rb", "ext/native/native.c"]
s.extensions = ["ext/native/extconf.rb"]
s.require_paths = ["lib"]
end
yaml = yaml_dump(spec)
loaded = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, loaded
assert_equal ["ext/native/extconf.rb"], loaded.extensions
assert_equal ["ext/native/extconf.rb", "ext/native/native.c", "lib/native.rb"], loaded.files
end
def test_roundtrip_specification_with_windows_paths
spec = Gem::Specification.new do |s|
s.name = "win-path-test"
s.version = "1.0.0"
s.authors = ["Test"]
s.summary = "A gem with Windows-style paths"
s.files = ["lib/foo.rb", "lib/foo/bar.rb"]
s.require_paths = ["lib"]
s.description = 'Installed in D:\ruby\lib\ruby\gems'
s.post_install_message = "Installed to C:\\Program Files\\Ruby\\lib\\rdoc"
end
yaml = yaml_dump(spec)
loaded = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, loaded
assert_equal 'Installed in D:\ruby\lib\ruby\gems', loaded.description
assert_equal "Installed to C:\\Program Files\\Ruby\\lib\\rdoc", loaded.post_install_message
end
def test_roundtrip_specification_with_metadata
spec = Gem::Specification.new do |s|
s.name = "metadata-test"
s.version = "1.0.0"
s.authors = ["Test"]
s.summary = "A gem with metadata"
s.files = ["lib/foo.rb"]
s.require_paths = ["lib"]
s.metadata = {
"changelog_uri" => "https://example.com/CHANGELOG.md",
"source_code_uri" => "https://github.com/example/metadata-test",
"bug_tracker_uri" => "https://github.com/example/metadata-test/issues",
"allowed_push_host" => "https://rubygems.org",
}
end
yaml = yaml_dump(spec)
loaded = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, loaded
assert_kind_of Hash, loaded.metadata
assert_equal 4, loaded.metadata.size
assert_equal "https://example.com/CHANGELOG.md", loaded.metadata["changelog_uri"]
assert_equal "https://github.com/example/metadata-test", loaded.metadata["source_code_uri"]
assert_equal "https://github.com/example/metadata-test/issues", loaded.metadata["bug_tracker_uri"]
assert_equal "https://rubygems.org", loaded.metadata["allowed_push_host"]
end
def test_roundtrip_version
ver = Gem::Version.new("1.2.3")
yaml = yaml_dump(ver)
loaded = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Version, loaded
assert_equal ver, loaded
end
def test_roundtrip_platform
plat = Gem::Platform.new("x86_64-linux")
yaml = yaml_dump(plat)
loaded = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Platform, loaded
assert_equal plat.cpu, loaded.cpu
assert_equal plat.os, loaded.os
assert_equal plat.version, loaded.version
end
def test_roundtrip_requirement
req = Gem::Requirement.new(">= 1.0", "< 2.0")
yaml = yaml_dump(req)
loaded = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Requirement, loaded
assert_equal req.requirements.sort_by(&:to_s), loaded.requirements.sort_by(&:to_s)
end
def test_roundtrip_dependency
dep = Gem::Dependency.new("foo", ">= 1.0", :development)
yaml = yaml_dump(dep)
loaded = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Dependency, loaded
assert_equal "foo", loaded.name
assert_equal :development, loaded.type
assert_equal dep.requirement.requirements, loaded.requirement.requirements
end
def test_roundtrip_nested_hash
obj = { "a" => { "b" => "c", "d" => [1, 2, 3] } }
yaml = yaml_dump(obj)
loaded = yaml_load(yaml)
assert_equal obj, loaded
end
def test_roundtrip_block_scalar
obj = { "text" => "line1\nline2\n" }
yaml = yaml_dump(obj)
loaded = yaml_load(yaml)
assert_equal "line1\nline2\n", loaded["text"]
end
def test_roundtrip_special_characters
obj = {
"dollar" => "$HOME",
"exclamation" => "!important",
"ampersand" => "&anchor",
"asterisk" => "*ref",
"colon_prefix" => ":symbol",
"hash_char" => "value#comment",
"brackets" => "[item]",
"braces" => "{key}",
"comma" => "a,b,c",
}
yaml = yaml_dump(obj)
loaded = yaml_load(yaml)
obj.each do |key, value|
assert_equal value, loaded[key], "Round-trip failed for key #{key}"
end
end
def test_roundtrip_boolean_nil_integer
obj = { "flag" => true, "count" => 42, "empty" => nil, "off" => false }
yaml = yaml_dump(obj)
loaded = yaml_load(yaml)
assert_equal true, loaded["flag"]
assert_equal 42, loaded["count"]
assert_nil loaded["empty"]
assert_equal false, loaded["off"]
end
def test_roundtrip_time
time = Time.utc(2024, 6, 15, 12, 30, 45)
obj = { "created" => time }
yaml = yaml_dump(obj)
loaded = yaml_load(yaml)
assert_kind_of Time, loaded["created"]
assert_equal time.year, loaded["created"].year
assert_equal time.month, loaded["created"].month
assert_equal time.day, loaded["created"].day
end
def test_roundtrip_empty_collections
obj = { "arr" => [], "hash" => {} }
yaml = yaml_dump(obj)
loaded = yaml_load(yaml)
assert_equal [], loaded["arr"]
assert_equal({}, loaded["hash"])
end
def test_load_double_quoted_escape_sequences
result = yaml_load("newline: \"hello\\nworld\"")
assert_equal "hello\nworld", result["newline"]
result = yaml_load("tab: \"col1\\tcol2\"")
assert_equal "col1\tcol2", result["tab"]
result = yaml_load("cr: \"line\\rend\"")
assert_equal "line\rend", result["cr"]
result = yaml_load("quote: \"say\\\"hi\\\"\"")
assert_equal "say\"hi\"", result["quote"]
end
def test_load_double_quoted_backslash_before_escape_chars
# \\r in YAML should become literal backslash + r, not carriage return
result = yaml_load('path: "D:\\\\ruby-mswin\\\\lib"')
assert_equal "D:\\ruby-mswin\\lib", result["path"]
# \\n should become literal backslash + n, not newline
result = yaml_load('path: "C:\\\\new_folder"')
assert_equal "C:\\new_folder", result["path"]
# \\t should become literal backslash + t, not tab
result = yaml_load('path: "C:\\\\tmp\\\\test"')
assert_equal "C:\\tmp\\test", result["path"]
# \\\\ should become two literal backslashes
result = yaml_load('val: "a\\\\\\\\b"')
assert_equal "a\\\\b", result["val"]
end
def test_load_single_quoted_escape
result = yaml_load("key: 'it''s'")
assert_equal "it's", result["key"]
result = yaml_load("key: 'no escape \\n here'")
assert_equal "no escape \\n here", result["key"]
end
def test_load_quoted_numeric_stays_string
result = yaml_load("key: \"42\"")
assert_equal "42", result["key"]
assert_kind_of String, result["key"]
result = yaml_load("key: '99'")
assert_equal "99", result["key"]
assert_kind_of String, result["key"]
end
def test_load_empty_string_value
result = yaml_load("key: \"\"")
assert_equal "", result["key"]
end
def test_load_unquoted_integer
result = yaml_load("key: 42")
assert_equal 42, result["key"]
assert_kind_of Integer, result["key"]
result = yaml_load("key: -7")
assert_equal(-7, result["key"])
end
def test_load_boolean_values
result = yaml_load("a: true\nb: false")
assert_equal true, result["a"]
assert_equal false, result["b"]
end
def test_load_nil_value
# YAML 1.2: "nil" is not a null value, only ~ and null are
result = yaml_load("key: nil")
assert_equal "nil", result["key"]
result = yaml_load("key: ~")
assert_nil result["key"]
result = yaml_load("key: null")
assert_nil result["key"]
end
def test_load_time_value
result = yaml_load("date: 2024-06-15 12:30:45.000000000 Z")
assert_kind_of Time, result["date"]
assert_equal 2024, result["date"].year
assert_equal 6, result["date"].month
assert_equal 15, result["date"].day
end
def test_load_block_scalar_keep_trailing_newline
yaml = "text: |\n line1\n line2\n"
result = yaml_load(yaml)
assert_equal "line1\nline2\n", result["text"]
end
def test_load_block_scalar_strip_trailing_newline
yaml = "text: |-\n no trailing newline\n"
result = yaml_load(yaml)
assert_equal "no trailing newline", result["text"]
refute result["text"].end_with?("\n")
end
def test_load_flow_array
result = yaml_load("items: [a, b, c]")
assert_equal ["a", "b", "c"], result["items"]
end
def test_load_flow_empty_array
result = yaml_load("items: []")
assert_equal [], result["items"]
end
def test_load_mapping_key_with_no_value
result = yaml_load("key:")
assert_kind_of Hash, result
assert_nil result["key"]
end
def test_load_sequence_item_as_mapping
yaml = "items:\n- name: foo\n ver: 1\n- name: bar\n ver: 2"
result = yaml_load(yaml)
assert_equal [{ "name" => "foo", "ver" => 1 }, { "name" => "bar", "ver" => 2 }], result["items"]
end
def test_load_nested_sequence
yaml = "matrix:\n- - a\n - b\n- - c\n - d"
result = yaml_load(yaml)
assert_equal [["a", "b"], ["c", "d"]], result["matrix"]
end
def test_load_comment_stripped_from_value
result = yaml_load("key: value # this is a comment")
assert_equal "value", result["key"]
end
def test_load_comment_in_quoted_string_preserved
result = yaml_load("key: \"value # not a comment\"")
assert_equal "value # not a comment", result["key"]
result = yaml_load("key: 'value # not a comment'")
assert_equal "value # not a comment", result["key"]
end
def test_load_crlf_line_endings
result = yaml_load("key: value\r\nother: data\r\n")
assert_equal "value", result["key"]
assert_equal "data", result["other"]
end
def test_load_version_requirement_old_tag
yaml = <<~YAML
!ruby/object:Gem::Version::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: "1.0"
YAML
req = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Requirement, req
assert_equal [[">=", Gem::Version.new("1.0")]], req.requirements
end
def test_load_dependency_version_version_requirement_old_tag
yaml = <<~YAML
- !ruby/object:Gem::Dependency
name: test-unit
type: :development
version_requirement:
version_requirements: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: 2.0.2
version:
YAML
deps = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_not_nil(deps.first)
assert_equal [[">=", Gem::Version.new("2.0.2")]], deps.first.requirement.requirements
end
def test_load_platform_from_value_field
yaml = "!ruby/object:Gem::Platform\nvalue: x86-linux\n"
plat = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Platform, plat
assert_nil plat.cpu
end
def test_load_platform_from_cpu_os_version_fields
yaml = "!ruby/object:Gem::Platform\ncpu: x86_64\nos: darwin\nversion: nil\n"
plat = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Platform, plat
assert_equal "x86_64", plat.cpu
assert_equal "darwin", plat.os
end
def test_load_platform_malicious_sequence
yaml = "!ruby/object:Gem::Platform\n- \"x86-mswin32\\n system('id')#\"\n"
result = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
refute_kind_of Gem::Platform, result
assert_kind_of Array, result
end
def test_load_dependency_missing_requirement_uses_default
yaml = <<~YAML
!ruby/object:Gem::Dependency
name: foo
type: :runtime
YAML
dep = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_kind_of Gem::Dependency, dep
assert_equal "foo", dep.name
assert_equal :runtime, dep.type
assert_nil dep.instance_variable_get(:@requirement)
end
def test_load_dependency_missing_type_defaults_to_runtime
yaml = <<~YAML
!ruby/object:Gem::Dependency
name: bar
requirement: !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: '0'
YAML
dep = yaml_load(yaml, permitted_classes: Gem::SafeYAML::PERMITTED_CLASSES)
assert_equal :runtime, dep.type
end
def test_specification_version_non_numeric_string_not_converted
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test
version: !ruby/object:Gem::Version
version: 1.0.0
specification_version: abc
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Specification, spec
# Non-numeric string should not be converted to Integer
assert_equal "abc", spec.specification_version
end
def test_unknown_permitted_tag_raises_argument_error
yaml = "!ruby/object:MyCustomClass\nfoo: bar\n"
assert_raise(ArgumentError) do
yaml_load(yaml, permitted_classes: ["MyCustomClass"])
end
end
def test_dump_block_scalar_with_trailing_newline
yaml = yaml_dump({ "text" => "line1\nline2\n" })
assert_include yaml, " |\n"
refute_includes yaml, " |-\n"
end
def test_dump_block_scalar_without_trailing_newline
yaml = yaml_dump({ "text" => "line1\nline2" })
assert_include yaml, " |-\n"
end
def test_dump_nil_value
yaml = yaml_dump({ "key" => nil })
loaded = yaml_load(yaml)
assert_nil loaded["key"]
end
def test_dump_symbol_keys_quoted
yaml = yaml_dump({ foo: "bar" })
# Symbol keys should use inspect format
assert_include yaml, ":foo:"
# Symbol values in hash with symbol keys should be quoted
yaml = yaml_dump({ type: ":runtime" })
assert_include yaml, "\":runtime\""
end
def test_regression_flow_empty_hash_as_root
# Previously returned Mapping struct instead of Hash
result = yaml_load("--- {}")
assert_kind_of Hash, result
assert_empty result
end
def test_regression_alias_check_in_builder_not_parser
# Previously aliases were resolved in Parser, bypassing Builder's policy check.
# The Builder must enforce aliases: false.
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = false
# Alias in mapping value
assert_raise(Psych::AliasesNotEnabled) do
yaml_load("a: &x val\nb: *x", aliases: false)
end
# Alias in sequence item
assert_raise(Psych::AliasesNotEnabled) do
yaml_load("items:\n- &x val\n- *x", aliases: false)
end
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_regression_anchored_mapping_stored_for_alias_resolution
# Previously build_mapping didn't call store_anchor, so anchored
# Gem types (Requirement, etc.) couldn't be resolved via aliases.
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = true
yaml = <<~YAML
a: &req !ruby/object:Gem::Requirement
requirements:
- - ">="
- !ruby/object:Gem::Version
version: '0'
b: *req
YAML
result = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Gem::Requirement, result["a"]
assert_kind_of Gem::Requirement, result["b"]
assert_equal result["a"].requirements, result["b"].requirements
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_regression_register_anchor_sets_node_anchor
# Previously register_anchor only stored node in @anchors hash but
# didn't set node.anchor, so Builder couldn't track anchored values.
aliases_enabled = Gem::SafeYAML.aliases_enabled?
Gem::SafeYAML.aliases_enabled = true
yaml = <<~YAML
items:
- &item !ruby/object:Gem::Version
version: '1.0'
- *item
YAML
result = Gem::SafeYAML.safe_load(yaml)
assert_kind_of Array, result["items"]
assert_equal 2, result["items"].size
assert_kind_of Gem::Version, result["items"][0]
assert_kind_of Gem::Version, result["items"][1]
assert_equal result["items"][0], result["items"][1]
ensure
Gem::SafeYAML.aliases_enabled = aliases_enabled
end
def test_regression_coerce_empty_hash_not_wrapped_in_scalar
# Previously coerce("{}") returned Mapping but parse_plain_scalar
# wrapped it in Scalar.new(value: Mapping), causing type mismatch.
result = yaml_load("--- {}")
assert_kind_of Hash, result
result = yaml_load("key: {}")
assert_kind_of Hash, result["key"]
end
def test_regression_rdoc_options_normalized_to_array
# rdoc_options as Hash (malformed gemspec)
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test
version: !ruby/object:Gem::Version
version: 1.0.0
rdoc_options:
--title: MyGem
--main: README
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_equal ["--title", "MyGem", "--main", "README"], spec.rdoc_options
end
def test_regression_requirements_field_normalized_to_array
# The "requirements" field in a Specification (not Requirement)
# should be normalized from Hash to Array if malformed
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: test
version: !ruby/object:Gem::Version
version: 1.0.0
requirements:
foo: bar
YAML
spec = Gem::SafeYAML.safe_load(yaml)
assert_equal [["foo", "bar"]], spec.requirements
end
def test_binary_tag_decoded_in_mapping_key
yaml = <<~YAML
---
!binary "U0hBMQ==":
metadata.gz: abc123
YAML
result = yaml_load(yaml)
assert_equal "SHA1", result.keys.first
assert_equal "abc123", result["SHA1"]["metadata.gz"]
end
def test_binary_tag_decoded_in_block_scalar_value
yaml = <<~YAML
---
SHA256:
metadata.gz: !binary |-
OWY4YTM5Y2MxOTc3Mzc5MWYzNzk1NjRmZjVlYzljYjY1MDQwYWIwMg==
YAML
result = yaml_load(yaml)
assert_equal "9f8a39cc19773791f379564ff5ec9cb65040ab02", result["SHA256"]["metadata.gz"]
end
def test_binary_tag_decoded_in_inline_value
yaml = <<~YAML
---
key: !binary "U0hBMQ=="
YAML
result = yaml_load(yaml)
assert_equal "SHA1", result["key"]
end
def test_binary_tag_checksums_yaml_roundtrip
# Simulates the checksums.yaml.gz format from older gems
yaml = <<~YAML
---
!binary "U0hBMQ==":
metadata.gz: !binary |-
OWY4YTM5Y2MxOTc3Mzc5MWYzNzk1NjRmZjVlYzljYjY1MDQwYWIwMg==
data.tar.gz: !binary |-
ZTRmZGRhNjc1MWM5NmIwYzRhODFkYjI0OTlkMjY3ZjQ2MWNkMGM1ZA==
YAML
result = yaml_load(yaml)
assert_equal ["SHA1"], result.keys
assert_equal "9f8a39cc19773791f379564ff5ec9cb65040ab02", result["SHA1"]["metadata.gz"]
assert_equal "e4fdda6751c96b0c4a81db2499d267f461cd0c5d", result["SHA1"]["data.tar.gz"]
end
def test_binary_tag_decoded_in_sequence_item_inline
yaml = <<~YAML
---
- !binary "U0hBMQ=="
YAML
result = yaml_load(yaml)
assert_equal ["SHA1"], result
end
def test_version_requirement_tag_always_permitted
yaml = <<~YAML
--- !ruby/object:Gem::Specification
name: escape
version: !ruby/object:Gem::Version
version: 0.0.4
required_ruby_version: !ruby/object:Gem::Version::Requirement
requirements:
- - ">"
- !ruby/object:Gem::Version
version: 0.0.0
version:
YAML
result = yaml_load(yaml)
assert_kind_of Gem::Specification, result
assert_equal "escape", result.name
assert_kind_of Gem::Requirement, result.required_ruby_version
end
end
|