Files
ruby/test/psych/test_string.rb
Hiroshi SHIBATAandClaude Opus 4.8 82ab14ecb0 [ruby/psych] Address Copilot review feedback on the libfyaml backend
Reject canonical output with NotImplementedError instead of silently
ignoring the request, and honor the implicit flag in start_sequence and
start_mapping so an implicit tag is not printed as a redundant verbose
tag. Relax the unquoted-boolean dump test to allow an optional document
end marker. Also correct the version docstrings and a stale comment
about how the parser collects diagnostics.

https://github.com/ruby/psych/commit/23f60daff1

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-02 02:40:16 +00:00

292 lines
8.4 KiB
Ruby

# encoding: UTF-8
# frozen_string_literal: true
require_relative 'helper'
module Psych
class TestString < TestCase
class X < String
end
class Y < String
attr_accessor :val
end
class Z < String
def initialize
force_encoding Encoding::US_ASCII
end
end
# 'y', 'Y', 'n', 'N' are kind of ambiguous. Syck treated those literals in
# YAML documents as strings. But this is not what the YAML 1.1 spec says.
# YAML 1.1 says they should be treated as booleans. When we're dumping
# documents, we know it's a string, so adding quotes will eliminate the
# "ambiguity" in the emitted document
def test_all_yaml_1_1_booleans_are_quoted
# The YAML 1.2 libfyaml backend does not treat yes/no/on/off as booleans,
# so it has no reason to quote them.
omit 'YAML 1.1 booleans are not special on the libfyaml backend' if libfyaml?
yaml_1_1_booleans = %w[y Y yes Yes YES n N no No NO true True TRUE false False FALSE on On ON off Off OFF] # from https://yaml.org/type/bool.html
yaml_1_1_booleans.each do |boolean|
assert_match(/"#{boolean}"|'#{boolean}'/, Psych.dump(boolean))
end
end
def test_yaml_1_1_booleans_are_not_quoted_on_libfyaml
omit 'YAML 1.1 booleans are plain strings on the libfyaml backend' unless libfyaml?
%w[yes no on off].each do |boolean|
# Unquoted plain scalar, allowing an optional document end marker.
assert_match(/\A--- #{boolean}\n(?:\.\.\.\n)?\z/, Psych.dump(boolean))
assert_equal boolean, Psych.load(Psych.dump(boolean))
end
end
def test_string_with_newline
assert_equal "1\n2", Psych.load("--- ! '1\n\n 2'\n")
end
def test_no_doublequotes_with_special_characters
assert_equal 2, Psych.dump(%Q{<%= ENV["PATH"] %>}).count('"')
end
def test_no_quotes_when_start_with_non_ascii_character
yaml = Psych.dump 'Český non-ASCII'.encode(Encoding::UTF_8)
assert_match(/---\s*[^"'!]+$/, yaml)
end
def test_doublequotes_when_there_is_a_single
str = "@123'abc"
yaml = Psych.dump str
assert_match(/---\s*"/, yaml)
assert_equal str, Psych.load(yaml)
end
def test_single_quote_when_matching_date
pend "Failing on JRuby" if RUBY_PLATFORM =~ /java/
lib = File.expand_path("../../../lib", __FILE__)
assert_separately(["-I", lib, "-r", "psych"], __FILE__, __LINE__ + 1, <<~'RUBY')
yml = Psych.dump('2024-11-19')
assert_equal '2024-11-19', Psych.load(yml)
RUBY
end
def test_datetime_string_with_tab_separator
str = "2023-12-31\t12:00:00"
assert_cycle str
end
def test_datetime_string_with_whitespace_separators
["\v", "\r", "\f", " \t", "\t "].each do |sep|
assert_cycle "2023-12-31#{sep}12:00:00"
end
end
def test_plain_when_shorten_than_line_width_and_no_final_line_break
str = "Lorem ipsum"
yaml = Psych.dump str, line_width: 12
assert_match(/---\s*[^>|]+\n/, yaml)
assert_equal str, Psych.load(yaml)
end
def test_plain_when_shorten_than_line_width_and_with_final_line_break
str = "Lorem ipsum\n"
yaml = Psych.dump str, line_width: 12
assert_match(/---\s*[^>|]+\n/, yaml)
assert_equal str, Psych.load(yaml)
end
def test_folded_when_longer_than_line_width_and_with_final_line_break
omit 'libfyaml uses a different block chomping indicator' if libfyaml?
str = "Lorem ipsum dolor sit\n"
yaml = Psych.dump str, line_width: 12
assert_match(/---\s*>\n(.*\n){2}\Z/, yaml)
assert_equal str, Psych.load(yaml)
end
# http://yaml.org/spec/1.2/2009-07-21/spec.html#id2593651
def test_folded_strip_when_longer_than_line_width_and_no_newlines
str = "Lorem ipsum dolor sit amet, consectetur"
yaml = Psych.dump str, line_width: 12
assert_match(/---\s*>-\n(.*\n){3}\Z/, yaml)
assert_equal str, Psych.load(yaml)
end
def test_literal_when_inner_and_final_line_break
omit 'libfyaml uses a different block chomping indicator' if libfyaml?
[
"Lorem ipsum\ndolor\n",
"Lorem ipsum\nZolor\n",
].each do |str|
yaml = Psych.dump str, line_width: 12
assert_match(/---\s*\|\n(.*\n){2}\Z/, yaml)
assert_equal str, Psych.load(yaml)
end
end
# http://yaml.org/spec/1.2/2009-07-21/spec.html#id2593651
def test_literal_strip_when_inner_line_break_and_no_final_line_break
[
"Lorem ipsum\ndolor",
"Lorem ipsum\nZolor",
].each do |str|
yaml = Psych.dump str, line_width: 12
assert_match(/---\s*\|-\n(.*\n){2}\Z/, yaml)
assert_equal str, Psych.load(yaml)
end
end
def test_cycle_x
str = X.new 'abc'
assert_cycle str
end
def test_dash_dot
assert_cycle '-.'
assert_cycle '+.'
end
def test_float_with_no_fractional_before_exponent
assert_cycle '0.E+0'
end
def test_string_subclass_with_anchor
y = Psych.unsafe_load <<-eoyml
---
body:
string: &70121654388580 !ruby/string
str: ! 'foo'
x:
body: *70121654388580
eoyml
assert_equal({"body"=>{"string"=>"foo", "x"=>{"body"=>"foo"}}}, y)
end
def test_self_referential_string
y = Psych.unsafe_load <<-eoyml
---
string: &70121654388580 !ruby/string
str: ! 'foo'
body: *70121654388580
eoyml
assert_equal({"string"=>"foo"}, y)
value = y['string']
assert_equal value, value.instance_variable_get(:@body)
end
def test_another_subclass_with_attributes
y = Psych.unsafe_load Psych.dump Y.new("foo").tap {|o| o.val = 1}
assert_equal "foo", y
assert_equal Y, y.class
assert_equal 1, y.val
end
def test_backwards_with_syck
x = Psych.unsafe_load "--- !str:#{X.name} foo\n\n"
assert_equal X, x.class
assert_equal 'foo', x
end
def test_empty_subclass
assert_match "!ruby/string:#{X}", Psych.dump(X.new)
x = Psych.unsafe_load Psych.dump X.new
assert_equal X, x.class
end
def test_empty_character_subclass
assert_match "!ruby/string:#{Z}", Psych.dump(Z.new)
x = Psych.unsafe_load Psych.dump Z.new
assert_equal Z, x.class
end
def test_subclass_with_attributes
y = Psych.unsafe_load Psych.dump Y.new.tap {|o| o.val = 1}
assert_equal Y, y.class
assert_equal 1, y.val
end
class NotAString
end
def test_string_tag_rejects_non_string_class
assert_raise(ArgumentError) do
Psych.unsafe_load "--- !ruby/string:#{NotAString} foo\n"
end
assert_raise(ArgumentError) do
Psych.unsafe_load "--- !ruby/string:#{NotAString}\nstr: foo\n"
end
end
def test_string_with_base_60
yaml = Psych.dump '01:03:05'
assert_match "'01:03:05'", yaml
assert_equal '01:03:05', Psych.load(yaml)
end
def test_nonascii_string_as_binary
string = "hello \x80 world!".dup
string.force_encoding 'ascii-8bit'
yml = Psych.dump string
assert_match(/binary/, yml)
assert_equal string, Psych.load(yml)
end
def test_binary_string_null
string = "\x00\x92".b
yml = Psych.dump string
assert_match(/binary/, yml)
assert_equal string, Psych.load(yml)
end
def test_binary_string
string = binary_string
yml = Psych.dump string
assert_match(/binary/, yml)
assert_equal string, Psych.load(yml)
end
def test_ascii_only_binary_string
string = "non bnry string".b
yml = Psych.dump string
refute_match(/binary/, yml)
assert_equal string, Psych.load(yml)
end
def test_ascii_only_8bit_string
string = "abc".encode(Encoding::ASCII_8BIT)
yml = Psych.dump string
refute_match(/binary/, yml)
assert_equal string, Psych.load(yml)
end
def test_string_with_ivars
food = "is delicious".dup
ivar = "on rock and roll"
food.instance_variable_set(:@we_built_this_city, ivar)
Psych.load Psych.dump food
assert_equal ivar, food.instance_variable_get(:@we_built_this_city)
end
def test_binary
string = [0, 123,22, 44, 9, 32, 34, 39].pack('C*')
assert_cycle string
end
def test_float_confusion
assert_cycle '1.'
end
def binary_string percentage = 0.31, length = 100
string = ''.b
(percentage * length).to_i.times do |i|
string << "\x92".b
end
string << 'a' * (length - string.length)
string
end
end
end