Invoke Ruby package static methods in Java app

This article provides an introduction to cross-technology invocation of static methods.

Javonet allows you to reference and use modules or packages written in (Java/Kotlin/Groovy/Clojure, C#/VB.NET, Ruby, Perl, Python, JavaScript/TypeScript) like they were created in your technology. If have not yet created your first project check Javonet overview and quick start guides for your technology.

With Javonet you can interact with static methods from Ruby package like they were available in Java but invocation must be performed through Javonet SDK API, passing the name of the target method as String.

Javonet allows you to pass any Java value type as argument to static method from Ruby package. In example: int, float, string, char, long and other. For reference type arguments (instances of other classes) you can create such instance with Javonet and pass the Invocation Context variable referencing that object as argument of static method invocation.

Use custom Ruby package static methods in Java application

With Javonet it is possible to reference any custom Ruby package and interact with public static methods declared on types defined within that module almost the same as with any other Java library.

Snippet below represents the sample code from Ruby package which contains class and its methods:

module TestClass
    class TestClass

        def self.multiply_by_two(a)
          return 2 * a
        end
        
        def multiply_two_numbers(a, b)
          return a * b
        end
    end
end
def self.multiply_by_two(a)
  return 2 * a
end

def multiply_two_numbers(a, b)
  return a * b
end

It is possible to invoke one of the declared static methods from Ruby package using following Java code.

import com.javonet.sdk.*;

public class SampleProgram {

    private static final String resourcesDirectory = ".";
    public static void main(String []args) {

        // use activate only once in your app
        Javonet.activate("your-license-key");
        
        // create called runtime context
        RuntimeContext calledRuntime = Javonet.inMemory().ruby();
        
        // set up variables
        String libraryPath = resourcesDirectory + "/TestClass.rb";
        String className = "TestClass::TestClass";
        
        // load custom library
        calledRuntime.loadLibrary(libraryPath);
        
        // get type from runtime
        InvocationContext calledRuntimeType = calledRuntime.getType(className).execute();
        
        // invoke type's method
        InvocationContext response = calledRuntimeType.invokeStaticMethod("multiply_by_two", 25).execute();
        
        // get value from response
        int result = (int) response.getValue();
        
        // write result to console
        System.out.println(result);
     }
}module TestClass
    class TestClass

        def self.multiply_by_two(a)
          return 2 * a
        end
        
        def multiply_two_numbers(a, b)
          return a * b
        end
    end
end
// use activate only once in your app
Javonet.activate("your-license-key");

// create called runtime context
RuntimeContext calledRuntime = Javonet.inMemory().ruby();

// set up variables
String libraryPath = resourcesDirectory + "/TestClass.rb";
String className = "TestClass::TestClass";

// load custom library
calledRuntime.loadLibrary(libraryPath);

// get type from runtime
InvocationContext calledRuntimeType = calledRuntime.getType(className).execute();

// invoke type's method
InvocationContext response = calledRuntimeType.invokeStaticMethod("multiply_by_two", 25).execute();

// get value from response
int result = (int) response.getValue();

// write result to console
System.out.println(result);

In code snippet above you can see how easily you can activate Javonet and instruct it using inMemory() method to create new RuntimeContext that will run ruby-package runtime within your current process. Next with addLibrary method it triggers the load of required ruby-package module and allows you to interact with any classes and their static methods defined in that package.

Further calls to invokeStaticMethod() allows to call "multiplyByTwo" ruby-package static method and pass the value type arguments. With Javonet you can invoke methods with any number and any type of arguments including value type arguments, reference type arguments, arrays and collections.

You can receive and further process and type of result returned by called ruby-package method, regardless if it is reference type that will get returned as another instance of Invocation Context that you can use for further interaction, or value type that you can obtain as java value with getValue() method.

Use framework static methods in Java application

With Javonet you can interact not only with any custom ruby-package module but also with any ruby-package framework objects. The same steps are required to use types and methods from standard Ruby package framework class:

import com.javonet.sdk.*;

public class SampleProgram {

    private static final String resourcesDirectory = ".";
    public static void main(String []args) {

        // use activate only once in your app
        Javonet.activate("your-license-key");
        
        // create called runtime context
        RuntimeContext calledRuntime = Javonet.inMemory().ruby();
        
        // get type from runtime
        InvocationContext calledRuntimeType = calledRuntime.getType("Math").execute();
        
        // invoke type's static method
        InvocationContext response = calledRuntimeType.invokeStaticMethod("sqrt", 2500).execute();
        
        // get result from response
        double result = (double) response.getValue();
        
        // write result to console
        System.out.println(result);
     }
}module TestClass
    class TestClass

        # empty
    end
end
// use activate only once in your app
Javonet.activate("your-license-key");

// create called runtime context
RuntimeContext calledRuntime = Javonet.inMemory().ruby();

// get type from runtime
InvocationContext calledRuntimeType = calledRuntime.getType("Math").execute();

// invoke type's static method
InvocationContext response = calledRuntimeType.invokeStaticMethod("sqrt", 2500).execute();

// get result from response
double result = (double) response.getValue();

// write result to console
System.out.println(result);

In sample above you see how the Javonet allows to create an instance of Ruby package Math class and interact with its static abs method. The same operation can be performed remotely by just changing the new Runtime Context invocation from in memory to tcp that will create and interact with your Ruby package objects on any remote node, container or service that hosts Javonet Code Gateway. This way you can preserve the same logic in your application and instantly switch between monolithic and microservices architecture without the need to implement the integration layer based on web services or other remote invocation methods.

Read more about use cases and software architecture scenarios where Javonet runtime bridging technology can support your development process.

Invoke Ruby package static methods in Java app

Use custom Ruby package static methods in Java application

Use framework static methods in Java application

Additional references