SpaceShoes

SpaceShoes allows embedding Ruby GUI code in your web pages. You can embed simple Ruby GUI applications directly or you can write a multi-file application and package it up to be loaded from the page or pages of your choice.

SpaceShoes is based on Scarpe, which is a reimplementation of Shoes by _why the lucky stiff. It contains a lot of code from Scarpe-Wasm by Giovanni Borgh and Noah Gibbs.

SpaceShoes operates in two ways. You can use it in a Ruby application and bundle that into a web site. Or you can use it via a Wasm module included from Javascript.

JS-based installation is useful if you have a single Shoes file with no additional files included, or with only assets you can reference via URL. It's a great way to experiment with SpaceShoes without repeated build steps.

You'll still need to create a Wasm module containing the SpaceShoes code and some default gems and so on. Eventually we'll have a prebuilt default for this accessible directly, but for now you'll have to build your own.

$ space_shoes build-default

(MORE INSTALL INSTRUCTIONS HERE)

If you want or need multiple files bundled into a Wasm module, you'll start from the Ruby side.

Install the gem and add to the application's Gemfile by executing:

$ bundle add space_shoes

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install space_shoes

You can directly run SpaceShoes-based apps from the command line, which will package the application and run a browser:

$ space_shoes my_app.rb

You can also package a SpaceShoes application to be included in a web page of your choice:

$ space_shoes src-package my_app_dir

(MORE INSTALL INSTRUCTIONS HERE)

TODO: Write usage instructions here

You'll need a Ruby-based install to help develop SpaceShoes.

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/scarpe-team/space_shoes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

This will package gems in ruby.wasm, built into the Ruby binary bundle exec rbwasm build --ruby-version 3.3 -o ruby.wasm

Think we can use the built Ruby-with-gems with rbwasm pack to combine with source dir bundle exec rbwasm pack ruby.wasm --mapdir GUESTDIR:HOSTDIR -o packed_ruby.wasm

To install wasmtime for testing: https://github.com/bytecodealliance/wasmtime

Single-line HTTP server: "ruby -run -e httpd -- -p 4321 ."

EvilMartians blog post on using Ruby.wasm's Bundler integration https://evilmartians.com/chronicles/first-steps-with-ruby-wasm-or-building-ruby-next-playground

Giovanni Borgh wrote the initial scarpe-wasm code, including tools like wasify, for his Google Summer of Code project. Noah Gibbs then adapted it to Scarpe and its dependencies (e.g. Lacci, Scarpe-Components, Calzini).

The top-level structure of SpaceShoes is different from scarpe-wasm. But a lot of the actual initial code comes from scarpe-wasm and was co-written by Noah Gibbs and/or Giovanni Borgh. The import of scarpe-wasm doesn't attempt to tease all this apart accurately - there are some commits that credit Giovanni as co-author in general, but mostly the code is just copied over.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the SpaceShoes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.