[GR-18163] Expose all InteropLibrary messages as Truffle::Interop methods consistently (#2139)

PullRequest: truffleruby/2135

Author: bjfish

CHANGELOG.md

@@ -17,6 +17,7 @@ Performance:
 
 Changes:
 
+* All `InteropLibrary` messages are now exposed consistently as methods on `Truffle::Interop` (#2139). Some methods were renamed to match the scheme described in the documentation.
 
 # 20.3.0
 

spec/tags/truffle/interop/invoke_tags.txt

@@ -9,15 +9,13 @@
 require_relative '../../ruby/spec_helper'
 require_relative 'fixtures/classes'
 
-describe "Truffle::Interop.new" do
-
+describe "Truffle::Interop.instantiate" do
   it "creates new instances of objects" do
-    obj = Truffle::Interop.new(TruffleInteropSpecs::NewTestClass, 14, 2)
+    obj = Truffle::Interop.instantiate(TruffleInteropSpecs::NewTestClass, 14, 2)
     obj.should be_an_instance_of(TruffleInteropSpecs::NewTestClass)
   end
 
   it "calls initialize" do
-    Truffle::Interop.new(TruffleInteropSpecs::NewTestClass, 14, 2).x.should == 16
+    Truffle::Interop.instantiate(TruffleInteropSpecs::NewTestClass, 14, 2).x.should == 16
   end
-
 end

spec/truffle/interop/new_spec.rb renamed to spec/truffle/interop/instantiate_spec.rb

@@ -9,14 +9,14 @@
 require_relative '../../ruby/spec_helper'
 require_relative 'fixtures/classes'
 
-describe "Truffle::Interop.invoke" do
+describe "Truffle::Interop.invoke_member" do
 
   it "invokes methods using symbols" do
-    Truffle::Interop.invoke(TruffleInteropSpecs::InvokeTestClass.new, :add, 14, 2).should == 16
+    Truffle::Interop.invoke_member(TruffleInteropSpecs::InvokeTestClass.new, :add, 14, 2).should == 16
   end
 
   it "invokes methods using strings" do
-    Truffle::Interop.invoke(TruffleInteropSpecs::InvokeTestClass.new, 'add', 14, 2).should == 16
+    Truffle::Interop.invoke_member(TruffleInteropSpecs::InvokeTestClass.new, 'add', 14, 2).should == 16
   end
 
   it "raises a NoMethodError when the method is not found on a foreign object" do

spec/truffle/interop/invoke_spec.rb renamed to spec/truffle/interop/invoke_member_spec.rb

@@ -11,7 +11,7 @@
 describe "Java strings" do
 
   it "is String" do
-    Truffle::Interop.is_string?(Truffle::Interop.to_java_string('test')).should be_true
+    Truffle::Interop.string?(Truffle::Interop.to_java_string('test')).should be_true
   end
 
   it "return the same object if attempted to be unboxed" do

spec/truffle/interop/java_string_spec.rb

@@ -18,12 +18,12 @@ def key_info(object, index)
        *(:insertable if Truffle::Interop.array_element_insertable?(object, index)),
        *(:removable if Truffle::Interop.array_element_removable?(object, index))]
     else
-      [*(:readable if Truffle::Interop.is_member_readable?(object, index)),
-       *(:modifiable if Truffle::Interop.is_member_modifiable?(object, index)),
-       *(:insertable if Truffle::Interop.is_member_insertable?(object, index)),
-       *(:removable if Truffle::Interop.is_member_removable?(object, index)),
-       *(:internal if Truffle::Interop.is_member_internal?(object, index)),
-       *(:invocable if Truffle::Interop.is_member_invocable?(object, index))]
+      [*(:readable if Truffle::Interop.member_readable?(object, index)),
+       *(:modifiable if Truffle::Interop.member_modifiable?(object, index)),
+       *(:insertable if Truffle::Interop.member_insertable?(object, index)),
+       *(:removable if Truffle::Interop.member_removable?(object, index)),
+       *(:internal if Truffle::Interop.member_internal?(object, index)),
+       *(:invocable if Truffle::Interop.member_invocable?(object, index))]
     end
   end
 

spec/truffle/interop/key_info_spec.rb

@@ -0,0 +1,36 @@
+# truffleruby_primitives: 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.
+
+require_relative '../../ruby/spec_helper'
+
+describe "Truffle::Interop" do
+  it "has a method for each InteropLibrary message" do
+    all_methods = Primitive.interop_library_all_methods
+    all_methods -= %w[getFactory getUncached]
+    expected = all_methods.map do |name|
+      name = name.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2.downcase}" }
+      if name.start_with?('is_', 'has_', 'fits_')
+        name += '?'
+      end
+      if name.start_with?('is_')
+        name = name[3..-1]
+      elsif name.start_with?('get_')
+        name = name[4..-1]
+      end
+      name.to_sym
+    end.sort
+
+    actual = Truffle::Interop.methods.sort
+
+    # pp expected
+    # pp actual
+    (expected - actual).should == []
+  end
+end