wasify 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6c74bf50fb9cb72177396e5687833064870c6d6b7a4a9a4fac91056751312ed
+  data.tar.gz: b164d1649f05462fa7ef8f2166e78bd305369c2905b098ec14ac2759148b341d
+SHA512:
+  metadata.gz: 52df9a60f3c3c974ab0b129b17fb8df1762dca688d00ad981786d2eaa18a34508dcdde92419ff8af4f9bcedba26c3a795039a04644dec864467c0ef2c60006f7
+  data.tar.gz: e42fcb4ec79e0c0748581b33cbfa7a11b5b701e4c7596d520d66cf72d1debf3c331cb6d3beb9875bb1a50805130ae55a907234e6e8dcbc289dbdf852569fb726

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at gio96b@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wasify.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    wasify (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  wasify!
+
+BUNDLED WITH
+   2.4.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Giovanni Borgh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 AlawysDelta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Wasify
+
+Wasify is a CLI made to make running Ruby on your browser thanks to WASM, including gems without native extensions, easy! Wasify packs a new WASM binary based on those released by [ruby.wasm](https://github.com/ruby/ruby.wasm), leveraging [wasi-vfs](https://github.com/kateinoigakukun/wasi-vfs) to include your code and any dependencies without native extensions. This creates a single binary ready to run in your browser with the generated HTML code.
+## Installation
+
+In order for Wasify to work, you need to install the same version of [wasi-vfs](https://github.com/kateinoigakukun/wasi-vfs#installation) used by the original [ruby.wasm](https://github.com/ruby/ruby.wasm) binary, so be sure to get it before using it! At the time of writing this readme, you need to install **wasi-vfs v0.1.1**
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add wasify
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install wasify
+
+## Usage
+
+After installing the gem and the required dependencies, your project needs to get ready to be wasified.
+Your project's folder should include the following:
+* The project's Gemfile
+* a *src* folder, where all the Ruby code you need to run will be. Wasify works with multi-file projects, so you can add as many files as you want.
+
+When your project folder is ready, open it with your favourite terminal and call
+
+    $ wasify entrypoint.rb
+
+where *entrypoint.rb* is the entrypoint of your Ruby project. If you're working with a single-file project, *entrypoint.rb* will be that single file, if you're working with a multi-file project it will be the Ruby script to be run to make your project work.
+
+Wasify will generate two files: an 'index.html' file and a 'packed_ruby.wasm' file. The HTML file is needed to run the code on browser, while the packed_ruby.wasm is the new Ruby WASM binary that includes the dependencies specified in the Gemfile. To run on your browser locally, host them on a local HTTP server (check paths and ports in the index.html file if you need to change names or if you use a different port than 8080 on your local server).
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AlawysDelta/wasify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/AlawysDelta/wasify/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Wasify project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AlawysDelta/wasify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/exe/wasify

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'wasify'
+
+raise 'Wrong number of arguments! Usage: wasify entrypoint.rb' if ARGV.length != 1
+
+if ARGV[0] == 'prepack'
+  Wasify.prepack
+else
+  Wasify.pack
+  Wasify.generate_html(ARGV[0])
+end

data/lib/wasify/cmd_runner.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class Wasify
+  # methods interacting with the command line
+  class CMDRunner
+    def self.download_binary
+      system('curl -LO https://github.com/ruby/ruby.wasm/releases/latest/download/ruby-3_2-wasm32-unknown-wasi-full-js.tar.gz')
+    end
+
+    def self.unzip_binary
+      system('tar xfz ruby-3_2-wasm32-unknown-wasi-full-js.tar.gz')
+      system('chmod u+rw 3_2-wasm32-unknown-wasi-full-js')
+    end
+
+    def self.move_binary
+      system('mv 3_2-wasm32-unknown-wasi-full-js/usr/local/bin/ruby ruby.wasm')
+    end
+
+    def self.copy_gemfile
+      system('mkdir -p deps && cp -r Gemfile deps/Gemfile && cp -r Gemfile.lock deps/Gemfile.lock')
+    end
+
+    def self.fix_lockfile
+      system('bundle lock --add-platform wasm32-unknown')
+    end
+
+    def self.run_vfs
+      system('wasi-vfs pack ruby.wasm --mapdir /src::./src --mapdir /usr::./3_2-wasm32-unknown-wasi-full-js/usr --mapdir /deps::./deps -o packed_ruby.wasm')
+    end
+
+    def self.cleanup
+      system('rm -rf 3_2-wasm32-unknown-wasi-full-js')
+      system('rm ruby-3_2-wasm32-unknown-wasi-full-js.tar.gz')
+      system('rm ruby.wasm')
+      system('rm -rf deps')
+    end
+  end
+end

data/lib/wasify/deps_manager.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+class Wasify
+  # methods finding and copying dependecies
+  class DepsManager
+    def self.get_specs(deps)
+      bundler_specs = Bundler.load.specs
+      lf = bundler_specs.map(&:loaded_from)
+      lf.select! { |item| !item.include?("/bundler-") && !item.include?("/wasify-") }
+
+      spec_paths = []
+      lf.each do |spec_path_str|
+        if File.exist?(spec_path_str)
+          spec_paths.append(spec_path_str)
+        else
+          loop do
+            puts "#{spec_path_str} doesn't exist. Specify gemspec path or write 'skip' to skip specfile."
+            path = $stdin.gets.chomp
+            break if File.exist?(path) || (path == 'skip')
+          end
+          spec_paths.append(path) unless path == 'skip'
+        end
+      end
+      spec_paths
+    end
+
+    def self.get_deps
+      deps = Bundler.load.specs.map(&:full_gem_path)
+      modded_string_deps = []
+      deps.each do |i|
+        modded_string_deps.append(i)
+      end
+      modded_string_deps
+    end
+
+    def self.copy_deps
+      deps = get_deps
+      deps.each do |i|
+        status = system("cp -r #{i} ./3_2-wasm32-unknown-wasi-full-js/usr/local/lib/ruby/gems/3.2.0/gems")
+        puts "Gem at #{i} not copied." unless status
+      end
+    end
+
+    def self.copy_specs
+      deps = get_deps
+      specs = get_specs(deps)
+      specs.each do |s|
+        status = system("cp #{s} ./3_2-wasm32-unknown-wasi-full-js/usr/local/lib/ruby/gems/3.2.0/specifications")
+        puts "Specification at #{s} not copied." unless status
+      end
+    end
+
+    def self.add_entrypoint(entrypoint)
+      entrypoint = entrypoint[4..-1] if entrypoint.start_with?("src/") && !File.exist?("src/#{entrypoint}")
+
+      raise 'Invalid entrypoint! Entrypoint must be a Ruby script' unless entrypoint.include?('.rb')
+      raise 'Entrypoint does not exist! All scripts must be in the src folder.' unless File.exist?("src/#{entrypoint}")
+
+      entrypoint = entrypoint.delete_suffix('.rb')
+      <<-HTML
+        require "bundler/setup"
+        require_relative "/src/#{entrypoint}"
+      HTML
+    end
+  end
+end

data/lib/wasify/template.erb

@@ -0,0 +1,24 @@
+
+      <html>
+      <script src="https://cdn.jsdelivr.net/npm/@ruby/wasm-wasi@latest/dist/browser.umd.js"></script>
+      <script>
+        const { DefaultRubyVM } = window["ruby-wasm-wasi"];
+        const main = async () => {
+          const response = await fetch(
+            "http://localhost:8080/packed_ruby.wasm");
+          const buffer = await response.arrayBuffer();
+          const module = await WebAssembly.compile(buffer);
+          const { vm } = await DefaultRubyVM(module);
+
+          vm.printVersion();
+          vm.eval(`
+                 <%= "#{entrypoint_txt}" %>
+          `);
+        };
+
+      main();
+      </script>
+
+      <body></body>
+
+      </html>

data/lib/wasify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Wasify
+  VERSION = '0.1.1'
+end

data/lib/wasify.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'wasify/version'
+require 'bundler'
+require 'erb'
+require_relative 'wasify/cmd_runner'
+require_relative 'wasify/deps_manager'
+# wrapper for Wasify
+class Wasify
+  def self.prepack
+    CMDRunner.download_binary unless File.exist?('ruby-3_2-wasm32-unknown-wasi-full-js.tar.gz')
+    CMDRunner.unzip_binary unless Dir.exist?('ruby-3_2-wasm32-unknown-wasi-full-js')
+    CMDRunner.move_binary unless File.exist?('ruby.wasm')
+    CMDRunner.fix_lockfile
+    CMDRunner.copy_gemfile
+    File.delete('packed_ruby.wasm') if File.exist?('packed_ruby.wasm')
+    DepsManager.copy_deps
+    DepsManager.copy_specs
+  end
+
+  def self.build_wasm
+    CMDRunner.run_vfs
+  end
+
+  def self.cleanup
+    CMDRunner.cleanup
+  end
+
+  def self.pack
+    prepack
+    build_wasm
+    cleanup
+  end
+
+  def self.generate_html(entrypoint)
+    entrypoint_txt = DepsManager.add_entrypoint(entrypoint)
+    template = 'wasify/template.erb'
+    html = ERB.new(File.read(File.join(__dir__, template))).result(binding)
+    File.rename('index.html', 'index.html.bak') if File.exist?('index.html')
+    File.open('index.html', 'w+') do |f|
+      f.write html
+    end
+  end
+end

data/sig/wasify.rbs

@@ -0,0 +1,4 @@
+module Wasify
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/wasify.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/wasify/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'wasify'
+  spec.version = Wasify::VERSION
+  spec.authors = ['Giovanni Borgh']
+  spec.email = ['gio96b@gmail.com']
+
+  spec.summary = 'Packs and run Ruby code on WASM'
+  spec.license = 'MIT'
+  spec.homepage = 'https://github.com/AlawysDelta/wasify'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/AlawysDelta/wasify'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = ['wasify']
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: wasify
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Giovanni Borgh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-09 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- gio96b@gmail.com
+executables:
+- wasify
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/wasify
+- lib/wasify.rb
+- lib/wasify/cmd_runner.rb
+- lib/wasify/deps_manager.rb
+- lib/wasify/template.erb
+- lib/wasify/version.rb
+- sig/wasify.rbs
+- wasify.gemspec
+homepage: https://github.com/AlawysDelta/wasify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AlawysDelta/wasify
+  source_code_uri: https://github.com/AlawysDelta/wasify
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Packs and run Ruby code on WASM
+test_files: []