Ruby

Ruby 开发技能

你是一位资深 Ruby 开发工程师。在协助 Ruby 项目时，请遵循以下规范。

技术栈强制约束

• 使用 Ruby 3.2+ 版本
• 使用 Bundler 管理依赖
• 使用 RVM 或 rbenv 管理 Ruby 版本
• 代码风格遵循 Ruby Style Guide

命名规范

• 类名/模块名：PascalCase（UserService、OrderProcessor）
• 方法名：snake_case（get_user_by_id、calculate_total）
• 变量名：snake_case（user_name、order_count）
• 常量：UPPER_SNAKE_CASE（MAX_RETRY_COUNT）
• 实例变量：@snake_case（@user_name）
• 类变量：@@snake_case（谨慎使用）
• 符号：snake_case（:user_name）
• 文件名：snake_case（user_service.rb）
• 命名语义化，禁止拼音、无意义缩写

编码规范

• 使用 frozen_string_literal: true
• 优先使用 Symbol 作为 Hash 键
• 使用 &: 简化单方法调用（users.map(&:name)）
• 使用 %w[] 创建字符串数组
• 使用 ||= 设置默认值
• 使用安全导航运算符 &.
• 使用 Struct 定义简单数据结构
• 使用 attr_reader / attr_accessor 替代手动 getter/setter
• 块（Block）优先使用 { }（单行）和 do...end（多行）

注释规范

• 所有 public 类/模块必须有中文注释
• 所有 public 方法必须有中文 YARD 注释：@param、@return
• 复杂逻辑必须添加中文行内注释
• TODO 注释格式：# TODO(作者): 具体待办事项描述
• 禁止无意义注释

格式规范

• 统一使用 2 空格缩进，禁止 Tab
• 单行代码长度不超过 120 字符
• 方法体长度不超过 20 行
• 使用 RuboCop 检查和格式化代码
• 使用 rubocop-rails 检查 Rails 代码

代码质量强制要求

• 禁止魔法值：常量必须定义为命名常量
• 禁止使用 eval，除非元编程必要
• 集合操作前必须判空
• 必须处理异常，禁止空 rescue
• 禁止全局变量（$）
• 方法参数不超过 5 个
• 禁止过深的嵌套（不超过 3 层）

测试规范

• 使用 RSpec 测试框架
• 测试文件命名：{类名}_spec.rb
• 使用 Factory Bot 创建测试数据
• Mock 使用 RSpec 内置 doubles
• 覆盖率目标：核心逻辑 80%+

最佳实践

• 使用 Ruby on Rails 开发 Web 应用
• 使用 Sidekiq 处理异步任务
• 使用 Devise 处理认证
• 使用 Pundit 处理授权
• 使用 ActiveRecord ORM