SearchObject
1.0.0
用于构建搜索对象的 DSL。
搜索对象从初始集合（范围）开始，并允许根据各种选项对其进行过滤。
用途：
将此行添加到应用程序的 Gemfile 中：
gem 'search_object'然后执行：
$ bundle
或者自己安装：
$ gem install search_object
更改可在 CHANGELOG.md 中找到
只需包含SearchObject.module并定义您的搜索选项：
class PostSearch
include SearchObject . module
scope { Post . all }
option ( :name ) { | scope , value | scope . where name : value }
option ( :created_at ) { | scope , dates | scope . created_after dates }
option ( :published , false ) { | scope , value | value ? scope . unopened : scope . opened }
end然后你可以只搜索给定的范围：
search = PostSearch . new ( filters : params [ :filters ] )
# accessing search options
search . name # => name option
search . created_at # => created at option
# accessing results
search . count # => number of found results
search . results? # => is there any results found
search . results # => found results
# params for url generations
search . params # => option values
search . params opened : false # => overwrites the 'opened' option您可以在这里找到最重要的功能和插件的示例。
SearchObject支持插件，这些插件被传递给SearchObject.module方法。
插件只是普通的 Ruby 模块，包含在SearchObject.module中。它们位于SearchObject::Plugin模块下。
非常简单的分页插件，它使用简单的.limit和.offset方法。
class ProductSearch
include SearchObject . module ( :paging )
scope { Product . all }
option :name
option :category_name
# per page defaults to 10
per_page 10
# range of values is also possible
min_per_page 5
max_per_page 100
end
search = ProductSearch . new ( filters : params [ :filters ] , page : params [ :page ] , per_page : params [ :per_page ] )
search . page # => page number
search . per_page # => per page (10)
search . results # => paginated page results当然，如果您想要更复杂的分页插件，您可以使用：
include SearchObject . module ( :will_paginate )
include SearchObject . module ( :kaminari )为您提供带有预定义选项的过滤器。
class ProductSearch
include SearchObject . module ( :enum )
scope { Product . all }
option :order , enum : %w( popular date )
private
# Gets called when order with 'popular' is given
def apply_order_with_popular ( scope )
scope . by_popularity
end
# Gets called when order with 'date' is given
def apply_order_with_date ( scope )
scope . by_date
end
# (optional) Gets called when invalid enum is given
def handle_invalid_order ( scope , invalid_value )
scope
end
end使用ActiveModel扩展您的搜索对象，以便您可以在 Rails 表单中使用它。
class ProductSearch
include SearchObject . module ( :model )
scope { Product . all }
option :name
option :category_name
end <%# in some view: %>
<%= form_for ProductSearch.new do |form| %>
<% form.label :name %>
<% form.text_field :name %>
<% form.label :category_name %>
<% form.text_field :category_name %>
<% end %> 它作为单独的 gem 安装，旨在与 GraphQL 一起使用：
gem 'search_object_graphql'
class PostResolver
include SearchObject . module ( :graphql )
type PostType
scope { Post . all }
option ( :name , type : types . String ) { | scope , value | scope . where name : value }
option ( :published , type : types . Boolean ) { | scope , value | value ? scope . published : scope . unpublished }
end解决处理排序属性和方向的痛苦。
class ProductSearch
include SearchObject . module ( :sorting )
scope { Product . all }
sort_by :name , :price
end
search = ProductSearch . new ( filters : { sort : 'price desc' } )
search . results # => Product sorted my price DESC
search . sort_attribute # => 'price'
search . sort_direction # => 'desc'
# Smart sort checking
search . sort? ( 'price' ) # => true
search . sort? ( 'price desc' ) # => true
search . sort? ( 'price asc' ) # => false
# Helpers for dealing with reversing sort direction
search . reverted_sort_direction # => 'asc'
search . sort_direction_for ( 'price' ) # => 'asc'
search . sort_direction_for ( 'name' ) # => 'desc'
# Params for sorting links
search . sort_params_for ( 'name' ) 很多时候你只需要搜索结果：
ProductSearch . new ( params ) . results == ProductSearch . results ( params ) class ProductSearch
include SearchObject . module
end
# first arguments is treated as scope (if no scope option is provided)
search = ProductSearch . new ( scope : Product . visible , filters : params [ :f ] )
search . results # => includes only visible products class ProductSearch
include SearchObject . module
scope { Product . all }
# nil values returned from option blocks are ignored
option ( :sold ) { | scope , value | scope . sold if value }
end class ProductSearch
include SearchObject . module
scope { Product . all }
option :name # automaticly applies => { |scope, value| scope.where name: value unless value.blank? }
end class ProductSearch
include SearchObject . module
scope { Product . all }
option ( :date ) { | scope , value | scope . by_date parse_dates ( value ) }
private
def parse_dates ( date_string )
# some "magic" method to parse dates
end
end class ProductSearch
include SearchObject . module
scope { Product . all }
option :date , with : :parse_dates
private
def parse_dates ( scope , value )
# some "magic" method to parse dates
end
end class ProductSearch
include SearchObject . module
scope { RemoteEndpoint . fetch_product_as_hashes }
option ( :name ) { | scope , value | scope . select { | product | product [ :name ] == value } }
option ( :category ) { | scope , value | scope . select { | product | product [ :category ] == value } }
end您可以通过覆盖initialize方法来获得细粒度的范围：
class ProductSearch
include SearchObject . module
option :name
option :category_name
def initialize ( user , options = { } )
super options . merge ( scope : Product . visible_to ( user ) )
end
end或者您可以通过覆盖initialize和fetch_results （用于获取结果）来添加简单的分页：
class ProductSearch
include SearchObject . module
scope { Product . all }
option :name
option :category_name
attr_reader :page
def initialize ( filters = { } , page = 0 )
super filters
@page = page . to_i . abs
end
def fetch_results
super . paginate page : @page
end
end您可以为您的应用程序提取基本搜索类。
class BaseSearch
include SearchObject . module
# ... options and configuration
end然后像这样使用它：
class ProductSearch < BaseSearch
scope { Product }
end git checkout -b my-new-feature ）git commit -am 'Add some feature' ）git push origin my-new-feature ）rake ）另请参阅参与该项目的贡献者列表。
麻省理工学院许可证
