Remarkable 项目技术文档

1. 安装指南

1.1 安装 Remarkable Rails

在 Rails 项目中安装 Remarkable Rails 的步骤如下：

1. 使用以下命令安装 remarkable_rails gem：

   sudo gem install remarkable_rails
   

2. 在 Rails 项目的 Gemfile 中添加以下依赖：

   gem "rspec"
   gem "rspec-rails"
   gem "remarkable_activerecord"
   

3. 在 spec_helper.rb 文件中添加以下代码以确保 RSpec 和 Remarkable 正确加载：

   require 'rspec/rails'
   require 'remarkable/active_record'
   

1.2 安装 Remarkable Core

如果你是开发者，并且需要开发自定义的匹配器，可以只安装 Remarkable 的核心 gem：

sudo gem install remarkable

2. 项目的使用说明

2.1 概述

Remarkable 是一个用于 RSpec 匹配器的框架，支持宏和 I18n。它由以下几个部分组成：

• Remarkable: 提供辅助工具、DSL、I18n 和 RSpec 功能。
• Remarkable ActiveModel: 为 ActiveModel 兼容模型提供匹配器，支持所有 ActiveModel 验证。
• Remarkable ActiveRecord: 为 ActiveRecord 提供匹配器，支持所有 ActiveRecord 验证和关联。
• Remarkable Rails: 为 ActionController 提供匹配器，并包含 MacroStubs，用于简化控制器方法的存根。

2.2 主要功能

• ActiveRecord 验证匹配器: 支持所有 ActiveRecord 验证选项，包括 :on 和 :with 选项。
• ActiveRecord 关联匹配器: 支持所有关联选项，如 :through, :source, :source_type, :class_name, :foreign_key 等。
• ActionController 匹配器: 提供 :assign_to, :filter_params, :redirect_to, :render_with_layout, :respond_with, :render_template, :route, :set_session, :set_the_flash 等匹配器。
• 宏存根: 使控制器规范更易于维护、更具可读性和 DRY。
• I18n 和文档: 提供多语言支持和详细的文档。

2.3 使用示例

以下是一些使用 Remarkable 的示例：

# 验证数值性
it { should validate_numericality_of(:age).greater_than(18).only_integer }

# 验证关联
it { should belong_to(:user).with_foreign_key(:user_id) }

# 控制器匹配器
it { should assign_to(:current_user) }

3. 项目 API 使用文档

3.1 ActiveRecord 匹配器

3.1.1 验证匹配器

• validate_presence_of: 验证字段是否存在。
• validate_uniqueness_of: 验证字段的唯一性。
• validate_numericality_of: 验证字段的数值性。

3.1.2 关联匹配器

• belong_to: 验证 belongs_to 关联。
• have_many: 验证 have_many 关联。
• have_and_belong_to_many: 验证 has_and_belongs_to_many 关联。

3.2 ActionController 匹配器

• assign_to: 验证控制器是否分配了指定的实例变量。
• redirect_to: 验证控制器是否重定向到指定的 URL。
• render_template: 验证控制器是否渲染了指定的模板。

4. 项目安装方式

4.1 通过 Gem 安装

使用以下命令安装 Remarkable 相关的 gem：

sudo gem install remarkable_rails

4.2 在 Rails 项目中配置

在 Gemfile 中添加以下依赖：

gem "rspec"
gem "rspec-rails"
gem "remarkable_activerecord"

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

require 'rspec/rails'
require 'remarkable/active_record'

4.3 开发环境安装

如果你是开发者，并且需要为 Remarkable 贡献代码，可以按照以下步骤设置开发环境：

1. 安装 Bundler：

   gem install bundler
   

2. 安装依赖：

   bundle install
   

3. 运行测试：

   rake
   

通过以上步骤，你可以在本地开发和测试 Remarkable 项目。