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

ruby_wasm_ui 0.8.3 → 0.9.0

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: ba3eb2a44a8b73913fb511fe95407173c865a57890f3622915b8e6eb6ef42c87
+  data.tar.gz: '00526093db65a601dc375cd3c9944dde4d9c04bee00cf33701e656914e89e2c1'
 SHA512:
-  metadata.gz: 97e3cf3322340377c5cb75d74796bd20096d604d9ef1efe87ed9598d8394ae76ad6d7b481c43c3e721b683208489083164b6c7730b09106f4dceefdb8647a52c
-  data.tar.gz: 7d04075d81325a78375ffbd9d711e82af3a48531acc9eec340f6d71df76501741d4573bae368eca7ae14c752c1f4fb8c894ee028007c028df39cab2595ef10a1
+  metadata.gz: 3529c934f5bef222cdcbb85b3b83e8ca323b36da9ea0d150c5977c4ebe1dfe282d8e97e7933eb8ae2bf90e632373d731928e14e48e105bede36239f782ab7fd5
+  data.tar.gz: e883ae7b71653376ccd06de8fe760aa909116614c1b0ad7a8357e9427b0bd9709dfa5de43be241c0ba1630a37a95ed02f099eb5515880a07b6acf4afde3f8cf5

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,53 @@
+.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 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.0"></script>
     <script defer type="text/ruby" src="app.rb"></script>
   </head>
   <body>
@@ -112,20 +112,38 @@ 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
 ```
+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
 2. Pack your application files:
 ```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.
+**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
+  ```
 ### Creating Your HTML File
 Create an HTML file in the `src` directory that loads the WASM file:

data/examples/.gitignore ADDED Viewed

@@ -0,0 +1,3 @@
+*.wasm
+/rubies
+/build

data/examples/Gemfile.lock CHANGED Viewed

@@ -3,36 +3,34 @@ PATH
   specs:
     ruby_wasm_ui (0.8.3)
       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,174 @@
+# frozen_string_literal: true
+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
+        def update_gitignore(entries_to_add)
+          gitignore_path = ".gitignore"
+          # Read existing .gitignore or create new content
+          if File.exist?(gitignore_path)
+            content = File.read(gitignore_path)
+            lines = content.lines.map(&:chomp)
+          else
+            lines = []
+          end
+          # Add entries that don't already exist
+          added_entries = []
+          entries_to_add.each do |entry|
+            unless lines.include?(entry)
+              lines << entry
+              added_entries << entry
+            end
+          end
+          # Write back to .gitignore
+          File.write(gitignore_path, lines.join("\n") + "\n")
+          if added_entries.any?
+            log_info("Added to .gitignore: #{added_entries.join(', ')}")
+          else
+            log_info("No new entries added to .gitignore (all entries already exist)")
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,206 @@
+# 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
+          # 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
+          command = "bundle exec rbwasm pack ruby.wasm --dir ./src::./src -o src.wasm"
+          log_info("Building: #{command}")
+          success = run_command(command, exit_on_error: false)
+          if success
+            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"]
+            if path == "/"
+              file_path = File.join(Dir.pwd, "src", "index.html")
+            else
+              file_path = File.join(Dir.pwd, path)
+            end
+            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}/src/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
+          # Pack WASM file
+          pack
+        end
+        private
+        def pack
+          command = "bundle exec rbwasm pack ruby.wasm --dir ./src::./src -o src.wasm"
+          log_info("Packing: #{command}")
+          run_command(command)
+          log_success("✓ Pack completed")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require_relative "base"
+module RubyWasmUi
+  module Cli
+    class Command
+      class Rebuild < Base
+        def self.description
+          "Rebuild Ruby WASM file (useful when gems are added)"
+        end
+        def run(_argv)
+          log_info("Rebuilding Ruby WASM...")
+          puts ""
+          # Check Ruby version
+          ruby_version_str = check_ruby_version
+          # Configure excluded gems for WASM build
+          log_info("Step 1/2: Configuring excluded gems...")
+          configure_excluded_gems
+          log_success("✓ Excluded gems configured")
+          # Build Ruby WASM
+          puts ""
+          log_info("Step 2/2: Building Ruby WASM...")
+          log_info("Running: rbwasm build --ruby-version #{ruby_version_str} -o ruby.wasm")
+          build_ruby_wasm(ruby_version_str)
+          log_success("✓ Ruby WASM build completed")
+          puts ""
+          log_success("Rebuild completed successfully!")
+        end
+      end
+    end
+  end
+end