RubyGems - ruby_wasm_ui - Versions diffs - 0.8.3 → 0.9.1 - Mend

ruby_wasm_ui 0.8.3 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b322433e65bc63155825e97695c798bce90602a54e52797cd040aea67b909751
-  data.tar.gz: 1655781e0e93952e5f2ecc2e450d5a9286718979f3201f0169ae35dc94979872
+  metadata.gz: bd9d0a33dc10a59959527fb70eb2080fb612f5c1d07cea603eb23ca5c957f342
+  data.tar.gz: c5dad3fabee2912ea43fe45d0fdbc899357323e127edd572b5572d4cc474a3cd
 SHA512:
-  metadata.gz: 97e3cf3322340377c5cb75d74796bd20096d604d9ef1efe87ed9598d8394ae76ad6d7b481c43c3e721b683208489083164b6c7730b09106f4dceefdb8647a52c
-  data.tar.gz: 7d04075d81325a78375ffbd9d711e82af3a48531acc9eec340f6d71df76501741d4573bae368eca7ae14c752c1f4fb8c894ee028007c028df39cab2595ef10a1
+  metadata.gz: 7cd4c88f0f24adb3521448e94eae17a69836b517bf916e752e8dcb69793d8ec22930eda80a5492f4f5118fabeb546112e6bf142854beee415574ba55474f7b9c
+  data.tar.gz: 316e8854f16c214e0f0ce488584d5c3c0ace723fe7b5cd47f45e3961367c29cb72073772519944c71e6d1e8d50db3020e25844c3f6f2224c2dda4412fe414ccf

data/.github/workflows/rspec.yml CHANGED Viewed

@@ -24,10 +24,8 @@ jobs:
       - name: Install dependencies
         run: |
-          cd packages/npm-packages/runtime
           bundle install
       - name: Run RSpec
         run: |
-          cd packages/npm-packages/runtime
           bundle exec rspec

data/Makefile ADDED Viewed

@@ -0,0 +1,56 @@
+.PHONY: bump help
+help:
+	@echo "Usage: make bump <version>"
+	@echo "       make bump VERSION=<version>"
+	@echo "Example: make bump 0.9.0"
+	@echo ""
+	@echo "This command updates the version number in the following files:"
+	@echo "  - lib/ruby_wasm_ui/version.rb"
+	@echo "  - package.json"
+	@echo "  - packages/npm-packages/runtime/package.json"
+	@echo "  - README.md"
+	@echo "  - package-lock.json (via npm install)"
+	@echo "  - packages/npm-packages/runtime/package-lock.json (via npm install)"
+# Get version from position argument (if VERSION is not already set)
+VERSION_ARG := $(word 2,$(MAKECMDGOALS))
+ifndef VERSION
+  ifneq ($(VERSION_ARG),)
+    VERSION := $(VERSION_ARG)
+  endif
+endif
+bump:
+	@if [ -z "$(VERSION)" ]; then \
+		echo "Error: VERSION is required. Usage: make bump 0.9.0"; \
+		exit 1; \
+	fi
+	@echo "Bumping version to $(VERSION)..."
+	@# Update lib/ruby_wasm_ui/version.rb
+	@sed -i '' 's/VERSION = ".*"/VERSION = "$(VERSION)"/' lib/ruby_wasm_ui/version.rb
+	@echo "✓ Updated lib/ruby_wasm_ui/version.rb"
+	@# Update Gemfile.lock
+	@bundle install
+	@echo "✓ Updated Gemfile.lock"
+	@# Update root package.json
+	@sed -i '' 's/"version": ".*"/"version": "$(VERSION)"/' package.json
+	@echo "✓ Updated package.json"
+	@# Update packages/npm-packages/runtime/package.json
+	@sed -i '' 's/"version": ".*"/"version": "$(VERSION)"/' packages/npm-packages/runtime/package.json
+	@echo "✓ Updated packages/npm-packages/runtime/package.json"
+	@# Update README.md (unpkg.com URL)
+	@sed -i '' 's|unpkg.com/ruby-wasm-ui@[0-9.]*|unpkg.com/ruby-wasm-ui@$(VERSION)|' README.md
+	@echo "✓ Updated README.md"
+	@echo ""
+	@echo "Updating package-lock.json files..."
+	@npm install --package-lock-only
+	@echo "✓ Updated root package-lock.json"
+	@cd packages/npm-packages/runtime && npm install --package-lock-only && cd ../../..
+	@echo "✓ Updated packages/npm-packages/runtime/package-lock.json"
+	@echo ""
+	@echo "Version bumped to $(VERSION) successfully!"
+# Prevent make from treating the version argument as a target
+%:
+	@:

data/README.md CHANGED Viewed

@@ -21,7 +21,7 @@ Create an HTML file:
 <!DOCTYPE html>
 <html>
   <head>
-    <script src="https://unpkg.com/ruby-wasm-ui@0.8.3"></script>
+    <script src="https://unpkg.com/ruby-wasm-ui@0.9.1"></script>
     <script defer type="text/ruby" src="app.rb"></script>
   </head>
   <body>
@@ -112,19 +112,39 @@ bundle install
 ### Building Your Application
-1. Build Ruby WASM:
+1. Set up your project (first time only):
 ```bash
-bundle exec rbwasm build --ruby-version 3.4 -o ruby.wasm
+bundle exec ruby-wasm-ui setup
 ```
-2. Pack your application files:
+This command will:
+- Configure excluded gems for WASM build
+- Build Ruby WASM file
+- Update `.gitignore`
+- Create initial `src/index.html` and `src/index.rb` files
+**Additional Commands:**
+- **Development server**: Start a development server with file watching and auto-build:
+  ```bash
+  bundle exec ruby-wasm-ui dev
+  ```
+- **Rebuild Ruby WASM**: Rebuild the Ruby WASM file when you add new gems:
+  ```bash
+  bundle exec ruby-wasm-ui rebuild
+  ```
+### Deployment
+Pack your application files for deployment:
 ```bash
-bundle exec rbwasm pack ruby.wasm --dir ./src::./src -o src.wasm
+bundle exec ruby-wasm-ui pack
 ```
-This command packs your Ruby files from the `./src` directory into the WASM file.
+This command packs your Ruby files from the `./src` directory into the WASM file and outputs to the `dist` directory for deployment.
 ### Creating Your HTML File

data/examples/.gitignore ADDED Viewed

@@ -0,0 +1,4 @@
+ruby.wasm
+/rubies
+/build
+/dist

data/examples/Gemfile.lock CHANGED Viewed

@@ -1,38 +1,36 @@
 PATH
   remote: ../..
   specs:
-    ruby_wasm_ui (0.8.3)
+    ruby_wasm_ui (0.9.0)
       js (~> 2.7)
+      listen (~> 3.8)
+      puma (~> 6.0)
+      rack (~> 3.0)
       ruby_wasm (~> 2.7)
 GEM
   remote: https://rubygems.org/
   specs:
+    ffi (1.17.2-arm64-darwin)
     js (2.7.2)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
+    nio4r (2.7.5)
+    puma (6.6.1)
+      nio4r (~> 2.0)
+    rack (3.2.4)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
     ruby_wasm (2.7.2)
       logger
-    ruby_wasm (2.7.2-aarch64-linux)
-      logger
-    ruby_wasm (2.7.2-aarch64-linux-musl)
-      logger
     ruby_wasm (2.7.2-arm64-darwin)
       logger
-    ruby_wasm (2.7.2-x86_64-darwin)
-      logger
-    ruby_wasm (2.7.2-x86_64-linux)
-      logger
-    ruby_wasm (2.7.2-x86_64-linux-musl)
-      logger
 PLATFORMS
-  aarch64-linux
-  aarch64-linux-musl
   arm64-darwin
-  ruby
-  x86_64-darwin
-  x86_64-linux
-  x86_64-linux-musl
 DEPENDENCIES
   ruby_wasm_ui!

data/examples/src/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>My App</title>
+    <script type="module">
+      import { DefaultRubyVM } from "https://cdn.jsdelivr.net/npm/@ruby/wasm-wasi@2.7.2/dist/browser/+esm";
+      const response = await fetch("./src.wasm");
+      const module = await WebAssembly.compileStreaming(response);
+      const { vm } = await DefaultRubyVM(module);
+      vm.evalAsync(`
+        require "ruby_wasm_ui"
+        require_relative './src/index.rb'
+      `);
+    </script>
+  </head>
+  <body>
+    <h1>My App</h1>
+    <div id="app"></div>
+  </body>
+</html>

data/examples/src/index.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# Simple Hello World component
+HelloComponent = RubyWasmUi.define_component(
+  state: ->(props) {
+    { message: props[:message] || "Hello, Ruby WASM UI!" }
+  },
+  template: ->() {
+    RubyWasmUi::Template::Parser.parse_and_eval(<<~HTML, binding)
+      <div>
+        <h2>{state[:message]}</h2>
+        <button on="{ click: -> { update_message } }">
+          Click me!
+        </button>
+      </div>
+    HTML
+  },
+  methods: {
+    update_message: ->() {
+      update_state(message: "You clicked the button!")
+    }
+  }
+)
+# Create and mount the app
+app = RubyWasmUi::App.create(HelloComponent, message: "Hello, Ruby WASM UI!")
+app_element = JS.global[:document].getElementById("app")
+app.mount(app_element)

data/exe/ruby-wasm-ui ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require_relative "../lib/ruby_wasm_ui/cli/command"
+RubyWasmUi::Cli::Command.run(ARGV)

data/lib/ruby_wasm_ui/cli/command/base.rb ADDED Viewed

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+require "fileutils"
+require "open3"
+require "bundler/setup"
+require "ruby_wasm"
+require "ruby_wasm/cli"
+module RubyWasmUi
+  module Cli
+    class Command
+      class Base
+        def self.description
+          nil
+        end
+        def run(_argv)
+          raise NotImplementedError, "Subclasses must implement #run"
+        end
+        protected
+        def run_command(command, exit_on_error: true)
+          log_debug("Executing command: #{command}")
+          Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+            stdin.close
+            # Read stdout and stderr in separate threads for real-time output
+            stdout_thread = Thread.new do
+              stdout.each_line do |line|
+                print line
+                $stdout.flush
+              end
+            end
+            stderr_thread = Thread.new do
+              stderr.each_line do |line|
+                $stderr.print line
+                $stderr.flush
+              end
+            end
+            # Wait for both threads to finish reading
+            stdout_thread.join
+            stderr_thread.join
+            # Wait for the process to finish
+            exit_status = wait_thr.value
+            unless exit_status.success?
+              log_error("Command failed: #{command}")
+              if exit_on_error
+                raise SystemExit.new(exit_status.exitstatus)
+              else
+                return false
+              end
+            end
+            true
+          end
+        end
+        def ensure_src_directory
+          unless Dir.exist?("src")
+            log_error("src directory not found. Please run 'ruby-wasm-ui setup' first.")
+            raise SystemExit.new(1)
+          end
+        end
+        def ensure_ruby_wasm
+          unless File.exist?("ruby.wasm")
+            log_error("ruby.wasm not found. Please run 'ruby-wasm-ui setup' first.")
+            raise SystemExit.new(1)
+          end
+        end
+        protected
+        def log_info(message)
+          puts "[INFO] #{message}"
+        end
+        def log_success(message)
+          puts "[SUCCESS] #{message}"
+        end
+        def log_error(message)
+          puts "[ERROR] #{message}"
+        end
+        def log_debug(message)
+          puts "[DEBUG] #{message}"
+        end
+        def check_ruby_version
+          ruby_version = RUBY_VERSION.split('.').map(&:to_i)
+          major, minor = ruby_version[0], ruby_version[1]
+          if major < 3 || (major == 3 && minor < 2)
+            log_error("Ruby WASM requires Ruby 3.2 or higher. Current version: #{RUBY_VERSION}")
+            raise SystemExit.new(1)
+          end
+          "#{major}.#{minor}"
+        end
+        def configure_excluded_gems
+          # Get all gems from Bundler definition including all dependencies
+          definition = Bundler.definition
+          resolved = definition.resolve
+          # Get all resolved specs (including transitive dependencies)
+          all_specs = resolved.materialize(definition.requested_dependencies)
+          gem_names = all_specs.map(&:name).uniq
+          # Always exclude gems that cause WASM build errors
+          # These gems have native extensions that don't work in WASM environment
+          always_excluded = %w[nio4r puma rack listen ffi]
+          # Exclude gems that cause build errors or are unnecessary for WASM
+          # Keep essential gems like 'js' for WASM
+          excluded_gems = gem_names.select do |gem_name|
+            # Exclude gems that cause WASM build errors
+            always_excluded.include?(gem_name) ||
+              # Exclude development/test gems
+              gem_name.start_with?("rspec", "rubocop", "rake")
+          end
+          # Always add always_excluded gems to ensure they're excluded even if not in dependencies
+          excluded_gems.concat(always_excluded)
+          excluded_gems.uniq!
+          # Add to EXCLUDED_GEMS
+          RubyWasm::Packager::EXCLUDED_GEMS.concat(excluded_gems)
+        end
+        def build_ruby_wasm(ruby_version_str)
+          command = ["build", "--ruby-version", ruby_version_str, "-o", "ruby.wasm"]
+          cli = RubyWasm::CLI.new(stdout: $stdout, stderr: $stderr)
+          cli.run(command)
+        end
+        def ensure_dist_directory
+          unless Dir.exist?("dist")
+            Dir.mkdir("dist")
+            log_info("Created dist directory")
+          end
+        end
+        def copy_non_ruby_files
+          log_info("Copying non-Ruby files from src to dist...")
+          copied_files = []
+          Dir.glob("src/**/*").each do |src_path|
+            next if File.directory?(src_path)
+            next if src_path.end_with?(".rb")
+            # Get relative path from src directory
+            relative_path = src_path.sub(/^src\//, "")
+            dest_path = File.join("dist", relative_path)
+            # Create destination directory if needed
+            dest_dir = File.dirname(dest_path)
+            FileUtils.mkdir_p(dest_dir) unless Dir.exist?(dest_dir)
+            # Copy file
+            FileUtils.cp(src_path, dest_path)
+            copied_files << relative_path
+          end
+          if copied_files.any?
+            log_success("✓ Copied #{copied_files.size} file(s): #{copied_files.join(', ')}")
+          else
+            log_info("No non-Ruby files to copy")
+          end
+        end
+        def pack_wasm(exit_on_error: true, log_prefix: "Packing")
+          command = "bundle exec rbwasm pack ruby.wasm --dir ./src::./src -o dist/src.wasm"
+          log_info("#{log_prefix}: #{command}")
+          success = run_command(command, exit_on_error: exit_on_error)
+          if success
+            log_success("✓ Pack completed")
+          end
+          success
+        end
+      end
+    end
+  end
+end

data/lib/ruby_wasm_ui/cli/command/dev.rb ADDED Viewed

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+require_relative "base"
+require "listen"
+require "rack"
+require "thread"
+require "rbconfig"
+module RubyWasmUi
+  module Cli
+    class Command
+      class Dev < Base
+        def self.description
+          "Start development server with file watching and auto-build"
+        end
+        def run(_argv)
+          log_info("Starting development server...")
+          puts ""
+          ensure_src_directory
+          ensure_ruby_wasm
+          # Initial build
+          log_info("Performing initial build...")
+          build
+          log_success("✓ Initial build completed")
+          puts ""
+          # Start file watcher in a separate thread
+          @build_lock = Mutex.new
+          @build_queue = Queue.new
+          @listener = nil
+          @watcher_thread = nil
+          @watcher_thread = Thread.new do
+            start_file_watcher
+          end
+          # Register cleanup hook to ensure cleanup runs on exit
+          @cleanup_done = false
+          at_exit do
+            cleanup unless @cleanup_done
+          end
+          # Start development server
+          begin
+            start_server
+          ensure
+            cleanup
+          end
+        end
+        private
+        def open_browser(url)
+          case RbConfig::CONFIG["host_os"]
+          when /darwin/
+            system("open", url)
+          when /linux/
+            system("xdg-open", url)
+          when /mswin|mingw|cygwin/
+            system("start", url)
+          else
+            log_info("Please open #{url} in your browser")
+          end
+        rescue => e
+          log_info("Could not open browser automatically: #{e.message}")
+          log_info("Please open #{url} in your browser")
+        end
+        def cleanup
+          return if @cleanup_done
+          @cleanup_done = true
+          @listener&.stop
+          @watcher_thread&.kill
+        end
+        def build
+          ensure_dist_directory
+          success = pack_wasm(exit_on_error: false, log_prefix: "Building")
+          if success
+            copy_non_ruby_files
+            log_success("✓ Build completed")
+          else
+            log_error("Build failed")
+          end
+          success
+        end
+        def start_file_watcher
+          @listener = Listen.to("src") do |modified, added, removed|
+            files_changed = (modified + added + removed).reject do |file|
+              # Ignore temporary files and common build artifacts
+              file.end_with?(".swp", ".tmp", "~", ".wasm")
+            end
+            if files_changed.any?
+              log_info("Files changed: #{files_changed.join(', ')}")
+              # Debounce: add to queue
+              @build_queue << :build
+              # Process queue with debouncing
+              Thread.new do
+                sleep 0.5 # Debounce delay
+                begin
+                  if @build_queue.pop(true)
+                    @build_queue.clear
+                    @build_lock.synchronize do
+                      build
+                    end
+                  end
+                rescue ThreadError
+                  # Queue is empty, ignore
+                end
+              end
+            end
+          end
+          @listener.start
+        rescue => e
+          log_error("File watcher error: #{e.message}")
+        end
+        def start_server
+          port = 8080
+          log_info("Starting development server on http://localhost:#{port}")
+          log_info("Press Ctrl+C to stop")
+          puts ""
+          # Static file server application
+          static_app = lambda do |env|
+            path = env["PATH_INFO"]
+            # Remove leading slash and handle root path
+            relative_path = path == "/" ? "index.html" : path.sub(/^\//, "")
+            # Serve files from dist directory
+            file_path = File.join(Dir.pwd, "dist", relative_path)
+            if File.exist?(file_path) && File.file?(file_path)
+              content_type = Rack::Mime.mime_type(File.extname(file_path), "text/html")
+              [200, { "Content-Type" => content_type }, [File.read(file_path)]]
+            else
+              [404, { "Content-Type" => "text/plain" }, ["File not found: #{path}"]]
+            end
+          end
+          # CORS middleware
+          cors_middleware = lambda do |env|
+            if env["REQUEST_METHOD"] == "OPTIONS"
+              [
+                200,
+                {
+                  "Access-Control-Allow-Origin" => "*",
+                  "Access-Control-Allow-Methods" => "GET, POST, OPTIONS",
+                  "Access-Control-Allow-Headers" => "Content-Type"
+                },
+                []
+              ]
+            else
+              status, headers, body = static_app.call(env)
+              headers["Access-Control-Allow-Origin"] = "*"
+              headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS"
+              headers["Access-Control-Allow-Headers"] = "Content-Type"
+              [status, headers, body]
+            end
+          end
+          # Create Rack application
+          app = Rack::Builder.new do
+            run cors_middleware
+          end
+          # Handle shutdown
+          trap("INT") do
+            log_info("\nShutting down server...")
+            cleanup
+            raise SystemExit.new(0)
+          end
+          # Use Puma handler (Rack 3.0 compatible)
+          begin
+            require "rack/handler/puma"
+            log_info("Using handler: puma")
+            # Open browser after a short delay to ensure server is ready
+            Thread.new do
+              sleep 1
+              open_browser("http://localhost:#{port}/index.html")
+            end
+            Rack::Handler::Puma.run(app, Port: port, Host: "0.0.0.0")
+          rescue LoadError => e
+            log_error("Puma handler not available: #{e.message}")
+            log_error("Please ensure puma gem is installed: gem install puma")
+            raise SystemExit.new(1)
+          end
+        rescue => e
+          log_error("Server error: #{e.message}")
+          raise SystemExit.new(1)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_wasm_ui/cli/command/pack.rb ADDED Viewed

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require_relative "base"
+module RubyWasmUi
+  module Cli
+    class Command
+      class Pack < Base
+        def self.description
+          "Pack WASM file by packing Ruby source files"
+        end
+        def run(_argv)
+          log_info("Packing WASM file...")
+          puts ""
+          ensure_src_directory
+          ensure_ruby_wasm
+          ensure_dist_directory
+          # Pack WASM file
+          pack
+          # Copy non-Ruby files from src to dist
+          copy_non_ruby_files
+        end
+        private
+        def pack
+          pack_wasm(exit_on_error: true, log_prefix: 'Packing')
+        end
+      end
+    end
+  end
+end