[GR-18163] Introduce primitives to warn in methods that accept a block

PullRequest: truffleruby/3652

Author: andrykonchin

src/main/java/org/truffleruby/core/kernel/KernelNodes.java

@@ -37,6 +37,7 @@
 import org.truffleruby.builtins.NonStandard;
 import org.truffleruby.annotations.Primitive;
 import org.truffleruby.builtins.PrimitiveArrayArgumentsNode;
+import org.truffleruby.builtins.PrimitiveNode;
 import org.truffleruby.core.array.ArrayUtils;
 import org.truffleruby.core.array.RubyArray;
 import org.truffleruby.core.basicobject.BasicObjectNodes.ObjectIDNode;
@@ -2024,4 +2025,36 @@ protected boolean setCategory(RubySymbol category, boolean newValue) {
 
     }
 
+    @Primitive(name = "warn_given_block_not_used")
+    public abstract static class WarnGivenBlockNotUsedNode extends PrimitiveNode {
+        @Specialization
+        protected Object warn(
+                @Cached("new()") WarnNode warnNode) {
+            if (warnNode.shouldWarn()) {
+                warnNode.warningMessage(
+                        getContext().getCallStack().getTopMostUserSourceSection(),
+                        "given block not used");
+            }
+
+            return Nil.INSTANCE;
+        }
+
+    }
+
+    @Primitive(name = "warn_block_supersedes_default_value_argument")
+    public abstract static class WarnBlockSupersedesDefaultValueArgumentNode extends PrimitiveNode {
+        @Specialization
+        protected Object warn(
+                @Cached("new()") WarnNode warnNode) {
+            if (warnNode.shouldWarn()) {
+                warnNode.warningMessage(
+                        getContext().getCallStack().getTopMostUserSourceSection(),
+                        "block supersedes default value argument");
+            }
+
+            return Nil.INSTANCE;
+        }
+
+    }
+
 }

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

@@ -304,7 +304,7 @@ def combination(num)
   def count(item = undefined)
     seq = 0
     if !Primitive.undefined?(item)
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
       each { |o| seq += 1 if item == o }
     elsif block_given?
       each { |o| seq += 1 if yield(o) }
@@ -407,7 +407,7 @@ def fetch(idx, default=undefined)
 
     if idx < 0 or idx >= size
       if block_given?
-        warn 'block supersedes default value argument', uplevel: 1 unless Primitive.undefined?(default)
+        Primitive.warn_block_supersedes_default_value_argument unless Primitive.undefined?(default)
 
         return yield(orig)
       end
@@ -1012,7 +1012,7 @@ def rindex(obj=undefined)
         i -= 1
       end
     else
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
 
       i = size - 1
       while i >= 0

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

@@ -128,7 +128,7 @@ def compact
   def count(item = undefined)
     seq = 0
     if !Primitive.undefined?(item)
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
       each do
         o = Primitive.single_block_arg
         seq += 1 if item == o
@@ -522,7 +522,7 @@ def inject(initial=undefined, sym=undefined, &block)
 
     # inject(initial_operand, symbol) { ... }
     if block_given? && !Primitive.undefined?(sym)
-      warn 'given block not used', uplevel: 1
+      Primitive.warn_given_block_not_used
     end
 
     if Primitive.undefined?(sym) && block_given?
@@ -563,7 +563,7 @@ def inject(initial=undefined, sym=undefined, &block)
 
   def all?(pattern = undefined)
     if !Primitive.undefined?(pattern)
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
       each { return false unless pattern === Primitive.single_block_arg }
     elsif block_given?
       each { |*e| return false unless yield(*e) }
@@ -575,7 +575,7 @@ def all?(pattern = undefined)
 
   def any?(pattern = undefined)
     if !Primitive.undefined?(pattern)
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
       each { return true if pattern === Primitive.single_block_arg }
     elsif block_given?
       each { |*o| return true if yield(*o) }
@@ -735,7 +735,7 @@ def find_index(value=undefined)
         i += 1
       end
     else
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
 
       i = 0
       each do
@@ -926,7 +926,7 @@ def minmax_by(&block)
 
   def none?(pattern = undefined)
     if !Primitive.undefined?(pattern)
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
       each { return false if pattern === Primitive.single_block_arg }
     elsif block_given?
       each { |*o| return false if yield(*o) }
@@ -941,7 +941,7 @@ def one?(pattern = undefined)
     found_one = false
 
     if !Primitive.undefined?(pattern)
-      warn 'given block not used', uplevel: 1 if block_given?
+      Primitive.warn_given_block_not_used if block_given?
       each do
         if pattern === Primitive.single_block_arg
           return false if found_one

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

@@ -143,7 +143,7 @@ def include?(key)
 
   def fetch(key, absent=undefined)
     if block_given? and !Primitive.undefined?(absent)
-      warn 'block supersedes default value argument', uplevel: 1
+      Primitive.warn_block_supersedes_default_value_argument
     end
 
     if value = lookup(key)

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

@@ -231,7 +231,7 @@ def fetch(key, default=undefined)
     end
 
     if block_given?
-      warn 'block supersedes default value argument', uplevel: 1 unless Primitive.undefined?(default)
+      Primitive.warn_block_supersedes_default_value_argument unless Primitive.undefined?(default)
 
       return yield(key)
     end

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

@@ -223,7 +223,7 @@ def report_on_exception=(val)
   end
 
   def fetch(name, default = undefined)
-    warn 'block supersedes default value argument' if !Primitive.undefined?(default) && block_given?
+    Primitive.warn_block_supersedes_default_value_argument if !Primitive.undefined?(default) && block_given?
 
     key = convert_to_local_name(name)
     locals = Primitive.thread_get_fiber_locals self

src/main/ruby/truffleruby/core/truffle/polyglot.rb

@@ -156,7 +156,7 @@ def fetch(key, default = undefined)
       end
 
       if block_given?
-        warn 'block supersedes default value argument', uplevel: 1 unless Primitive.undefined?(default)
+        Primitive.warn_block_supersedes_default_value_argument unless Primitive.undefined?(default)
 
         return yield(key)
       end