rspec-html-matchers 技术文档

本文档将详细介绍如何安装、使用以及调用 rspec-html-matchers 项目，帮助用户更好地理解和运用该项目。

1. 安装指南

在项目 Gemfile 中，将以下代码添加到 :test 组中：

gem 'rspec-html-matchers'

接下来，在你的 RSpec 配置文件中包含该库：

RSpec.configure do |config|
  config.include RSpecHtmlMatchers
end

或者在特定的 spec 文件中包含它：

describe "my view spec" do
  include RSpecHtmlMatchers

  it "has tags" do
    expect(rendered).to have_tag('div')
  end
end

对于 Cucumber 配置，使用以下代码：

World RSpecHtmlMatchers

由于该库依赖于 nokogiri，请参考 nokogiri 安装指南。

2. 项目的使用说明

假设您的代码生成了以下 HTML 输出：

<h1>Simple Form</h1>
<form action="/users" method="post">
<p>
  <input type="email" name="user[email]" />
</p>
<p>
  <input type="submit" id="special_submit" />
</p>
</form>

您可以这样进行测试：

expect(rendered).to have_tag('form', :with => { :action => '/users', :method => 'post' }) do
  with_tag "input", :with => { :name => "user[email]", :type => 'email' }
  with_tag "input#special_submit", :count => 1
  without_tag "h1", :text => 'unneeded tag'
  without_tag "p",  :text => /content/i
end

输入可以是任何 HTML 字符串。以下是一些示例：

• 通过 CSS 匹配标签：

  expect('<p class="qwe rty" id="qwerty">Paragraph</p>').to have_tag('p')
  expect('<p class="qwe rty" id="qwerty">Paragraph</p>').to have_tag(:p)
  expect('<p class="qwe rty" id="qwerty">Paragraph</p>').to have_tag('p#qwerty')
  expect('<p class="qwe rty" id="qwerty">Paragraph</p>').to have_tag('p.qwe.rty')
  

• 类匹配的特殊情况：

  expect('<p class="qwe rty" id="qwerty">Paragraph</p>').to have_tag('p', :with => { :class => 'qwe rty' })
  expect('<p class="qwe rty" id="qwerty">Paragraph</p>').to have_tag('p', :with => { :class => 'rty qwe' })
  

• 内容匹配：

  expect('<p> Some content&nbsphere</p>').to have_tag('p', :text => ' Some content here')
  expect('<p> Some content&nbsphere</p>').to have_tag('p', :text => /Some content here/)
  

• 与 capybara 和 cucumber 一起使用：

  expect(page).to have_tag( ... )
  

  其中 page 是 Capybara::Session 的一个实例。

• 还包括表单输入的简写匹配器：

  • have_form
  • with_checkbox
  • with_email_field
  • with_file_field
  • with_hidden_field
  • with_option
  • with_password_field
  • with_radio_button
  • with_button
  • with_select
  • with_submit
  • with_text_area
  • with_text_field
  • with_url_field
  • with_number_field
  • with_range_field
  • with_date_field

  当然，您也可以使用 without_ 匹配器。更多详情请查看 文档。

3. 项目API使用文档

具体 API 使用方法请参考 rspec-html-matchers API 文档。

4. 项目安装方式

项目安装方式已在“安装指南”一节中详细说明。请按照上述步骤进行安装。