wasmtime 0.3.0-x86_64-linux → 0.4.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64421267f57fe90afa44623614764f249cb7fc06734509d1643f88513eac2797
-  data.tar.gz: d4d7c84b2f92dd9c6a9103e2aa7720b83515d083cdbb0a7aed887e2b89717c92
+  metadata.gz: 9d4bbd6fe60e446c784f194aee2d1aa36473000237a06c1d87e7a06656ef591c
+  data.tar.gz: 472059120cc3f6959caebc4bca061fcd766c61ccfda4fcfbb1aa315818770b38
 SHA512:
-  metadata.gz: 585c63f8747ac0c7d4e794257db037723c4d9b8ee96ba02ef87966d09ebe5ee86ea689a2fd44ec2d2ce857bc1d5cd6349c0516addf3419b3fd92018541744d97
-  data.tar.gz: a0b66e6c7ff40b3053f98a60b73e23e099dd270537be0a9e328e45f7d262596a0dbbc1ffcba6182795e32630b936ed5bcb70936316517656a70a767d5648c3ed
+  metadata.gz: 5e781487208571c1c5fcb490db087953b597c20194abfa8a7653e7a108c0d1407971db1940ec5162a81ec29b24cb2d7fdd0da1eb48ae8ef55aee5613e7e82172
+  data.tar.gz: d8e07914fc9c09f2532a292406819bced2e356e7cb66893f028dde87536211fd92d9e97d344db24ea2282de4b14ab59076d984ada1faf4e5056018b49f740a2d

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: x86_64-linux
 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,10 +19,11 @@ 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/3.1/ext.so
+- lib/wasmtime/2.7/wasmtime_rb.so
+- lib/wasmtime/3.0/wasmtime_rb.so
+- lib/wasmtime/3.1/wasmtime_rb.so
 - lib/wasmtime/version.rb
 homepage: https://github.com/BytecodeAlliance/wasmtime-rb
 licenses:
@@ -33,7 +34,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