SuperAPI AI 工具集

simplifying-ruby-code

编程与开发

查看项目

更新于 11-03 16:18

技能介绍

用途

该技能用于识别 Ruby 代码中的过度工程,并给出简化方向:优先使用简单数据结构(Hash、Array、Struct、Data)和纯函数,而不是不必要的类和抽象。

核心原则

  • 优先简单数据结构与纯函数,避免多余的类和抽象。
  • 强制要求:判断代码是“决策”(纯逻辑)还是“效果”(I/O),并将两者分离。技能中指向 writing-code 技能。

何时使用

  • 只有一个 call 方法且没有状态的命令对象。
  • 只包裹数据、没有行为的值对象。
  • 本可作为模块函数的服务类。
  • 为坐标、区间、元组等简单数据编写的自定义类。
  • 本可用组合替代的深层继承。
  • 缺少 Ruby 协议(to_h、to_a、each)的类。
  • 测试需要大量 mocking,说明关注点混杂。

常见过度工程模式与简化方式

  1. 命令对象 → 模块函数:单方法无状态的类可直接调用或改为模块函数;有状态、多步算法、需要排队的场景仍保留命令对象。
  2. 值对象 → Struct/Data/Hash:固定属性且不可变可用 Data(Ruby 3.2+),可变可用 Struct,最简单可用 Hash。
  3. 工具类 → 模块:只有类方法的类可改为带 module_function 的模块。
  4. 深层继承 → 组合:用模块 include 共享行为。

数据结构选型

  • Hash:临时数据、键不固定、JSON 接口。
  • Struct:固定属性、需要方法、可变可以接受。
  • Data:固定属性、不可变(Ruby 3.2+)。
  • 自定义类:复杂校验、丰富行为、领域概念。

Ruby 协议

为实现与标准库的互操作,应实现 to_h、to_a、to_json、to_s、each、<=>、hash/eql? 等协议。示例中通过 include Enumerable 并定义 each 获得 map、select 等能力。

重构步骤

  1. 标记纯逻辑与 I/O。
  2. 提取带数据参数的模块函数。
  3. 对纯函数测试,无需 mock。
  4. 用 Struct/Data/Hash 替换类。
  5. 内联无价值的包装层。

检测清单

  • 单方法无状态命令对象 → 模块函数。
  • 无行为值对象 → Struct/Data/Hash。
  • 仅类方法的类 → 模块。
  • 包装单一操作的服务 → 直接调用。
  • 为共享行为的深层继承 → 模块/组合。
  • 缺少 to_h、to_a、to_json → 补充协议。
  • 测试需大量 mocking → 分离决策与效果。

限制

资料未说明该技能的安装方式、运行环境要求或工具集成细节,暂未提供。