Email Spec 项目技术文档

1. 安装指南

1.1 使用 Gemfile 安装

在项目的 Gemfile 中添加以下代码，并运行 bundle install 来安装 email_spec 库：

group :test do
  gem 'email_spec'
end

1.2 手动安装

你也可以通过命令行手动安装 email_spec：

gem install email_spec

2. 项目的使用说明

2.1 Cucumber 使用步骤

1. 在 env.rb 文件中添加以下代码：

   require 'email_spec'
   require 'email_spec/cucumber'
   

2. 生成 Cucumber 步骤文件：

   rails generate email_spec:steps
   

3. 在 Cucumber 场景中使用生成的步骤。例如：

   Scenario: A new person signs up
       Given I am at "/"
       When I fill in "Email" with "[e-mail]"
       And I press "Sign up"
       Then "[e-mail]" should receive an email
   

2.2 RSpec 使用步骤

1. 在 spec_helper.rb 中添加以下代码：

   require "email_spec"
   require "email_spec/rspec"
   

2. 在 RSpec 测试中使用 email_spec 提供的匹配器和辅助方法。例如：

   describe "Signup Email" do
     include EmailSpec::Helpers
     include EmailSpec::Matchers
   
     before(:all) do
       @email = UserMailer.create_signup("[e-mail]", "Jojo Binks")
     end
   
     it "should be set to be delivered to the email passed in" do
       expect(@email).to deliver_to("[e-mail]")
     end
   end
   

2.3 MiniTest 使用步骤

1. 在 test_helper.rb 中添加以下代码：

   require "minitest-matchers"
   require "email_spec"
   
   class MiniTest::Unit::TestCase
     include EmailSpec::Helpers
     include EmailSpec::Matchers
   end
   

2. 在 MiniTest 测试中使用 email_spec 提供的匹配器和辅助方法。例如：

   class SignupMailerTest < MiniTest::Unit::TestCase
     include EmailSpec::Helpers
     include EmailSpec::Matchers
   
     def test_signup_email
       email = UserMailer.create_signup("[e-mail]", "Jojo Binks")
       assert_must deliver_to("[e-mail]"), email
     end
   end
   

3. 项目API使用文档

3.1 RSpec 匹配器

• deliver_to(email_addresses)：检查邮件的收件人地址是否正确。
• deliver_from(email)：检查邮件的发件人地址是否正确。
• have_subject(subject)：检查邮件的主题是否正确。
• have_body_text(text)：检查邮件正文中是否包含指定的文本。
• include_email_with_subject(subject)：检查邮件列表中是否包含指定主题的邮件。

3.2 MiniTest 匹配器

• must_deliver_to(email_addresses)：检查邮件的收件人地址是否正确。
• must_deliver_from(email)：检查邮件的发件人地址是否正确。
• must_have_subject(subject)：检查邮件的主题是否正确。
• must_have_body_text(text)：检查邮件正文中是否包含指定的文本。

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加以下代码：

group :test do
  gem 'email_spec'
end

然后运行 bundle install。

4.2 手动安装

通过命令行手动安装：

gem install email_spec

4.3 配置 Cucumber、RSpec 和 MiniTest

根据项目需求，配置相应的测试框架（Cucumber、RSpec 或 MiniTest）以使用 email_spec。