Standout App Bridge

app_bridge is a Ruby gem designed to facilitate communication with WebAssembly components that implement the WIT specification standout:app. This gem is developed for use in Standout's products.

Installation

Add the following line to your Gemfile:

gem 'app_bridge'

Then, install the gem by running:

bundle install

Usage

To use this gem, you need a WebAssembly component that adheres to the specification defined in ext/app_bridge/wit/world.wit.

You can check out the example components in spec/fixtures/components to see how such a component should be structured.

Once you have a WebAssembly component, you can use the gem as follows:

require 'app_bridge'

app = AppBridge::App.new('path/to/your/component.wasm')
app.triggers # => ['trigger1', 'trigger2']

More documentation and features will be added as the gem evolves.

Development

To contribute or modify this gem, ensure you have the following dependencies installed:

• Ruby 3.3.0 (or later)
• Rust 1.84.0 (or later)

Setting Up the Development Environment

Run the following command to setup and install additional dependencies:

bin/setup

Then, to compile example applications, run tests, and perform syntax checks, execute:

rake

Useful Commands

• Interactive Console: Run bin/console to interactively test the code.
• Full Test Suite & Linting: Run rake to compile, execute tests, and perform syntax checks.
• Run Tests Only: Execute rake spec to run only the test suite.
• Linting: Run rake rubocop to check code style and formatting.
• Compile Example Applications: Use rake fixtures to build the example apps.

To install this gem locally for testing purposes, run:

bundle exec rake install

Release & Distribution

To release a new version of the gem, update the version number in lib/app_bridge/version.rb and in ext/app_bridge/Cargo.toml. They should be the same.

Then push the changes to the repository and create a new release on GitHub. The gem will be automatically built and published to RubyGems.