SuperAPI AI 工具集

andrew-kane-gem-writer

编程与开发

查看项目

更新于 11-12 22:25

技能介绍

用途:该技能在编写或重构 Ruby gem 时提供一套遵循 Andrew Kane 风格的实现规范,资料来源称其模式来自 100 多个 gem、累计 374M+ 下载的项目实践(如 Searchkick、PgHero、Chartkick、Strong Migrations、Lockbox、Ahoy、Blazer、Groupdate、Neighbor、Blind Index)。

核心理念:简洁优先于取巧;零依赖或最小依赖;显式代码优于元编程;与 Rails 集成但不与 Rails 耦合;每个模式都服务于生产用例。

主要能力与约定:

  1. 入口文件结构:lib/gemname.rb 按固定顺序组织——先引入依赖(优先标准库,如 forwardable),再引入内部模块(model、version),然后用 require_relative "gemname/railtie" if defined?(Rails) 做条件加载(不得直接 require Rails),最后定义带配置与错误类的模块,并在定义时立即设置默认值(如 timeout = 10)。
  2. 类宏 DSL:以单次方法调用完成配置,示例为 searchkick word_start: [:name];实现时校验未知关键字并抛出 ArgumentError,通过匿名 Module 与 define_method 注入方法(避免 method_missing),并用 cattr_reader 保存选项。
  3. Rails 集成:始终使用 ActiveSupport.on_load(如 on_load(:active_record) 中 extend 模块),修改行为用 prepend;禁止直接 require active_record 等 Rails gem。
  4. 配置模式:使用 class << self 配合 attr_accessor,而非 Configuration 对象;敏感配置可回退到环境变量。
  5. 错误处理:简单的错误层级(Error、ConfigError、ValidationError 等),构造时尽早用 ArgumentError 校验参数。
  6. 测试:仅使用 Minitest,test_helper 中通过 bundler/setup、Bundler.require 与 minitest/autorun 组织。
  7. gemspec:尽量零运行时依赖,声明 required_ruby_version(示例 >= 3.1),不在 gemspec 中写 add_dependency,开发依赖放入 Gemfile。

应避免的反模式:method_missing、Configuration 对象、@@class_variables、直接 require Rails gem、大量运行时依赖、在 gem 中提交 Gemfile.lock、RSpec、重型 DSL。

参考文件:references/module-organization.md(目录布局与方法拆分)、references/rails-integration.md(Railtie、Engine、on_load 模式)、references/database-adapters.md(多数据库支持)、references/testing-patterns.md(多版本测试与 CI)、references/resources.md(相关仓库与文章链接)。

适用场景:创建新 Ruby gem、重构现有 gem 以贴近上述风格、为 gem 设计 Rails 集成与配置接口、制定测试与打包规范。

限制:资料未提供该技能的安装命令、运行环境要求、支持的平台、收费方式或效果数据,这些内容暂未提供。