Capybara 项目技术文档

1. 安装指南

环境要求

• Ruby 3.0.0 或更高版本。

安装步骤

1. 在项目的 Gemfile 中添加以下内容：

   gem 'capybara'
   

2. 运行 bundle install 安装 Capybara。

配置 Rails 应用

如果测试的应用是 Rails 应用，请在测试辅助文件中添加以下内容：

require 'capybara/rails'

配置 Rack 应用

如果测试的应用是 Rack 应用（非 Rails），请设置 Capybara.app 为你的 Rack 应用：

Capybara.app = MyRackApp

配置 JavaScript 测试

如果需要测试 JavaScript，或者应用与远程 URL 交互，需要使用不同的驱动。对于 Rails 5.0+ 的应用，建议将服务器切换为 Puma：

Capybara.server = :puma

2. 项目的使用说明

使用 Capybara 进行测试

Capybara 通过模拟真实用户与应用的交互来帮助你测试 Web 应用程序。它支持多种测试框架，如 Cucumber、RSpec、Test::Unit 和 Minitest。

使用 Capybara 与 Cucumber

如果使用 Cucumber，可以通过以下方式加载 Capybara：

require 'capybara/cucumber'
Capybara.app = MyRackApp

使用 Capybara 与 RSpec

在 RSpec 中使用 Capybara，需要在 spec_helper.rb 中添加：

require 'capybara/rspec'

使用 Capybara 与 Test::Unit

如果使用 Test::Unit，可以定义一个基类：

require 'capybara/dsl'

class CapybaraTestCase < Test::Unit::TestCase
  include Capybara::DSL

  def teardown
    Capybara.reset_sessions!
    Capybara.use_default_driver
  end
end

使用 Capybara 与 Minitest

如果使用 Minitest，可以定义一个基类：

require 'capybara/minitest'

class CapybaraTestCase < Minitest::Test
  include Capybara::DSL
  include Capybara::Minitest::Assertions

  def teardown
    Capybara.reset_sessions!
    Capybara.use_default_driver
  end
end

3. 项目 API 使用文档

DSL（领域特定语言）

Capybara 提供了一套直观的 DSL，用于模拟用户操作。以下是一些常用的 DSL 方法：

导航

• visit('/path')：访问指定路径。
• current_path：获取当前路径。

点击链接和按钮

• click_link('Link Text')：点击指定文本的链接。
• click_button('Button Text')：点击指定文本的按钮。

表单交互

• fill_in('Field Name', with: 'Value')：填写表单字段。
• choose('Radio Button Label')：选择单选按钮。
• check('Checkbox Label')：勾选复选框。
• uncheck('Checkbox Label')：取消勾选复选框。
• attach_file('File Field', '/path/to/file')：上传文件。

查询

• has_content?('Text')：检查页面是否包含指定文本。
• has_css?('CSS Selector')：检查页面是否包含指定 CSS 选择器。
• has_xpath?('XPath')：检查页面是否包含指定 XPath。

查找

• find('CSS Selector')：查找元素。
• find_button('Button Text')：查找按钮。
• find_link('Link Text')：查找链接。

作用域

• within('CSS Selector')：在指定作用域内执行操作。

窗口操作

• switch_to_window(window_handle)：切换到指定窗口。
• open_new_window：打开新窗口。

脚本执行

• execute_script('JavaScript Code')：执行 JavaScript 代码。

模态框

• accept_alert：接受警告框。
• dismiss_confirm：取消确认框。

调试

• save_and_open_page：保存并打开当前页面。

4. 项目安装方式

通过 Gemfile 安装

在项目的 Gemfile 中添加：

gem 'capybara'

然后运行 bundle install。

手动安装

可以通过以下命令手动安装 Capybara：

gem install capybara

配置驱动

Capybara 支持多种驱动，如 RackTest、Selenium 等。可以通过以下方式选择驱动：

Capybara.default_driver = :selenium

配置服务器

如果需要测试 JavaScript，建议将服务器切换为 Puma：

Capybara.server = :puma

通过以上步骤，你可以成功安装并配置 Capybara，开始使用它进行 Web 应用的测试。