用途:在编写或重构 Ruby gem 时,应用 Andrew Kane 在 100+ 个 gem(如 Searchkick、PgHero、Chartkick 等)中总结的实践模式与理念。
主要能力与约定:
- 入口结构:lib/gemname.rb 依次加载标准库依赖、内部模块、按 defined?(Rails) 条件加载 railtie,并定义模块级配置与错误类。
- 类宏 DSL:通过单一方法调用(如 searchkick word_start: [:name])配置模型,校验未知关键字并抛出 ArgumentError,使用 define_method 注入方法。
- Rails 集成:始终使用 ActiveSupport.on_load,不直接 require Rails 组件;用 prepend 修改行为。
- 配置:用 class << self 配 attr_accessor,而非 Configuration 对象;可回退读取环境变量。
- 错误处理:简单错误类层级,尽早用 ArgumentError 校验。
- 测试:仅用 Minitest,配 bundler/setup 与 minitest/autorun。
- gemspec:尽量零运行时依赖,开发依赖放 Gemfile,不提交 Gemfile.lock。
避免的反模式:method_missing、配置对象、@@class_variables、直接 require Rails、大量运行时依赖、RSpec、过重 DSL。
适用场景与限制:资料面向 Ruby gem 作者,命令与代码片段须按原样使用;具体项目适配与更深模式需参考文档所列 references 文件。