Fix new rubocop warnings
[rails.git] / lib / classic_pagination / pagination.rb
1 module ActionController
2   # === Action Pack pagination for Active Record collections
3   #
4   # The Pagination module aids in the process of paging large collections of
5   # Active Record objects. It offers macro-style automatic fetching of your
6   # model for multiple views, or explicit fetching for single actions. And if
7   # the magic isn't flexible enough for your needs, you can create your own
8   # paginators with a minimal amount of code.
9   #
10   # The Pagination module can handle as much or as little as you wish. In the
11   # controller, have it automatically query your model for pagination; or,
12   # if you prefer, create Paginator objects yourself.
13   #
14   # Pagination is included automatically for all controllers.
15   #
16   # For help rendering pagination links, see
17   # ActionView::Helpers::PaginationHelper.
18   #
19   # ==== Automatic pagination for every action in a controller
20   #
21   #   class PersonController < ApplicationController
22   #     model :person
23   #
24   #     paginate :people, :order => 'last_name, first_name',
25   #              :per_page => 20
26   #
27   #     # ...
28   #   end
29   #
30   # Each action in this controller now has access to a <tt>@people</tt>
31   # instance variable, which is an ordered collection of model objects for the
32   # current page (at most 20, sorted by last name and first name), and a
33   # <tt>@person_pages</tt> Paginator instance. The current page is determined
34   # by the <tt>params[:page]</tt> variable.
35   #
36   # ==== Pagination for a single action
37   #
38   #   def list
39   #     @person_pages, @people =
40   #       paginate :people, :order => 'last_name, first_name'
41   #   end
42   #
43   # Like the previous example, but explicitly creates <tt>@person_pages</tt>
44   # and <tt>@people</tt> for a single action, and uses the default of 10 items
45   # per page.
46   #
47   # ==== Custom/"classic" pagination
48   #
49   #   def list
50   #     @person_pages = Paginator.new self, Person.count, 10, params[:page]
51   #     @people = Person.find :all, :order => 'last_name, first_name',
52   #                           :limit  =>  @person_pages.items_per_page,
53   #                           :offset =>  @person_pages.current.offset
54   #   end
55   #
56   # Explicitly creates the paginator from the previous example and uses
57   # Paginator#to_sql to retrieve <tt>@people</tt> from the model.
58   #
59   module Pagination
60     if const_defined?(:OPTIONS)
61       DEFAULT_OPTIONS[:group] = nil
62     else
63       # A hash holding options for controllers using macro-style pagination
64       OPTIONS = {}.freeze
65
66       # The default options for pagination
67       DEFAULT_OPTIONS = {
68         :class_name => nil,
69         :singular_name => nil,
70         :per_page => 10,
71         :conditions => nil,
72         :order_by => nil,
73         :order => nil,
74         :join => nil,
75         :joins => nil,
76         :count => nil,
77         :include => nil,
78         :select => nil,
79         :group => nil,
80         :parameter => "page"
81       }.freeze
82     end
83
84     def self.included(base) #:nodoc:
85       super
86       base.extend(ClassMethods)
87     end
88
89     def self.validate_options!(collection_id, options, in_action) #:nodoc:
90       options.merge!(DEFAULT_OPTIONS) { |_key, old, _new| old }
91
92       valid_options = DEFAULT_OPTIONS.keys
93       valid_options << :actions unless in_action
94
95       unknown_option_keys = options.keys - valid_options
96       unless unknown_option_keys.empty?
97         raise ActionController::ActionControllerError,
98               "Unknown options: #{unknown_option_keys.join(', ')}"
99       end
100
101       options[:singular_name] ||= ActiveSupport::Inflector.singularize(collection_id.to_s)
102       options[:class_name] ||= ActiveSupport::Inflector.camelize(options[:singular_name])
103     end
104
105     # Returns a paginator and a collection of Active Record model instances
106     # for the paginator's current page. This is designed to be used in a
107     # single action; to automatically paginate multiple actions, consider
108     # ClassMethods#paginate.
109     #
110     # +options+ are:
111     # <tt>:singular_name</tt>:: the singular name to use, if it can't be inferred by singularizing the collection name
112     # <tt>:class_name</tt>:: the class name to use, if it can't be inferred by
113     #                        camelizing the singular name
114     # <tt>:per_page</tt>::   the maximum number of items to include in a
115     #                        single page. Defaults to 10
116     # <tt>:conditions</tt>:: optional conditions passed to Model.find(:all, *params) and
117     #                        Model.count
118     # <tt>:order</tt>::      optional order parameter passed to Model.find(:all, *params)
119     # <tt>:order_by</tt>::   (deprecated, used :order) optional order parameter passed to Model.find(:all, *params)
120     # <tt>:joins</tt>::      optional joins parameter passed to Model.find(:all, *params)
121     #                        and Model.count
122     # <tt>:join</tt>::       (deprecated, used :joins or :include) optional join parameter passed to Model.find(:all, *params)
123     #                        and Model.count
124     # <tt>:include</tt>::    optional eager loading parameter passed to Model.find(:all, *params)
125     #                        and Model.count
126     # <tt>:select</tt>::     :select parameter passed to Model.find(:all, *params)
127     #
128     # <tt>:count</tt>::      parameter passed as :select option to Model.count(*params)
129     #
130     # <tt>:group</tt>::     :group parameter passed to Model.find(:all, *params). It forces the use of DISTINCT instead of plain COUNT to come up with the total number of records
131     #
132     def paginate(collection_id, options = {})
133       Pagination.validate_options!(collection_id, options, true)
134       paginator_and_collection_for(collection_id, options)
135     end
136
137     # These methods become class methods on any controller
138     module ClassMethods
139       # Creates a +before_action+ which automatically paginates an Active
140       # Record model for all actions in a controller (or certain actions if
141       # specified with the <tt>:actions</tt> option).
142       #
143       # +options+ are the same as PaginationHelper#paginate, with the addition
144       # of:
145       # <tt>:actions</tt>:: an array of actions for which the pagination is
146       #                     active. Defaults to +nil+ (i.e., every action)
147       def paginate(collection_id, options = {})
148         Pagination.validate_options!(collection_id, options, false)
149         module_eval do
150           before_action :create_paginators_and_retrieve_collections
151           OPTIONS[self] ||= {}
152           OPTIONS[self][collection_id] = options
153         end
154       end
155     end
156
157     protected
158
159     def create_paginators_and_retrieve_collections #:nodoc:
160       Pagination::OPTIONS[self.class].each do |collection_id, options|
161         next if options[:actions] && !options[:actions].include?(action_name)
162
163         paginator, collection =
164           paginator_and_collection_for(collection_id, options)
165
166         paginator_name = "@#{options[:singular_name]}_pages"
167         instance_variable_set(paginator_name, paginator)
168
169         collection_name = "@#{collection_id}"
170         instance_variable_set(collection_name, collection)
171       end
172     end
173
174     # Returns the total number of items in the collection to be paginated for
175     # the +model+ and given +conditions+. Override this method to implement a
176     # custom counter.
177     def count_collection_for_pagination(model, options)
178       collection = model.joins(options[:join] || options[:joins])
179       collection = collection.where(options[:conditions])
180       collection = collection.includes(options[:include])
181
182       if options[:group]
183         collection = collection.select(options[:group]).distinct
184       elsif options[:count]
185         collection = collection.select(options[:count])
186       end
187
188       collection.count
189     end
190
191     # Returns a collection of items for the given +model+ and +options[conditions]+,
192     # ordered by +options[order]+, for the current page in the given +paginator+.
193     # Override this method to implement a custom finder.
194     def find_collection_for_pagination(model, options, paginator)
195       collection = model.joins(options[:join] || options[:joins])
196       collection = collection.where(options[:conditions])
197       collection = collection.order(options[:order_by] || options[:order])
198       collection = collection.includes(options[:include])
199       collection = collection.group(options[:group])
200       collection = collection.select(options[:select]) if options[:select]
201
202       collection.offset(paginator.current.offset).limit(options[:per_page])
203     end
204
205     private
206
207     def paginator_and_collection_for(_collection_id, options) #:nodoc:
208       klass = options[:class_name].constantize
209       page  = params[options[:parameter]]
210       count = count_collection_for_pagination(klass, options)
211       paginator = Paginator.new(self, count, options[:per_page], page)
212       collection = find_collection_for_pagination(klass, options, paginator)
213
214       [paginator, collection]
215     end
216
217     # A class representing a paginator for an Active Record collection.
218     class Paginator
219       include Enumerable
220
221       # Creates a new Paginator on the given +controller+ for a set of items
222       # of size +item_count+ and having +items_per_page+ items per page.
223       # Raises ArgumentError if items_per_page is out of bounds (i.e., less
224       # than or equal to zero). The page CGI parameter for links defaults to
225       # "page" and can be overridden with +page_parameter+.
226       def initialize(controller, item_count, items_per_page, current_page = 1)
227         raise ArgumentError, "must have at least one item per page" if
228           items_per_page <= 0
229
230         @controller = controller
231         @item_count = item_count || 0
232         @items_per_page = items_per_page
233         @pages = {}
234
235         self.current_page = current_page
236       end
237       attr_reader :controller, :item_count, :items_per_page
238
239       # Sets the current page number of this paginator. If +page+ is a Page
240       # object, its +number+ attribute is used as the value; if the page does
241       # not belong to this Paginator, an ArgumentError is raised.
242       def current_page=(page)
243         if page.is_a? Page
244           raise ArgumentError, "Page/Paginator mismatch" unless
245             page.paginator == self
246         end
247         page = page.to_i
248         @current_page_number = has_page_number?(page) ? page : 1
249       end
250
251       # Returns a Page object representing this paginator's current page.
252       def current_page
253         @current_page ||= self[@current_page_number]
254       end
255       alias current current_page
256
257       # Returns a new Page representing the first page in this paginator.
258       def first_page
259         @first_page ||= self[1]
260       end
261       alias first first_page
262
263       # Returns a new Page representing the last page in this paginator.
264       def last_page
265         @last_page ||= self[page_count]
266       end
267       alias last last_page
268
269       # Returns the number of pages in this paginator.
270       def page_count
271         @page_count ||= if @item_count.zero?
272                           1
273                         else
274                           q, r = @item_count.divmod(@items_per_page)
275                           r.zero? ? q : q + 1
276                         end
277       end
278
279       alias length page_count
280
281       # Returns true if this paginator contains the page of index +number+.
282       def has_page_number?(number)
283         number >= 1 && number <= page_count
284       end
285
286       # Returns a new Page representing the page with the given index
287       # +number+.
288       def [](number)
289         @pages[number] ||= Page.new(self, number)
290       end
291
292       # Successively yields all the paginator's pages to the given block.
293       def each(&_block)
294         page_count.times do |n|
295           yield self[n + 1]
296         end
297       end
298
299       # A class representing a single page in a paginator.
300       class Page
301         include Comparable
302
303         # Creates a new Page for the given +paginator+ with the index
304         # +number+. If +number+ is not in the range of valid page numbers or
305         # is not a number at all, it defaults to 1.
306         def initialize(paginator, number)
307           @paginator = paginator
308           @number = number.to_i
309           @number = 1 unless @paginator.has_page_number? @number
310         end
311         attr_reader :paginator, :number
312         alias to_i number
313
314         # Compares two Page objects and returns true when they represent the
315         # same page (i.e., their paginators are the same and they have the
316         # same page number).
317         def ==(other)
318           return false if other.nil?
319
320           @paginator == other.paginator &&
321             @number == other.number
322         end
323
324         # Compares two Page objects and returns -1 if the left-hand page comes
325         # before the right-hand page, 0 if the pages are equal, and 1 if the
326         # left-hand page comes after the right-hand page. Raises ArgumentError
327         # if the pages do not belong to the same Paginator object.
328         def <=>(other)
329           raise ArgumentError unless @paginator == other.paginator
330
331           @number <=> other.number
332         end
333
334         # Returns the item offset for the first item in this page.
335         def offset
336           @paginator.items_per_page * (@number - 1)
337         end
338
339         # Returns the number of the first item displayed.
340         def first_item
341           offset + 1
342         end
343
344         # Returns the number of the last item displayed.
345         def last_item
346           [@paginator.items_per_page * @number, @paginator.item_count].min
347         end
348
349         # Returns true if this page is the first page in the paginator.
350         def first?
351           self == @paginator.first
352         end
353
354         # Returns true if this page is the last page in the paginator.
355         def last?
356           self == @paginator.last
357         end
358
359         # Returns a new Page object representing the page just before this
360         # page, or nil if this is the first page.
361         def previous
362           first? ? nil : @paginator[@number - 1]
363         end
364
365         # Returns a new Page object representing the page just after this
366         # page, or nil if this is the last page.
367         def next
368           last? ? nil : @paginator[@number + 1]
369         end
370
371         # Returns a new Window object for this page with the specified
372         # +padding+.
373         def window(padding = 2)
374           Window.new(self, padding)
375         end
376
377         # Returns the limit/offset array for this page.
378         def to_sql
379           [@paginator.items_per_page, offset]
380         end
381
382         def to_param #:nodoc:
383           @number.to_s
384         end
385       end
386
387       # A class for representing ranges around a given page.
388       class Window
389         # Creates a new Window object for the given +page+ with the specified
390         # +padding+.
391         def initialize(page, padding = 2)
392           @paginator = page.paginator
393           @page = page
394           self.padding = padding
395         end
396         attr_reader :paginator, :page
397
398         # Sets the window's padding (the number of pages on either side of the
399         # window page).
400         def padding=(padding)
401           @padding = padding.negative? ? 0 : padding
402           # Find the beginning and end pages of the window
403           @first = if @paginator.has_page_number?(@page.number - @padding)
404                      @paginator[@page.number - @padding]
405                    else
406                      @paginator.first
407                    end
408           @last = if @paginator.has_page_number?(@page.number + @padding)
409                     @paginator[@page.number + @padding]
410                   else
411                     @paginator.last
412                   end
413         end
414         attr_reader :padding, :first, :last
415
416         # Returns an array of Page objects in the current window.
417         def pages
418           (@first.number..@last.number).to_a.collect! { |n| @paginator[n] }
419         end
420         alias to_a pages
421       end
422     end
423   end
424 end