wasmify-rails 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a391ad32c5709fedb1427c1802781700d9f71a7c9b18633369440246a89ade7e
-  data.tar.gz: db08da5b58547b4ec76874fdec3adecea88c99178f6aa863fc2e95c5e2f14942
+  metadata.gz: 3ba6a11376e388d3ded351a2c72bfed1bab2063c2b4eb98d8c63f1a5d50214e4
+  data.tar.gz: 8444b60b24fbfac498cf489c09ad0d4787552cee1e921cb3c9f5dece19643666
 SHA512:
-  metadata.gz: 7b823f898970c450844294c43bcbb2776c0ce6c0ec1953213a798cf203d3f42b61d503a768a1f74a0173a9f4a7c72346612ace29a7caea39020c52ad9cc133e6
-  data.tar.gz: 4c3b55592d56940b857a9b6424dbefa859435630a53f9ef05b6e71351e96788084ced7b4cdddc801d4fc8c8fd3893c91e2e339b362f59af33a4c23e39eecc71f
+  metadata.gz: 653e2e65cbeb368db2da8b6c357e25d6b017750d906b08a2e60bd71e24c9b5f6410970223a5c13cb806a99b495eb3256b3e1c5964181f0ad0e51a0d85e2190d3
+  data.tar.gz: 105c28242943f9055901e116fb4bac929028b225751d49f5745a3304683a8fb8cb7f8a917119aa63fa0bab1d127b7d96bd1ac2ff12dff3b31e053507549f7d28

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 0.3.1
+
+- Use latest patch versions for Ruby 3.3 and 3.4.
+
+## 0.3.0
+
+- Add `ignore_gem_extensions` configuration option.
+
+- Make it possible to use builder and packer without Rails.
+
 ## 0.2.3
 
 - Add `skipInitialize` option to `initVM`.

data/README.md

@@ -188,6 +188,21 @@ This gem provides a variety of _adapters_ and plugins to make your Rails applica
 
   - `Rack::DataUriUploads` middleware to transparently transform Data URI uploads into files.
 
+## Known Issues
+
+### `can't load bigdecimal.so`
+
+Compiling `bigdecimal` as a gem (not a part of the Ruby distribution, i.e., when using recent Ruby versions) doesn't work; at the same time, modern Rails versions have `require 'bigdecimal` call on boot. Currently, we propose the following workaround:
+
+- Add `bigdecimal` to the `ignore_gem_extensions` list in the `wasmify.yml` file.
+- Add the following line to your `config/application.rb` file (before loading Wasm shims):
+
+```ruby
+$LOADED_FEATURES << $LOAD_PATH.resolve_feature_path("bigdecimal")[1]
+```
+
+We do not include this patch by default hoping that we can have a proper fix in the future.
+
 ## Roadmap
 
 - PGLite support (see [this example](https://github.com/kateinoigakukun/mastodon/blob/fff2e4a626a20a616c546ddf4f91766abaf1133a/pwa/dist/pglite.rb#L1))

data/lib/generators/wasmify/install/install_generator.rb

@@ -133,7 +133,7 @@ class Wasmify::InstallGenerator < Rails::Generators::Base
   def finish
     run "bundle install"
 
-    say_status :info, "✅ The application is prepared for Wasm-ificaiton!\n\n" \
+    say_status :info, "✅ The application is prepared for Wasm-ification!\n\n" \
                       "Next steps are:\n" \
                       " - Check your Gemfile: add `group: [:default, :wasm]` to the dependencies required in Wasm runtime" \
                       " - Run `bin/rails wasmify:build:core:verify` to see if the bundle compiles"

data/lib/generators/wasmify/install/templates/config/wasmify.yml

@@ -16,3 +16,9 @@ exclude_gems:
   - io-console
   - psych
   - date
+
+# Skip building native extensions for the following gems (and keep their Ruby source)
+# ignore_gem_extensions:
+#  - bigdecimal
+#  - date
+#

data/lib/wasmify/rails/builder.rb

@@ -5,10 +5,22 @@ require "wasmify-rails"
 require "ruby_wasm"
 require "ruby_wasm/cli"
 
+# Patch ruby.wasm CLI to use the latest patch versions of Ruby
+RubyWasm::CLI.singleton_class.prepend(Module.new do
+  def build_source_aliases(root)
+    super.tap do |sources|
+      sources["3.3"][:url] = "https://cache.ruby-lang.org/pub/ruby/3.3/ruby-3.3.8.tar.gz"
+      sources["3.4"][:url] = "https://cache.ruby-lang.org/pub/ruby/3.4/ruby-3.4.3.tar.gz"
+    end
+  end
+end)
+
 module Wasmify
   module Rails
     # A wrapper for rbwasm build command
     class Builder
+      ORIGINAL_EXCLUDED_GEMS = RubyWasm::Packager::EXCLUDED_GEMS.dup.freeze
+
       attr_reader :output_dir, :target
 
       def initialize(output_dir: Wasmify::Rails.config.tmp_dir, target: Wasmify::Rails.config.wasm_target)
@@ -16,16 +28,28 @@ module Wasmify
         @target = target
       end
 
-      def run(name:, exclude_gems: [], opts: "")
+      def run(name:, exclude_gems: [], ignore_extensions: [], opts: "")
+        # Reset excluded gems
+        RubyWasm::Packager::EXCLUDED_GEMS.replace(ORIGINAL_EXCLUDED_GEMS)
+        $exclude_gems = []
         $exclude_exts = []
 
         # Add configured excluded gems
         Wasmify::Rails.config.exclude_gems.each do |gem_name|
-          $exclude_exts << gem_name
+          RubyWasm::Packager::EXCLUDED_GEMS << gem_name
+        end
+
+        # Add configured excluded extensions
+        Wasmify::Rails.config.ignore_gem_extensions.each do |ext_name|
+          $exclude_exts << ext_name
         end
 
         # Add additional excluded gems
         exclude_gems.each do |gem_name|
+          RubyWasm::Packager::EXCLUDED_GEMS << gem_name
+        end
+
+        ignore_extensions.each do |gem_name|
           $exclude_exts << gem_name
         end
 
@@ -46,7 +70,7 @@ module Wasmify
           -o #{File.join(output_dir, name)}
         ) + opts
 
-        patches_dir = ::Rails.root.join("ruby_wasm_patches").to_s
+        patches_dir = Wasmify::Rails.config.root_dir.join("ruby_wasm_patches").to_s
 
         if File.directory?(patches_dir)
           Dir.children(patches_dir).each do |patch|

data/lib/wasmify/rails/configuration.rb

@@ -1,28 +1,30 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module Wasmify
   module Rails
-    RUBY_VERSION_TO_WASM_RUBY_VERSION = {
-      "3.3" => "3.3.3",
-      "3.2" => "3.2.4"
-    }
-
     class Configuration
-      attr_reader :pack_directories, :exclude_gems, :ruby_version,
+      attr_reader :pack_directories, :pack_root, :additional_root_files,
+                  :exclude_gems, :ignore_gem_extensions,
+                  :ruby_version,
                   :tmp_dir, :output_dir, :wasm_target,
                   :skip_assets_precompile
 
       def initialize
-        config_path = ::Rails.root.join("config", "wasmify.yml")
+        config_path = ENV.fetch("WASMIFY_CONFIG_PATH") { root_dir.join("config", "wasmify.yml") }
         raise "config/wasmify.yml not found" unless File.exist?(config_path)
 
         config = YAML.load_file(config_path)
 
         @pack_directories = config["pack_directories"]
-        @exclude_gems = config["exclude_gems"]
+        @additional_root_files = config["additional_root_files"]
+        @exclude_gems = config["exclude_gems"] || []
+        @ignore_gem_extensions = config["ignore_gem_extensions"] || []
+        @pack_root = config["pack_root"] || "/rails"
         @ruby_version = config["ruby_version"] || ruby_version_from_file || "3.3"
-        @tmp_dir = config["tmp_dir"] || ::Rails.root.join("tmp", "wasmify")
-        @output_dir = config["output_dir"] || ::Rails.root.join("dist")
+        @tmp_dir = config["tmp_dir"] || root_dir.join("tmp", "wasmify")
+        @output_dir = config["output_dir"] || root_dir.join("dist")
         @skip_assets_precompile = config["skip_assets_precompile"] || false
         @wasm_target = config["wasm_target"] || "wasm32-unknown-wasip1"
       end
@@ -37,12 +39,18 @@ module Wasmify
 
       def ruby_version = @ruby_version ||= ruby_version_from_file || "3.3"
 
+      def root_dir
+        return ::Rails.root if defined?(::Rails) && ::Rails.respond_to?(:root)
+
+        Pathname.new(Dir.pwd)
+      end
+
       private
 
       def ruby_version_from_file
-        return unless File.file?(::Rails.root.join(".ruby-version"))
+        return unless File.file?(root_dir.join(".ruby-version"))
 
-        File.read(::Rails.root.join(".ruby-version")).strip.match(/(\d+\.\d+(?:\.d+)?)/).then do |matches|
+        File.read(root_dir.join(".ruby-version")).strip.match(/(\d+\.\d+(?:\.d+)?)/).then do |matches|
           matches[1] if matches
         end
       end

data/lib/wasmify/rails/packer.rb

@@ -12,7 +12,24 @@ module Wasmify
 
       attr_reader :output_dir
 
-      include ActionView::Helpers::NumberHelper
+      if defined?(ActionView::Helpers::NumberHelper)
+        include ActionView::Helpers::NumberHelper
+      else
+        include(Module.new do
+          def number_to_human_size(num)
+            num = num.to_i
+            human_size = case
+            when num < 1024
+              "#{num} bytes"
+            when num < 1024*1024
+              "#{(num.to_f/1024).round(1)} KB"
+            else
+              "#{(num.to_f/1024/1024).round(1)} MB"
+            end
+            human_size
+          end
+        end)
+      end
 
       def initialize(output_dir: Wasmify::Rails.config.output_dir)
         @output_dir = output_dir
@@ -24,12 +41,14 @@ module Wasmify
                "Please see installations instructions at: https://github.com/kateinoigakukun/wasi-vfs"
         end
 
+        pack_root = Wasmify::Rails.config.pack_root
+
         args = %W[
           pack #{ruby_wasm_path}
         ]
 
         directories.each do |dir|
-          args << "--dir #{::Rails.root.join(dir)}::/rails/#{dir}"
+          args << "--dir #{Wasmify::Rails.config.root_dir.join(dir)}::#{pack_root}/#{dir}"
         end
 
         output_path = File.join(output_dir, name)
@@ -38,14 +57,14 @@ module Wasmify
 
         # Generate a temporary directory with the require root files
         Dir.mktmpdir do |tdir|
-          ROOT_FILES.each do |file|
-            FileUtils.cp(::Rails.root.join(file), tdir) if File.exist?(::Rails.root.join(file))
+          (ROOT_FILES + (Wasmify::Rails.config.additional_root_files || [])).each do |file|
+            FileUtils.cp(Wasmify::Rails.config.root_dir.join(file), tdir) if File.exist?(Wasmify::Rails.config.root_dir.join(file))
           end
 
           # Create a storage/ directory for Active Storage attachments
           FileUtils.mkdir_p(File.join(tdir, storage_dir)) if storage_dir
 
-          args << "--dir #{tdir}::/rails"
+          args << "--dir #{tdir}::#{pack_root}"
 
           args << "-o #{output_path}"
 

data/lib/wasmify/rails/railtie.rb

@@ -15,3 +15,15 @@ module Wasmify
     end
   end
 end
+
+
+require "action_mailer/null_delivery"
+
+# 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")
+
+# PGlite adapter
+ActiveRecord::ConnectionAdapters.register("pglite", "ActiveRecord::ConnectionAdapters::PGliteAdapter", "active_record/connection_adapters/pglite_adapter")

data/lib/wasmify/rails/shims/rails-html-sanitizer.rb

@@ -135,6 +135,9 @@ module Rails
     class NullSanitizer
       class << self
         def safe_list_sanitizer = self
+        def full_sanitizer = self
+        def link_sanitizer = self
+        def safe_list_sanitizer = self
       end
 
       def sanitize(html, ...) = html

data/lib/wasmify/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Wasmify
   module Rails # :nodoc:
-    VERSION = "0.2.3"
+    VERSION = "0.3.1"
   end
 end

data/lib/wasmify-rails.rb

@@ -3,7 +3,7 @@
 require "wasmify/rails/version"
 require "wasmify/rails/configuration"
 require "wasmify/rails/shim"
-require "wasmify/rails/railtie"
+require "wasmify/rails/railtie" if defined?(::Rails::Railtie)
 
 module Wasmify
   module Rails
@@ -17,14 +17,3 @@ end
 module ImageProcessing
   autoload :Null, "image_processing/null"
 end
-
-require "action_mailer/null_delivery"
-
-# 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")
-
-# PGlite adapter
-ActiveRecord::ConnectionAdapters.register("pglite", "ActiveRecord::ConnectionAdapters::PGliteAdapter", "active_record/connection_adapters/pglite_adapter")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wasmify-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties