ruby-refactor

社区 Ruby 重构最佳实践

由社区维护的 Ruby 应用综合重构指南。包含 8 个类别、45 条规则，并按影响力排序，帮助指导自动化重构和代码生成。

适用场景

在以下情况下参考这些指南：

• 重构 Ruby 代码，以降低复杂度并改进设计
• 从大型代码单元中提取方法、类或值对象
• 简化复杂条件判断和深层嵌套
• 减少类与模块之间的耦合
• 采用惯用的 Ruby 模式和现代 Ruby 3.x 特性

按优先级划分的规则类别

优先级	类别	影响	前缀
1	结构与分解	严重	struct-
2	条件简化	严重	cond-
3	耦合与依赖	高	couple-
4	Ruby 惯用法	高	idiom-
5	数据与值对象	中高	data-
6	设计模式	中	pattern-
7	现代 Ruby 3.x	中	modern-
8	命名与可读性	中低	name-

快速参考

1. 结构与分解（严重）

• struct-extract-method - 将长方法提取为职责明确的单元
• struct-extract-class - 提取类以实现单一职责
• struct-parameter-object - 为过长的参数列表引入参数对象
• struct-compose-method - 将方法组合在同一抽象层级
• struct-replace-method-with-object - 用方法对象替换复杂方法
• struct-single-responsibility - 每个类只有一个变更理由
• struct-flatten-deep-nesting - 通过提前提取来扁平化深层嵌套

2. 条件简化（严重）

• cond-guard-clauses - 用守卫子句替换嵌套条件判断
• cond-decompose-conditional - 将复杂布尔表达式提取为具名谓词
• cond-replace-with-polymorphism - 用多态替换 case/when
• cond-null-object - 用空对象替换 nil 检查
• cond-pattern-matching - 使用模式匹配处理结构条件
• cond-consolidate-duplicates - 合并重复的条件代码片段

3. 耦合与依赖（高）

• couple-law-of-demeter - 通过委托贯彻迪米特法则
• couple-feature-envy - 移动方法以解决特性依恋
• couple-dependency-injection - 通过构造函数默认值注入依赖
• couple-composition-over-inheritance - 用组合对象替换混入
• couple-tell-dont-ask - 告诉对象要做什么，而非查询其状态
• couple-avoid-class-methods-domain - 避免在领域逻辑中使用类方法

4. Ruby 惯用法（高）

• idiom-prefer-enumerable - 使用 map/select/reject 代替带累加器的 each
• idiom-keyword-arguments - 使用关键字参数，提升清晰度
• idiom-duck-typing - 使用 respond_to? 而非 is_a? 进行类型检查
• idiom-predicate-methods - 布尔方法使用 ? 后缀命名
• idiom-respond-to-missing - 始终将 method_missing 与 respond_to_missing? 配对使用
• idiom-block-yield - 对于简单代码块，使用 yield 而非 block.call
• idiom-implicit-return - 省略最后一个表达式前的显式 return

5. 数据与值对象（中高）

• data-value-object - 用值对象替代对基本类型的过度依赖
• data-define-immutable - 使用 Data.define 创建不可变值对象
• data-encapsulate-collection - 通过领域方法封装集合
• data-replace-data-clump - 用分组对象替代数据簇
• data-separate-query-command - 将查询方法与命令方法分离

6. 设计模式（中）

• pattern-strategy - 将算法变体提取为策略对象
• pattern-factory - 使用工厂方法抽象对象创建过程
• pattern-template-method - 使用模板方法定义算法骨架
• pattern-decorator - 使用装饰器包装对象以增加行为
• pattern-null-object-protocol - 使用完整协议实现空对象

7. 现代 Ruby 3.x（中）

• modern-pattern-matching - 使用 case/in 进行结构化模式匹配
• modern-deconstruct-keys - 实现 deconstruct_keys 以支持自定义模式匹配
• modern-endless-methods - 使用无终止符方法定义简化简单方法
• modern-hash-pattern-guard - 使用带守卫子句的模式匹配
• modern-rightward-assignment - 使用右向赋值处理流水线表达式

8. 命名与可读性（低中）

• name-intention-revealing - 使用能体现意图的名称
• name-consistent-vocabulary - 在整个代码库中为每个概念使用统一词汇
• name-avoid-abbreviations - 除通用缩写外，将名称拼写完整
• name-rename-to-remove-comments - 通过重命名消除注释需求

使用方法

阅读单独的参考文件，了解详细说明和代码示例：

• 章节定义 - 类别结构和影响级别
• 规则模板 - 添加新规则的模板

参考文件

文件	说明
references/_sections.md	类别定义和排序
assets/templates/_template.md	新规则模板
metadata.json	版本和参考信息