ActivePresenter 技术文档

1. 安装指南

通过 Gem 安装

$ sudo gem install active_presenter

作为 Rails Gem 依赖

在 config/environment.rb 文件中添加以下配置：

config.gem 'active_presenter'

通过 GitHub 获取源码

$ git clone git://github.com/giraffesoft/active_presenter.git

你也可以在 GitHub 上 fork 该项目：GitHub 仓库地址

2. 项目使用说明

创建 Presenter

创建一个 Presenter 非常简单，只需继承 ActivePresenter::Base 类，并使用 presents 方法指定需要呈现的模型。

class SignupPresenter < ActivePresenter::Base
  presents :user, :account
end

在上面的例子中，:user 将自动成为 User 模型。如果你想覆盖这种行为，可以在 presents 方法中使用哈希指定模型类型：

class PresenterWithTwoAddresses < ActivePresenter::Base
  presents :primary_address => Address, :secondary_address => Address
end

实例化 Presenter

你可以使用两种形式来实例化 Presenter：

1. 通过参数哈希初始化：

SignupPresenter.new(:user_login => 'james', :user_password => 'swordfish', :user_password_confirmation => 'swordfish', :account_subdomain => 'giraffesoft')

2. 通过模型实例初始化：

SignupPresenter.new(:user => User.find(1), :account => Account.find(2))

这两种形式可以混合使用：

SignupPresenter.new(:user => User.find(1), :user_login => 'james')

验证

#valid? 方法将根据呈现对象的有效性返回 true 或 false。你可以通过以下两种方式获取错误信息：

1. 调用 #errors 方法：

@presenter.errors.on(:user_login)

2. 调用 @presenter.user_errors 或 @presenter.user.errors：

@presenter.user_errors

受保护和可访问的属性

ActivePresenter 支持 attr_protected 和 attr_accessible，类似于 ActiveRecord 对象，以避免大规模赋值。

class AccountPresenter < ActivePresenter::Base
  presents :user, :profile
  attr_accessible :user_email, :profile_birthday
end

保存

你可以像保存 ActiveRecord 对象一样保存 Presenter。#save 和 #save! 的行为与 ActiveRecord 中的行为相同。

回调

回调的工作方式与 ActiveRecord 回调完全相同。支持 before_save 和 after_save 回调。

3. 项目 API 使用文档

presents 方法

presents 方法用于指定 Presenter 需要呈现的模型。可以接受符号或哈希作为参数。

presents :user, :account

new 方法

new 方法用于实例化 Presenter，可以接受参数哈希或模型实例。

SignupPresenter.new(:user_login => 'james', :user_password => 'swordfish')

valid? 方法

valid? 方法用于验证 Presenter 的有效性。

@presenter.valid?

errors 方法

errors 方法用于获取 Presenter 的错误信息。

@presenter.errors.on(:user_login)

save 和 save! 方法

save 和 save! 方法用于保存 Presenter。

@presenter.save

4. 项目安装方式

通过 Gem 安装

$ sudo gem install active_presenter

作为 Rails Gem 依赖

在 config/environment.rb 文件中添加以下配置：

config.gem 'active_presenter'

通过 GitHub 获取源码

$ git clone git://github.com/giraffesoft/active_presenter.git

你也可以在 GitHub 上 fork 该项目：GitHub 仓库地址