wag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8db1e828d1c55e0c59b0a6539f5dcad050122978b58aaa58c50c81df127d7ba5
+  data.tar.gz: a607dc324fbb937d62d805ebb3ca78ca1e1ace3f2e76f5d2be5f3f91286414aa
+SHA512:
+  metadata.gz: d1126a636ca4025172739c045f2db368570fd81d0a9f74d871a9804f605afe194e3a9183ac1f508dd9a69b5583cb8aa3a122c0164657d3e18aa9b8ada316132a
+  data.tar.gz: 453b4607afe93437cdbacb39156bcb9915e0fba5d40f4bce6337d2974af211efcf79c478e1f292f4cd853aeb7a023a831941c81b561973f5acf2b9b78d031b6a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+image: ruby:latest
+
+before_script:
+  - apt-get update && apt-get install wabt && rm -rf /var/cache/apt
+  - bundle install
+
+test:
+  stage: test
+  script:
+    - bundle exec rspec
+
+rubocop:
+  stage: test
+  script:
+    - bundle exec rspec

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+Layout/LineLength:
+  Max: 120
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/OptionalArguments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wag.gemspec
+gemspec
+
+gem 'pry', '~> 0.13.0'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 0.80.1'
+
+gem 'faker', '~> 2.11'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    wag (0.1.0)
+      dry-inflector (~> 0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    dry-inflector (0.2.0)
+    faker (2.11.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.11)
+  pry (~> 0.13.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80.1)
+  wag!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,40 @@
+Copyright 2020 James Harton
+
+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.
+
+* No Harm: The software may not be used by anyone for systems or activities that
+actively and knowingly endanger, harm, or otherwise threaten the physical,
+mental, economic, or general well-being of other individuals or groups, in
+violation of the United Nations Universal Declaration of Human Rights
+(https://www.un.org/en/universal-declaration-human-rights/).
+
+* Services: If the Software is used to provide a service to others, the licensee
+shall, as a condition of use, require those others not to use the service in any
+way that violates the No Harm clause above.
+
+* Enforceability: If any portion or provision of this License shall to any
+extent be declared illegal or unenforceable by a court of competent
+jurisdiction, then the remainder of this License, or the application of such
+portion or provision in circumstances other than those as to which it is so
+declared illegal or unenforceable, shall not be affected thereby, and each
+portion and provision of this Agreement shall be valid and enforceable to the
+fullest extent permitted by law.
+
+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.
+
+This Hippocratic License is an Ethical Source license
+(https://ethicalsource.dev) derived from the MIT License, amended to limit the
+impact of the unethical use of open source software.

data/README.md

@@ -0,0 +1,170 @@
+# WAG - The WebAssembly Code Generator
+
+This Ruby gem allows you to generate WebAssembly programs programmatically using
+a DSL.
+
+It is closely modeled after WAT, the WebAssembly text format, and at this stage
+generates WAT and compiles and validates it using [the WebAssembly Binary Toolkit][1].
+
+Due to the flexibility of WAT this library is very flexible in what structures
+it allows you to create.  Be aware that you can build modules which are not
+valid WASM.  Always validate your modules by using `#to_wasm.valid?`.
+
+## Keyword conflict
+
+Any WASM instructions whose name conflicts with a Ruby keyword (eg `loop`,
+`return`, etc) are also aliased with a underscore suffix for use in the DSL. The
+methods defining the original names are also there, so can be used by the likes
+of `public_send`, etc.
+
+## Folding
+
+WAG supports generating both the "folded" and "unfolded" variants of the WAT
+language.  As an example here are two implementations of Euclid's Greatest
+Common Divisor algorithm:
+
+### Example of unfolded generation
+
+```ruby
+unfolded = WAG::Module.new.build do
+  func(:gcd) do
+    param(:a, :i32)
+    param(:b, :i32)
+    result(:i32)
+    local(:r, :i32)
+
+    block
+    loop_
+
+    # let r = a % b
+    local.get(:a)
+    local.get(:b)
+    i32.rem_s
+    local.set(:r)
+
+    # let a = b and b = R
+    local.get(:b)
+    local.set(:a)
+    local.get(:r)
+    local.set(:b)
+
+
+    # if a % b == 0, return b
+    local.get(:a)
+    local.get(:b)
+    i32.rem_s
+    i32.eqz
+    br_if 1
+
+    br 0
+    end_
+    end_
+
+    local.get(:b)
+    return_
+  end
+  export("gcd").func(:gcd)
+end
+```
+
+### Example of folded generation
+```ruby
+folded = WAG::Module.new.build do
+  func(:gcd) do
+    param(:a, :i32)
+    param(:b, :i32)
+    result(:i32)
+
+    local(:r, :i32)
+
+    block do
+      loop_ do
+        # let r = a % b
+        local.set(:r) do
+          i32.rem_s do
+            local.get(:a)
+            local.get(:b)
+          end
+        end
+
+        # let a = b and b = R
+        local.set(:a) do
+          local.get(:b)
+        end
+        local.set(:b) do
+          local.get(:r)
+        end
+
+        # if a % b == 0, return b
+        br_if(1) do
+          i32.eqz do
+            i32.rem_s do
+              local.get(:a)
+              local.get(:b)
+            end
+          end
+        end
+
+        br 0
+      end
+    end
+
+    return_ do
+      local.get(:b)
+    end
+  end
+  export("gcd") do
+    func(:gcd)
+  end
+end
+```
+
+Both modules emit identical WASM bytecode and produce the same answers:
+
+```ruby
+folded.to_wasm.save("folded.wasm")
+unfolded.to_wasm.save("unfolded.wasm")
+```
+
+```bash
+$ sha256sum folded.wasm unfolded.wasm
+0023ef97eba001226401e432912f2e644a6cbef107ba183546c51177eee46e2c  folded.wasm
+0023ef97eba001226401e432912f2e644a6cbef107ba183546c51177eee46e2c  unfolded.wasm
+$ wasmtime folded.wasm --invoke gcd 270 192
+6
+$ wasmtime unfolded.wasm --invoke gcd 270 192
+6
+```
+
+1: https://github.com/WebAssembly/wabt
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'wag'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wag
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/jimsy/wag.
+
+## License
+
+The gem is available as open source under the terms of the [Hippocratic License](https://firstdonoharm.dev/version/2/1/license.html).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'wag'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wag.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'wag/version'
+
+module WAG
+  class Error < StandardError; end
+  # Your code goes here...
+
+  require 'wag/encodable'
+  require 'wag/inflector'
+  require 'wag/instructable'
+
+  require 'wag/data'
+  require 'wag/element'
+  require 'wag/export'
+  require 'wag/f32_instructions'
+  require 'wag/f64_instructions'
+  require 'wag/function'
+  require 'wag/function_type'
+  require 'wag/global_instructions'
+  require 'wag/global'
+  require 'wag/i32_instructions'
+  require 'wag/i64_instructions'
+  require 'wag/import'
+  require 'wag/indices'
+  require 'wag/instruction'
+  require 'wag/label'
+  require 'wag/local_instructions'
+  require 'wag/local'
+  require 'wag/memory_instructions'
+  require 'wag/memory'
+  require 'wag/module'
+  require 'wag/param'
+  require 'wag/result'
+  require 'wag/table'
+  require 'wag/then'
+  require 'wag/type'
+
+  require 'wag/wabt'
+  require 'wag/wasm'
+  require 'wag/wat'
+end