Harmony 项目技术文档

2024-12-20 15:44:27作者：沈韬淼Beryl

1. 安装指南

在安装Harmony之前，需要确保环境中已经安装了一些依赖项。以下是手动安装这些依赖项的步骤：

首先，安装stackdeck库：

gem install stackdeck

接着，安装johnson库的特定版本：

gem install johnson -v "2.0.0.pre3"

最后，安装Harmony库：

gem install harmony

请注意，当前Ruby的gem包管理器中存在一个bug，因此需要手动安装这些依赖项。预计这个问题将在未来的版本中得到修复。

2. 项目的使用说明

Harmony提供了一个简单的领域特定语言（DSL），允许在Ruby中执行JavaScript和DOM代码。以下是一些使用示例：

JavaScript解析

require 'harmony'

page = Harmony::Page.new(<<-HTML)
  <html>
    <head>
      <title>Foo</title>
    </head>
    <body></body>
  </html>
HTML

puts page.execute_js("1+1")            # 输出: 2
puts page.execute_js("document.title") # 输出: "Foo"

JavaScript单元测试

Harmony可以用于在Ruby应用程序的测试中执行JavaScript代码，例如：

require 'test/unit'
require 'harmony'

class JavascriptTest < Test::Unit::TestCase
  def setup
    @page = Harmony::Page.new
    @page.load('public/javascripts/foo.js')
  end

  def test_foo
    assert_equal "world", @page.execute_js(<<-JS)
      foo = new Foo;
      foo.hello();
    JS
  end
end

DOM处理

Harmony支持在页面中使用JavaScript框架，如jQuery或Prototype。所有在<script>标签中引用的脚本都会自动加载。

page = Harmony::Page.new(<<-HTML)
  <html>
    <head>
      <script src="javascripts/jquery.js" type="text/javascript"></script>
    </head>
    <body>
      <div id="widget">ohaie</div>
    </body>
  </html>
HTML

puts page.execute_js("$('#widget').innerHTML") # 输出: "ohaie"

获取远程文档

使用Harmony::Page.fetch(uri)方法可以从远程文档创建一个页面。

page = Harmony::Page.fetch('http://example.com')
puts page.execute_js('document.title') # 输出: "Example Web Page"

3. 项目API使用文档

以下是Harmony项目中主要的API文档：

Harmony::Page.new(html): 创建一个新的页面实例，并可选地加载HTML内容。
page.execute_js(js_code): 执行JavaScript代码并返回最后一个语句的值。
page.load(file_path): 加载本地JavaScript文件到页面中。
Harmony::Page.fetch(uri): 从提供的URI创建一个页面实例。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，这里不再赘述。简要步骤为：

安装依赖库stackdeck和johnson。
安装Harmony库。

请确保遵循上述步骤以成功安装Harmony项目。

登录后查看全文