opal-vite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b141645cbef98169c750427f39d902e6f8377430fb41ec282ccfdaf9ff6bc5a5
+  data.tar.gz: ec0717edcaf168380c5bd92419d84d2e14f12d41430a373d45c7f095109d2b82
+SHA512:
+  metadata.gz: e27461464983db947b29e81c64da1ef4d5872c45709e66e078c315dc9133c15ec453b88d596788a5321a235e604da1c7c7f1eefb87240574566da709d933cbbb
+  data.tar.gz: 8d70ec17da3cb04a529e55640aec9e8ed6efc6bc1acdf4aad0ac93949b83593820a18d624c86db11df764b3c5481cc2228828617c71e8694005dc4e0abead6f2

data/README.md

@@ -0,0 +1,177 @@
+# opal-vite
+
+Core Ruby gem for integrating [Opal](https://opalrb.com/) (Ruby to JavaScript compiler) with [Vite](https://vitejs.dev/). This gem provides the compilation backend for the `vite-plugin-opal` package.
+
+## Features
+
+- 🔨 **Ruby Compilation**: Compiles Ruby code to JavaScript using Opal
+- 📊 **Dependency Tracking**: Tracks `require` statements and dependencies
+- 🗺️ **Source Maps**: Generates source maps for debugging
+- ⚙️ **Configuration**: Flexible configuration options
+- 🔧 **CLI**: Command-line interface for standalone compilation
+- 🔌 **JSON API**: JSON-based API for Node.js integration
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'opal-vite'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Requirements
+
+- Ruby >= 3.0
+- Opal >= 1.8
+
+## Usage
+
+### As a Library
+
+```ruby
+require 'opal-vite'
+
+# Create a compiler instance
+compiler = Opal::Vite::Compiler.new
+
+# Compile Ruby code
+source = <<~RUBY
+  class Greeter
+    def greet(name)
+      "Hello, #{name}!"
+    end
+  end
+
+  greeter = Greeter.new
+  puts greeter.greet("World")
+RUBY
+
+result = compiler.compile(source, 'greeter.rb')
+
+# Access compiled code
+puts result[:code]         # JavaScript output
+puts result[:map]          # Source map (JSON string)
+puts result[:dependencies] # Array of required files
+```
+
+### CLI Commands
+
+#### Compile a File
+
+```bash
+opal-vite compile app.rb
+```
+
+#### Compile to File
+
+```bash
+opal-vite compile app.rb -o app.js
+```
+
+#### Generate Source Map
+
+```bash
+opal-vite compile app.rb -o app.js -m
+```
+
+#### Verbose Output
+
+```bash
+opal-vite compile app.rb -v
+```
+
+#### Show Version
+
+```bash
+opal-vite version
+```
+
+#### Show Help
+
+```bash
+opal-vite help
+```
+
+## API Reference
+
+### `Opal::Vite::Compiler`
+
+Main compiler class for converting Ruby to JavaScript.
+
+#### `#compile(source, file_path)`
+
+Compiles Ruby source code to JavaScript.
+
+**Parameters:**
+- `source` (String): Ruby source code
+- `file_path` (String): Path to the source file
+
+**Returns:**
+- Hash with `:code`, `:map`, and `:dependencies` keys
+
+#### `.runtime_code`
+
+Returns the Opal runtime JavaScript code.
+
+### `Opal::Vite::Config`
+
+Configuration class with attributes:
+- `load_paths` (Array<String>)
+- `source_map_enabled` (Boolean)
+- `debug` (Boolean)
+
+## Integration with Vite
+
+This gem works with [vite-plugin-opal](../../packages/vite-plugin-opal).
+
+The Vite plugin spawns Ruby processes and uses this gem to compile `.rb` files.
+
+## Examples
+
+### Simple Compilation
+
+```ruby
+require 'opal-vite'
+
+compiler = Opal::Vite::Compiler.new
+result = compiler.compile('puts "Hello, World!"', 'hello.rb')
+puts result[:code]
+```
+
+### CLI Usage
+
+```bash
+# Simple compilation
+opal-vite compile app.rb > app.js
+
+# With source map
+opal-vite compile app.rb -o app.js -m
+
+# Verbose mode
+opal-vite compile app.rb -v
+```
+
+## Development
+
+### Running Tests
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+## Related Projects
+
+- [vite-plugin-opal](../../packages/vite-plugin-opal) - Vite plugin
+- [opal-vite-rails](../opal-vite-rails) - Rails integration
+- [Opal](https://opalrb.com/) - Ruby to JavaScript compiler
+
+## License
+
+MIT

data/bin/opal-vite

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'opal-vite'
+require 'opal/vite/cli'
+
+begin
+  cli = Opal::Vite::CLI.new(ARGV)
+  cli.run
+rescue Interrupt
+  puts "\nInterrupted"
+  exit 1
+rescue => e
+  puts "Error: #{e.message}"
+  exit 1
+end

data/lib/opal/vite/cli.rb

@@ -0,0 +1,139 @@
+require 'optparse'
+require 'opal/vite'
+
+module Opal
+  module Vite
+    class CLI
+      def initialize(argv)
+        @argv = argv
+        @options = {}
+      end
+
+      def run
+        command = @argv.shift
+
+        case command
+        when 'compile'
+          compile_command
+        when 'version', '-v', '--version'
+          version_command
+        when 'help', '-h', '--help', nil
+          help_command
+        else
+          puts "Unknown command: #{command}"
+          puts "Run 'opal-vite help' for usage information"
+          exit 1
+        end
+      end
+
+      private
+
+      def compile_command
+        file_path = @argv.shift
+
+        unless file_path
+          puts "Error: No file specified"
+          puts "Usage: opal-vite compile FILE"
+          exit 1
+        end
+
+        unless File.exist?(file_path)
+          puts "Error: File not found: #{file_path}"
+          exit 1
+        end
+
+        parse_compile_options
+
+        begin
+          puts "Compiling #{file_path}..."
+
+          compiler = Opal::Vite::Compiler.new
+          source = File.read(file_path)
+          result = compiler.compile(source, file_path)
+
+          if @options[:output]
+            output_file = @options[:output]
+            File.write(output_file, result[:code])
+            puts "✅ Compiled to: #{output_file}"
+
+            if @options[:source_map] && result[:map]
+              map_file = "#{output_file}.map"
+              File.write(map_file, result[:map])
+              puts "✅ Source map: #{map_file}"
+            end
+          else
+            puts result[:code]
+          end
+
+          if @options[:verbose]
+            puts "\nDependencies:"
+            result[:dependencies].each do |dep|
+              puts "  - #{dep}"
+            end
+          end
+
+          puts "✅ Compilation successful!"
+        rescue => e
+          puts "❌ Compilation failed: #{e.message}"
+          puts e.backtrace.first(5).join("\n") if @options[:verbose]
+          exit 1
+        end
+      end
+
+      def version_command
+        puts "opal-vite version #{Opal::Vite::VERSION}"
+        puts "opal version #{Opal::VERSION}"
+      end
+
+      def help_command
+        puts <<~HELP
+          opal-vite - Integrate Opal with Vite
+
+          USAGE:
+            opal-vite COMMAND [OPTIONS]
+
+          COMMANDS:
+            compile FILE    Compile a Ruby file to JavaScript
+            version         Show version information
+            help            Show this help message
+
+          COMPILE OPTIONS:
+            -o, --output FILE       Write output to FILE
+            -m, --source-map        Generate source map
+            -v, --verbose           Show verbose output
+
+          EXAMPLES:
+            # Compile a file and print to stdout
+            opal-vite compile app.rb
+
+            # Compile and save to a file
+            opal-vite compile app.rb -o app.js
+
+            # Compile with source map
+            opal-vite compile app.rb -o app.js -m
+
+            # Show version
+            opal-vite version
+
+          For more information, visit: https://github.com/opal/opal-vite
+        HELP
+      end
+
+      def parse_compile_options
+        OptionParser.new do |opts|
+          opts.on('-o', '--output FILE', 'Output file') do |file|
+            @options[:output] = file
+          end
+
+          opts.on('-m', '--source-map', 'Generate source map') do
+            @options[:source_map] = true
+          end
+
+          opts.on('-v', '--verbose', 'Verbose output') do
+            @options[:verbose] = true
+          end
+        end.parse!(@argv)
+      end
+    end
+  end
+end

data/lib/opal/vite/compiler.rb

@@ -0,0 +1,107 @@
+require 'opal'
+require 'json'
+
+module Opal
+  module Vite
+    class Compiler
+      class CompilationError < StandardError; end
+
+      def initialize(options = {})
+        @options = options
+        @config = options[:config] || Opal::Vite.config
+      end
+
+      # Compile Ruby source code to JavaScript
+      # Returns a hash with :code, :map, and :dependencies
+      def compile(source, file_path)
+        begin
+          # Use Opal::Builder and add the file's directory to load paths
+          builder = Opal::Builder.new
+
+          # Add the directory containing the file to load paths
+          # This allows require statements to work relative to the file
+          file_dir = File.dirname(File.expand_path(file_path))
+          builder.append_paths(file_dir)
+
+          # Also add parent directories for common patterns like 'lib/foo'
+          parent_dir = File.dirname(file_dir)
+          builder.append_paths(parent_dir)
+
+          builder.build_str(source, file_path)
+
+          result = {
+            code: builder.to_s,
+            dependencies: extract_dependencies(builder)
+          }
+
+          # Try to extract source map if available
+          if @config.source_map_enabled
+            begin
+              # Opal::Builder should have source map information
+              # Try to get it from the processed assets
+              source_map = extract_source_map(builder)
+              result[:map] = source_map if source_map
+            rescue => e
+              # Source map extraction failed, log but don't fail compilation
+              warn "Warning: Failed to extract source map for #{file_path}: #{e.message}" if ENV['DEBUG']
+            end
+          end
+
+          result
+        rescue StandardError => e
+          raise CompilationError, "Failed to compile #{file_path}: #{e.message}\n#{e.backtrace.first(5).join("\n")}"
+        end
+      end
+
+      # Compile a Ruby file to JavaScript
+      def compile_file(file_path)
+        unless File.exist?(file_path)
+          raise CompilationError, "File not found: #{file_path}"
+        end
+
+        source = File.read(file_path)
+        compile(source, file_path)
+      end
+
+      # Get the Opal runtime code
+      def self.runtime_code
+        builder = Opal::Builder.new
+        builder.build('opal')
+        builder.to_s
+      end
+
+      private
+
+      def compiler_options
+        @config.to_compiler_options
+      end
+
+      def extract_dependencies(builder)
+        # Extract required files from the builder
+        builder.processed.map { |asset| asset.filename }.compact
+      end
+
+      def extract_source_map(builder)
+        # Get source map from the builder's processed assets
+        # Opal stores source maps in the compiled assets
+        return nil unless builder.processed.any?
+
+        # Get the main compiled asset (usually the last one)
+        main_asset = builder.processed.last
+        return nil unless main_asset
+
+        # Check if the asset has source map data
+        if main_asset.respond_to?(:source_map) && main_asset.source_map
+          return main_asset.source_map.to_json
+        end
+
+        # Try to get from the builder directly
+        if builder.respond_to?(:source_map) && builder.source_map
+          return builder.source_map.to_json
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/opal/vite/config.rb

@@ -0,0 +1,50 @@
+require 'json'
+
+module Opal
+  module Vite
+    class Config
+      attr_accessor :source_map_enabled,
+                    :arity_check,
+                    :freezing,
+                    :esm,
+                    :dynamic_require_severity,
+                    :missing_require_severity
+
+      def initialize
+        @source_map_enabled = true
+        @arity_check = false
+        @freezing = true
+        @esm = true
+        @dynamic_require_severity = :ignore
+        @missing_require_severity = :error
+      end
+
+      def self.load_from_file(path)
+        config = new
+        if File.exist?(path)
+          data = JSON.parse(File.read(path))
+          config.apply_hash(data)
+        end
+        config
+      end
+
+      def apply_hash(hash)
+        hash.each do |key, value|
+          setter = "#{key}="
+          send(setter, value) if respond_to?(setter)
+        end
+      end
+
+      def to_compiler_options
+        {
+          source_map_enabled: source_map_enabled,
+          arity_check: arity_check,
+          freezing: freezing,
+          esm: esm,
+          dynamic_require_severity: dynamic_require_severity,
+          missing_require_severity: missing_require_severity
+        }
+      end
+    end
+  end
+end

data/lib/opal/vite/source_map.rb

@@ -0,0 +1,39 @@
+require 'json'
+
+module Opal
+  module Vite
+    class SourceMapValidator
+      # Validate a source map JSON string
+      def self.valid?(source_map_json)
+        return false if source_map_json.nil? || source_map_json.empty?
+
+        begin
+          map = JSON.parse(source_map_json)
+
+          # Check required fields
+          return false unless map['version']
+          return false unless map['sources']
+          return false unless map['mappings']
+
+          true
+        rescue JSON::ParserError
+          false
+        end
+      end
+
+      # Get information about a source map
+      def self.info(source_map_json)
+        return nil unless valid?(source_map_json)
+
+        map = JSON.parse(source_map_json)
+        {
+          version: map['version'],
+          sources: map['sources'],
+          sources_count: map['sources']&.length || 0,
+          has_names: !map['names'].nil?,
+          has_source_content: !map['sourcesContent'].nil?
+        }
+      end
+    end
+  end
+end

data/lib/opal/vite/version.rb

@@ -0,0 +1,5 @@
+module Opal
+  module Vite
+    VERSION = "0.1.0"
+  end
+end

data/lib/opal/vite.rb

@@ -0,0 +1,2 @@
+# Load the main opal-vite file
+require_relative '../opal-vite'

data/lib/opal-vite.rb

@@ -0,0 +1,37 @@
+require 'opal'
+require 'json'
+
+require_relative 'opal/vite/version'
+require_relative 'opal/vite/config'
+require_relative 'opal/vite/compiler'
+require_relative 'opal/vite/source_map'
+
+module Opal
+  module Vite
+    class Error < StandardError; end
+
+    class << self
+      attr_writer :config
+
+      def config
+        @config ||= Config.new
+      end
+
+      def configure
+        yield(config) if block_given?
+      end
+
+      # CLI entry point for compilation
+      def compile_for_vite(file_path)
+        compiler = Compiler.new
+        result = compiler.compile_file(file_path)
+
+        # Output JSON to stdout for the Vite plugin to consume
+        puts JSON.generate(result)
+      rescue Compiler::CompilationError => e
+        STDERR.puts e.message
+        exit 1
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: opal-vite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- stofu1234
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Compile Ruby to JavaScript using Opal and Vite for fast development
+email:
+- ''
+executables:
+- opal-vite
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/opal-vite
+- lib/opal-vite.rb
+- lib/opal/vite.rb
+- lib/opal/vite/cli.rb
+- lib/opal/vite/compiler.rb
+- lib/opal/vite/config.rb
+- lib/opal/vite/source_map.rb
+- lib/opal/vite/version.rb
+homepage: https://github.com/stofu1234/opal-vite
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stofu1234/opal-vite
+  source_code_uri: https://github.com/stofu1234/opal-vite
+  changelog_uri: https://github.com/stofu1234/opal-vite/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Integrate Opal with Vite
+test_files: []