[GR-17457] Remove Warning.warn override in MSpec and --warnings option

PullRequest: truffleruby/3674

Author: eregon

CHANGELOG.md

@@ -116,6 +116,7 @@ Bug fixes:
 * Fix `Kernel#sleep` and `Mutex#sleep` for durations smaller than 1 millisecond (#2716, @eregon).
 * Fix `IO#{wait,wait_readable,wait_writable}` with a timeout > INT_MAX seconds (@eregon).
 * Use the compatible encoding for `String#{sub,gsub,index,rindex}` (#2749, @eregon).
+* Fix `Warning#warn` called with category specified is no longer throwing exception (#20446, @horakivo).
 
 Compatibility:
 

spec/mspec/lib/mspec/commands/mspec.rb

@@ -38,11 +38,6 @@ def options(argv = ARGV)
 
     options.targets
 
-    options.on("--warnings", "Don't suppress warnings") do
-      config[:flags] << '-w'
-      ENV['OUTPUT_WARNINGS'] = '1'
-    end
-
     options.on("-j", "--multi", "Run multiple (possibly parallel) subprocesses") do
       config[:multi] = true
     end

spec/mspec/lib/mspec/helpers/io.rb

@@ -7,7 +7,7 @@ def initialize
   end
 
   def write(*str)
-    self << str.join
+    self << str.join('')
   end
 
   def << str
@@ -16,7 +16,7 @@ def << str
   end
 
   def print(*str)
-    write(str.join + $\.to_s)
+    write(str.join('') + $\.to_s)
   end
 
   def method_missing(name, *args, &block)

spec/mspec/lib/mspec/matchers/complain.rb

@@ -19,15 +19,13 @@ def matches?(proc)
     @verbose = $VERBOSE
     err = IOStub.new
 
-    Thread.current[:in_mspec_complain_matcher] = true
     $stderr = err
     $VERBOSE = @options.key?(:verbose) ? @options[:verbose] : false
     begin
       proc.call
     ensure
       $VERBOSE = @verbose
       $stderr = @saved_err
-      Thread.current[:in_mspec_complain_matcher] = false
     end
 
     @warning = err.to_s

spec/mspec/lib/mspec/utils/warnings.rb

@@ -8,46 +8,3 @@
   Warning[:deprecated] = true
   Warning[:experimental] = false
 end
-
-if Object.const_defined?(:Warning) and Warning.respond_to?(:warn)
-  def Warning.warn(message, category: nil)
-    # Suppress any warning inside the method to prevent recursion
-    verbose = $VERBOSE
-    $VERBOSE = nil
-
-    if Thread.current[:in_mspec_complain_matcher]
-      return $stderr.write(message)
-    end
-
-    case message
-    # $VERBOSE = true warnings
-    when /(.+\.rb):(\d+):.+possibly useless use of (<|<=|==|>=|>) in void context/
-      # Make sure there is a .should otherwise it is missing
-      line_nb = Integer($2)
-      unless File.exist?($1) and /\.should(_not)? (<|<=|==|>=|>)/ === File.readlines($1)[line_nb-1]
-        $stderr.write message
-      end
-    when /possibly useless use of (\+|-) in void context/
-    when /assigned but unused variable/
-    when /method redefined/
-    when /previous definition of/
-    when /instance variable @.+ not initialized/
-    when /statement not reached/
-    when /shadowing outer local variable/
-    when /setting Encoding.default_(in|ex)ternal/
-    when /unknown (un)?pack directive/
-    when /(un)?trust(ed\?)? is deprecated/
-    when /\.exists\? is a deprecated name/
-    when /Float .+ out of range/
-    when /passing a block to String#(bytes|chars|codepoints|lines) is deprecated/
-    when /core\/string\/modulo_spec\.rb:\d+: warning: too many arguments for format string/
-    when /regexp\/shared\/new_ascii(_8bit)?\.rb:\d+: warning: Unknown escape .+ is ignored/
-    else
-      $stderr.write message
-    end
-  ensure
-    $VERBOSE = verbose
-  end
-else
-  $VERBOSE = nil unless ENV['OUTPUT_WARNINGS']
-end

spec/mspec/spec/commands/mspec_spec.rb

@@ -92,33 +92,6 @@
   end
 end
 
-RSpec.describe "The --warnings option" do
-  before :each do
-    @options, @config = new_option
-    allow(MSpecOptions).to receive(:new).and_return(@options)
-    @script = MSpecMain.new
-    allow(@script).to receive(:config).and_return(@config)
-  end
-
-  it "is enabled by #options" do
-    allow(@options).to receive(:on)
-    expect(@options).to receive(:on).with("--warnings", an_instance_of(String))
-    @script.options
-  end
-
-  it "sets flags to -w" do
-    @config[:flags] = []
-    @script.options ["--warnings"]
-    expect(@config[:flags]).to include("-w")
-  end
-
-  it "set OUTPUT_WARNINGS = '1' in the environment" do
-    ENV['OUTPUT_WARNINGS'] = '0'
-    @script.options ["--warnings"]
-    expect(ENV['OUTPUT_WARNINGS']).to eq('1')
-  end
-end
-
 RSpec.describe "The -j, --multi option" do
   before :each do
     @options, @config = new_option

spec/ruby/core/warning/warn_spec.rb

@@ -73,6 +73,54 @@ def Warning.warn(msg)
         $VERBOSE = verbose
       end
     end
+
+    it "should print message when category is :deprecated and Warning[:deprecated] is true" do
+      warn_deprecated = Warning[:deprecated]
+      Warning[:deprecated] = true
+      begin
+        -> {
+          warn("foo", category: :deprecated)
+        }.should complain("foo\n")
+      ensure
+        Warning[:deprecated] = warn_deprecated
+      end
+    end
+
+    it "should print message when category is :experimental and Warning[:experimental] is true" do
+      warn_experimental = Warning[:experimental]
+      Warning[:experimental] = true
+      begin
+        -> {
+          warn("foo", category: :experimental)
+        }.should complain("foo\n")
+      ensure
+        Warning[:experimental] = warn_experimental
+      end
+    end
+
+    it "should not print message when category is :deprecated but Warning[:deprecated] is false" do
+      warn_deprecated = Warning[:deprecated]
+      Warning[:deprecated] = false
+      begin
+        -> {
+          warn("foo", category: :deprecated)
+        }.should_not complain
+      ensure
+        Warning[:deprecated] = warn_deprecated
+      end
+    end
+
+    it "should not print message when category is :experimental but Warning[:experimental] is false" do
+      warn_experimental = Warning[:experimental]
+      Warning[:experimental] = false
+      begin
+        -> {
+          warn("foo", category: :experimental)
+        }.should_not complain
+      ensure
+        Warning[:experimental] = warn_experimental
+      end
+    end
   end
 
   ruby_version_is ''...'3.0' do

spec/ruby/language/predefined_spec.rb

@@ -979,6 +979,10 @@ def obj.foo2; yield; end
     $VERBOSE = @verbose
   end
 
+  it "is false by default" do
+    $VERBOSE.should be_false
+  end
+
   it "converts truthy values to true" do
     [true, 1, 0, [], ""].each do |true_value|
       $VERBOSE = true_value

src/main/java/org/truffleruby/core/CoreLibrary.java

@@ -1048,6 +1048,7 @@ public boolean isTruffleBootMainMethod(SharedMethodInfo info) {
             "/core/truffle/method_operations.rb",
             "/core/method.rb",
             "/core/unbound_method.rb",
+            "/core/truffle/warning_operations.rb",
             "/core/warning.rb",
             "/core/weakmap.rb",
             "/core/tracepoint.rb",

src/main/ruby/truffleruby/core/warning.rb

@@ -16,9 +16,18 @@ def warn(message, category: nil)
     unless message.encoding.ascii_compatible?
       raise Encoding::CompatibilityError, "ASCII incompatible encoding: #{message.encoding}"
     end
+
     unless Primitive.nil?(category)
       Truffle::Type.rb_check_type(category, Symbol)
       Truffle::WarningOperations.check_category(category)
+
+      if category == :deprecated && !Warning[:deprecated]
+        return nil
+      end
+
+      if category == :experimental && !Warning[:experimental]
+        return nil
+      end
     end
 
     $stderr.write message