Transitions 项目技术文档

1. 安装指南

1.1 在 Rails 项目中安装

在 Rails 项目中，可以通过 Gemfile 安装 transitions 库。首先，在 Gemfile 中添加以下内容：

gem "transitions", :require => ["transitions", "active_model/transitions"]

然后，在你的 ORM 模型中引入 ActiveModel::Transitions：

include ActiveModel::Transitions

1.2 独立安装

如果你不在 Rails 项目中，可以通过以下命令安装 transitions：

gem install transitions

安装完成后，在你的类中引入 Transitions：

include Transitions

2. 项目的使用说明

transitions 是一个 Ruby 状态机实现库，允许你在模型中定义状态和状态转换。以下是一个简单的使用示例：

class Product
  include ActiveModel::Transitions

  state_machine do
    state :available # 初始状态
    state :out_of_stock, :exit => :exit_out_of_stock
    state :discontinued, :enter => lambda { |product| product.cancel_orders }

    event :discontinued do
      transitions :to => :discontinued, :from => [:available, :out_of_stock], :on_transition => :do_discontinue
    end
    event :out_of_stock, :success => :reorder do
      transitions :to => :out_of_stock, :from => [:available, :discontinued]
    end
    event :available do
      transitions :to => :available, :from => [:out_of_stock], :guard => lambda { |product| product.in_stock > 0 }
    end
  end
end

在这个示例中，我们定义了一个 Product 类，并为其定义了三个状态：available、out_of_stock 和 discontinued。每个状态都可以定义进入和退出时的回调方法。

3. 项目 API 使用文档

3.1 获取和设置当前状态

使用 current_state 方法可以获取当前状态。如果你没有显式设置状态，将返回初始状态：

>> Product.new.current_state
=> :available

你也可以通过 update_current_state(new_state, persist = true / false) 方法显式设置新状态，但不建议直接使用此方法，除非你非常清楚自己在做什么。

3.2 事件

每个事件定义会生成三个方法：事件名称、事件名称加 ! 和 can_事件名称?。例如，定义一个 discontinue 事件会生成 discontinue、discontinue! 和 can_discontinue? 方法。

• discontinue 和 discontinue! 方法会在成功转换时修改 state 属性，但只有 discontinue! 会调用 save! 方法。
• can_discontinue? 方法不会修改状态，而是返回一个布尔值，表示给定的转换是否可能。

3.3 回调

transitions 提供了多种回调，允许你在状态转换的不同阶段执行代码：

• State callbacks (enter 和 exit)：在进入或退出状态时触发。
• Transition callback (on_transition)：在转换过程中执行的回调。
• Event callback (success)：在成功转换后执行的回调。

4. 项目安装方式

4.1 在 Rails 项目中安装

在 Rails 项目中，通过 Gemfile 安装 transitions：

gem "transitions", :require => ["transitions", "active_model/transitions"]

然后在模型中引入 ActiveModel::Transitions：

include ActiveModel::Transitions

4.2 独立安装

通过以下命令安装 transitions：

gem install transitions

安装完成后，在类中引入 Transitions：

include Transitions

通过以上步骤，你可以在项目中成功安装并使用 transitions 库。