Shoulda Matchers 技术文档

安装指南

1. 添加 Gem 到 Gemfile

首先，将 shoulda-matchers 添加到你的 Gemfile 中。根据你使用的测试框架（RSpec 或 Minitest），添加相应的配置。

使用 RSpec

group :test do
  gem 'shoulda-matchers', '~> 6.0'
end

使用 Minitest

group :test do
  gem 'shoulda-matchers', '~> 6.0'
end

2. 安装 Gem

运行以下命令来安装 Gem：

bundle install

3. 配置 Gem

根据你使用的测试框架和项目类型（Rails 或非 Rails），进行相应的配置。

Rails 项目（RSpec）

在 spec/rails_helper.rb 文件底部添加以下配置：

Shoulda::Matchers.configure do |config|
  config.integrate do |with|
    with.test_framework :rspec
    with.library :rails
  end
end

非 Rails 项目（RSpec）

在 spec/spec_helper.rb 文件底部添加以下配置：

Shoulda::Matchers.configure do |config|
  config.integrate do |with|
    with.test_framework :rspec
    with.library :active_record
    with.library :active_model
  end
end

Rails 项目（Minitest）

在 test/test_helper.rb 文件底部添加以下配置：

Shoulda::Matchers.configure do |config|
  config.integrate do |with|
    with.test_framework :minitest
    with.library :rails
  end
end

非 Rails 项目（Minitest）

在 test/test_helper.rb 文件底部添加以下配置：

Shoulda::Matchers.configure do |config|
  config.integrate do |with|
    with.test_framework :minitest
    with.library :active_record
    with.library :active_model
  end
end

项目的使用说明

1. 基本使用

Shoulda Matchers 提供了许多用于测试 Rails 应用的简便方法。你可以在模型、控制器等不同部分使用这些匹配器。

示例：模型测试

# RSpec
RSpec.describe MenuItem, type: :model do
  describe 'associations' do
    it { should belong_to(:category).class_name('MenuCategory') }
  end

  describe 'validations' do
    it { should validate_presence_of(:name) }
    it { should validate_uniqueness_of(:name).scoped_to(:category_id) }
  end
end

# Minitest
class MenuItemTest < ActiveSupport::TestCase
  context 'associations' do
    should belong_to(:category).class_name('MenuCategory')
  end

  context 'validations' do
    should validate_presence_of(:name)
    should validate_uniqueness_of(:name).scoped_to(:category_id)
  end
end

2. 自定义 subject

在某些情况下，你可能需要自定义 subject。例如，在测试模型验证时，通常会提供一个有效的模型实例，而不是一个全新的实例。

# RSpec
RSpec.describe Post, type: :model do
  describe 'validations' do
    subject { build(:post) }

    it { should validate_presence_of(:title) }
  end
end

# Minitest
class PostTest < ActiveSupport::TestCase
  context 'validations' do
    subject { build(:post) }

    should validate_presence_of(:title)
  end
end

项目 API 使用文档

1. ActiveModel 匹配器

用于测试 ActiveModel 的匹配器，例如：

• validate_presence_of
• validate_uniqueness_of

2. ActiveRecord 匹配器

用于测试 ActiveRecord 的匹配器，例如：

• belong_to
• have_many

3. ActionController 匹配器

用于测试控制器的匹配器，例如：

• render_template
• have_http_status

4. 独立匹配器

用于测试 Rails 特定功能的匹配器，例如：

• delegate

项目安装方式

1. 通过 Gemfile 安装

将 shoulda-matchers 添加到 Gemfile 中，然后运行 bundle install。

2. 手动安装

你也可以通过以下命令手动安装 Gem：

gem install shoulda-matchers

3. 配置

根据你使用的测试框架和项目类型，进行相应的配置。配置文件通常位于 spec/rails_helper.rb 或 test/test_helper.rb 中。

通过以上步骤，你可以成功安装并配置 Shoulda Matchers，开始使用它来简化你的 Rails 测试。