Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Custom domain types don't deserialize properly from anchors

未关闭
#786 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
58/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
冷清
技术栈
ruby
领域
data

调研方向

重现提供的 Psych YAML 示例,然后检查 lib/psych/visitors/to_ruby.rb 中的 Psych::Visitors::ToRuby#accept,尤其是域类型处理和别名注册。完成标准是:自定义域类型的重复别名被反序列化为同一个自定义对象,而不是属性哈希。

由索引模型根据 Issue 内容生成。

描述

I discovered this while trying to make YAML deserialization work with Sorbet enum classes, but this could happen with any custom domain type. I wrote a custom serializer using add_domain_type and a corresponding implementation of encode_with that I defined on T::Enum only to find that, if I serialize an object with the same enum value more than once, anything besides the first instance would actually just be a Hash with the properties I serialized on it. I have a simple example that repros the behavior:

require "yaml"
require "json"

::YAML.add_domain_type('test/custom_yaml', 'my_test_object') do |type, value|
  MyTestClass.new(prop1: value['prop1'], prop2: value['prop2'])
end

class MyTestClass
  attr_reader :prop1, :prop2

  def initialize(prop1:, prop2:)
    @prop1 = prop1
    @prop2 = prop2
  end

  def encode_with(coder)
    coder.tag = '!test/custom_yaml:my_test_object'

    coder.map = {
      'prop1' => @prop1,
      'prop2' => @prop2
    }
  end
end

test_obj = MyTestClass.new(prop1: 13, prop2: 1989)

generated = ::Psych.dump(
  {
    'object1' => test_obj,
    'object2' => test_obj,
    'object3' => test_obj
  }
)

puts "GENERATED YAML:"
puts generated
puts "END"

puts "PARSED YAML:"
puts ::Psych.safe_load(generated, permitted_classes: [MyTestClass], aliases: true)
puts "END"

Gives me the output:

GENERATED YAML:
---
object1: &1 !test/custom_yaml:my_test_object
  prop1: 13
  prop2: 1989
object2: *1
object3: *1
END
PARSED YAML:
{"object1" => #<MyTestClass:0x0000000120b4cfa0 @prop1=13, @prop2=1989>, "object2" => {"prop1" => 13, "prop2" => 1989}, "object3" => {"prop1" => 13, "prop2" => 1989}}
END

where the values of object2 and object3 in the resulting hash are actually hashes of the serialized properties, rather than an instance of MyTestClass

I believe the bug is that when objects are deserialized via domain types, the result isn't registered, such that subsequent alias references don't get the parsed version of the object. If I add in a register method inside of Psych::Visitors::ToRuby.accept, I get the same object for all 3 references in my example:

require "yaml"
require "json"

module Psych
  module Visitors
    class ToRuby
      def accept(target)
        result = super

        unless @domain_types.empty? || !target.tag
          key = target.tag.sub(/^[!\/]*/, '').sub(/(,\d+)\//, '\1:')
          key = "tag:#{key}" unless key.match?(/^(?:tag:|x-private)/)

          if @domain_types.key? key
            value, block = @domain_types[key]
            result = block.call value, result

            register(target, result)
          end
        end

        result = deduplicate(result).freeze if @freeze
        result
      end
    end
  end
end

::YAML.add_domain_type('test/custom_yaml', 'my_test_object') do |type, value|
  MyTestClass.new(prop1: value['prop1'], prop2: value['prop2'])
end

class MyTestClass
  attr_reader :prop1, :prop2

  def initialize(prop1:, prop2:)
    @prop1 = prop1
    @prop2 = prop2
  end

  def encode_with(coder)
    coder.tag = '!test/custom_yaml:my_test_object'

    coder.map = {
      'prop1' => @prop1,
      'prop2' => @prop2
    }
  end
end

test_obj = MyTestClass.new(prop1: 13, prop2: 1989)

generated = ::Psych.dump(
  {
    'object1' => test_obj,
    'object2' => test_obj,
    'object3' => test_obj
  }
)

puts "GENERATED YAML:"
puts generated
puts "END"

puts "PARSED YAML:"
puts ::Psych.safe_load(generated, permitted_classes: [MyTestClass], aliases: true)
puts "END"

Gives me the output:

GENERATED YAML:
---
object1: &1 !test/custom_yaml:my_test_object
  prop1: 13
  prop2: 1989
object2: *1
object3: *1
END
PARSED YAML:
{"object1" => #<MyTestClass:0x00000001015dc918 @prop1=13, @prop2=1989>, "object2" => #<MyTestClass:0x00000001015dc918 @prop1=13, @prop2=1989>, "object3" => #<MyTestClass:0x00000001015dc918 @prop1=13, @prop2=1989>}
END
Machine details

Apple M3 Macbook Air
Reproduced on: "ruby 3.4.9 (2026-03-11 revision 76cca827ab) +PRISM [arm64-darwin25]"

主要语言
Ruby
星标
597
派生
223
平均合并
11 小时 23 分钟
30 天内合并 PR
3

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ruby/psych 的其他 Issue

查看 ruby/psych 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。