ActiveMocker 使用教程

ActiveMocker 使用教程

active_mocker Generate mocks from ActiveRecord models for unit tests that run fast because they don’t need to load Rails or a database. 项目地址: https://gitcode.com/gh_mirrors/ac/active_mocker

1. 项目介绍

ActiveMocker 是一个用于生成 ActiveRecord 模型模拟类的开源项目。通过使用 ActiveMocker，开发者可以在单元测试中使用模拟类，而不需要加载 Rails 或数据库，从而显著提高测试速度。ActiveMocker 会分析 ActiveRecord 模型的方法和数据库列，生成一个 Ruby 类文件。这个模拟类可以在没有 Rails 和数据库的情况下独立运行，并且包含了 ActiveRecord 的许多有用功能。

2. 项目快速启动

2.1 安装

首先，将 ActiveMocker 添加到你的 Gemfile 中：

group :development, :test do
  gem 'active_mocker'
end

然后执行以下命令安装：

$ bundle install

或者手动安装：

$ gem install active_mocker

2.2 生成模拟类

在 Rails 项目中，运行以下 Rake 任务来生成或重新生成模拟类：

$ rake active_mocker:build

这个任务会在每次数据库模式更改后自动运行。如果模型发生变化，你需要手动运行此任务。

2.3 使用模拟类

在 RSpec 测试中使用模拟类：

require 'rspec'
require 'active_mocker/rspec_helper'
require 'spec/mocks/person_mock'
require 'spec/mocks/account_mock'

describe 'Example', active_mocker: true do
  before do
    Person.create # 使用 PersonMock.create
  end

  it 'should create a person' do
    person = Person.new(first_name: 'Dustin', last_name: 'Zeisler')
    expect(person.first_name).to eq('Dustin')
  end
end

3. 应用案例和最佳实践

3.1 提高测试速度

使用 ActiveMocker 生成的模拟类可以在不加载 Rails 和数据库的情况下运行测试，从而显著提高测试速度。这对于大型 Rails 项目尤其有用，可以减少测试运行时间。

3.2 防止测试与生产代码不一致

ActiveMocker 会在每次数据库模式更改后重新生成模拟类，确保模拟类与实际模型保持一致。这样可以防止测试通过但生产代码失败的情况。

3.3 自定义模拟类

你可以通过在模型文件中添加 ActiveMocker::safe_methods 注释来标记安全的方法，这些方法将被复制到生成的模拟类中。例如：

# ActiveMocker::safe_methods(scopes: [], instance_methods: [:full_name], class_methods: [])
class User
  def full_name
    "#{first_name} #{last_name}"
  end
end

4. 典型生态项目

4.1 RSpec

ActiveMocker 与 RSpec 集成良好，可以在 RSpec 测试中使用生成的模拟类。通过在 describe 块中添加 active_mocker: true 标签，RSpec 会自动使用模拟类进行测试。

4.2 Rails

ActiveMocker 主要用于 Rails 项目，特别是那些依赖 ActiveRecord 模型的项目。通过使用 ActiveMocker，开发者可以在不加载 Rails 和数据库的情况下进行单元测试，从而提高测试效率。

4.3 CodeClimate

ActiveMocker 可以与 CodeClimate 集成，用于代码质量分析。通过在 .codeclimate.yml 文件中配置，可以确保生成的模拟类符合代码质量标准。

engines:
  rubocop:
    enabled: true
    config: .rubocop.yml

通过以上步骤，你可以快速上手并充分利用 ActiveMocker 的优势，提高 Rails 项目的测试效率和代码质量。

active_mocker Generate mocks from ActiveRecord models for unit tests that run fast because they don’t need to load Rails or a database. 项目地址: https://gitcode.com/gh_mirrors/ac/active_mocker