javonet-ruby-sdk 2.1.13 → 2.1.14

data/lib/javonet-ruby-sdk/sdk/internal/invocation_context.rb

@@ -3,6 +3,10 @@ require_relative '../../core/interpreter/interpreter'
 require_relative '../../core/exceptions/exception_thrower'
 require_relative 'invocation_context_iterator'
 
+# InvocationContext is a class that represents a context for invoking commands.
+# It implements several interfaces for different types of interactions.
+# This class is used to construct chains of invocations, representing expressions of interaction that have not yet been executed.
+# @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/invocation-context article on Javonet Guides}
 class InvocationContext < AbstractInvocationContext
   include Enumerable
 
@@ -14,16 +18,15 @@ class InvocationContext < AbstractInvocationContext
     @current_command = command
     @response_command = nil
     @interpreter = Interpreter.new
-
-    # generates warning
-    # ObjectSpace.define_finalizer(self, self.finalize(@current_command, @is_executed, @interpreter, @connection_type, @tcp_ip_address))
+    # generates error: ruby/lib/javonet-ruby-sdk/sdk/internal/invocation_context.rb:17: warning: finalizer references object to be finalized
+    #ObjectSpace.define_finalizer(self, self.finalize(@current_command, @is_executed, @interpreter, @connection_type, @tcp_ip_address))
   end
 
   def finalize(command, is_executed, interpreter, connection_type, tcp_ip_address)
     proc do
       if command.command_type == CommandType::REFERENCE && is_executed == true
-        destructCommand = Command.new(@runtime_name, CommandType::DESTRUCT_REFERENCE, command.payload)
-        interpreter.execute(destructCommand, connection_type, tcp_ip_address)
+        destruct_command = Command.new(@runtime_name, CommandType::DESTRUCT_REFERENCE, command.payload)
+        interpreter.execute(destruct_command, connection_type, tcp_ip_address)
       end
     end
   end
@@ -32,7 +35,7 @@ class InvocationContext < AbstractInvocationContext
     if not [CommandType::REFERENCE, CommandType::ARRAY_GET_ITEM, CommandType::ARRAY_SET_ITEM].include? @current_command.command_type
       raise "Object is not iterable"
     else
-      return InvocationContextIterator.new(self)
+      InvocationContextIterator.new(self)
     end
   end
 
@@ -54,6 +57,14 @@ class InvocationContext < AbstractInvocationContext
     end
   end
 
+  # Executes the current command.
+  # Because invocation context is building the intent of executing particular expression on target environment, we call the initial state of invocation context as non-materialized. 
+  # The non-materialized context wraps either single command or chain of recursively nested commands.
+  # Commands are becoming nested through each invocation of methods on Invocation Context.
+  # Each invocation triggers the creation of new Invocation Context instance wrapping the current command with new parent command valid for invoked method.
+  # Developer can decide on any moment of the materialization for the context taking full control of the chunks of the expression being transferred and processed on target runtime.
+  # @return [InvocationContext] the InvocationContext after executing the command.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/execute-method article on Javonet Guides}
   def execute
     @response_command = @interpreter.execute(@current_command, @connection_type, @tcp_ip_address)
 
@@ -67,106 +78,178 @@ class InvocationContext < AbstractInvocationContext
       return self
     end
 
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, @response_command, true)
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, @response_command, true)
   end
 
-  def invoke_instance_method(*args)
-    local_command = Command.new(@runtime_name, CommandType::INVOKE_INSTANCE_METHOD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Invokes a static method on the target runtime.
+  # @param method_name [String] The name of the static method to invoke.
+  # @param args [Array] The arguments to pass to the static method.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to invoke the static method.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/calling-methods/invoking-static-method article on Javonet Guides}
+  def invoke_static_method(method_name, *args)
+    local_command = Command.new(@runtime_name, CommandType::INVOKE_STATIC_METHOD, [method_name, *args])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def create_instance(*args)
-    local_command = Command.new(@runtime_name, CommandType::CREATE_CLASS_INSTANCE, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
-  end
+  # Invokes an instance method on the target runtime.
+  # @param method_name [String] The name of the instance method to invoke.
+  # @param args [Array] The arguments to pass to the instance method.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to invoke the instance method.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/calling-methods/creating-instance-and-calling-instance-methods article on Javonet Guides}
 
-  def get_static_field(*args)
-    local_command = Command.new(@runtime_name, CommandType::GET_STATIC_FIELD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  def invoke_instance_method(method_name, *args)
+    local_command = Command.new(@runtime_name, CommandType::INVOKE_INSTANCE_METHOD, [method_name, *args])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def set_static_field(*args)
-    local_command = Command.new(@runtime_name, CommandType::SET_STATIC_FIELD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Creates a new instance of a class in the target runtime.
+  # @param args [Array] The arguments to class constructor
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to create the instance.
+  # @see https://www.javonet.com/guides/v2/ruby/calling-methods/creating-instance-and-calling-instance-methods
+  def create_instance(*args)
+    local_command = Command.new(@runtime_name, CommandType::CREATE_CLASS_INSTANCE, [*args])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_instance_field(*args)
-    local_command = Command.new(@runtime_name, CommandType::GET_INSTANCE_FIELD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the value of a static field from the target runtime.
+  # @param field_name [String] The name of the static field to get.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the static field.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/fields-and-properties/getting-and-setting-values-for-static-fields-and-properties article on Javonet Guides}
+  def get_static_field(field_name)
+    local_command = Command.new(@runtime_name, CommandType::GET_STATIC_FIELD, [field_name])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def set_instance_field(*args)
-    local_command = Command.new(@runtime_name, CommandType::SET_INSTANCE_FIELD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Sets the value of a static field in the target runtime.
+  # @param field_name [String] The name of the static field to set.
+  # @param value [Object] The new value of the static field.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to set the static field.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/fields-and-properties/getting-and-setting-values-for-static-fields-and-properties article on Javonet Guides}
+  def set_static_field(field_name, value)
+    local_command = Command.new(@runtime_name, CommandType::SET_STATIC_FIELD, [field_name, value])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def invoke_static_method(*args)
-    local_command = Command.new(@runtime_name, CommandType::INVOKE_STATIC_METHOD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the value of an instance field from the target runtime.
+  # @param field_name [String] The name of the instance field to get.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the instance field.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/fields-and-properties/getting-values-for-instance-fields-and-properties article on Javonet Guides}
+  def get_instance_field(field_name)
+    local_command = Command.new(@runtime_name, CommandType::GET_INSTANCE_FIELD, [field_name])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_index(*args)
-    local_command = Command.new(@runtime_name, CommandType::ARRAY_GET_ITEM, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Sets the value of an instance field in the target runtime.
+  # @param field_name [String] The name of the instance field to set.
+  # @param value [Object] The new value of the instance field.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to set the instance field.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/fields-and-properties/getting-values-for-instance-fields-and-properties article on Javonet Guides}
+  def set_instance_field(field_name, value)
+    local_command = Command.new(@runtime_name, CommandType::SET_INSTANCE_FIELD, [field_name, value])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_size(*args)
-    local_command = Command.new(@runtime_name, CommandType::ARRAY_GET_SIZE, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the value at a specific indexes in an array from the target runtime.
+  # @param indexes [Array] The indexes to pass to the get index command.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the index.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/arrays-and-collections/one-dimensional-arrays article on Javonet Guides}
+  def get_index(*indexes)
+    local_command = Command.new(@runtime_name, CommandType::ARRAY_GET_ITEM, [*indexes])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_rank(*args)
-    local_command = Command.new(@runtime_name, CommandType::ARRAY_GET_RANK, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Sets the value at a specific index in an array in the target runtime.
+  # @param indexes [Array] The indexes where new value should be set
+  # @param value [Object] The new value to set at the indexes.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to set the index.
+  # @see https://www.javonet.com/guides/v2/ruby/arrays-and-collections/one-dimensional-arrays Setting Array Element Guide
+  def set_index(indexes, value)
+    local_command = Command.new(@runtime_name, CommandType::ARRAY_SET_ITEM, [indexes, value])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def set_index(*args)
-    local_command = Command.new(@runtime_name, CommandType::ARRAY_SET_ITEM, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the number of elements from the target runtime.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the size.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/arrays-and-collections/one-dimensional-arrays article on Javonet Guides}
+  def get_size
+    local_command = Command.new(@runtime_name, CommandType::ARRAY_GET_SIZE, [])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def invoke_generic_static_method(*args)
-    local_command = Command.new(@runtime_name, CommandType::INVOKE_GENERIC_STATIC_METHOD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the rank of an array from the target runtime.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the rank.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/arrays-and-collections/multidimensional-arrays article on Javonet Guides}
+  def get_rank
+    local_command = Command.new(@runtime_name, CommandType::ARRAY_GET_RANK, [])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def invoke_generic_method(*args)
-    local_command = Command.new(@runtime_name, CommandType::INVOKE_GENERIC_METHOD, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Invokes a generic static method on the target runtime.
+  # @param method_name [String] The name of the generic static method to invoke.
+  # @param args [Array] The arguments to pass to the generic static method.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to invoke the generic static method.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/generics/calling-generic-static-method article on Javonet Guides}
+  def invoke_generic_static_method(method_name, *args)
+    local_command = Command.new(@runtime_name, CommandType::INVOKE_GENERIC_STATIC_METHOD, [method_name, *args])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_enum_name(*args)
-    local_command = Command.new(@runtime_name, CommandType::GET_ENUM_NAME, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Invokes a generic method on the target runtime.
+  # @param method_name [String] The name of the generic method to invoke.
+  # @param args [Array] The arguments to pass to the generic method.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to invoke the generic method.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/generics/calling-generic-instance-method article on Javonet Guides}
+  def invoke_generic_method(method_name, *args)
+    local_command = Command.new(@runtime_name, CommandType::INVOKE_GENERIC_METHOD, [method_name, *args])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_enum_value(*args)
-    local_command = Command.new(@runtime_name, CommandType::GET_ENUM_VALUE, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the name of an enum from the target runtime.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the enum name.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/enums/using-enum-type article on Javonet Guides}
+  def get_enum_name
+    local_command = Command.new(@runtime_name, CommandType::GET_ENUM_NAME, [])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
-  def get_ref_value(*args)
-    local_command = Command.new(@runtime_name, CommandType::GET_REF_VALUE, [*args])
-    return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  # Retrieves the value of an enum from the target runtime.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the enum value.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/enums/using-enum-type article on Javonet Guides}
+  def get_enum_value
+    local_command = Command.new(@runtime_name, CommandType::GET_ENUM_VALUE, [])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
   end
 
+  # Retrieves the value of a reference from the target runtime.
+  # @return [InvocationContext] A new InvocationContext instance that wraps the command to get the ref value.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/methods-arguments/passing-arguments-by-reference-with-ref-keyword article on Javonet Guides}
+  def get_ref_value
+    local_command = Command.new(@runtime_name, CommandType::GET_REF_VALUE, [])
+    InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+  end
 
-  def retrieve_array(*args)
-    local_command = Command.new(@runtime_name, CommandType::RETRIEVE_ARRAY, [*args])
-    localInvCtx = InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
-    localInvCtx.execute
-    return localInvCtx.response_command.payload
+  # Retrieves an array from the target runtime.
+  # @return [Object] A new InvocationContext instance that wraps the command to retrieve the array.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/arrays-and-collections/one-dimensional-arrays article on Javonet Guides}
+  def retrieve_array
+    local_command = Command.new(@runtime_name, CommandType::RETRIEVE_ARRAY, [])
+    local_inv_ctx = InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command))
+    local_inv_ctx.execute
+    local_inv_ctx.response_command.payload
   end
 
+  # Retrieves the value of the current command from the target runtime.
+  # @return [Object] The value of the current command.
+  # @see https://www.javonet.com/guides/v2/ruby/foundations/execute-method Getting Command Value Guide
   def get_value
-    return @current_command.payload[0]
+    @current_command.payload[0]
   end
 
   def build_command(command)
     command.payload.each_index { |i|
       command.payload[i] = encapsulate_payload_item(command.payload[i])
     }
-    return command.prepend_arg_to_payload(@current_command)
+    command.prepend_arg_to_payload(@current_command)
   end
 
   def encapsulate_payload_item(payload_item)

data/lib/javonet-ruby-sdk/sdk/internal/runtime_context.rb

@@ -3,6 +3,14 @@ require_relative 'invocation_context'
 require_relative '../../utils/connection_type'
 require_relative '../../core/interpreter/interpreter'
 
+ # Represents a single context which allows interaction with a selected technology.
+ # Refers to a single instance of the called runtime within a particular target OS process.
+ # This can be either the local currently running process (inMemory) or a particular remote process identified by the IP Address and PORT of the target Javonet instance.
+ # Multiple Runtime Contexts can be initialized within one process.
+ # Calling the same technology on inMemory communication channel will return the existing instance of runtime context.
+ # Calling the same technology on TCP channel but on different nodes will result in unique Runtime Contexts.
+ # Within the runtime context, any number of libraries can be loaded and any objects from the target technology can be interacted with, as they are aware of each other due to sharing the same memory space and same runtime instance.
+ # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
 class RuntimeContext < AbstractRuntimeContext
   @@memory_runtime_contexts = Hash.new
   @@network_runtime_contexts = Hash.new
@@ -45,6 +53,12 @@ class RuntimeContext < AbstractRuntimeContext
     end
   end
 
+  # Executes the current command. The initial state of RuntimeContext is non-materialized,
+  # wrapping either a single command or a chain of recursively nested commands.
+  # Commands become nested through each invocation of methods on RuntimeContext.
+  # Each invocation triggers the creation of a new RuntimeContext instance wrapping the current command with a new parent command.
+  # The developer can decide at any moment of the materialization for the context, taking full control of the chunks of the expression being transferred and processed on the target runtime.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/execute-method article on Javonet Guides}
   def execute
     @response_command = @interpreter.execute(@current_command, @connection_type, @tcp_ip_address)
     @current_command = nil
@@ -53,6 +67,13 @@ class RuntimeContext < AbstractRuntimeContext
     end
   end
   
+  # Adds a reference to a library. Javonet allows you to reference and use modules or packages written in various languages.
+  # This method allows you to use any library from all supported technologies. The necessary libraries need to be referenced.
+  # The argument is a relative or full path to the library. If the library has dependencies on other libraries, the latter needs to be added first.
+  # After referencing the library, any objects stored in this package can be used. Use static classes, create instances, call methods, use fields and properties, and much more.
+  # @param args [Array] The relative or full path to the library.
+  # @return [RuntimeContext] RuntimeContext instance.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/getting-started/adding-references-to-libraries article on Javonet Guides}
   def load_library(*args)
     local_command = Command.new(@runtime_name, CommandType::LOAD_LIBRARY, [*args])
     @current_command = build_command(local_command)
@@ -60,30 +81,62 @@ class RuntimeContext < AbstractRuntimeContext
     return self
   end
 
+  # Retrieves a reference to a specific type. The type can be a class, interface or enum. The type can be retrieved from any referenced library.
+  # @param args [Array] The full name of the type.
+  # @return [InvocationContext] InvocationContext instance.
   def get_type(*args)
     local_command = Command.new(@runtime_name, CommandType::GET_TYPE, [*args])
     @current_command = nil
     return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command), false)
   end
 
+  # Casts the provided value to a specific type. This method is used when invoking methods that require specific types of arguments.
+  # The arguments include the target type and the value to be cast. The target type must be retrieved from the called runtime using the getType method.
+  # After casting the value, it can be used as an argument when invoking methods.
+  # @param args [Array] The target type and the value to be cast.
+  # @return [InvocationContext] InvocationContext instance.
+  # #see Refer to this {https://www.javonet.com/guides/v2/ruby/casting/casting article on Javonet Guides}
   def cast(*args)
     local_command = Command.new(@runtime_name, CommandType::CAST, [*args])
     @current_command = nil
     return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command), false)
   end
 
+  # Retrieves a specific item from an enum type. This method is used when working with enums from the called runtime.
+  # The arguments include the enum type and the name of the item. The enum type must be retrieved from the called runtime using the getType method.
+  # After retrieving the item, it can be used
+  # as an argument when invoking methods.
+  # @param args [Array] The enum type and the name of the item.
+  # @return [InvocationContext] InvocationContext instance.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/enums/using-enum-type article on Javonet Guides}
   def get_enum_item(*args)
     local_command = Command.new(@runtime_name, CommandType::GET_ENUM_ITEM, [*args])
     @current_command = nil
     return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command), false)
   end
 
+  # Creates a reference type argument that can be passed to a method with a ref parameter modifier. 
+  # This method is used when working with methods from the called runtime that require arguments to be passed by reference.
+  # The arguments include the value and optionally the type of the reference. 
+  # The type must be retrieved from the called runtime using the getType method.
+  # After creating the reference, it can be used as an argument when invoking methods.
+  # @param args [Array] The value and optionally the type of the reference.
+  # @return [InvocationContext] InvocationContext instance.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/methods-arguments/passing-arguments-by-reference-with-ref-keyword article on Javonet Guides}
   def as_ref(*args)
     local_command = Command.new(@runtime_name, CommandType::AS_REF, [*args])
     @current_command = nil
     return InvocationContext.new(@runtime_name, @connection_type, @tcp_ip_address, build_command(local_command), false)
   end
 
+  # Creates a reference type argument that can be passed to a method with an out parameter modifier. 
+  # This method is used when working with methods from the called runtime that require arguments to be passed by reference.
+  # The arguments include the value and optionally the type of the reference. 
+  # The type must be retrieved from the called runtime using the getType method.
+  # After creating the reference, it can be used as an argument when invoking methods.
+  # @param args [Array] The value and optionally the type of the reference.
+  # @return [InvocationContext] InvocationContext instance.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/methods-arguments/passing-arguments-by-reference-with-out-keyword article on Javonet Guides}
   def as_out(*args)
     local_command = Command.new(@runtime_name, CommandType::AS_OUT, [*args])
     @current_command = nil

data/lib/javonet-ruby-sdk/sdk/internal/runtime_factory.rb

@@ -2,6 +2,9 @@ require_relative 'abstract/abstract_runtime_factory'
 require_relative '../../utils/connection_type'
 require_relative 'runtime_context'
 
+# The RuntimeFactory class implements the AbstractRuntimeFactory interface and provides methods for creating runtime contexts.
+# Each method corresponds to a specific runtime (CLR, JVM, .NET Core, Perl, Ruby, Node.js, Python) and returns a RuntimeContext instance for that runtime.
+# # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
 class RuntimeFactory < AbstractRuntimeFactory
 
   def initialize(connection_type, tcp_address = nil)
@@ -14,36 +17,53 @@ class RuntimeFactory < AbstractRuntimeFactory
     @tcp_address = tcp_address
   end
 
+  # Creates a RuntimeContext instance to interact with CLR runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the CLR runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def clr
-    RuntimeContext.get_instance(RuntimeName::CLR, @connection_type, @tcp_address )
-  end
-
-  def go
-    RuntimeContext.get_instance(RuntimeName::GO, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::CLR, @connection_type, @tcp_address)
   end
 
+  # Creates a RuntimeContext instance to interact with JVM runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the JVM runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def jvm
-    RuntimeContext.get_instance(RuntimeName::JVM, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::JVM, @connection_type, @tcp_address)
   end
 
+  # Creates a RuntimeContext instance to interact with .NET runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the .NET runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def netcore
-    RuntimeContext.get_instance(RuntimeName::NETCORE, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::NETCORE, @connection_type, @tcp_address)
   end
 
+  # Creates a RuntimeContext instance to interact with Perl runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the Perl runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def perl
-    RuntimeContext.get_instance(RuntimeName::PERL, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::PERL, @connection_type, @tcp_address)
   end
 
+  # Creates a RuntimeContext instance to interact with Ruby runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the Ruby runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def ruby
-    RuntimeContext.get_instance(RuntimeName::RUBY, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::RUBY, @connection_type, @tcp_address)
   end
 
+  # Creates a RuntimeContext instance to interact with Node.js runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the Node.js runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def nodejs
-    RuntimeContext.get_instance(RuntimeName::NODEJS, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::NODEJS, @connection_type, @tcp_address)
   end
 
+  # Creates a RuntimeContext instance to interact with Python runtime.
+  # @return [RuntimeContext] a RuntimeContext instance for the Python runtime
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}
   def python
-    RuntimeContext.get_instance(RuntimeName::PYTHON, @connection_type, @tcp_address )
+    RuntimeContext.get_instance(RuntimeName::PYTHON, @connection_type, @tcp_address)
   end
 
 end

data/lib/javonet-ruby-sdk/utils/runtime_name.rb

@@ -7,6 +7,7 @@ module RuntimeName
   PYTHON = 5
   RUBY = 6
   NODEJS = 7
+  CPP = 8
 
   def self.get_name(runtime_number)
     if runtime_number == 0
@@ -33,5 +34,8 @@ module RuntimeName
     if runtime_number == 7
       return 'NODEJS'
     end
+    if runtime_number == 8
+      return 'CPP'
+    end
   end
 end

data/lib/javonet-ruby-sdk.rb

@@ -2,22 +2,41 @@ require_relative './javonet-ruby-sdk/utils/connection_type'
 require_relative './javonet-ruby-sdk/sdk/internal/runtime_factory'
 require_relative './javonet-ruby-sdk/core/transmitter/transmitter'
 
+# The Javonet class is a singleton class that serves as the entry point for interacting with Javonet.
+# It provides methods to activate and initialize the Javonet SDK.
+# It supports both in-memory and TCP connections.
+# @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/javonet-static-class article on Javonet Guides}
 class Javonet
 
-  Transmitter.activate_with_licence_file()
+  Transmitter.activate_with_licence_file
 
+  # Initializes Javonet using an in-memory channel on the same machine.
+  # @return [RuntimeFactory] A RuntimeFactory instance configured for an in-memory connection.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/in-memory-channel article on Javonet Guides}
   def self.in_memory
     connection_type = ConnectionType::IN_MEMORY
     return RuntimeFactory.new(connection_type)
   end
 
+  # Initializes Javonet with a TCP connection to a remote machine.
+  # @param address [TcpConnectionData] The address of the remote machine.
+  # @return [RuntimeFactory] A RuntimeFactory instance configured for a TCP connection.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/tcp-channel article on Javonet Guides}
   def self.tcp(address)
     connection_type = ConnectionType::TCP
     return RuntimeFactory.new(connection_type, address)
   end
 
-  def self.activate(licenceKey, proxyHost="", proxyUserName="", proxyPassword="")
-    return Transmitter.activate_with_credentials_and_proxy(licenceKey, proxyHost, proxyUserName, proxyPassword)
+
+  # Activates Javonet with the provided license key and optionally with proxy data.
+  # @param licence_key [String] The license key to activate Javonet.
+  # @param proxy_host [String] The host for the proxy server (optional).
+  # @param proxy_user_name [String] The username for the proxy server (optional).
+  # @param proxy_user_password [String] The password for the proxy server (optional).
+  # @return [Integer] The activation status code.
+  # @see https://www.javonet.com/guides/v2/ruby/getting-started/activating-javonet Activating Javonet Guide
+  def self.activate(licence_key, proxy_host="", proxy_user_name="", proxy_password="")
+    return Transmitter.activate_with_credentials_and_proxy(licence_key, proxy_host, proxy_user_name, proxy_password)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: javonet-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.13
+  version: 2.1.14
 platform: ruby
 authors:
 - SdNCenter Sp. z o. o.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -192,9 +192,10 @@ files:
 - lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libnode.so.108
 - lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libperl.so.5.30.0
 - lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libpython3.11.so.1.0
-- lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libruby.so.2.7
+- lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libruby.so.2.7.8
 - lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libxmlsec1-openssl.so.1.2.34
 - lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/libxmlsec1.so.1.2.34
+- lib/javonet-ruby-sdk/Binaries/Native/Linux/X64/version.txt
 - lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/NetVersion31LatestPatch.runtimeconfig.json
 - lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/NetVersion60LatestPatch.runtimeconfig.json
 - lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/NetVersion70LatestPatch.runtimeconfig.json
@@ -218,6 +219,7 @@ files:
 - lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/libnethost.dylib
 - lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/libnode.108.dylib
 - lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/libruby.2.7.dylib
+- lib/javonet-ruby-sdk/Binaries/Native/MacOs/X64/version.txt
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetClrRuntimeNative.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetCppRuntimeNative.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetGoRuntimeNative.dll
@@ -227,6 +229,9 @@ files:
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetPerlRuntimeNative.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetPerlRuntimeNativeAuxiliary.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetPythonRuntimeNative.dll
+- lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetRuby278RuntimeNative.dll
+- lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetRuby314RuntimeNative.dll
+- lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetRuby322RuntimeNative.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetRubyRuntimeNative.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/JavonetRubyRuntimeNativeAuxiliary.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/NetVersion31LatestPatch.runtimeconfig.json
@@ -249,6 +254,7 @@ files:
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/libxslt.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/nethost.dll
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/python311.dll
+- lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/version.txt
 - lib/javonet-ruby-sdk/Binaries/Native/Windows/X64/x64-msvcrt-ruby270.dll
 - lib/javonet-ruby-sdk/Binaries/Netcore/Linux/X64/Javonet.Netcore.Core.dll
 - lib/javonet-ruby-sdk/Binaries/Netcore/Linux/X64/Javonet.Netcore.Utils.dll