Combustion 项目使用教程

Combustion 项目使用教程

combustion Simple, elegant testing for Rails Engines 项目地址: https://gitcode.com/gh_mirrors/co/combustion

1. 项目介绍

Combustion 是一个用于测试 Rails Engines 的简单而优雅的库。它允许你在引擎的上下文中编写测试，而不需要在 spec 或 test 文件夹中创建一个完整的 Rails 应用程序。Combustion 只加载你需要的 Rails 应用部分，从而简化了测试过程。

2. 项目快速启动

安装

首先，将 Combustion 添加到你的 Gemfile 或 gemspec 中：

# 在 Gemfile 中
gem 'combustion', '~> 1.3'

# 或在 gemspec 中
spec.add_development_dependency 'combustion', '~> 1.3'

然后运行 bundle install 安装依赖。

初始化

在你的 spec_helper.rb 中，初始化 Combustion：

require 'bundler'
Bundler.require(:default, :development)

# 初始化所有 Rails 组件
Combustion.initialize! :all

# 或者只初始化你需要的组件
# Combustion.initialize! :active_record, :action_controller

require 'rspec/rails'

生成测试应用

运行以下命令生成一个最小化的 Rails 应用：

combust

编写测试

现在你可以像测试一个完整的 Rails 应用一样编写测试。例如：

require 'spec_helper'

describe Page do
  describe '#valid' do
    it 'requires a name' do
      # 编写你的测试代码
    end
  end
end

3. 应用案例和最佳实践

应用案例

Combustion 特别适用于以下场景：

• Rails Engines 测试：当你开发一个 Rails Engine 时，Combustion 可以帮助你快速设置测试环境，而不需要创建一个完整的 Rails 应用。
• 轻量级测试：如果你只需要测试 Rails 应用的某些部分（如 ActiveRecord 或 ActionController），Combustion 可以只加载这些部分，从而加快测试速度。

最佳实践

• 按需加载组件：在 Combustion.initialize! 中只加载你需要的 Rails 组件，以减少不必要的依赖和加载时间。

• 自定义测试应用目录：如果你希望将测试应用放在其他目录，可以在初始化 Combustion 之前设置路径：

  Combustion.path = 'spec/dummy'
  Combustion.initialize! :all
  

• 使用其他 Rails 库：如果你使用其他依赖 Rails 的库（如 FactoryBot），可能需要手动管理它们的加载顺序，以避免与 Combustion 的初始化冲突。

4. 典型生态项目

Combustion 通常与其他 Rails 相关的测试工具和库一起使用，以构建一个完整的测试生态系统。以下是一些常见的生态项目：

• RSpec：用于编写和运行测试。
• Capybara：用于集成测试和模拟用户交互。
• FactoryBot：用于创建测试数据。
• DatabaseCleaner：用于在测试之间清理数据库。

这些工具与 Combustion 结合使用，可以为你的 Rails Engine 提供全面的测试支持。

combustion Simple, elegant testing for Rails Engines 项目地址: https://gitcode.com/gh_mirrors/co/combustion