wasmtime 0.3.0-x64-mingw32 → 0.4.0-x64-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da44cfffd95306a044885024790f8e72f8d8311fb7d1ac2fa20769da4039664
-  data.tar.gz: '009295a87373108f51068985cc4e1729af1937653385107a2ecf3bea45df953b'
+  metadata.gz: 42f22c3364bc4f6444f2f1f64d100c477528f84e169a76d7853eddae94626319
+  data.tar.gz: d32ff46a0deea6f4ece93eee203f44225153f146d41c04adfdb956fed0773041
 SHA512:
-  metadata.gz: 34b7f8d1b983543f82804590b1c1c966a1cde6ef9c1bdb3d67284596f73dc77d130dae5fe5c8ed21929f5fe72dbd08c469a18699718bfccfde8217710cd882d5
-  data.tar.gz: ddeb4b62bda0ead2cb2654eabd1464f973e59d4134808ca6cb5f146e40a3c93972550a87bafcfed48d0123276c97f26b2792d680ffea134f3991bcd50bea6c4e
+  metadata.gz: 3eefdb7e8902e74cdf19918a24d14d26a07bfd703db7eb424e269e11b6aa35015f9928e46018b5acd471506f551fb462e0ad1bbfb729c745eb2288fb6e2bf2b0
+  data.tar.gz: 72de3e3f3cc4f0579f3a4946df1ffb5a1c88c2e9ac33b399ec4626b99bdeaae649135398c32a46f125f147ea3432be68b9aee1b1b7b2d2fe1099778dfd458af2

data/README.md

@@ -15,22 +15,39 @@
   </p>
 </div>
 
-## Status
+## Goal
 
-The Wasmtime Ruby bindings are still under development, [some features](https://github.com/bytecodealliance/wasmtime-rb/issues?q=is%3Aissue+is%3Aopen+label%3A%22missing+feature%22) are still missing.
+`wasmtime-rb`'s goal is to expose the full power of Wasmtime in Ruby with
+minimal overhead, serving as a foundation layer for other projects or gems.
 
 ## Installation
 
-Install from RubyGems
+Add the `wasmtime` gem to your Gemfile and run `bundle install`:
 
-```shell
+```ruby
+gem "wasmtime"
+```
+
+Alternatively, you can install the gem manually:
+
+```sh
 gem install wasmtime
 ```
 
-Or use in your Gemfile:
+### Precompiled gems
 
-```ruby
-gem "wasmtime", "~> 0.3.0"
+We recommend installing the `wasmtime` precompiled gems available for Linux, macOS, and Windows. Installing a precompiled gem avoids the need to compile from source code, which is generally slower and less reliable.
+
+When installing the `wasmtime` gem for the first time using `bundle install`, Bundler will automatically download the precompiled gem for your current platform. However, you will need to inform Bundler of any additional platforms you plan to use.
+
+To do this, lock your Bundle to the required platforms you will need from the list of supported platforms below:
+
+```sh
+bundle lock --add-platform x86_64-linux # Standard Linux (e.g. Heroku, GitHub Actions, etc.)
+bundle lock --add-platform x86_64-linux-musl # MUSL Linux deployments (i.e. Alpine Linux)
+bundle lock --add-platform aarch64-linux # ARM64 Linux deployments (i.e. AWS Graviton2)
+bundle lock --add-platform x86_64-darwin # Intel MacOS (i.e. pre-M1)
+bundle lock --add-platform arm64-darwin # Apple Silicon MacOS  (i.e. M1)
 ```
 
 ## Usage
@@ -41,10 +58,10 @@ Example usage:
 require "wasmtime"
 
 # Create an engine. Generally, you only need a single engine and can
-# re-use it a throughout your program
+# re-use it throughout your program.
 engine = Wasmtime::Engine.new
 
-# Compile a Wasm module from either Wasm or WAT.  The compiled module is
+# Compile a Wasm module from either Wasm or WAT. The compiled module is
 # specific to the Engine's configuration.
 mod = Wasmtime::Module.new(engine, <<~WAT)
   (module
@@ -57,19 +74,20 @@ WAT
 store = Wasmtime::Store.new(engine, {count: 0})
 
 # Define a Wasm function from Ruby code.
-func = Wasmtime::Func.new(store, Wasmtime::FuncType.new([], [])) do |caller|
+func = Wasmtime::Func.new(store, [], []) do |caller|
   puts "Hello from Func!"
-  puts "Ran #{caller[:count]} time(s)"
+  caller.store_data[:count] += 1
+  puts "Ran #{caller.store_data[:count]} time(s)"
 end
 
-# Build the Wasm instance by providing its imports
+# Build the Wasm instance by providing its imports.
 instance = Wasmtime::Instance.new(store, mod, [func])
 
 # Run the `run` export.
 instance.invoke("run")
 
-# Or: get the `run` export and call it
-instance.export("run").call
+# Or: get the `run` export and call it.
+instance.export("run").to_func.call
 ```
 
 For more, see [examples](https://github.com/bytecodealliance/wasmtime-rb/tree/main/examples)

data/ext/build.rs

@@ -0,0 +1,8 @@
+use std::error::Error;
+
+// Propogate linking from rb-sys for usage in the wasmtime-rb Rust crate
+fn main() -> Result<(), Box<dyn Error>> {
+    let _ = rb_sys_env::activate()?;
+
+    Ok(())
+}

data/lib/wasmtime/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wasmtime
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/wasmtime.rb

@@ -5,18 +5,25 @@ require_relative "wasmtime/version"
 # Tries to require the extension for the given Ruby version first
 begin
   RUBY_VERSION =~ /(\d+\.\d+)/
-  require "wasmtime/#{Regexp.last_match(1)}/ext"
+  require "wasmtime/#{Regexp.last_match(1)}/wasmtime_rb"
 rescue LoadError
-  require "wasmtime/ext"
+  require "wasmtime/wasmtime_rb"
 end
 
 module Wasmtime
   class Error < StandardError; end
 
+  # Raised when failing to convert the return value of a Ruby-backed Func to
+  # Wasm types.
+  class ResultError < Error; end
+
+  # Raised when converting an {Extern} to its concrete type fails.
   class ConversionError < Error; end
 
+  # Raised on Wasm trap.
   class Trap < Error
     STACK_OVERFLOW = :stack_overflow
+    MEMORY_OUT_OF_BOUNDS = :memory_out_of_bounds
     HEAP_MISALIGNED = :heap_misaligned
     TABLE_OUT_OF_BOUNDS = :table_out_of_bounds
     INDIRECT_CALL_TO_NULL = :indirect_call_to_null
@@ -27,6 +34,22 @@ module Wasmtime
     UNREACHABLE_CODE_REACHED = :unreachable_code_reached
     INTERRUPT = :interrupt
     ALWAYS_TRAP_ADAPTER = :always_trap_adapter
+    OUT_OF_FUEL = :out_of_fuel
     UNKNOWN = :unknown
   end
+
+  # Raised when a WASI program terminates early by calling +exit+.
+  class WasiExit < Error
+    # @return [Integer] The system exit code.
+    attr_reader(:code)
+
+    def initialize(code)
+      @code = code
+    end
+
+    # @return [String]
+    def message
+      "WASI exit with code #{code}"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wasmtime
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: x64-mingw32
 authors:
 - The Wasmtime Project Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby binding for Wasmtime, a WebAssembly runtime.
 email:
@@ -19,9 +19,10 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- ext/build.rs
 - lib/wasmtime.rb
-- lib/wasmtime/2.7/ext.so
-- lib/wasmtime/3.0/ext.so
+- lib/wasmtime/2.7/wasmtime_rb.so
+- lib/wasmtime/3.0/wasmtime_rb.so
 - lib/wasmtime/version.rb
 homepage: https://github.com/BytecodeAlliance/wasmtime-rb
 licenses:
@@ -32,7 +33,9 @@ metadata:
   cargo_crate_name: ext
   changelog_uri: https://github.com/bytecodealliance/wasmtime-rb/blob/main/CHANGELOG.md
 post_install_message:
-rdoc_options: []
+rdoc_options:
+- "--exclude"
+- vendor
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement