Class: Kadmin::Finder

Inherits:
Object
  • Object
show all
Includes:
Presentable
Defined in:
app/components/kadmin/finder.rb,
app/components/kadmin/finder/filter.rb,
app/components/kadmin/finder/presenter.rb

Defined Under Namespace

Classes: Filter, Presenter

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Presentable

#present

Constructor Details

#initialize(scope) ⇒ Finder

Returns a new instance of Finder.

Parameters:

  • scope (ActiveRecord::Relation) —

    base relation to page/filter on



17
18
19
20
21
22
23
 
# File 'app/components/kadmin/finder.rb', line 17

def initialize(scope)
  @scope = scope
  @pager = nil
  @filters = {}
  @results = nil
  @filtering = false
end

Instance Attribute Details

#filters ⇒ Hash<String, Kadmin::Finder::Filter> (readonly)

Returns array of filters applied to the finder.

Returns:



11
12
13
 
# File 'app/components/kadmin/finder.rb', line 11

def filters
  @filters
end

#pager ⇒ Kadmin::Pager (readonly)

Returns the pager to use (if any).

Returns:



8
9
10
 
# File 'app/components/kadmin/finder.rb', line 8

def pager
  @pager
end

#scope ⇒ ActiveRecord::Relation (readonly)

Returns the base relation to find items from.

Returns:

  • (ActiveRecord::Relation) —

    the base relation to find items from



14
15
16
 
# File 'app/components/kadmin/finder.rb', line 14

def scope
  @scope
end

Instance Method Details

#filter(filter, value = nil) ⇒ Object

Parameters:

  • name (String) —

    the filter name (should be unique)

  • column (String, Array<String>) —

    the column(s) name to filter on

  • value (String, Array<String>) (defaults to: nil) —

    the value or values to look for (OR’d)



28
29
30
31
32
33
34
35
36
 
# File 'app/components/kadmin/finder.rb', line 28

def filter(filter, value = nil)
  @filters[filter.name] = filter
  if value.present?
    @filtering = true
    @scope = filter.apply(@scope, value)
  end

  return self
end

#filtering? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'app/components/kadmin/finder.rb', line 38

def filtering?
  return @filtering
end

#find! ⇒ Object

Forces to refetch/recalculate the find operation results



67
68
69
70
71
 
# File 'app/components/kadmin/finder.rb', line 67

def find!
  @total_found = 0
  @results = nil
  return results
end

#paginate(offset: nil, size: nil) ⇒ Kadmin::Finder

Returns itself.

Parameters:

  • offset (Integer) (defaults to: nil) —

    optional; offset/index for the current page

  • size (Integer) (defaults to: nil) —

    optional; size of a page

Returns:



45
46
47
48
49
50
51
52
53
54
 
# File 'app/components/kadmin/finder.rb', line 45

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

#results ⇒ ActiveRecord::Relation

Returns the filtered (and optionally paginated) results.

Returns:

  • (ActiveRecord::Relation) —

    the filtered (and optionally paginated) results



57
58
59
60
61
62
63
64
 
# File 'app/components/kadmin/finder.rb', line 57

def results
  return @results ||= begin
    results = @scope
    results = @pager.paginate(results) unless @pager.nil?
    results.load
    results
  end
end