Sha256: d12e031dfc252e095c2f9506a10f31ffe519bee1323bc0549103617746632249
Contents?: true
Size: 1.95 KB
Versions: 8
Compression:
Stored size: 1.95 KB
Contents
require 'active_support/concern'
require 'yap/exceptions'
require 'yap/column_mapper'
require 'yap/filter'
##
# ActiveRecords can be filtered by their attributes if either Yap or Filterable is included into the model. Filters can
# be applied through the filter or paginate scope. Multiple filters for the same attribute can be separated by comma,
# negative filters have a leading exclamation mark (!) and 'null' will be translated to the NULL value.
#
# User.filter('gender' => 'f') # => All female users.
# User.filter(
# 'team_id' => '1,2',
# 'gender' => 'm'
# ) # => All males of teams 1 and 2.
# User.filter('team_id' => '!null') # => All users with any team.
# User.paginate(params) # => Passing parameters in controller (http://localhost/users?filter[gender]=f)
# User.paginate(
# page: 1,
# filter: { 'team' => 'null' }
# ) # => Combining filter and pagination.
#
module Yap
module Filterable
extend ActiveSupport::Concern
included do
extend ColumnMapper
##
# Filter scope can be invoked explicitly or implicitly by passing :filter to paginate.
#
# @param [Hash] Attribute/value pairs to filter ( { 'gender' => 'f' } )
#
scope :filter, -> (params = nil) {
if params.blank?
all
else
filter = extract_filter_params(params)
where(filter[:where]).where.not(filter[:not])
end
}
private
def self.extract_filter_params(params)
filter = Filter.new
failed = []
params.each do |key, values|
column = map_column(key.to_s.downcase)
if column
filter.parse!(column, values)
else
failed << key
end
end
raise FilterError.new('Cannot filter by: ' + failed.join(', ')) unless failed.empty?
filter
end
end
end
end
Version data entries
8 entries across 8 versions & 1 rubygems