SuperAPI AI 工具集

controller-agent

编程与开发

查看项目

更新于 10-16 06:57

技能介绍

用途

controller-agent 是一个 Rails 控制器设计专家技能,用于创建精简(thin)、符合 REST 规范的 Rails 控制器,并同步编写请求规格(request specs)。它的核心目标是让控制器只负责编排流程,将业务逻辑委托给服务对象,同时保证授权、错误处理和测试的完整性。

主要能力

  • 创建和修改 app/controllers/ 下的控制器,遵循 Rails REST 约定(index、show、new、create、edit、update、destroy)。
  • 为每个动作使用 Pundit 的 authorize 进行授权,确保安全优先。
  • 使用强参数(strong parameters)处理请求参数。
  • 优雅地处理错误,返回恰当的 HTTP 状态码。
  • 始终同步编写请求规格测试(spec/requests/),覆盖所有 RESTful 动作、认证、授权、有效/无效参数、边界情况、响应状态码、重定向与渲染、flash 消息以及 Turbo Stream 响应。
  • 调用服务对象(app/services/)、查询对象(app/queries/)、呈现器(app/presenters/),并读取模型、验证器和 Pundit 策略。
  • 支持 Rails 8 特性,如内置认证(has_secure_password 或 authenticate_by)、API 限流(rate_limit)、Solid Queue 后台任务、Turbo 8 变形与视图过渡。

使用方式

该技能通过明确的边界和原则指导控制器开发:

  • 始终:控制器与请求规格同步编写;每个动作使用 authorize;委托给服务对象。
  • 先询问:修改现有控制器动作、添加非 RESTful 路由之前。
  • 绝不:在控制器中放置业务逻辑、跳过授权、在动作中直接修改模型。

可用的命令包括:

  • 测试:bundle exec rspec spec/requests/、bundle exec rspec spec/requests/entities_spec.rb、bundle exec rspec spec/requests/entities_spec.rb:25、bundle exec rspec --format documentation spec/requests/
  • 开发:bin/rails console、bin/rails routes、bin/rails routes | grep entity
  • 代码检查:bundle exec rubocop -a app/controllers/、bundle exec rubocop -a spec/requests/
  • 安全扫描:bin/brakeman --only-files app/controllers/

技能提供了模板参考(templates.md)和请求规格示例(request-specs.md),涵盖标准 REST、服务对象、嵌套资源、API(JSON)、Turbo Streams、错误处理和 HTTP 状态码参考。

适用场景

  • 在 Rails 项目中创建新的控制器或添加控制器动作。
  • 需要遵循 REST 约定和精简控制器原则进行重构。
  • 需要为控制器编写完整的请求规格测试。
  • 需要集成 Pundit 授权、强参数和错误处理。
  • 构建 API 端点或使用 Turbo Streams 的控制器。

限制

  • 该技能基于特定技术栈:Ruby 3.3、Rails 8.1、Hotwire(Turbo + Stimulus)、PostgreSQL、Pundit、RSpec。
  • 不负责实现业务逻辑,业务逻辑应放在服务对象中。
  • 不直接修改模型,模型仅用于读取。
  • 添加非 RESTful 动作、创建 API 端点、修改 ApplicationController 或添加自定义 rescue_from 处理器前需要先询问。
  • 关于收费、价格、平台支持等具体信息暂未提供。