Jasmine-Rails Gem 技术文档

1. 安装指南

1.1 添加 Gem 到 Gemfile

首先，将 jasmine-rails 添加到你的 Gemfile 中，如下所示：

group :test, :development do
  gem 'jasmine-rails'
end

1.2 安装 Gem

接下来，运行以下命令来安装 Gem：

$ bundle install

1.3 运行安装生成器

最后，运行 Rails 生成器来创建必要的配置文件：

$ rails generate jasmine_rails:install

生成器将创建所需的配置文件，并将测试运行器挂载到 /specs 路径，以便你可以开始编写测试。

2. 项目的使用说明

2.1 配置文件

配置 Jasmine 测试运行器是通过 spec/javascripts/support/jasmine.yml 文件完成的。

2.2 资产管道支持

jasmine-rails gem 完全支持 Rails 资产管道，这意味着你可以：

• 使用 coffee_script 或其他 JavaScript 预编译器来编写源文件或测试文件。
• 使用 Sprockets 指令来控制依赖文件的包含或排除。
• 利用资产管道的搜索路径来包含来自不同源或 gem 的资产。

如果你选择使用资产管道支持，许多 jasmine.yml 配置将变得不必要，你可以依赖 Rails 资产管道来处理测试套件中包含的文件。

# 当使用资产管道时的最小化 jasmine.yml 配置
spec_files:
  - "**/*[Ss]pec.{js,coffee}"

2.3 引擎中的测试文件

如果你的项目中挂载了一个引擎，并且你需要测试引擎的 JavaScript 文件，可以在 jasmine.yml 文件中添加引擎目录：

spec_dir:
  - spec/javascripts
  - ../engine/spec/javascripts

2.4 包含外部 JavaScript 文件

如果你需要测试不属于资产管道的 JavaScript 文件（例如，如果你的移动应用程序位于 Rails 应用之外），可以在 jasmine.yml 文件中添加以下内容：

include_dir:
  - ../mobile_app/public/js

3. 项目API使用文档

3.1 从命令行运行测试

你可以通过以下命令从命令行运行 Jasmine 测试：

bundle exec rake spec:javascript

你还可以通过 SPEC 选项来过滤测试的执行：

bundle exec rake spec:javascript SPEC=my_test

3.2 在浏览器中运行测试

启动 Rails 服务器（例如 bundle exec rails s），然后导航到你在 routes.rb 文件中配置的路径（例如 http://localhost:3000/specs）。Jasmine 测试运行器将出现并立即开始运行你的测试套件。

4. 项目安装方式

4.1 使用 PhantomJS Gem

默认情况下，jasmine-rails 使用 PhantomJS gem 来查找并使用适当的 PhantomJS 版本。如果你希望管理自己的 PhantomJS 可执行文件，可以在 jasmine.yml 中设置：

use_phantom_gem: false

这将尝试使用当前 PATH 中的 phantom 可执行文件。

4.2 PhantomJS 命令行选项

如果你希望将命令行选项传递给 PhantomJS 可执行文件，可以在 jasmine.yml 中设置：

phantom_options: --web-security=no --debug=yes

这将传递 phantom_options 中定义的所有内容作为 PhantomJS 命令行选项。