[GR-18163] Improve {Method,UnboundMethod}#inspect

PullRequest: truffleruby/2046

Author: eregon

spec/ruby/core/method/shared/to_s.rb

@@ -4,7 +4,7 @@
 describe :method_to_s, shared: true do
   before :each do
     @m = MethodSpecs::MySub.new.method :bar
-    @string = @m.send(@method).sub(/0x\w+/, '0xXXXXXX')
+    @string = @m.send(@method)
   end
 
   it "returns a String" do
@@ -32,21 +32,29 @@
     @string.should =~ /MethodSpecs::MySub/
   end
 
+  it "returns a String including all details" do
+    @string.should.start_with? "#<Method: MethodSpecs::MySub(MethodSpecs::MyMod)#bar"
+  end
+
+  it "does not show the defining module if it is the same as the receiver class" do
+    MethodSpecs::A.new.method(:baz).send(@method).should.start_with? "#<Method: MethodSpecs::A#baz"
+  end
+
   ruby_version_is '3.0' do
     it "returns a String containing the Module containing the method if object has a singleton class but method is not defined in the singleton class" do
       obj = MethodSpecs::MySub.new
       obj.singleton_class
       @m = obj.method(:bar)
-      @string = @m.send(@method).sub(/0x\w+/, '0xXXXXXX')
-      @string.should =~ /\A#<Method: MethodSpecs::MySub\(MethodSpecs::MyMod\)#bar\(\) /
+      @string = @m.send(@method)
+      @string.should.start_with? "#<Method: MethodSpecs::MySub(MethodSpecs::MyMod)#bar"
     end
   end
 
   it "returns a String containing the singleton class if method is defined in the singleton class" do
     obj = MethodSpecs::MySub.new
     def obj.bar; end
     @m = obj.method(:bar)
-    @string = @m.send(@method).sub(/0x\w+/, '0xXXXXXX')
-    @string.should =~ /\A#<Method: #<MethodSpecs::MySub:0xXXXXXX>\.bar/
+    @string = @m.send(@method).sub(/0x\h+/, '0xXXXXXX')
+    @string.should.start_with? "#<Method: #<MethodSpecs::MySub:0xXXXXXX>.bar"
   end
 end

spec/ruby/core/unboundmethod/shared/to_s.rb

@@ -22,4 +22,13 @@
     @from_module.send(@method).should =~ /\bUnboundMethodSpecs::Mod\b/
     @from_method.send(@method).should =~ /\bUnboundMethodSpecs::Methods\b/
   end
+
+  it "returns a String including all details" do
+    @from_module.send(@method).should.start_with? "#<UnboundMethod: UnboundMethodSpecs::Methods(UnboundMethodSpecs::Mod)#from_mod"
+    @from_method.send(@method).should.start_with? "#<UnboundMethod: UnboundMethodSpecs::Methods(UnboundMethodSpecs::Mod)#from_mod"
+  end
+
+  it "does not show the defining module if it is the same as the origin" do
+    UnboundMethodSpecs::A.instance_method(:baz).send(@method).should.start_with? "#<UnboundMethod: UnboundMethodSpecs::A#baz"
+  end
 end

spec/tags/core/method/inspect_tags.txt

@@ -1131,6 +1131,7 @@ public boolean isTruffleBootMainMethod(SharedMethodInfo info) {
             "/core/class.rb",
             "/core/binding.rb",
             "/core/math.rb",
+            "/core/truffle/method_operations.rb",
             "/core/method.rb",
             "/core/unbound_method.rb",
             "/core/warning.rb",

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

@@ -323,22 +323,33 @@ protected int getCacheLimit() {
     public abstract static class MethodUnimplementNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization
-        protected Object methodUnimplement(RubyMethod rubyMethod) {
-            final InternalMethod method = rubyMethod.method;
-            method.getDeclaringModule().fields.addMethod(
-                    getContext(),
-                    this,
-                    method.unimplemented());
+        protected Object bound(RubyMethod rubyMethod) {
+            unimplement(rubyMethod.method);
+            return nil;
+        }
+
+        @Specialization
+        protected Object unbound(RubyUnboundMethod rubyMethod) {
+            unimplement(rubyMethod.method);
             return nil;
         }
 
+        @TruffleBoundary
+        private void unimplement(InternalMethod method) {
+            method.getDeclaringModule().fields.addMethod(getContext(), this, method.unimplemented());
+        }
     }
 
     @Primitive(name = "method_unimplemented?")
-    public abstract static class MethodUnimplementedQueryNode extends PrimitiveArrayArgumentsNode {
+    public abstract static class MethodIsUnimplementedNode extends PrimitiveArrayArgumentsNode {
+
+        @Specialization
+        protected boolean bound(RubyMethod rubyMethod) {
+            return rubyMethod.method.isUnimplemented();
+        }
 
         @Specialization
-        protected boolean isMethodUnimplemented(RubyMethod rubyMethod) {
+        protected boolean unbound(RubyUnboundMethod rubyMethod) {
             return rubyMethod.method.isUnimplemented();
         }
 

src/main/java/org/truffleruby/core/method/MethodNodes.java

@@ -9,22 +9,10 @@
 # GNU Lesser General Public License version 2.1.
 
 class Method
-
   def inspect
-    extra = ''
-
-    if Primitive.method_unimplemented? self
-      extra = ' (not-implemented)'
-    else
-      file, line = source_location
-
-      if file && line
-        extra = " #{file}:#{line}"
-      end
-    end
-
-    "#<#{self.class}: #{receiver.class}(#{owner})##{name}#{extra}>"
+    Truffle::MethodOperations.inspect_method(self, receiver.class, owner, receiver)
   end
+  alias_method :to_s, :inspect
 
   def curry(curried_arity = nil)
     self.to_proc.curry(curried_arity)
@@ -37,7 +25,4 @@ def >>(other)
   def <<(other)
     self.to_proc << other
   end
-
-  alias_method :to_s, :inspect
-
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 2.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+module Truffle
+  module MethodOperations
+    def self.inspect_method(meth, origin, owner, receiver = undefined)
+      extra = ''
+      if Primitive.method_unimplemented? meth
+        extra = ' (not-implemented)'
+      else
+        file, line = meth.source_location
+        if file && line
+          extra = " #{file}:#{line}"
+        end
+      end
+
+      if !Primitive.undefined?(receiver) && owner.singleton_class?
+        "#<#{meth.class}: #{receiver.inspect}.#{meth.name}#{extra}>"
+      else
+        origin_owner = origin == owner ? origin : "#{origin}(#{owner})"
+        "#<#{meth.class}: #{origin_owner}##{meth.name}#{extra}>"
+      end
+    end
+  end
+end

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

@@ -9,11 +9,9 @@
 # GNU Lesser General Public License version 2.1.
 
 class UnboundMethod
-
   def inspect
-    "#<#{self.class}: #{origin}(#{owner})##{name}>"
+    Truffle::MethodOperations.inspect_method(self, origin, owner)
   end
-
   alias_method :to_s, :inspect
 
   def bind_call(recv, *args, &block)