extism 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b540fbbf71c7df6e1830473a374de243616af3fbed809b54e65d54b97521ca4
-  data.tar.gz: 9c37464eb99dd16e7481e6ad1b1a46385b2b8c33861041ede0d055cbdaab2317
+  metadata.gz: 844243a86e28c001eceea6a44a3e73b07aea648d608b2c3e989d0c1185e6207c
+  data.tar.gz: 13caf6cf47b8cf7640a194a3a91607392f5f5a963c8dca56ff466c92055ea17a
 SHA512:
-  metadata.gz: 541a4167c2985a8adecb5565d6c4fca794c87de64ccd10bbde410f22c752e9eaaf16686306ec280e9755deeafa47866b6bf26a098cb54199c6185ed6321fadfc
-  data.tar.gz: f3711e03292689c31547d22bc099ec356e07fa7876698c8d00cc5d0ab4b54f0f76377bca5d34789e76766978b9bd620721d11639143fde06572ef07ec07b086f
+  metadata.gz: c78963cf077ac7d85710554f781b6a4e4dac2352bd89ecbc62852a33b4a1ada70f4728eea80b6b2894d3508ce164f817c70bddc537958514fb0353d63ee02252
+  data.tar.gz: c9270b4c474c816a743fd5ba1efd9c37b765ee177d59bae93a0e17540d91ae95e618292c257e6873b198e508fb79cf051156bf397cefb812554be0cb52c0db2e

data/Gemfile

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in extism.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-gem "ffi", "~> 1.15.5"
-
-group :development do
-  gem "yard", "~> 0.9.28"
-  gem "rufo", "~> 0.13.0"
-  gem "minitest", "~> 5.18.0"
-end
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in extism.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "ffi", "~> 1.15.5"
+
+group :development do
+  gem "yard", "~> 0.9.28"
+  gem "rufo", "~> 0.13.0"
+  gem "minitest", "~> 5.19.0"
+end

data/example.rb

@@ -1,17 +1,11 @@
-require "./lib/extism"
-require "json"
-
-# a Context provides a scope for plugins to be managed within. creating multiple contexts
-# is expected and groups plugins based on source/tenant/lifetime etc.
-# We recommend you use `Extism.with_context` unless you have a reason to keep your context around.
-# If you do you can create a context with `Extism#new`, example: `ctx = Extism.new`
-Extism.with_context do |ctx|
-  manifest = {
-    :wasm => [{ :path => "../wasm/code.wasm" }],
-  }
-
-  plugin = ctx.plugin(manifest)
-  res = JSON.parse(plugin.call("count_vowels", ARGV[0] || "this is a test"))
-
-  puts res["count"]
-end
+require "./lib/extism"
+require "json"
+
+manifest = {
+  :wasm => [{ :path => "../wasm/code.wasm" }],
+}
+
+plugin = Extism::Plugin.new(manifest)
+res = JSON.parse(plugin.call("count_vowels", ARGV[0] || "this is a test"))
+
+puts res["count"]

data/lib/extism/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Extism
-  VERSION = "0.3.0"
-end
+# frozen_string_literal: true
+
+module Extism
+  VERSION = '0.5.0'
+end

data/lib/extism.rb

@@ -1,264 +1,267 @@
-require "ffi"
-require "json"
-require_relative "./extism/version"
-
-module Extism
-  class Error < StandardError
-  end
-
-  # Return the version of Extism
-  #
-  # @return [String] The version string of the Extism runtime
-  def self.extism_version
-    C.extism_version
-  end
-
-  # Set log file and level, this is a global configuration
-  # @param name [String] The path to the logfile
-  # @param level [String] The log level. One of {"debug", "error", "info", "trace" }
-  def self.set_log_file(name, level = nil)
-    if level
-      level = FFI::MemoryPointer::from_string(level)
-    end
-    C.extism_log_file(name, level)
-  end
-
-  $PLUGINS = {}
-  $FREE_PLUGIN = proc { |id|
-    x = $PLUGINS[id]
-    if !x.nil?
-      C.extism_plugin_free(x[:context].pointer, x[:plugin])
-      $PLUGINS.delete(id)
-    end
-  }
-
-  $CONTEXTS = {}
-  $FREE_CONTEXT = proc { |id|
-    x = $CONTEXTS[id]
-    if !x.nil?
-      C.extism_context_free($CONTEXTS[id])
-      $CONTEXTS.delete(id)
-    end
-  }
-
-  # A Context is needed to create plugins. The Context
-  # is where your plugins live. Freeing the context
-  # frees all of the plugins in its scope.
-  #
-  # @example Create and free a context
-  #  ctx = Extism::Context.new
-  #  plugin = ctx.plugin(my_manifest)
-  #  puts plugin.call("my_func", "my-input")
-  #  ctx.free # frees any plugins
-  #
-  # @example Use with_context to auto-free
-  #  Extism.with_context do |ctx|
-  #    plugin = ctx.plugin(my_manifest)
-  #    puts plugin.call("my_func", "my-input")
-  #  end # frees context after exiting this block
-  #
-  # @attr_reader pointer [FFI::Pointer] Pointer to the Extism context. *Used internally*.
-  class Context
-    attr_reader :pointer
-
-    # Initialize a new context
-    def initialize
-      @pointer = C.extism_context_new()
-      $CONTEXTS[self.object_id] = @pointer
-      ObjectSpace.define_finalizer(self, $FREE_CONTEXT)
-    end
-
-    # Remove all registered plugins in this context
-    # @return [void]
-    def reset
-      C.extism_context_reset(@pointer)
-    end
-
-    # Free the context, this should be called when it is no longer needed
-    # @return [void]
-    def free
-      return if @pointer.nil?
-
-      $CONTEXTS.delete(self.object_id)
-      C.extism_context_free(@pointer)
-      @pointer = nil
-    end
-
-    # Create a new plugin from a WASM module or JSON encoded manifest
-    #
-    # @param wasm [Hash, String] The manifest for the plugin. See https://extism.org/docs/concepts/manifest/.
-    # @param wasi [Boolean] Enable WASI support
-    # @param config [Hash] The plugin config
-    # @return [Plugin]
-    def plugin(wasm, wasi = false, config = nil)
-      Plugin.new(self, wasm, wasi, config)
-    end
-  end
-
-  # A context manager to create contexts and ensure that they get freed.
-  #
-  # @example Use with_context to auto-free
-  #  Extism.with_context do |ctx|
-  #    plugin = ctx.plugin(my_manifest)
-  #    puts plugin.call("my_func", "my-input")
-  #  end # frees context after exiting this block
-  #
-  # @yield [ctx] Yields the created Context
-  # @return [Object] returns whatever your block returns
-  def self.with_context(&block)
-    ctx = Context.new
-    begin
-      x = block.call(ctx)
-      return x
-    ensure
-      ctx.free
-    end
-  end
-
-  # A CancelHandle can be used to cancel a running plugin from another thread
-  class CancelHandle
-    def initialize(handle)
-      @handle = handle
-    end
-
-    # Cancel the plugin used to generate the handle
-    def cancel
-      return C.extism_plugin_cancel(@handle)
-    end
-  end
-
-  # A Plugin represents an instance of your WASM program from the given manifest.
-  class Plugin
-    # Intialize a plugin
-    #
-    # @see Extism::Context#plugin
-    # @param context [Context] The context to manager this plugin
-    # @param wasm [Hash, String] The manifest or WASM binary. See https://extism.org/docs/concepts/manifest/.
-    # @param wasi [Boolean] Enable WASI support
-    # @param config [Hash] The plugin config
-    def initialize(context, wasm, wasi = false, config = nil)
-      @context = context
-      if wasm.class == Hash
-        wasm = JSON.generate(wasm)
-      end
-      code = FFI::MemoryPointer.new(:char, wasm.bytesize)
-      code.put_bytes(0, wasm)
-      @plugin = C.extism_plugin_new(context.pointer, code, wasm.bytesize, nil, 0, wasi)
-      if @plugin < 0
-        err = C.extism_error(@context.pointer, -1)
-        if err&.empty?
-          raise Error.new "extism_plugin_new failed"
-        else
-          raise Error.new err
-        end
-      end
-      $PLUGINS[self.object_id] = { :plugin => @plugin, :context => context }
-      ObjectSpace.define_finalizer(self, $FREE_PLUGIN)
-      if config != nil and @plugin >= 0
-        s = JSON.generate(config)
-        ptr = FFI::MemoryPointer::from_string(s)
-        C.extism_plugin_config(@context.pointer, @plugin, ptr, s.bytesize)
-      end
-    end
-
-    # Update a plugin with new WASM module or manifest
-    #
-    # @param wasm [Hash, String] The manifest or WASM binary. See https://extism.org/docs/concepts/manifest/.
-    # @param wasi [Boolean] Enable WASI support
-    # @param config [Hash] The plugin config
-    # @return [void]
-    def update(wasm, wasi = false, config = nil)
-      if wasm.class == Hash
-        wasm = JSON.generate(wasm)
-      end
-      code = FFI::MemoryPointer.new(:char, wasm.bytesize)
-      code.put_bytes(0, wasm)
-      ok = C.extism_plugin_update(@context.pointer, @plugin, code, wasm.bytesize, nil, 0, wasi)
-      if !ok
-        err = C.extism_error(@context.pointer, @plugin)
-        if err&.empty?
-          raise Error.new "extism_plugin_update failed"
-        else
-          raise Error.new err
-        end
-      end
-
-      if config != nil
-        s = JSON.generate(config)
-        ptr = FFI::MemoryPointer::from_string(s)
-        C.extism_plugin_config(@context.pointer, @plugin, ptr, s.bytesize)
-      end
-    end
-
-    # Check if a function exists
-    #
-    # @param name [String] The name of the function
-    # @return [Boolean] Returns true if function exists
-    def has_function?(name)
-      C.extism_plugin_function_exists(@context.pointer, @plugin, name)
-    end
-
-    # Call a function by name
-    #
-    # @param name [String] The function name
-    # @param data [String] The input data for the function
-    # @return [String] The output from the function in String form
-    def call(name, data, &block)
-      # If no block was passed then use Pointer::read_string
-      block ||= ->(buf, len) { buf.read_string(len) }
-      input = FFI::MemoryPointer::from_string(data)
-      rc = C.extism_plugin_call(@context.pointer, @plugin, name, input, data.bytesize)
-      if rc != 0
-        err = C.extism_error(@context.pointer, @plugin)
-        if err&.empty?
-          raise Error.new "extism_call failed"
-        else
-          raise Error.new err
-        end
-      end
-      out_len = C.extism_plugin_output_length(@context.pointer, @plugin)
-      buf = C.extism_plugin_output_data(@context.pointer, @plugin)
-      block.call(buf, out_len)
-    end
-
-    # Free a plugin, this should be called when the plugin is no longer needed
-    #
-    # @return [void]
-    def free
-      return if @context.pointer.nil?
-
-      $PLUGINS.delete(self.object_id)
-      C.extism_plugin_free(@context.pointer, @plugin)
-      @plugin = -1
-    end
-
-    # Get a CancelHandle for a plugin
-    def cancel_handle
-      return CancelHandle.new(C.extism_plugin_cancel_handle(@context.pointer, @plugin))
-    end
-  end
-
-  private
-
-  # Private module used to interface with the Extism runtime.
-  # *Warning*: Do not use or rely on this directly.
-  module C
-    extend FFI::Library
-    ffi_lib "extism"
-    attach_function :extism_context_new, [], :pointer
-    attach_function :extism_context_free, [:pointer], :void
-    attach_function :extism_plugin_new, [:pointer, :pointer, :uint64, :pointer, :uint64, :bool], :int32
-    attach_function :extism_plugin_update, [:pointer, :int32, :pointer, :uint64, :pointer, :uint64, :bool], :bool
-    attach_function :extism_error, [:pointer, :int32], :string
-    attach_function :extism_plugin_call, [:pointer, :int32, :string, :pointer, :uint64], :int32
-    attach_function :extism_plugin_function_exists, [:pointer, :int32, :string], :bool
-    attach_function :extism_plugin_output_length, [:pointer, :int32], :uint64
-    attach_function :extism_plugin_output_data, [:pointer, :int32], :pointer
-    attach_function :extism_log_file, [:string, :pointer], :void
-    attach_function :extism_plugin_free, [:pointer, :int32], :void
-    attach_function :extism_context_reset, [:pointer], :void
-    attach_function :extism_version, [], :string
-    attach_function :extism_plugin_cancel_handle, [:pointer, :int32], :pointer
-    attach_function :extism_plugin_cancel, [:pointer], :bool
-  end
-end
+require "ffi"
+require "json"
+require_relative "./extism/version"
+
+module Extism
+  class Error < StandardError
+  end
+
+  # Return the version of Extism
+  #
+  # @return [String] The version string of the Extism runtime
+  def self.extism_version
+    C.extism_version
+  end
+
+  # Set log file and level, this is a global configuration
+  # @param name [String] The path to the logfile
+  # @param level [String] The log level. One of {"debug", "error", "info", "trace" }
+  def self.set_log_file(name, level = nil)
+    if level
+      level = FFI::MemoryPointer::from_string(level)
+    end
+    C.extism_log_file(name, level)
+  end
+
+  $PLUGINS = {}
+  $FREE_PLUGIN = proc { |id|
+    x = $PLUGINS[id]
+    if !x.nil?
+      C.extism_plugin_free(x[:context].pointer, x[:plugin])
+      $PLUGINS.delete(id)
+    end
+  }
+
+  $CONTEXTS = {}
+  $FREE_CONTEXT = proc { |id|
+    x = $CONTEXTS[id]
+    if !x.nil?
+      C.extism_context_free($CONTEXTS[id])
+      $CONTEXTS.delete(id)
+    end
+  }
+
+  # A Context is needed to create plugins. The Context
+  # is where your plugins live. Freeing the context
+  # frees all of the plugins in its scope.
+  #
+  # @example Create and free a context
+  #  ctx = Extism::Context.new
+  #  plugin = ctx.plugin(my_manifest)
+  #  puts plugin.call("my_func", "my-input")
+  #  ctx.free # frees any plugins
+  #
+  # @example Use with_context to auto-free
+  #  Extism.with_context do |ctx|
+  #    plugin = ctx.plugin(my_manifest)
+  #    puts plugin.call("my_func", "my-input")
+  #  end # frees context after exiting this block
+  #
+  # @attr_reader pointer [FFI::Pointer] Pointer to the Extism context. *Used internally*.
+  class Context
+    attr_reader :pointer
+
+    # Initialize a new context
+    def initialize
+      @pointer = C.extism_context_new()
+      $CONTEXTS[self.object_id] = @pointer
+      ObjectSpace.define_finalizer(self, $FREE_CONTEXT)
+    end
+
+    # Remove all registered plugins in this context
+    # @return [void]
+    def reset
+      C.extism_context_reset(@pointer)
+    end
+
+    # Free the context, this should be called when it is no longer needed
+    # @return [void]
+    def free
+      return if @pointer.nil?
+
+      $CONTEXTS.delete(self.object_id)
+      C.extism_context_free(@pointer)
+      @pointer = nil
+    end
+
+    # Create a new plugin from a WASM module or JSON encoded manifest
+    #
+    # @see Plugin#new
+    # @param wasm [Hash, String] The manifest for the plugin. See https://extism.org/docs/concepts/manifest/.
+    # @param wasi [Boolean] Enable WASI support
+    # @param config [Hash] The plugin config
+    # @return [Plugin]
+    def plugin(wasm, wasi = false, config = nil)
+      Plugin.new(wasm, wasi, config, self)
+    end
+  end
+
+  # A context manager to create contexts and ensure that they get freed.
+  #
+  # @example Use with_context to auto-free
+  #  Extism.with_context do |ctx|
+  #    plugin = ctx.plugin(my_manifest)
+  #    puts plugin.call("my_func", "my-input")
+  #  end # frees context after exiting this block
+  #
+  # @yield [ctx] Yields the created Context
+  # @return [Object] returns whatever your block returns
+  def self.with_context(&block)
+    ctx = Context.new
+    begin
+      x = block.call(ctx)
+      return x
+    ensure
+      ctx.free
+    end
+  end
+
+  # A CancelHandle can be used to cancel a running plugin from another thread
+  class CancelHandle
+    def initialize(handle)
+      @handle = handle
+    end
+
+    # Cancel the plugin used to generate the handle
+    def cancel
+      return C.extism_plugin_cancel(@handle)
+    end
+  end
+
+  # A Plugin represents an instance of your WASM program from the given manifest.
+  class Plugin
+    # Intialize a plugin
+    #
+    # @param wasm [Hash, String] The manifest or WASM binary. See https://extism.org/docs/concepts/manifest/.
+    # @param wasi [Boolean] Enable WASI support
+    # @param config [Hash] The plugin config
+    # @param context [Context] The context to manager this plugin
+    def initialize(wasm, wasi = false, config = nil, context = nil)
+      if context.nil? then
+        context = Context.new
+      end
+      @context = context
+      if wasm.class == Hash
+        wasm = JSON.generate(wasm)
+      end
+      code = FFI::MemoryPointer.new(:char, wasm.bytesize)
+      code.put_bytes(0, wasm)
+      @plugin = C.extism_plugin_new(context.pointer, code, wasm.bytesize, nil, 0, wasi)
+      if @plugin < 0
+        err = C.extism_error(@context.pointer, -1)
+        if err&.empty?
+          raise Error.new "extism_plugin_new failed"
+        else
+          raise Error.new err
+        end
+      end
+      $PLUGINS[self.object_id] = { :plugin => @plugin, :context => context }
+      ObjectSpace.define_finalizer(self, $FREE_PLUGIN)
+      if config != nil and @plugin >= 0
+        s = JSON.generate(config)
+        ptr = FFI::MemoryPointer::from_string(s)
+        C.extism_plugin_config(@context.pointer, @plugin, ptr, s.bytesize)
+      end
+    end
+
+    # Update a plugin with new WASM module or manifest
+    #
+    # @param wasm [Hash, String] The manifest or WASM binary. See https://extism.org/docs/concepts/manifest/.
+    # @param wasi [Boolean] Enable WASI support
+    # @param config [Hash] The plugin config
+    # @return [void]
+    def update(wasm, wasi = false, config = nil)
+      if wasm.class == Hash
+        wasm = JSON.generate(wasm)
+      end
+      code = FFI::MemoryPointer.new(:char, wasm.bytesize)
+      code.put_bytes(0, wasm)
+      ok = C.extism_plugin_update(@context.pointer, @plugin, code, wasm.bytesize, nil, 0, wasi)
+      if !ok
+        err = C.extism_error(@context.pointer, @plugin)
+        if err&.empty?
+          raise Error.new "extism_plugin_update failed"
+        else
+          raise Error.new err
+        end
+      end
+
+      if config != nil
+        s = JSON.generate(config)
+        ptr = FFI::MemoryPointer::from_string(s)
+        C.extism_plugin_config(@context.pointer, @plugin, ptr, s.bytesize)
+      end
+    end
+
+    # Check if a function exists
+    #
+    # @param name [String] The name of the function
+    # @return [Boolean] Returns true if function exists
+    def has_function?(name)
+      C.extism_plugin_function_exists(@context.pointer, @plugin, name)
+    end
+
+    # Call a function by name
+    #
+    # @param name [String] The function name
+    # @param data [String] The input data for the function
+    # @return [String] The output from the function in String form
+    def call(name, data, &block)
+      # If no block was passed then use Pointer::read_string
+      block ||= ->(buf, len) { buf.read_string(len) }
+      input = FFI::MemoryPointer::from_string(data)
+      rc = C.extism_plugin_call(@context.pointer, @plugin, name, input, data.bytesize)
+      if rc != 0
+        err = C.extism_error(@context.pointer, @plugin)
+        if err&.empty?
+          raise Error.new "extism_call failed"
+        else
+          raise Error.new err
+        end
+      end
+      out_len = C.extism_plugin_output_length(@context.pointer, @plugin)
+      buf = C.extism_plugin_output_data(@context.pointer, @plugin)
+      block.call(buf, out_len)
+    end
+
+    # Free a plugin, this should be called when the plugin is no longer needed
+    #
+    # @return [void]
+    def free
+      return if @context.pointer.nil?
+
+      $PLUGINS.delete(self.object_id)
+      C.extism_plugin_free(@context.pointer, @plugin)
+      @plugin = -1
+    end
+
+    # Get a CancelHandle for a plugin
+    def cancel_handle
+      return CancelHandle.new(C.extism_plugin_cancel_handle(@context.pointer, @plugin))
+    end
+  end
+
+  private
+
+  # Private module used to interface with the Extism runtime.
+  # *Warning*: Do not use or rely on this directly.
+  module C
+    extend FFI::Library
+    ffi_lib "extism"
+    attach_function :extism_context_new, [], :pointer
+    attach_function :extism_context_free, [:pointer], :void
+    attach_function :extism_plugin_new, [:pointer, :pointer, :uint64, :pointer, :uint64, :bool], :int32
+    attach_function :extism_plugin_update, [:pointer, :int32, :pointer, :uint64, :pointer, :uint64, :bool], :bool
+    attach_function :extism_error, [:pointer, :int32], :string
+    attach_function :extism_plugin_call, [:pointer, :int32, :string, :pointer, :uint64], :int32
+    attach_function :extism_plugin_function_exists, [:pointer, :int32, :string], :bool
+    attach_function :extism_plugin_output_length, [:pointer, :int32], :uint64
+    attach_function :extism_plugin_output_data, [:pointer, :int32], :pointer
+    attach_function :extism_log_file, [:string, :pointer], :void
+    attach_function :extism_plugin_free, [:pointer, :int32], :void
+    attach_function :extism_context_reset, [:pointer], :void
+    attach_function :extism_version, [], :string
+    attach_function :extism_plugin_cancel_handle, [:pointer, :int32], :pointer
+    attach_function :extism_plugin_cancel, [:pointer], :bool
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extism
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - zach
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -48,7 +48,7 @@ metadata:
   homepage_uri: https://github.com/extism/extism
   source_code_uri: https://github.com/extism/extism
   changelog_uri: https://github.com/extism/extism
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,8 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Extism WASM SDK
 test_files: []