nifty-generators 的 nifty:scaffold 实战:按需生成 CRUD 脚手架的入门教程
nifty-generators 的 nifty:scaffold 实战:按需生成 CRUD 脚手架的入门教程
nifty-generators 是一套经典的 Rails 生成器集合,其中的 nifty:scaffold 生成器能一句话生成模型、数据迁移、控制器、视图和测试——但相比 Rails 自带的 scaffold,它真正的杀手锏是按需生成:你可以精确指定只要哪几个 controller 动作(比如只生成 index 和 new),还能自由切换 HAML 视图与 RSpec 测试。本教程带你从零跑通 nifty:scaffold,掌握"按需生成 CRUD 脚手架"的完整流程 🛠️
💡 小提示:项目 README 标注该项目已停止维护(README.rdoc),但 nifty:scaffold 的核心功能依然清晰实用,非常适合学习和轻量项目使用。
nifty:scaffold 是什么?和原生 scaffold 有什么区别?
rails g scaffold 会一口气生成全部 7 个标准动作(index、show、new、create、edit、update、destroy),无法挑选。而 nifty:scaffold 的定位就是"可裁剪的脚手架":
| 对比项 | 原生 scaffold |
nifty:scaffold |
|---|---|---|
| 动作裁剪 | 只能全生成 | 自由指定任意动作,支持 ! 反选 |
| 视图语言 | ERB | 支持 ERB / HAML(--haml) |
| 测试框架 | 跟随项目 | 可选 RSpec / TestUnit / Shoulda |
| 默认格式 | XML + JSON | 默认不含 XML |
这一差异来自其参数解析逻辑,核心代码在 lib/generators/nifty/scaffold/scaffold_generator.rb:每当你传入 new,它会自动补上 create;传入 edit 则自动补上 update,保证表单动作成对出现。
快速上手:三步跑通 nifty:scaffold 入门
第一步:安装 nifty-generators
在 Rails 3 项目的 Gemfile 中加入 gem,并限定在 development 组:
gem "nifty-generators", :group => :development
第二步:执行脚手架命令
rails g nifty:scaffold Recipe name:string
第一个参数是资源名(驼峰或下划线均可),后面跟 属性:类型 形式的字段定义。这条命令会生成:
- 模型:
app/models/recipe.rb - 数据迁移:
db/migrate/..._create_recipes.rb(自动带t.timestamps,无需手写时间戳) - 控制器 + Helper:
app/controllers/recipes_controller.rb - 四个 ERB 视图:
index、show、new、edit - 测试文件(项目有
spec/目录则生成 RSpec,否则 TestUnit) - 自动向
config/routes.rb写入resources :recipes - 自动向 Gemfile 追加
mocha测试依赖
第三步:执行迁移并访问
rake db:migrate
打开 http://localhost:3000/recipes 就能看到列表页 🎉
按需生成 CRUD:controller 动作怎么选?
这是 nifty:scaffold 最值得学的部分。
只生成部分动作
rails g nifty:scaffold post name:string content:text index new edit
只会生成 index、new、create、edit、update 五个动作(create/update 是自动补齐的),不会有 show 和 destroy。适合"只看不改"或"只增不删"的简单资源。
用 ! 反选,做减法更方便
rails g nifty:scaffold post ! show new
加 ! 后语义反转:除了 show 和 new,其余 5 个动作全部生成。当你要"去掉某几个动作"时,反选比逐个罗列更直观。该逻辑同样在 scaffold_generator.rb 中实现。
不写属性会怎样?
注意:不指定属性对时不会创建模型和迁移,生成器会尝试从已有模型读取字段;如果模型也不存在,则退化为一个只有 name:string 的假想模型。想跳过模型可显式传 --skip-model。更多用法细节见 lib/generators/nifty/scaffold/USAGE。
常用参数速查表:skip、haml、rspec 一次看懂
| 参数 | 作用 |
|---|---|
--skip-model |
不生成模型与迁移文件 |
--skip-migration |
只保留模型,不生成迁移 |
--skip-timestamps |
迁移中不加 created_at / updated_at |
--skip-controller |
不生成控制器、Helper 和视图 |
--haml |
生成 HAML 视图替代 ERB |
--rspec / --testunit / --shoulda |
指定测试框架 |
--invert |
等价于 !,反选动作 |
--namespace_model |
资源带命名空间时,模型也放入对应命名空间 |
组合示例:用 HAML + RSpec 生成一个只读列表页:
rails g nifty:scaffold Comment body:text index show --haml --rspec
生成的测试会落在 spec/models/ 和 spec/controllers/ 下,模板分别位于 lib/generators/nifty/scaffold/templates/tests/rspec/ 目录。
生成的代码长什么样?
以默认参数生成的 Post 为例,关键文件一览:
- 模型模板 templates/model.rb:自动生成
attr_accessible白名单,字段直接取自你传入的属性对 - 控制器模板 templates/controller.rb:只拼装你选中的动作,动作实现拆在 templates/actions/ 目录下,一个动作一个文件
- 迁移模板 templates/migration.rb:
create_table+ 字段 + 时间戳 - 列表视图 templates/views/erb/index.html.erb:按字段输出表格,并只在对应动作存在时才渲染 Show / Edit / Destroy 链接和 New 按钮——这正是"按需生成"落到 UI 层的体现
进阶:命名空间资源 Admin::User
后台管理模块经常需要 Admin::User 这类带命名空间的资源:
rails g nifty:scaffold Admin::User name:string
默认生成 app/models/user.rb + app/controllers/admin/users_controller.rb,路由写入 namespace(:admin){ resources :users }。若希望模型也放到 Admin 命名空间下,加上 --namespace_model 即可,此时模型会声明 set_table_name :admin_users 指向 admin_users 表。
这些场景的完整断言可以在 Cucumber 特性文件 features/nifty_scaffold.feature 中找到,是理解生成器行为的"活文档"。
常见问题排查:这些报错都怎么解决?
1. 报 undefined method 'title'
生成的视图用了 title helper,它由 nifty:layout 生成器提供。先运行:
rails g nifty:layout
2. 模型里无法设置新字段
手动加的字段不会自动进入白名单,需自行补到模型的 attr_accessible 行中。
3. 报 undefined method 'root_url'
部分场景(如没有 index 动作时)重定向会落到 root_url,请在 config/routes.rb 中定义首页路由,例如 root :to => "home#index"。
4. 数据库不存在错误
先执行 rake db:migrate 建表。
5. 提交表单时出现路由错误
尝试重启开发服务器,Rails 有时不会即时感知路由变化。
总结:nifty:scaffold 适合谁?
一句话回顾:nifty:scaffold = 全量 scaffold 的自由裁剪版。
- ✅ 只需要部分动作的简单资源(只读列表、纯录入表单)
- ✅ 团队使用 HAML / RSpec,希望脚手架直接对齐技术栈
- ✅ 后台命名空间资源(
Admin::User) - ⚠️ 需要强校验、复杂关联的复杂模型,仍建议
scaffold+ 手写扩展
上手顺序建议:nifty:layout(打底样式与 helper)→ nifty:scaffold(生成资源)→ 按需调整模板。完整的生成器家族(layout / scaffold / config / authentication)说明见 README.rdoc。