Rubanok 开源项目教程
rubanokParameters-based transformation DSL项目地址:https://gitcode.com/gh_mirrors/ru/rubanok
1、项目介绍
Rubanok 是一个基于参数的转换 DSL(Domain-Specific Language),用于简化参数到转换的映射。它不依赖于 Rails,但提供了一些有用的 Rails 扩展,如 rubanok_process
助手方法用于控制器。Rubanok 的核心概念是处理器(Processor),负责将参数映射到转换。
2、项目快速启动
安装
首先,将 Rubanok 添加到你的 Gemfile 中:
gem "rubanok"
然后运行:
bundle install
使用示例
创建一个处理器类:
class CourseSessionsProcessor < Rubanok::Processor
map :q do |q:|
raw.search(q)
end
end
在控制器中使用:
class CourseSessionsController < ApplicationController
def index
@sessions = CourseSessionsProcessor.call(CourseSession.all, q: "xyz")
end
end
3、应用案例和最佳实践
应用案例
假设我们有一个课程会话(CourseSession)模型,我们希望根据查询参数进行搜索和排序:
class CourseSessionsProcessor < Rubanok::Processor
map :q do |q:|
raw.search(q)
end
map :sort_by, :sort do |sort_by:, sort:|
raw.order(sort_by => sort)
end
end
在控制器中使用:
class CourseSessionsController < ApplicationController
def index
@sessions = CourseSessionsProcessor.call(CourseSession.all, params.slice(:q, :sort_by, :sort))
end
end
最佳实践
- 明确映射规则:在处理器中明确映射规则,避免复杂的逻辑。
- 错误处理:使用
fail_when_no_matches
选项来处理未匹配的参数,避免意外错误。
4、典型生态项目
Rubanok 可以与其他 Ruby 生态项目结合使用,例如:
- RSpec:通过
require "rubanok/rspec"
集成 RSpec 测试。 - Steep:使用 Rubanok 的 Ruby 类型签名(RBS)与 Steep 结合进行类型检查。
通过这些生态项目的结合,可以进一步提高代码的质量和可维护性。
rubanokParameters-based transformation DSL项目地址:https://gitcode.com/gh_mirrors/ru/rubanok