StateMachine 审计跟踪使用文档

1. 安装指南

首先，确保您的项目已经集成了 state_machine 插件。接下来，通过将以下内容添加到您的 Gemfile 文件中，并将 gem 安装到您的项目中：

gem 'state_machine-audit_trail'

完成添加后，执行 bundle install 命令来安装 gem。

2. 项目的使用说明

本项目为 state_machine 插件提供一个审计跟踪功能，能够为任何状态机维护一个完整的状态变更历史。以下是使用本项目的步骤：

• 创建一个模型/表格来存储审计跟踪信息。该表格需要包含指向原始对象的的外键、一个“事件”字段、一个“从”状态字段、一个“到”状态字段以及一个存储转换时间戳的“创建时间”字段。本项目提供了一个 Rails 3 生成器来创建这样的模型和迁移。

  对于 Rails 3，使用以下命令：

  rails generate state_machine:audit_trail <模型名> <状态属性>
  

  对于 Rails 2，使用以下命令：

  rails generate state_machine_audit_trail <模型名> <状态属性>
  

• 在您的模型中配置状态机，并指示状态机存储审计跟踪：

  class <模型名> < ActiveRecord::Base
    state_machine :state, :initial => :起始状态 do
      store_audit_trail
      ...
    end
  end
  

• 如果您的审计跟踪模型使用了非默认命名方案，您需要通过 :to 选项指定它：

  class <模型名> < ActiveRecord::Base
    state_machine :state, :initial => :起始状态 do
      store_audit_trail :to => '<自定义审计跟踪模型名>'
      ...
    end
  end
  

• 完成这些步骤后，插件将注册一个 after_transition 回调，用于记录所有状态转换。如果存在初始状态，它也会记录初始状态。

3. 项目API使用文档

本项目通过 store_audit_trail 方法提供审计跟踪功能。以下是一些高级用法：

• 如果您想在审计跟踪中存储额外的消息，可以使用以下方式：

  store_audit_trail :context_to_log => :状态消息方法名 # 将在模型上调用状态消息方法并存储到审计跟踪模型的状态消息字段
  

  或者

  store_audit_trail :context_to_log => [:字段1, :字段2] # 将在模型上调用字段1和字段2方法并将它们存储到审计跟踪模型对应的字段
  

• 存储虚拟属性：有时存储动态计算的信息可能很有用。在这些情况下，您只需在 DeploymentStateTransitions 表中定义一个新列，并配置 context_to_log。

  例如：

  class <模型名> < ActiveRecord::Base
    state_machine :state, :initial => :起始状态 do
      store_audit_trail :context_to_log => :版本
      ...
    end
  
    def 版本
      # 动态计算字段，例如，基于其他模型
      ...
    end
  end
  
  class 添加版本到DeploymentStateTransitions < ActiveRecord::Migration
    def change
      add_column :deployment_state_transitions, :版本, :string
      ...
    end
  end
  

4. 项目安装方式

本项目的安装方式已在“安装指南”部分说明，概括来说，就是通过修改 Gemfile 并执行 bundle install 命令。此外，需要通过 Rails 生成器创建审计跟踪模型和迁移文件，并按照上述使用说明配置模型。