Decent Exposure开源项目指南

Decent Exposure开源项目指南

decent_exposureA helper for creating declarative interfaces in controllers项目地址:https://gitcode.com/gh_mirrors/de/decent_exposure

1. 项目介绍

Decent Exposure 是一个RubyGem，专为Rails框架设计，旨在减少控制器与视图之间的耦合，提高测试性和设计的整洁度。它允许开发者以声明式的方式暴露控制器中的状态接口，而不是依赖于实例变量来共享状态。这样，你可以编程到接口而非实现，使得代码更加灵活且易于维护。特别是，它简化了模型查找逻辑，支持如FriendlyId之类的库定制查找方式，并在创建新记录时提供便利。

2. 项目快速启动

要快速启动并运行Decent Exposure，首先确保你的环境已经配置好Ruby和Bundler。然后按照以下步骤操作：

安装Decent Exposure

在你的应用程序的 Gemfile 中添加以下行来引入Decent Exposure：

gem 'decent_exposure', '~> 3.0'

接着，执行Bundler安装这个gem：

$ bundle install

或者，如果你不在使用Bundler的环境中，可以通过命令直接全局安装：

$ gem install decent_exposure

应用示例

在Rails控制器中使用Decent Exposure，曝光一个模型给视图，例如曝光一本书的信息：

class BooksController < ApplicationController
  expose(:book, finder_parameter: :id, params: :book_params)

  def create
    if book.save
      redirect_to(book)
    else
      render :new
    end
  end

  private
  
  def book_params
    params.require(:book).permit(:name, :author, :annotation)
  end
end

在这个例子中，expose(:book, finder_parameter: :id)会尝试通过ID找到或创建书的对象，params: :book_params指定了创建或更新书对象时使用的参数白名单。

3. 应用案例和最佳实践

使用Decent Exposure的一个重要实践是保持控制器简洁，通过明确地定义如何访问数据，使其更专注于业务逻辑而不是数据传递细节。对于多态关联或基于条件的不同查询需求，可以利用其自定义查找逻辑和作用域的能力，比如：

expose(:post, scope: -> { Post.published }) do |controller|
  controller.params[:category]
end

这里展示了根据请求参数动态选择查询范围，减少了硬编码逻辑。

4. 典型生态项目集成

虽然Decent Exposure主要是为Rails应用设计的，但它很好地融入Rails生态系统，特别是在配合其他如Devise（认证）、FriendlyId（友好的URL）等流行gem时。例如，与FriendlyId一起使用，可以轻松调整查找方法来处理基于slug的查找：

expose(:thing, find_by: :slug)

这样的集成允许项目保持高度模块化，同时保持控制器层的干净和专注。

---

以上就是Decent Exposure的基本介绍、快速启动过程以及一些高级用法和最佳实践。通过合理应用这些原则，你的Rails应用将受益于更为清晰、解耦的架构。

decent_exposureA helper for creating declarative interfaces in controllers项目地址:https://gitcode.com/gh_mirrors/de/decent_exposure