PaperTrail 开源项目教程

PaperTrail 开源项目教程

paper_trailTrack changes to your rails models项目地址:https://gitcode.com/gh_mirrors/pa/paper_trail

项目介绍

PaperTrail 是一个用于记录 ActiveRecord 模型变化的 Ruby gem。它可以帮助开发者追踪和记录数据库中数据的变更历史，适用于审计、版本控制和数据恢复等场景。

项目快速启动

安装

在 Gemfile 中添加以下内容：

gem 'paper_trail'

然后运行：

bundle install

配置

在应用的初始化文件中（如 config/initializers/paper_trail.rb）添加以下内容：

PaperTrail.config do |config|
  config.enabled = true
end

启用版本控制

在需要版本控制的模型中添加 has_paper_trail：

class Article < ApplicationRecord
  has_paper_trail
end

使用示例

创建一个新文章并查看其版本历史：

article = Article.create(title: "First Article")
article.update(title: "Updated Title")

article.versions.each do |version|
  puts version.changeset
end

应用案例和最佳实践

审计日志

PaperTrail 常用于生成审计日志，记录用户对数据的每一次修改。例如，在用户管理系统中，可以记录用户信息的每次变更。

数据恢复

当数据被误删除或修改时，可以通过 PaperTrail 恢复到之前的版本。例如，恢复误删除的文章：

article = Article.find(1)
version = article.versions.last
restored_article = version.reify
restored_article.save

版本比较

通过比较不同版本的数据，可以了解数据的变更细节。例如，比较两个版本之间的差异：

version1 = article.versions[0]
version2 = article.versions[1]

diff = version1.changeset.diff(version2.changeset)
puts diff

典型生态项目

Audited

Audited 是另一个流行的 Ruby gem，用于记录 ActiveRecord 模型的变更历史。与 PaperTrail 类似，但它提供了更多的配置选项和灵活性。

Vestal Versions

Vestal Versions 是另一个用于版本控制的 gem，它提供了一些独特的功能，如版本合并和版本标签。

通过这些生态项目，开发者可以根据具体需求选择最适合的工具来管理数据版本和变更历史。

paper_trailTrack changes to your rails models项目地址:https://gitcode.com/gh_mirrors/pa/paper_trail