Activerecord-bitemporal 项目启动与配置教程

1. 项目的目录结构及介绍

activerecord-bitemporal 项目是一个开源项目，它为 Ruby on Rails 应用程序提供双向时间属性的支持。以下是项目的目录结构及其简要介绍：

• Gemfile：项目的 Ruby 依赖文件，定义了项目所需的所有 Ruby 库。
• Gemfile.lock：Ruby 依赖的锁定文件，确保项目的所有依赖保持一致。
• lib：包含项目核心代码的目录。
  • activerecord-bitemporal：项目的主要模块。
  • version：包含项目版本信息的模块。
• spec：包含单元测试和功能测试的目录。
  • models：针对模型进行的测试。
  • version：针对版本模块的测试。
• test：遗留的测试目录，可能包含一些旧的测试代码。
• bin：可执行脚本目录（如果有的话）。
• MIT-LICENSE：项目的许可证文件。
• README.md：项目的说明文件，通常包含项目描述、安装指南、贡献指南等。

2. 项目的启动文件介绍

activerecord-bitemporal 项目作为一个 Ruby 库，通常不需要特定的启动文件。在 Rails 应用中使用时，你只需将其添加到你的 Gemfile 中，然后执行 bundle install 命令来安装依赖。

# Gemfile
gem 'activerecord-bitemporal'

安装完成后，你可以在 Rails 应用的模型中引入和配置 activerecord-bitemporal。

3. 项目的配置文件介绍

activerecord-bitemporal 的配置主要通过 Rails 应用的模型和迁移来完成。以下是一些基本的配置步骤：

• 模型配置：在模型中声明 bitemporal，指定时间跟踪的属性。

class YourModel < ApplicationRecord
  bitemporal
end

• 迁移文件：在迁移文件中创建时间戳列，并确保使用了 bitemporal 方法。

class AddBitemporalToYourModel < ActiveRecord::Migration[6.0]
  def change
    add_column :your_models, :start_time, :datetime
    add_column :your_models, :end_time, :datetime
    add_column :your_models, :transaction_start, :datetime
    add_column :your_models, :transaction_end, :datetime

    YourModel.bitemporal
  end
end

• 数据库适配器：确保你的数据库适配器支持 activerecord-bitemporal 所需的功能。

完成上述配置后，你的 Rails 应用就可以使用 activerecord-bitemporal 提供的双向时间追踪功能了。记得在每次迁移后运行 rails db:migrate 来应用变更。