Module: Elasticsearch::Model::Response::Pagination::WillPaginate
- Defined in:
- lib/elasticsearch/model/response/pagination.rb
Overview
Allow models to be paginated with the “will_paginate” gem [github.com/mislav/will_paginate]
Class Method Summary collapse
Instance Method Summary collapse
-
#__default_per_page ⇒ Object
private
Returns the models’s ‘per_page` value or the default.
-
#current_page ⇒ Object
Return the current page.
- #length ⇒ Object
- #offset ⇒ Object
-
#page(num) ⇒ Object
Pagination method.
-
#paginate(options) ⇒ Object
Main pagination method.
-
#per_page(num = nil) ⇒ Object
Return or set the “size” value.
-
#total_entries ⇒ Object
Returns the total number of results.
Class Method Details
.included(base) ⇒ Object
110 111 112 113 114 115 116 117 118 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 110 def self.included(base) base.__send__ :include, ::WillPaginate::CollectionMethods # Include the paging methods in results and records # methods = [:current_page, :offset, :length, :per_page, :total_entries, :total_pages, :previous_page, :next_page, :out_of_bounds?] Elasticsearch::Model::Response::Results.__send__ :delegate, *methods, to: :response Elasticsearch::Model::Response::Records.__send__ :delegate, *methods, to: :response 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
184 185 186 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 184 def __default_per_page klass.respond_to?(:per_page) && klass.per_page || ::WillPaginate.per_page end |
#current_page ⇒ Object
Return the current page
146 147 148 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 146 def current_page search.definition[:from] / per_page + 1 if search.definition[:from] && per_page end |
#length ⇒ Object
124 125 126 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 124 def length search.definition[:size] end |
#offset ⇒ Object
120 121 122 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 120 def offset (current_page - 1) * per_page end |
#page(num) ⇒ Object
Pagination method
156 157 158 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 156 def page(num) paginate(page: num, per_page: per_page) # shorthand end |
#paginate(options) ⇒ Object
Main pagination method
134 135 136 137 138 139 140 141 142 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 134 def paginate() param_name = [:param_name] || :page page = [[param_name].to_i, 1].max per_page = ([:per_page] || __default_per_page).to_i search.definition.update size: per_page, from: (page - 1) * per_page self end |
#per_page(num = nil) ⇒ Object
Return or set the “size” value
166 167 168 169 170 171 172 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 166 def per_page(num = nil) if num.nil? search.definition[:size] else paginate(page: current_page, per_page: num) # shorthand end end |
#total_entries ⇒ Object
Returns the total number of results
176 177 178 |
# File 'lib/elasticsearch/model/response/pagination.rb', line 176 def total_entries results.total end |