Rein 项目技术文档

1. 安装指南

安装 Rein 项目

首先，确保你已经安装了 Ruby 环境。然后，通过以下命令安装 Rein gem：

gem install rein

2. 项目的使用说明

概述

Rein 是一个用于在 ActiveRecord 迁移中添加数据库约束的工具。通过 Rein，你可以在数据库级别上确保数据的完整性，而不是仅仅依赖于应用程序级别的验证。Rein 提供了多种约束类型，如外键约束、唯一约束、排除约束等，帮助你更好地管理数据库中的数据。

使用示例

以下是一个简单的示例，展示如何在创建 authors 表时添加一个 name 字段的非空约束：

class CreateAuthorsTable < ActiveRecord::Migration
  def change
    create_table :authors do |t|
      t.string :name, null: false
    end

    # 确保作者必须有一个名字
    add_presence_constraint :authors, :name
  end
end

3. 项目API使用文档

约束类型

Rein 提供了多种约束类型，以下是主要约束类型的简要说明：

外键约束

外键约束用于确保某一列的值必须存在于另一张表的某一列中。例如，确保 books 表中的 author_id 列的值必须存在于 authors 表的 id 列中：

add_foreign_key_constraint :books, :authors

唯一约束

唯一约束用于确保某一列的值在表中是唯一的。例如，确保 books 表中的 isbn 列的值是唯一的：

add_unique_constraint :books, :isbn

排除约束

排除约束类似于唯一约束，但它更通用，可以禁止两行在某些列上具有某种关系。例如，确保 book_owners 表中的 book_id 和 owned_during 列的值不会重叠：

add_exclusion_constraint :book_owners, [[:book_id, '='], [:owned_during, '&&']], using: :gist

包含约束

包含约束用于指定某一列的值必须包含在给定的值列表中。例如，确保 books 表中的 state 列的值只能是 available 或 on_loan：

add_inclusion_constraint :books, :state, in: %w[available on_loan]

长度约束

长度约束用于指定某一字符串列的长度范围。例如，确保 books 表中的 call_number 列的长度在 1 到 255 之间：

add_length_constraint :books, :call_number,
  greater_than_or_equal_to: 1,
  less_than_or_equal_to: 255

4. 项目安装方式

通过 Gem 安装

Rein 可以通过 RubyGems 安装，使用以下命令：

gem install rein

在 Rails 项目中使用

在 Rails 项目中，你可以在 Gemfile 中添加以下行来引入 Rein：

gem 'rein'

然后运行 bundle install 来安装。

在迁移中使用

安装完成后，你可以在 ActiveRecord 迁移中使用 Rein 提供的各种约束方法，如 add_presence_constraint、add_foreign_key_constraint 等。

class CreateAuthorsTable < ActiveRecord::Migration
  def change
    create_table :authors do |t|
      t.string :name, null: false
    end

    add_presence_constraint :authors, :name
  end
end

通过以上步骤，你可以在项目中成功安装并使用 Rein 来管理数据库约束。