Observational 项目技术文档

1. 安装指南

Observational 是一个基于观察者模式的项目，主要用于简化 Rails 应用中的回调逻辑。以下是安装 Observational 的步骤：

1. 添加 Gem 到 Gemfile： 在 Rails 项目的 Gemfile 中添加以下行：

   gem 'observational'
   

2. 安装 Gem： 在终端中运行以下命令来安装 Gem：

   bundle install
   

3. 生成文档： Observational 使用 YARD 生成文档。你可以通过以下命令生成文档：

   yard doc
   

2. 项目的使用说明

Observational 的主要功能是使用观察者模式来处理 ActiveRecord 的回调。通过 Observational，你可以将原本需要在模型中定义的回调逻辑转移到观察者类中，从而使代码更加清晰和模块化。

示例

假设你有一个 User 模型，当用户创建时，需要发送欢迎消息。传统的做法是在 User 模型中定义一个回调方法：

class User
  after_create :deliver_welcome_message

  protected
  def deliver_welcome_message
    Notifier.deliver_welcome_message(self)
  end
end

使用 Observational 后，你可以将这个逻辑转移到 Notifier 类中：

class Notifier < ActionMailer::Base
  observes :user, :invokes => :deliver_welcome_message, :after => :create

  def welcome_message(user)
    # 发送邮件的逻辑
  end
end

在这个例子中，当 User 创建后，Notifier.deliver_welcome_message(user) 会自动被调用。

3. 项目API使用文档

observes 方法

observes 方法是 Observational 的核心方法，用于定义观察者类与被观察对象之间的关系。

参数说明

• :user：被观察的对象，通常是一个 ActiveRecord 模型。
• :invokes：指定观察者类中要调用的方法。
• :after：指定在哪个 ActiveRecord 回调之后调用观察者方法。
• :with：可选参数，指定观察者方法接收的参数。

示例

class Creditor
  observes :message, :invokes => :use_credit, :with => :creator, :after => :create

  def use_credit(user)
    # 处理信用逻辑
  end
end

在这个例子中，当 Message 创建后，Creditor.use_credit(message.creator) 会被调用。

4. 项目安装方式

Observational 的安装方式非常简单，只需按照以下步骤操作：

1. 在 Gemfile 中添加 gem 'observational'。
2. 运行 bundle install 安装 Gem。
3. 使用 yard doc 生成文档。

通过以上步骤，你就可以成功安装并使用 Observational 来简化 Rails 应用中的回调逻辑。