SuperAPI AI 工具集

tdd-refactoring-agent

编程与开发

查看项目

更新于 10-16 06:08

技能介绍

tdd-refactoring-agent 是一个面向 Rails 应用的代码重构 AI 代理,专注于 TDD 的 REFACTOR 阶段。它的核心使命是在不改变代码行为的前提下,改进代码结构、可读性和可维护性。

用途:该代理用于在测试驱动开发流程中执行 REFACTOR 阶段。TDD 分为 RED(写一个失败测试)、GREEN(写最少代码让测试通过)、REFACTOR(在不破坏测试的情况下改进代码)三个阶段,该代理正对应 REFACTOR 阶段。它适合需要重构 Rails 代码、提取方法、消除重复、简化条件、降低复杂度、遵循 SOLID 原则的场景。

主要能力:它可以重构 app/models、app/controllers、app/services、app/queries、app/presenters、app/components、app/forms、app/validators、app/policies、app/jobs、app/mailers 等目录下的代码。它只读取和运行 spec/ 下的测试文件,绝不修改测试。它内置了八种常见重构模式:提取方法、用多态替换条件、引入参数对象、用命名常量替换魔法数字、分解条件、消除重复(DRY)、简化卫语句、从胖模型提取服务。它还提供重构工作流、检查清单和边界规则。

使用方式:使用时,需要先运行完整测试套件确认全部通过:bundle exec rspec。然后使用分析工具识别重构机会,例如 bundle exec flog app/ 查找复杂方法、bundle exec flay app/ 查找重复代码、bundle exec rubocop 检查风格问题。接着一次只做一个小的改动,例如提取一个方法、重命名一个变量、消除一处重复或简化一个条件。每次改动后立即运行 bundle exec rspec 验证测试是否保持绿色;如果测试通过则继续并提交,如果测试失败则立即回滚并分析原因,尝试更小的改动。重复该循环直到代码整洁,最后运行 bundle exec rspec、bundle exec rubocop -a、bin/brakeman 和 bundle exec flog app/ 做最终验证。其他可用命令包括:针对特定测试文件运行 bundle exec rspec spec/services/entities/create_service_spec.rb、快速反馈 bundle exec rspec --fail-fast、详细输出 bundle exec rspec --format documentation、监听模式 bundle exec guard、自动修复风格 bundle exec rubocop -a、安全扫描 bin/brakeman、Rails 控制台 bin/rails console。

适用场景:适用于 Rails 8.1 / Ruby 3.3 项目,技术栈包含 Hotwire(Turbo + Stimulus)、PostgreSQL、RSpec、Pundit、ViewComponent。适合在测试齐全且全部通过的前提下,对模型、控制器、服务、查询对象、Presenter、视图组件、表单对象、自定义校验器、Pundit 策略、后台任务和邮件器进行结构优化。

限制:它明确划定了边界。始终要做:重构前后运行完整测试套件、一次只做一个小改动、每次改动后运行测试、测试失败就停止、保持行为完全一致、改进结构与可读性、遵循 SOLID、消除重复、简化复杂逻辑、运行 RuboCop 修复风格、每次成功重构后提交。需要先询问:重大架构变更、提取到新的 gem 或 engine、修改公共 API、在没有测试覆盖时重构、性能优化(必须先测量)。绝不要做:在测试失败时重构、改变行为或业务逻辑、在重构时添加新功能、在重构时修复 bug(应作为单独任务)、为了让测试通过而修改测试、改动后跳过测试、测试前做多个改动、测试失败还继续、在没有测试时重构、删除测试、改变测试预期。如果测试失败、行为改变、添加新功能、修复 bug 或需要修改测试才能通过,应立即停止。