wasmify-rails 0.1.0

data/lib/wasmify/rails/tasks.rake

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+namespace :wasmify do
+  desc "Install wasmify-rails"
+  task :install do
+    Rails::Command.invoke :generate, ["wasmify:install"]
+  end
+
+  desc "Generate a PWA application to serve the Rails Wasm app"
+  task :pwa do
+    Rails::Command.invoke :generate, ["wasmify:pwa"]
+  end
+
+  desc "Build ruby.wasm with all dependencies"
+  task :build do
+    unless ENV["BUNDLE_ONLY"] == "wasm"
+      next spawn("BUNDLE_ONLY=wasm bundle exec rails wasmify:build").then { Process.wait(_1) }
+    end
+
+    require "wasmify/rails/builder"
+
+    builder = Wasmify::Rails::Builder.new
+    builder.run(name: "ruby.wasm")
+  end
+
+  namespace :build do
+    desc "Build ruby.wasm with all dependencies but JS shim (to use with wasmtime)"
+    task :core do
+      unless ENV["BUNDLE_ONLY"] == "wasm"
+        next spawn("BUNDLE_ONLY=wasm bundle exec rails wasmify:build:core").then { Process.wait(_1) }
+      end
+
+      require "wasmify/rails/builder"
+
+      builder = Wasmify::Rails::Builder.new
+      builder.run(name: "ruby-core.wasm", exclude_gems: ["js"])
+    end
+
+    namespace :core do
+      desc "Test that compiled ruby-core.wasm works (print Rails version)"
+      task :verify do
+        require "wasmify/rails/wasmtimer"
+
+        wasm_path = File.join(Wasmify::Rails.config.tmp_dir, "ruby-core.wasm")
+        Wasmify::Rails::Wasmtimer.run(
+          wasm_path,
+          <<~'RUBY'
+            require "wasmify/rails/shim"
+            require "rails"
+            puts "Your Rails version is: #{Rails.version} [#{RUBY_PLATFORM}]"
+          RUBY
+        )
+      end
+    end
+  end
+
+  desc "Pack the application into to a single module"
+  task pack: :build do
+    # First, precompile assets
+    unless Wasmify::Rails.config.skip_assets_precompile
+      Bundler.with_unbundled_env do
+        spawn("SECRET_KEY_BASE_DUMMY=1 RAILS_ENV=production bundle exec rails assets:precompile").then { Process.wait(_1) }
+      end
+    end
+
+    require "wasmify/rails/packer"
+
+    packer = Wasmify::Rails::Packer.new
+
+    packer.run(name: "app.wasm", ruby_wasm_path: File.join(Wasmify::Rails.config.tmp_dir, "ruby.wasm"))
+  end
+
+  namespace :pack do
+    desc "Pack the application into to a single module without JS shim"
+    task :core do
+      # First, precompile assets
+      unless Wasmify::Rails.config.skip_assets_precompile
+        Bundler.with_unbundled_env do
+          spawn("SECRET_KEY_BASE_DUMMY=1 RAILS_ENV=production bundle exec rails assets:precompile").then { Process.wait(_1) }
+        end
+      end
+
+      require "wasmify/rails/packer"
+
+      # Pack core module to the tmp dir (we only use it for testing purposes right now)
+      packer = Wasmify::Rails::Packer.new(
+        output_dir: Wasmify::Rails.config.tmp_dir
+      )
+
+      packer.run(name: "app-core.wasm",
+        ruby_wasm_path: File.join(Wasmify::Rails.config.tmp_dir, "ruby-core.wasm"),
+        storage_dir: "storage"
+      )
+    end
+
+    namespace :core do
+      desc "Test that the Rails application boots"
+      task :verify do
+        require "wasmify/rails/wasmtimer"
+
+        wasm_path = File.join(Wasmify::Rails.config.tmp_dir, "app-core.wasm")
+        Wasmify::Rails::Wasmtimer.run(
+          wasm_path,
+          <<~'RUBY'
+            ENV["RAILS_ENV"] = "wasm"
+            ENV["DEBUG"] = "1"
+            # ENV["ACTIVE_RECORD_ADAPTER"] = "sqlite3_wasm"
+            require "/rails/config/application"
+            puts "Initializing Rails application..."
+            Rails.application.initialize!
+            puts "Rails application initialized!\n\nLets try to make a request..."
+
+            request = Rack::MockRequest.env_for("http://localhost:3000", {"HTTP_HOST" => "localhost"})
+            puts Rails.application.call(request)
+          RUBY
+        )
+      end
+    end
+  end
+end

data/lib/wasmify/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wasmify
+  module Rails # :nodoc:
+    VERSION = "0.1.0"
+  end
+end

data/lib/wasmify/rails/wasmtimer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Wasmify
+  module Rails
+    # A wrapper for the wasmtime CLI used to
+    # verify compiled modules.
+    module Wasmtimer
+      class << self
+        def run(wasm_path, script)
+          return unless wasmtime_installed?
+
+          exec(%Q(wasmtime run --dir ./storage::/rails/storage #{wasm_path} -W0 -r/bundle/setup -e '#{script}'))
+        end
+
+        private
+
+        def wasmtime_installed?
+          unless system("which wasmtime > /dev/null 2>&1")
+            $stderr.puts "Wasmtime is required to verify Wasm builds.\nPlease see installations instructions at https://wasmtime.dev."
+            if RUBY_PLATFORM =~ /darwin/
+              $stderr.puts "You can also install it via Homebrew:\n  brew install wasmtime"
+            end
+            return false
+          end
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/wasmify-rails.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "wasmify/rails/version"
+require "wasmify/rails/configuration"
+require "wasmify/rails/shim"
+require "wasmify/rails/railtie"
+
+module Wasmify
+  module Rails
+    class << self
+      def config = @config ||= Configuration.new
+    end
+  end
+end
+
+# Autoloadable extensions
+module ImageProcessing
+  autoload :Null, "image_processing/null"
+end
+
+# NullDB for Active Record
+ActiveRecord::ConnectionAdapters.register("nulldb", "ActiveRecord::ConnectionAdapters::NullDBAdapter", "active_record/connection_adapters/nulldb_adapter")
+
+# SQLite3 Wasm adapter
+ActiveRecord::ConnectionAdapters.register("sqlite3_wasm", "ActiveRecord::ConnectionAdapters::SQLite3WasmAdapter", "active_record/connection_adapters/sqlite3_wasm_adapter")

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: wasmify-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Dementyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: ruby_wasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: js
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Tools and extensions to package Rails apps as Wasm modules
+email:
+- Vladimir Dementyev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/active_record/connection_adapters/nulldb_adapter.rb
+- lib/active_record/connection_adapters/nulldb_adapter/checkpoint.rb
+- lib/active_record/connection_adapters/nulldb_adapter/column.rb
+- lib/active_record/connection_adapters/nulldb_adapter/configuration.rb
+- lib/active_record/connection_adapters/nulldb_adapter/core.rb
+- lib/active_record/connection_adapters/nulldb_adapter/empty_result.rb
+- lib/active_record/connection_adapters/nulldb_adapter/index_definition.rb
+- lib/active_record/connection_adapters/nulldb_adapter/null_object.rb
+- lib/active_record/connection_adapters/nulldb_adapter/quoting.rb
+- lib/active_record/connection_adapters/nulldb_adapter/statement.rb
+- lib/active_record/connection_adapters/nulldb_adapter/table_definition.rb
+- lib/active_record/connection_adapters/sqlite3_wasm_adapter.rb
+- lib/active_storage/null_delivery.rb
+- lib/generators/wasmify/install/USAGE
+- lib/generators/wasmify/install/install_generator.rb
+- lib/generators/wasmify/install/templates/config/environments/wasm.rb
+- lib/generators/wasmify/install/templates/config/wasmify.yml
+- lib/generators/wasmify/pwa/USAGE
+- lib/generators/wasmify/pwa/pwa_generator.rb
+- lib/generators/wasmify/pwa/templates/pwa/README.md
+- lib/generators/wasmify/pwa/templates/pwa/boot.html
+- lib/generators/wasmify/pwa/templates/pwa/boot.js
+- lib/generators/wasmify/pwa/templates/pwa/database.js
+- lib/generators/wasmify/pwa/templates/pwa/index.html
+- lib/generators/wasmify/pwa/templates/pwa/package.json.tt
+- lib/generators/wasmify/pwa/templates/pwa/rails.sw.js
+- lib/generators/wasmify/pwa/templates/pwa/vite.config.js
+- lib/image_processing/null.rb
+- lib/wasmify-rails.rb
+- lib/wasmify/rails/builder.rb
+- lib/wasmify/rails/configuration.rb
+- lib/wasmify/rails/packer.rb
+- lib/wasmify/rails/railtie.rb
+- lib/wasmify/rails/shim.rb
+- lib/wasmify/rails/shims/io/console.rb
+- lib/wasmify/rails/shims/io/console/size.rb
+- lib/wasmify/rails/shims/io/wait.rb
+- lib/wasmify/rails/shims/ipaddr.rb
+- lib/wasmify/rails/shims/nio.rb
+- lib/wasmify/rails/shims/nokogiri.rb
+- lib/wasmify/rails/shims/nokogiri/nokogiri.rb
+- lib/wasmify/rails/shims/rails-html-sanitizer.rb
+- lib/wasmify/rails/shims/socket.rb
+- lib/wasmify/rails/shims/sqlite3.rb
+- lib/wasmify/rails/tasks.rake
+- lib/wasmify/rails/version.rb
+- lib/wasmify/rails/wasmtimer.rb
+homepage: https://github.com/palkan/wasmify-rails
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/palkan/wasmify-rails/issues
+  changelog_uri: https://github.com/palkan/wasmify-rails/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/palkan/wasmify-rails
+  homepage_uri: https://github.com/palkan/wasmify-rails
+  source_code_uri: https://github.com/palkan/wasmify-rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Tools and extensions to package Rails apps as Wasm modules
+test_files: []