SuperAPI AI 工具集

review-ruby

编程与开发

查看项目

更新于 11-03 16:18

技能介绍

review-ruby 是一个面向 Ruby 代码审查与重构的技能,核心目标是发现代码中不必要的自定义对象、类膨胀以及对 Ruby 通用数据结构利用不足的问题,并给出具体重构步骤与前后代码示例。资料说明其适用于库、gem、CLI 工具和 Ruby 应用。

用途与审查范围 该技能在用户要求“review ruby code”“audit ruby codebase”“find over-engineering in ruby”“simplify ruby classes”等场景下使用。范围判定方式包括:给出文件路径时只分析这些文件;给出目录路径时分析该目录下所有 Ruby 文件;给出分支名时对比当前分支与该分支,只审查变更文件;未指定范围时对 lib/ 目录执行完整代码库审计;也可指定“command objects”“data structures”等关注点进行优先分析。

主要能力 资料列出的反模式扫描包括四类。第一,不必要的类层次结构:简单行为使用超过两层的深继承树、只有单一实现的抽象基类、本可作为模块或简单函数的类、本可用块替代的模板方法模式。第二,过度设计的数据对象:为简单数据对(坐标、区间、元组)创建自定义类、没有行为/校验/转换的值对象、缺少 each、to_h、to_a、to_json、to_s 等 Ruby 协议实现、本应使用 Struct、Data 或 Hash 的数据对象。第三,本可用函数实现的有状态对象:只有类方法的类(应为模块)、单方法类(call、run、execute、perform)、简单对象构造却使用建造者模式、本可写成纯函数的有状态服务对象。第四,可简化的复杂度:重新发明 Ruby 语法的自定义 DSL、标准库的包装类、可用简单代码替代的复杂元编程、为简单任务引入不必要依赖的 gem。

使用方式与输出 资料要求强制加载 simplifying-ruby-code 技能,并在整个分析中应用其原则、明确引用具体模式(例如“Pattern 1: Command Objects -> Module Functions”)。每个问题需提供:文件与位置及行号、问题说明(为何违反简洁原则)、重构前代码、重构后代码、迁移步骤、测试注意事项。结果按严重问题(优先修复)、改进项、发现的好模式、总结(含建议重构顺序与预估复杂度)组织。资料未提供安装命令、调用命令或平台细节。

最佳实践 优先数据而非对象,简单数据使用 Hash、Array、Struct 和 Data;优先函数而非类,无状态操作用带 module_function 的模块;实现 Ruby 协议,使对象可与内置方法和 Enumerable 协作;有效使用块,以块替代回调对象;保持继承浅层,优先组合与模块;充分利用标准库,不重复实现 Array、Hash、Set 等。

适用场景与限制 适用于 Ruby 项目的代码审查、重构规划与过度设计识别。限制方面,资料未说明其支持的 Ruby 版本、运行环境、依赖安装方式、是否支持自动修复、收费模式或效果保证,这些信息暂未提供。