Create Ruby package instance and call instance method in JavaScript app

This article provides an introduction to cross-technology creation of instances of classes and invocation of instance methods.

With Javonet you can interact with classes from Ruby package like they were available in JavaScript but invocation must be performed through Javonet SDK API, passing type and method name as string.

Javonet allows you to pass any JavaScript value type as argument to instance 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 classes in JavaScript application

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

This section present sample custom Ruby package with class declaring methods and Javonet SDK syntax required to create object and invoke that methods and consume the results in JavaScript.

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 instance methods from Ruby package using following JavaScript code.

const { Javonet } = require('javonet-nodejs-sdk')

let resourcesDirectory = '.'

// use Activate only once in your app
Javonet.activate("your-license-key")

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

// set up variables
const libraryPath = resourcesDirectory + '/TestClass.rb'
const className = 'TestClass::TestClass'

//load custom library
calledRuntime.loadLibrary(libraryPath)

// get type from the runtime
let calledRuntimeType = calledRuntime.getType(className).execute()

// create type's instance
let instance = calledRuntimeType.createInstance().execute()

// invoke instance's method
let response = instance.invokeInstanceMethod("multiply_two_numbers", 5, 4).execute()

// get value from response
let result = response.getValue()

// write result to console
console.log(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
let calledRuntime = Javonet.inMemory().ruby()

// set up variables
const libraryPath = resourcesDirectory + '/TestClass.rb'
const className = 'TestClass::TestClass'

//load custom library
calledRuntime.loadLibrary(libraryPath)

// get type from the runtime
let calledRuntimeType = calledRuntime.getType(className).execute()

// create type's instance
let instance = calledRuntimeType.createInstance().execute()

// invoke instance's method
let response = instance.invokeInstanceMethod("multiply_two_numbers", 5, 4).execute()

// get value from response
let result = response.getValue()

// write result to console
console.log(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 methods defined in that package.

Further call to createInstance() allows to create instance of class. Calls to invokeInstanceMethod() allows to call "multiplyTwoNumbers" ruby-package instance 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 javascript value with getValue() method.

Use framework classes in JavaScript application

The same steps are required to use types and methods from standard Ruby package:

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.