ruby-changes:66224
From: Aaron <ko1@a...>
Date: Mon, 17 May 2021 11:21:09 +0900 (JST)
Subject: [ruby-changes:66224] 42b20bdbfe (master): [ruby/psych] remove deprecated interface
https://git.ruby-lang.org/ruby.git/commit/?id=42b20bdbfe From 42b20bdbfe770053e02948e9577bdd412a8c98cf Mon Sep 17 00:00:00 2001 From: Aaron Patterson <tenderlove@r...> Date: Tue, 11 May 2021 13:49:20 -0700 Subject: [ruby/psych] remove deprecated interface https://github.com/ruby/psych/commit/0767227051 --- ext/psych/lib/psych.rb | 60 +++++--------------------------------------- test/psych/test_exception.rb | 18 ------------- test/psych/test_psych.rb | 8 ++---- test/psych/test_safe_load.rb | 44 -------------------------------- 4 files changed, 8 insertions(+), 122 deletions(-) diff --git a/ext/psych/lib/psych.rb b/ext/psych/lib/psych.rb index c68952e..7c6b8d0 100644 --- a/ext/psych/lib/psych.rb +++ b/ext/psych/lib/psych.rb @@ -234,9 +234,6 @@ require 'psych/class_loader' https://github.com/ruby/ruby/blob/trunk/ext/psych/lib/psych.rb#L234 module Psych # The version of libyaml Psych is using LIBYAML_VERSION = Psych.libyaml_version.join('.').freeze - # Deprecation guard - NOT_GIVEN = Object.new.freeze - private_constant :NOT_GIVEN ### # Load +yaml+ in to a Ruby data structure. If multiple documents are @@ -271,12 +268,7 @@ module Psych https://github.com/ruby/ruby/blob/trunk/ext/psych/lib/psych.rb#L268 # YAML documents that are supplied via user input. Instead, please use the # load method or the safe_load method. # - def self.unsafe_load yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: false, symbolize_names: false, freeze: false - if legacy_filename != NOT_GIVEN - warn_with_uplevel 'Passing filename with the 2nd argument of Psych.load is deprecated. Use keyword argument like Psych.load(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE - filename = legacy_filename - end - + def self.unsafe_load yaml, filename: nil, fallback: false, symbolize_names: false, freeze: false result = parse(yaml, filename: filename) return fallback unless result result.to_ruby(symbolize_names: symbolize_names, freeze: freeze) @@ -327,27 +319,7 @@ module Psych https://github.com/ruby/ruby/blob/trunk/ext/psych/lib/psych.rb#L319 # Psych.safe_load("---\n foo: bar") # => {"foo"=>"bar"} # Psych.safe_load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"} # - def self.safe_load yaml, legacy_permitted_classes = NOT_GIVEN, legacy_permitted_symbols = NOT_GIVEN, legacy_aliases = NOT_GIVEN, legacy_filename = NOT_GIVEN, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false - if legacy_permitted_classes != NOT_GIVEN - warn_with_uplevel 'Passing permitted_classes with the 2nd argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, permitted_classes: ...) instead.', uplevel: 1 if $VERBOSE - permitted_classes = legacy_permitted_classes - end - - if legacy_permitted_symbols != NOT_GIVEN - warn_with_uplevel 'Passing permitted_symbols with the 3rd argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, permitted_symbols: ...) instead.', uplevel: 1 if $VERBOSE - permitted_symbols = legacy_permitted_symbols - end - - if legacy_aliases != NOT_GIVEN - warn_with_uplevel 'Passing aliases with the 4th argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, aliases: ...) instead.', uplevel: 1 if $VERBOSE - aliases = legacy_aliases - end - - if legacy_filename != NOT_GIVEN - warn_with_uplevel 'Passing filename with the 5th argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE - filename = legacy_filename - end - + def self.safe_load yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false result = parse(yaml, filename: filename) return fallback unless result @@ -422,22 +394,12 @@ module Psych https://github.com/ruby/ruby/blob/trunk/ext/psych/lib/psych.rb#L394 # end # # See Psych::Nodes for more information about YAML AST. - def self.parse yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: NOT_GIVEN - if legacy_filename != NOT_GIVEN - warn_with_uplevel 'Passing filename with the 2nd argument of Psych.parse is deprecated. Use keyword argument like Psych.parse(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE - filename = legacy_filename - end - + def self.parse yaml, filename: nil parse_stream(yaml, filename: filename) do |node| return node end - if fallback != NOT_GIVEN - warn_with_uplevel 'Passing the `fallback` keyword argument of Psych.parse is deprecated.', uplevel: 1 if $VERBOSE - fallback - else - false - end + false end ### @@ -486,12 +448,7 @@ module Psych https://github.com/ruby/ruby/blob/trunk/ext/psych/lib/psych.rb#L448 # Raises a TypeError when NilClass is passed. # # See Psych::Nodes for more information about YAML AST. - def self.parse_stream yaml, legacy_filename = NOT_GIVEN, filename: nil, &block - if legacy_filename != NOT_GIVEN - warn_with_uplevel 'Passing filename with the 2nd argument of Psych.parse_stream is deprecated. Use keyword argument like Psych.parse_stream(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE - filename = legacy_filename - end - + def self.parse_stream yaml, filename: nil, &block if block_given? parser = Psych::Parser.new(Handlers::DocumentStream.new(&block)) parser.parse yaml, filename @@ -592,12 +549,7 @@ module Psych https://github.com/ruby/ruby/blob/trunk/ext/psych/lib/psych.rb#L549 # end # list # => ['foo', 'bar'] # - def self.load_stream yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: [], **kwargs - if legacy_filename != NOT_GIVEN - warn_with_uplevel 'Passing filename with the 2nd argument of Psych.load_stream is deprecated. Use keyword argument like Psych.load_stream(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE - filename = legacy_filename - end - + def self.load_stream yaml, filename: nil, fallback: [], **kwargs result = if block_given? parse_stream(yaml, filename: filename) do |node| yield node.to_ruby(**kwargs) diff --git a/test/psych/test_exception.rb b/test/psych/test_exception.rb index d2ae76a..c1e69ab 100644 --- a/test/psych/test_exception.rb +++ b/test/psych/test_exception.rb @@ -53,12 +53,6 @@ module Psych https://github.com/ruby/ruby/blob/trunk/test/psych/test_exception.rb#L53 Psych.load '--- `', filename: 'meow' end assert_equal 'meow', ex.file - - # deprecated interface - ex = assert_raise(Psych::SyntaxError) do - Psych.unsafe_load '--- `', 'deprecated' - end - assert_equal 'deprecated', ex.file end def test_psych_parse_stream_takes_file @@ -86,12 +80,6 @@ module Psych https://github.com/ruby/ruby/blob/trunk/test/psych/test_exception.rb#L80 Psych.load_stream '--- `', filename: 'omg!' end assert_equal 'omg!', ex.file - - # deprecated interface - ex = assert_raise(Psych::SyntaxError) do - Psych.load_stream '--- `', 'deprecated' - end - assert_equal 'deprecated', ex.file end def test_parse_file_exception @@ -141,12 +129,6 @@ module Psych https://github.com/ruby/ruby/blob/trunk/test/psych/test_exception.rb#L129 Psych.parse '--- `', filename: 'omg!' end assert_match 'omg!', ex.message - - # deprecated interface - ex = assert_raise(Psych::SyntaxError) do - Psych.parse '--- `', 'deprecated' - end - assert_match 'deprecated', ex.message end def test_attributes diff --git a/test/psych/test_psych.rb b/test/psych/test_psych.rb index 912bcb9..256ed91 100644 --- a/test/psych/test_psych.rb +++ b/test/psych/test_psych.rb @@ -78,10 +78,6 @@ class TestPsych < Psych::TestCase https://github.com/ruby/ruby/blob/trunk/test/psych/test_psych.rb#L78 assert_raise(Psych::SyntaxError) { Psych.parse("--- `") } end - def test_parse_with_fallback - assert_equal 42, Psych.parse("", fallback: 42) - end - def test_non_existing_class_on_deserialize e = assert_raise(ArgumentError) do Psych.unsafe_load("--- !ruby/object:NonExistent\nfoo: 1") @@ -239,11 +235,11 @@ class TestPsych < Psych::TestCase https://github.com/ruby/ruby/blob/trunk/test/psych/test_psych.rb#L235 end def test_load_with_fallback_for_nil - assert_nil Psych.unsafe_load("--- null", "file", fallback: 42) + assert_nil Psych.unsafe_load("--- null", filename: "file", fallback: 42) end def test_load_with_fallback_for_false - assert_equal false, Psych.unsafe_load("--- false", "file", fallback: 42) + assert_equal false, Psych.unsafe_load("--- false", filename: "file", fallback: 42) end def test_load_file diff --git a/test/psych/test_safe_load.rb b/test/psych/test_safe_load.rb index d13ce7c..b52d604 100644 --- a/test/psych/test_safe_load.rb +++ b/test/psych/test_safe_load.rb @@ -31,8 +31,6 @@ module Psych https://github.com/ruby/ruby/blob/trunk/test/psych/test_safe_load.rb#L31 x = [] x << x assert_equal(x, Psych.safe_load(Psych.dump(x), permitted_classes: [], permitted_symbols: [], aliases: true)) - # deprecated interface - assert_equal(x, Psych.safe_load(Psych.dump(x), [], [], true)) end def test_permitted_symbol @@ -48,9 +46,6 @@ module Psych https://github.com/ruby/ruby/blob/trunk/test/psych/test_safe_load.rb#L46 permitted_symbols: [:foo] ) ) - - # deprecated interface - assert_equal(:foo, Psych.safe_load(yml, [Symbol], [:foo])) end def test_symbol @@ -61,17 +56,9 @@ module Psych https://github.com/ruby/ruby/blob/trunk/test/psych/test_safe_load.rb#L56 Psych.safe_load '--- !ruby/symbol foo', (... truncated) -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/