Opal 编译器技术文档

1. 安装指南

环境要求

• Ruby (推荐使用最新稳定版本)
• Node.js (推荐使用最新稳定版本)

安装步骤

1. 通过 RubyGems 安装 Opal：

   gem install opal
   

2. 通过 npm 安装 Opal 的命令行工具：

   npm install -g opal
   

3. 确保已安装上述依赖后，即可开始使用 Opal。

2. 项目的使用说明

通过命令行编译 Ruby 代码

1. 创建一个名为 app.rb 的 Ruby 文件，并写入以下内容：

   puts 'Hello world!'
   

2. 使用命令行工具编译 app.rb 到 JavaScript：

   opal --compile app.rb > app.js
   

3. 在 HTML 文件中引用生成的 app.js 文件：

   <script src="app.js"></script>
   

4. 确保在 HTML 文件中设置页面编码为 UTF-8：

   <meta charset="utf-8">
   

从 Ruby 环境编译 Ruby 代码

1. 使用 Opal.compile 方法编译 Ruby 字符串为 JavaScript 代码：

   Opal.compile("puts 'wow'")
   

2. 使用 Opal::Builder 编译完整的 Ruby 应用，包括依赖：

   builder = Opal::Builder.new
   builder.build_str('require "opal"; puts "wow"', '(inline)')
   File.binwrite 'app.js', builder.to_s # 使用二进制模式写入
   

在 HTML 文件中直接使用 Ruby 代码

1. 在 HTML 文件中引入 Opal 运行时和解析器：

   <script src="https://cdn.opalrb.com/opal/current/opal.js"></script>
   <script src="https://cdn.opalrb.com/opal/current/opal-parser.js" onload="Opal.load('opal-parser')"></script>
   

2. 在 HTML 文件中添加 <script type="text/ruby"> 标签，并写入 Ruby 代码：

   <script type="text/ruby">
     puts "hi"
   </script>
   

3. 打开页面并查看 JavaScript 控制台。

注意：虽然这种方式可行，但不推荐在生产环境中使用，仅建议作为快速上手 Opal 的方式。

3. 项目 API 使用文档

Opal 提供了以下 API 用于编译和运行 Ruby 代码：

Opal.compile

• 用途：将 Ruby 字符串编译为 JavaScript 代码。
• 参数：ruby_code (String) - 要编译的 Ruby 代码字符串。
• 返回值：编译后的 JavaScript 代码字符串。

Opal::Builder

• 用途：构建包含 Opal 运行时和核心库的完整 Ruby 应用的 JavaScript 字符串。
• 用法：

  builder = Opal::Builder.new
  builder.build_str('require "opal"; puts "wow"', '(inline)')
  File.binwrite 'app.js', builder.to_s
  

4. 项目安装方式

请参考上文“安装指南”部分，使用 RubyGems 或 npm 进行安装。