[GR-40333] adding import_methods support to refinement

PullRequest: truffleruby/3677

Author: horakivo

CHANGELOG.md

@@ -96,6 +96,7 @@ Compatibility:
 * Support optional `level` argument for `File.dirname` method (#2733, @moste00).
 * Add `Thread::Backtrace.limit` method (#2733, @andrykonchin).
 * Deprecate `rb_gc_force_recycle` and make it a no-op function (#2733, @moste00).
+* Add `Refinement#import_methods` method and add deprecation warning for `Refinement#include` and `Refinement#prepend` (#2733, @horakivo).
 
 Performance:
 

spec/ruby/core/module/refine_spec.rb

@@ -71,7 +71,7 @@ def blah
       Module.new do
         refine("foo") {}
       end
-    end.should raise_error(TypeError)
+    end.should raise_error(TypeError, "wrong argument type String (expected Class or Module)")
   end
 
   it "accepts a module as argument" do

spec/ruby/core/refinement/fixtures/classes.rb

@@ -0,0 +1,12 @@
+module RefinementSpec
+
+  module ModuleWithAncestors
+    include Module.new do
+      def indent(level)
+        " " * level + self
+      end
+    end
+  end
+end
+
+

spec/ruby/core/refinement/import_methods_spec.rb

@@ -1,4 +1,5 @@
 require_relative '../../spec_helper'
+require_relative 'fixtures/classes'
 
 describe "Refinement#import_methods" do
   ruby_version_is "3.1" do
@@ -17,6 +18,205 @@ def indent(level)
           end
         end
       end
+
+      it "throws an exception when argument is not a module" do
+        Module.new do
+          refine String do
+            -> {
+              import_methods Integer
+            }.should raise_error(TypeError, "wrong argument type Class (expected Module)")
+          end
+        end
+      end
+
+      it "imports methods from multiple modules" do
+        str_utils = Module.new do
+          def indent(level)
+            " " * level + self
+          end
+        end
+
+        str_utils_fancy = Module.new do
+          def indent_star(level)
+            "*" * level + self
+          end
+        end
+
+        Module.new do
+          refine String do
+            import_methods str_utils, str_utils_fancy
+            "foo".indent(3).should == "   foo"
+            "foo".indent_star(3).should == "***foo"
+          end
+        end
+      end
+
+      it "imports a method defined in the last module if method with same name is defined in multiple modules" do
+        str_utils = Module.new do
+          def indent(level)
+            " " * level + self
+          end
+        end
+
+        str_utils_fancy = Module.new do
+          def indent(level)
+            "*" * level + self
+          end
+        end
+
+        Module.new do
+          refine String do
+            import_methods str_utils, str_utils_fancy
+            "foo".indent(3).should == "***foo"
+          end
+        end
+      end
+
+      it "still imports methods of modules listed before a module that contains method not defined in Ruby" do
+        str_utils = Module.new do
+          def indent(level)
+            " " * level + self
+          end
+        end
+
+        string_refined = Module.new do
+          refine String do
+            -> {
+              import_methods str_utils, Kernel
+            }.should raise_error(ArgumentError)
+          end
+        end
+
+        Module.new do
+          using string_refined
+          "foo".indent(3).should == "   foo"
+        end
+      end
+    end
+
+    it "warns if a module includes/prepends some other module" do
+      module1 = Module.new do
+      end
+
+      module2 = Module.new do
+        include module1
+      end
+
+      Module.new do
+        refine String do
+          -> {
+            import_methods module2
+          }.should complain(/warning: #<Module:\w*> has ancestors, but Refinement#import_methods doesn't import their methods/)
+        end
+      end
+
+      Module.new do
+        refine String do
+          -> {
+            import_methods RefinementSpec::ModuleWithAncestors
+          }.should complain(/warning: RefinementSpec::ModuleWithAncestors has ancestors, but Refinement#import_methods doesn't import their methods/)
+        end
+      end
+    end
+
+    it "doesn't import methods from included/prepended modules" do
+      Module.new do
+        refine String do
+          suppress_warning { import_methods RefinementSpec::ModuleWithAncestors }
+        end
+
+
+        using self
+        -> {
+          "foo".indent(3)
+        }.should raise_error(NoMethodError, /undefined method `indent' for "foo":String/)
+      end
+    end
+
+    it "doesn't import any methods if one of the arguments is not a module" do
+        str_utils = Module.new do
+          def indent(level)
+            " " * level + self
+          end
+        end
+
+        string_refined = Module.new do
+          refine String do
+            -> {
+              import_methods str_utils, Integer
+            }.should raise_error(TypeError)
+          end
+        end
+
+        Module.new do
+          using string_refined
+          -> {
+            "foo".indent(3)
+          }.should raise_error(NoMethodError)
+        end
+    end
+
+    it "imports methods from multiple modules so that methods see other's module's methods" do
+      str_utils = Module.new do
+        def indent(level)
+          " " * level + self
+        end
+      end
+
+      str_utils_normal = Module.new do
+        def indent_normal(level)
+          self.indent(level)
+        end
+      end
+
+      Module.new do
+        refine String do
+          import_methods str_utils, str_utils_normal
+        end
+
+        using self
+        "foo".indent_normal(3).should == "   foo"
+      end
+    end
+
+    it "imports methods from module so that methods can see each other" do
+      str_utils = Module.new do
+        def indent(level)
+          " " * level + self
+        end
+
+        def indent_with_dot(level)
+          self.indent(level) + "."
+        end
+      end
+
+      Module.new do
+        refine String do
+          import_methods str_utils
+        end
+
+        using self
+        "foo".indent_with_dot(3).should == "   foo."
+      end
+    end
+
+    it "doesn't import module's class methods" do
+      str_utils = Module.new do
+        def self.indent(level)
+          " " * level + self
+        end
+      end
+
+      Module.new do
+        refine String do
+          import_methods str_utils
+        end
+
+        using self
+        -> {
+          String.indent(3)
+        }.should raise_error(NoMethodError, /undefined method `indent' for String:Class/)
+      end
     end
 
     context "when methods are not defined in Ruby code" do
@@ -29,6 +229,17 @@ def indent(level)
           end
         end
       end
+
+      it "raises ArgumentError when importing methods from C extension" do
+        require 'zlib'
+        Module.new do
+          refine String do
+            -> {
+              import_methods Zlib
+            }.should raise_error(ArgumentError, /Can't import method which is not defined with Ruby code: Zlib#*/)
+          end
+        end
+      end
     end
   end
 end

spec/ruby/core/warning/warn_spec.rb

@@ -74,7 +74,7 @@ def Warning.warn(msg)
       end
     end
 
-    it "should print message when category is :deprecated and Warning[:deprecated] is true" do
+    it "warns when category is :deprecated and Warning[:deprecated] is true" do
       warn_deprecated = Warning[:deprecated]
       Warning[:deprecated] = true
       begin
@@ -86,7 +86,7 @@ def Warning.warn(msg)
       end
     end
 
-    it "should print message when category is :experimental and Warning[:experimental] is true" do
+    it "warns when category is :experimental and Warning[:experimental] is true" do
       warn_experimental = Warning[:experimental]
       Warning[:experimental] = true
       begin
@@ -98,7 +98,7 @@ def Warning.warn(msg)
       end
     end
 
-    it "should not print message when category is :deprecated but Warning[:deprecated] is false" do
+    it "doesn't print message when category is :deprecated but Warning[:deprecated] is false" do
       warn_deprecated = Warning[:deprecated]
       Warning[:deprecated] = false
       begin
@@ -110,7 +110,7 @@ def Warning.warn(msg)
       end
     end
 
-    it "should not print message when category is :experimental but Warning[:experimental] is false" do
+    it "doesn't print message when category is :experimental but Warning[:experimental] is false" do
       warn_experimental = Warning[:experimental]
       Warning[:experimental] = false
       begin
@@ -121,6 +121,18 @@ def Warning.warn(msg)
         Warning[:experimental] = warn_experimental
       end
     end
+
+    it "prints the message when VERBOSE is false" do
+      -> { Warning.warn("foo") }.should complain("foo")
+    end
+
+    it "prints the message when VERBOSE is nil" do
+      -> { Warning.warn("foo") }.should complain("foo", verbose: nil)
+    end
+
+    it "prints the message when VERBOSE is true" do
+      -> { Warning.warn("foo") }.should complain("foo", verbose: true)
+    end
   end
 
   ruby_version_is ''...'3.0' do

spec/tags/core/refinement/import_methods_tags.txt

@@ -1,2 +0,0 @@
-fails:Refinement#import_methods when methods are defined in Ruby code imports methods
-fails:Refinement#import_methods when methods are not defined in Ruby code raises ArgumentError

spec/tags/core/refinement/include_tags.txt

@@ -2,5 +2,3 @@ slow:Warning.warn has Warning as the method owner
 slow:Warning.warn can be overridden
 slow:Warning.warn does not add a newline
 slow:Warning.warn returns nil
-fails:Warning.warn is called by Kernel.warn with nil category keyword
-fails:Warning.warn is called by Kernel.warn with given category keyword converted to a symbol

spec/tags/core/refinement/prepend_tags.txt

@@ -256,6 +256,8 @@ private RubyThread getOrCreateForeignThread(RubyContext context, Thread thread)
 
     @CompilationFinal public LanguageOptions options;
     @CompilationFinal private String rubyHome;
+    @CompilationFinal public String cextPath;
+
     private TruffleFile rubyHomeTruffleFile;
 
     @CompilationFinal private AllocationReporter allocationReporter;
@@ -708,6 +710,7 @@ private void setRubyHome(Env env, String home) {
         assert Thread.holdsLock(this);
         rubyHome = home;
         setRubyHomeTruffleFile(env, home);
+        cextPath = home == null ? null : home + "/lib/truffle/truffle/cext_ruby.rb";
     }
 
     private void setRubyHomeTruffleFile(Env env, String home) {