Sha256: 42a849d147eb3d9f608bb4a9703df63030c70695ef94355aeb3c32f72dc4458d
Contents?: true
Size: 1.88 KB
Versions: 13
Compression:
Stored size: 1.88 KB
Contents
# frozen_string_literal: true
module Kadmin
class Finder
include Kadmin::Presentable
# @return [Kadmin::Pager] the pager to use (if any)
attr_reader :pager
# @return [Hash<String, Kadmin::Finder::Filter>] array of filters applied to the finder
attr_reader :filters
# @return [ActiveRecord::Relation] the base relation to find items from
attr_reader :scope
# @param [ActiveRecord::Relation] scope base relation to page/filter on
def initialize(scope)
@scope = scope
@pager = nil
@filters = {}
@results = nil
@filtering = false
end
# @param [String] name the filter name (should be unique)
# @param [String, Array<String>] column the column(s) name to filter on
# @param [String, Array<String>] value the value or values to look for (OR'd)
def filter(filter, value = nil)
@filters[filter.name] = filter
if value.present?
@filtering = true
@scope = filter.apply(@scope, value)
end
return self
end
def filtering?
return @filtering
end
# @param [Integer] offset optional; offset/index for the current page
# @param [Integer] size optional; size of a page
# @return [Kadmin::Finder] itself
def paginate(offset: nil, size: nil)
offset = offset.to_i
size = size.to_i
if size.positive? && offset >= 0
@pager = Kadmin::Pager.new(size: size, offset: offset)
end
return self
end
# @return [ActiveRecord::Relation] the filtered (and optionally paginated) results
def results
return @results ||= begin
results = @scope
results = @pager.paginate(results) unless @pager.nil?
results.load
results
end
end
# Forces to refetch/recalculate the find operation results
def find!
@total_found = 0
@results = nil
return results
end
end
end
Version data entries
13 entries across 13 versions & 1 rubygems