Module: Elasticsearch::Model::Response::Pagination::Kaminari

Defined in:
lib/elasticsearch/model/response/pagination.rb

Overview

Allow models to be paginated with the “kaminari” gem [github.com/amatsuda/kaminari]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 11

def self.included(base)
  # Include the Kaminari configuration and paging method in response
  #
  base.__send__ :include, ::Kaminari::ConfigurationMethods::ClassMethods
  base.__send__ :include, ::Kaminari::PageScopeMethods

  # Include the Kaminari paging methods in results and records
  #
  Elasticsearch::Model::Response::Results.__send__ :include, ::Kaminari::ConfigurationMethods::ClassMethods
  Elasticsearch::Model::Response::Results.__send__ :include, ::Kaminari::PageScopeMethods
  Elasticsearch::Model::Response::Records.__send__ :include, ::Kaminari::PageScopeMethods

  Elasticsearch::Model::Response::Results.__send__ :delegate, :limit_value, :offset_value, :total_count, :max_pages, to: :response
  Elasticsearch::Model::Response::Records.__send__ :delegate, :limit_value, :offset_value, :total_count, :max_pages, to: :response

  base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    # Define the `page` Kaminari method
    #
    def #{::Kaminari.config.page_method_name}(num=nil)
      @results  = nil
      @records  = nil
      @response = nil
      @page     = [num.to_i, 1].max
      @per_page ||= __default_per_page

      self.search.definition.update size: @per_page,
                                    from: @per_page * (@page - 1)

      self
    end
  RUBY
end

Instance Method Details

#__default_per_page ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the models’s ‘per_page` value or the default



102
103
104
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 102

def __default_per_page
  klass.respond_to?(:default_per_page) && klass.default_per_page || ::Kaminari.config.default_per_page
end

#limit(value) ⇒ Object

Set the “limit” (‘size`) value



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 68

def limit(value)
  return self if value.to_i <= 0
  @results  = nil
  @records  = nil
  @response = nil
  @per_page = value.to_i

  search.definition.update :size => @per_page
  search.definition.update :from => @per_page * (@page - 1) if @page
  self
end

#limit_value ⇒ Object

Returns the current “limit” (‘size`) value



46
47
48
49
50
51
52
53
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 46

def limit_value
  case
    when search.definition[:size]
      search.definition[:size]
    else
      __default_per_page
  end
end

#offset(value) ⇒ Object

Set the “offset” (‘from`) value



82
83
84
85
86
87
88
89
90
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 82

def offset(value)
  return self if value.to_i < 0
  @results  = nil
  @records  = nil
  @response = nil
  @page     = nil
  search.definition.update :from => value.to_i
  self
end

#offset_value ⇒ Object

Returns the current “offset” (‘from`) value



57
58
59
60
61
62
63
64
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 57

def offset_value
  case
    when search.definition[:from]
      search.definition[:from]
    else
      0
  end
end

#total_count ⇒ Object

Returns the total number of results



94
95
96
 
# File 'lib/elasticsearch/model/response/pagination.rb', line 94

def total_count
  results.total
end