Supported category option in Warning#warn

This commit is contained in:
Nobuyoshi Nakada 2020-12-08 19:33:43 +09:00
parent d5ffa4e9a4
commit 2749123e21
No known key found for this signature in database
GPG Key ID: 7CD2805BFA3770C6
2 changed files with 51 additions and 3 deletions

11
error.c
View File

@ -238,7 +238,7 @@ rb_warning_s_aset(VALUE mod, VALUE category, VALUE flag)
* *
* Writes warning message +msg+ to $stderr. This method is called by * Writes warning message +msg+ to $stderr. This method is called by
* Ruby for all emitted warnings. A +category+ may be included with * Ruby for all emitted warnings. A +category+ may be included with
* the warning, but is ignored by default. * the warning.
* *
* See the documentation of the Warning module for how to customize this. * See the documentation of the Warning module for how to customize this.
*/ */
@ -248,13 +248,17 @@ rb_warning_s_warn(int argc, VALUE *argv, VALUE mod)
{ {
VALUE str; VALUE str;
VALUE opt; VALUE opt;
VALUE category; VALUE category = Qnil;
rb_scan_args(argc, argv, "1:", &str, &opt); rb_scan_args(argc, argv, "1:", &str, &opt);
if (!NIL_P(opt)) rb_get_kwargs(opt, &id_category, 0, 1, &category); if (!NIL_P(opt)) rb_get_kwargs(opt, &id_category, 0, 1, &category);
Check_Type(str, T_STRING); Check_Type(str, T_STRING);
rb_must_asciicompat(str); rb_must_asciicompat(str);
if (!NIL_P(category)) {
rb_warning_category_t cat = rb_warning_category_from_name(category);
if (!rb_warning_category_enabled_p(cat)) return Qnil;
}
rb_write_error_str(str); rb_write_error_str(str);
return Qnil; return Qnil;
} }
@ -301,7 +305,8 @@ rb_warning_warn(VALUE mod, VALUE str)
static int static int
rb_warning_warn_arity(void) { rb_warning_warn_arity(void)
{
return rb_method_entry_arity(rb_method_entry(rb_singleton_class(rb_mWarning), id_warn)); return rb_method_entry_arity(rb_method_entry(rb_singleton_class(rb_mWarning), id_warn));
} }

View File

@ -918,6 +918,7 @@ $stderr = $stdout; raise "\x82\xa0"') do |outs, errs, status|
def capture_warning_warn(category: false) def capture_warning_warn(category: false)
verbose = $VERBOSE verbose = $VERBOSE
deprecated = Warning[:deprecated] deprecated = Warning[:deprecated]
experimental = Warning[:experimental]
warning = [] warning = []
::Warning.class_eval do ::Warning.class_eval do
@ -937,12 +938,14 @@ $stderr = $stdout; raise "\x82\xa0"') do |outs, errs, status|
$VERBOSE = true $VERBOSE = true
Warning[:deprecated] = true Warning[:deprecated] = true
Warning[:experimental] = true
yield yield
return warning return warning
ensure ensure
$VERBOSE = verbose $VERBOSE = verbose
Warning[:deprecated] = deprecated Warning[:deprecated] = deprecated
Warning[:experimental] = experimental
::Warning.class_eval do ::Warning.class_eval do
remove_method :warn remove_method :warn
@ -1057,6 +1060,46 @@ $stderr = $stdout; raise "\x82\xa0"') do |outs, errs, status|
assert_include([true, false], Warning[:experimental]) assert_include([true, false], Warning[:experimental])
end end
def test_warning_category_deprecated
warning = EnvUtil.verbose_warning do
deprecated = Warning[:deprecated]
Warning[:deprecated] = true
Warning.warn "deprecated feature", category: :deprecated
ensure
Warning[:deprecated] = deprecated
end
assert_equal "deprecated feature", warning
warning = EnvUtil.verbose_warning do
deprecated = Warning[:deprecated]
Warning[:deprecated] = false
Warning.warn "deprecated feature", category: :deprecated
ensure
Warning[:deprecated] = deprecated
end
assert_empty warning
end
def test_warning_category_experimental
warning = EnvUtil.verbose_warning do
experimental = Warning[:experimental]
Warning[:experimental] = true
Warning.warn "experimental feature", category: :experimental
ensure
Warning[:experimental] = experimental
end
assert_equal "experimental feature", warning
warning = EnvUtil.verbose_warning do
experimental = Warning[:experimental]
Warning[:experimental] = false
Warning.warn "experimental feature", category: :experimental
ensure
Warning[:experimental] = experimental
end
assert_empty warning
end
def test_undefined_backtrace def test_undefined_backtrace
assert_separately([], "#{<<-"begin;"}\n#{<<-"end;"}") assert_separately([], "#{<<-"begin;"}\n#{<<-"end;"}")
begin; begin;