Paul Revere 项目技术文档

1. 安装指南

1.1 添加 Gem

首先，在您的 Rails 项目的 Gemfile 中添加以下内容：

gem "paul_revere"

1.2 运行生成器

接下来，运行生成器以创建迁移文件并复制 JavaScript 文件：

rails generate paul_revere

1.3 添加 JavaScript

将生成的 JavaScript 文件添加到 app/assets/javascripts/application.js 中：

//= require announcements

1.4 运行迁移

创建公告表，运行以下命令：

rake db:migrate

1.5 复制视图部分

最后，运行以下命令以将内置的视图部分复制到您的 Rails 应用程序中：

rails generate paul_revere:views

2. 项目使用说明

2.1 使用公告部分

在您的视图代码中，您可以使用以下部分来显示公告：

• 对于所有站点用户：

<%= render "announcements/public_announcement" %>

• 仅对已登录用户：

<%= render "announcements/private_announcement" %>

• 在邮件视图中：

<%= render "announcements/email_announcement" %>

2.2 创建公告

您可以通过 Rails 控制台创建新的公告记录：

Announcement.create!(body: "Free ice cream on Monday!")

2.3 自定义公告可见性

默认情况下，private_announcement 部分会调用 announcement_visibility_allowed? 方法来确定当前会话是否可以查看公告。默认实现仅检查 current_user 是否为真。如果您需要更复杂的检查，可以覆盖此辅助方法。

3. 项目 API 使用文档

3.1 Announcement 模型

• Announcement 模型包含 created_at 和 updated_at 时间戳，以及一个 body 文本列。
• current 类方法返回最新的 Announcement 记录，如果没有则返回一个新的未保存实例。

3.2 视图辅助方法

• #current_announcement 视图辅助方法返回最新的 Announcement 记录。

3.3 视图部分

• _public_announcement：用于显示给所有站点用户的公告。
• _private_announcement：仅用于显示给已登录用户的公告。
• _email_announcement：用于在站点邮件中包含公告。

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 gem "paul_revere"，然后运行 bundle install。

4.2 运行生成器和迁移

运行生成器以创建迁移文件并复制 JavaScript 文件，然后运行迁移以创建公告表。

4.3 添加 JavaScript 和视图部分

将生成的 JavaScript 文件添加到 application.js 中，并复制视图部分到您的应用程序中。

通过以上步骤，您可以成功安装并使用 Paul Revere 项目。