Temping 项目技术文档

本文档将详细介绍如何安装、使用Temping项目，以及如何使用其API。Temping允许您为测试创建任意基于临时SQL表的ActiveRecord模型。

1. 安装指南

在Gemfile中添加以下代码：

gem "temping"

在test_helper.rb文件中，如果是使用ActiveSupport::TestCase，请添加以下代码块：

class ActiveSupport::TestCase
  # ...
  teardown do
    Temping.teardown
  end
  # ...
end

如果是使用rspec，在spec_helper.rb中添加以下代码块：

RSpec.configure do |config|
  # ...
  config.after do
    Temping.teardown
  end
  # ...
end

如果你想仅清理表但保留定义的模型在内存中，可以使用：

Temping.cleanup

2. 项目的使用说明

Temping的基本设置包括调用create方法，并传递一个表示要创建的模型类名的符号。默认情况下，这将创建一个包含id列的临时表。

Temping.create(:dog)

Dog.create # => <Dog id: 1>
Dog.table_name # => "dogs"
Dog # => Dog(id: integer)

请注意，表名始终是复数形式，而类名是单数形式。

Temping.create(:dogs)

Dog.table_name # => "dogs"
Dogs # => NameError: uninitialized constant Dogs

可以通过with_columns方法指定额外的数据库列，它使用Rails迁移语法：

Temping.create(:dog) do
  with_columns do |t|
    t.string :name
    t.integer :age, :weight
  end
end

Dog.create # => <Dog id: 1, name: nil, age: nil, weight: nil>

当向create传递一个块时，该块在类的上下文中执行。这意味着在ActiveRecord模型类体中可以做的任何事情都可以在块中完成，包括方法定义、验证、模块包含等。

Temping.create(:dog) do
  validates :name, presence: true

  with_columns do |t|
    t.string :name
    t.integer :age, :weight
  end

  def quack
    "arf!"
  end
end

Dog.create!

# => ActiveRecord::RecordInvalid: Validation failed: Name can't be blank

codey = Dog.create!(name: "Codey")
codey.quack

# => "arf!"

传递给create_table的所有属性也会被评估。例如，您可以创建一个主键类型为uuid的狗（假设您使用的是启用了uuid-ossp扩展的PostgreSQL）：

Temping.create(:dog, id: :uuid, default: -> { "uuid_generate_v4()" })

Dog.create # => <Dog id: d937951b-765c-4bc9-804e-3171d22117b0>

3. 项目API使用文档

• Temping.create(symbol, [parent_class: nil])：创建一个名为symbol的临时模型。可选地，可以指定一个父类。
• Temping.create(symbol) do ... end：在块中定义模型的结构和属性。
• Temping.teardown：在测试结束时调用，用于销毁所有临时表和定义的模型。
• Temping.cleanup：清理所有临时表，但保留定义的模型在内存中。

4. 项目安装方式

请遵循以下步骤来安装Temping：

• 将Temping添加到您的Gemfile中。
• 运行bundle install来安装gem。
• 根据您的测试框架（如ActiveSupport或RSpec），在相应的测试帮助文件中配置Temping。

通过遵循以上步骤，您将能够成功安装和使用Temping项目。