Unread 项目技术文档

本文档将详细介绍如何安装和使用 Unread 项目，该项目是一个 Ruby gem，用于管理 ActiveRecord 对象的已读/未读状态，并且具有出色的性能。

1. 安装指南

在开始之前，请确保您的系统满足以下要求：

• Ruby 3.1 或更高版本
• Rails 6.1 或更高版本（包括 Rails 7.2）
• MySQL、PostgreSQL 或 SQLite 数据库
• 模型中需要一个时间戳字段（如 created_at 或 updated_at），并在数据库中对其进行索引

以下是安装步骤：

步骤 1：添加到 Gemfile

将以下代码添加到您的 Gemfile 文件中：

gem 'unread'

然后运行以下命令安装 gem：

bundle

步骤 2：生成和运行迁移

使用以下命令生成迁移文件：

rails g unread:migration

然后运行迁移：

rake db:migrate

2. 项目使用说明

以下是如何在项目中使用 Unread 的示例：

定义用户和消息模型

首先，确保您的用户和消息模型正确设置了 acts_as_reader 和 acts_as_readable：

class User < ActiveRecord::Base
  acts_as_reader

  # 可选：仅允许一部分用户作为阅读者
  def self.reader_scope
    where(is_admin: true)
  end
end

class Message < ActiveRecord::Base
  acts_as_readable on: :created_at
end

获取未读消息

message1 = Message.create!
message2 = Message.create!

# 获取指定用户的未读消息
Message.unread_by(current_user)
# => [ message1, message2 ]

标记消息为已读

message1.mark_as_read! for: current_user
Message.unread_by(current_user)
# => [ message2 ]

获取已读消息

Message.read_by(current_user)
# => [ ]

标记所有消息为已读

Message.mark_as_read! :all, for: current_user

获取所有用户包括他们的阅读状态

users = User.with_read_marks_for(message1)
# => [ user1, user2 ]
users[0].have_read?(message1)
# => true
users[1].have_read?(message2)
# => false

3. 项目 API 使用文档

Unread 提供了以下 API 方法：

• unread_by(reader): 获取指定阅读者的未读记录
• read_by(reader): 获取指定阅读者的已读记录
• mark_as_read!(reader): 将指定记录标记为已读
• mark_as_read! :all, for: reader: 将所有记录标记为已读
• have_not_read(record): 获取尚未阅读指定记录的用户列表
• have_read(record): 获取已阅读指定记录的用户列表
• with_read_marks_for(reader): 获取包括阅读状态的所有记录
• cleanup_read_marks!: 清理不必要的阅读标记

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。

确保遵循上述步骤，以便正确安装和配置 Unread gem。

---

以上就是关于 Unread 项目的技术文档，希望对您有所帮助。