has_scope 开源项目教程

has_scope 开源项目教程

has_scopeMap incoming controller parameters to named scopes in your resources项目地址:https://gitcode.com/gh_mirrors/ha/has_scope

项目介绍

has_scope 是一个用于简化 Rails 控制器中资源过滤的 Ruby gem。它允许开发者通过声明性的方式在控制器中定义和应用模型作用域（scopes）。这使得代码更加简洁和易于维护。has_scope 的主要功能是将控制器中的过滤器映射到模型作用域，从而实现资源的动态过滤。

项目快速启动

安装

首先，将 has_scope 添加到你的 Gemfile 中：

gem 'has_scope'

然后运行 bundle install 来安装 gem。

基本使用

假设我们有一个名为 Graduation 的模型，并且我们定义了一些作用域：

class Graduation < ActiveRecord::Base
  scope :featured, -> { where(featured: true) }
  scope :by_degree, ->(degree) { where(degree: degree) }
  scope :by_period, ->(started_at, ended_at) { where("started_at = ? AND ended_at = ?", started_at, ended_at) }
end

在控制器中使用 has_scope 来声明这些作用域：

class GraduationsController < ApplicationController
  has_scope :featured, type: :boolean
  has_scope :by_degree
  has_scope :by_period, using: %i[started_at ended_at], type: :hash

  def index
    @graduations = apply_scopes(Graduation).all
  end
end

应用案例和最佳实践

案例1：过滤特色毕业项目

假设我们有一个需求，只显示特色毕业项目。我们可以通过 featured 作用域来实现：

class GraduationsController < ApplicationController
  has_scope :featured, type: :boolean

  def index
    @graduations = apply_scopes(Graduation).all
  end
end

在视图中，我们可以这样渲染：

<% @graduations.each do |graduation| %>
  <%= graduation.name %>
<% end %>

案例2：按学位过滤

如果我们需要按学位过滤毕业项目，可以使用 by_degree 作用域：

class GraduationsController < ApplicationController
  has_scope :by_degree

  def index
    @graduations = apply_scopes(Graduation).all
  end
end

在视图中，我们可以这样渲染：

<% @graduations.each do |graduation| %>
  <%= graduation.name %>
<% end %>

最佳实践

1. 明确的作用域命名：确保作用域的命名清晰且具有描述性，便于理解和维护。
2. 类型检查：使用 type 选项来确保传入参数的类型正确。
3. 避免过度设计：只在必要时使用 has_scope，避免过度复杂的过滤逻辑。

典型生态项目

has_scope 通常与其他 Rails 生态项目一起使用，例如：

1. Ransack：用于高级搜索和过滤。
2. Kaminari：用于分页。
3. ActiveAdmin：用于管理后台。

这些项目与 has_scope 结合使用，可以大大增强 Rails 应用的查询和过滤能力。

通过本教程，你应该能够快速上手并有效地使用 has_scope 来简化你的 Rails 控制器中的资源过滤逻辑。

has_scopeMap incoming controller parameters to named scopes in your resources项目地址:https://gitcode.com/gh_mirrors/ha/has_scope