fa1307beef86dc9edc1ab3b55953327cc2a5c294
[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     unless const_defined?(:OPTIONS)
61       # A hash holding options for controllers using macro-style pagination
62       OPTIONS = Hash.new
63   
64       # The default options for pagination
65       DEFAULT_OPTIONS = {
66         :class_name => nil,
67         :singular_name => nil,
68         :per_page   => 10,
69         :conditions => nil,
70         :order_by   => nil,
71         :order      => nil,
72         :join       => nil,
73         :joins      => nil,
74         :count      => nil,
75         :include    => nil,
76         :select     => nil,
77         :group      => nil,
78         :parameter  => 'page'
79       }
80     else
81       DEFAULT_OPTIONS[:group] = nil
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       raise ActionController::ActionControllerError,
97             "Unknown options: #{unknown_option_keys.join(', ')}" unless
98               unknown_option_keys.empty?
99
100       options[:singular_name] ||= ActiveSupport::Inflector.singularize(collection_id.to_s)
101       options[:class_name]  ||= ActiveSupport::Inflector.camelize(options[:singular_name])
102     end
103
104     # Returns a paginator and a collection of Active Record model instances
105     # for the paginator's current page. This is designed to be used in a
106     # single action; to automatically paginate multiple actions, consider
107     # ClassMethods#paginate.
108     #
109     # +options+ are:
110     # <tt>:singular_name</tt>:: the singular name to use, if it can't be inferred by singularizing the collection name
111     # <tt>:class_name</tt>:: the class name to use, if it can't be inferred by
112     #                        camelizing the singular name
113     # <tt>:per_page</tt>::   the maximum number of items to include in a 
114     #                        single page. Defaults to 10
115     # <tt>:conditions</tt>:: optional conditions passed to Model.find(:all, *params) and
116     #                        Model.count
117     # <tt>:order</tt>::      optional order parameter passed to Model.find(:all, *params)
118     # <tt>:order_by</tt>::   (deprecated, used :order) optional order parameter passed to Model.find(:all, *params)
119     # <tt>:joins</tt>::      optional joins parameter passed to Model.find(:all, *params)
120     #                        and Model.count
121     # <tt>:join</tt>::       (deprecated, used :joins or :include) optional join parameter passed to Model.find(:all, *params)
122     #                        and Model.count
123     # <tt>:include</tt>::    optional eager loading parameter passed to Model.find(:all, *params)
124     #                        and Model.count
125     # <tt>:select</tt>::     :select parameter passed to Model.find(:all, *params)
126     #
127     # <tt>:count</tt>::      parameter passed as :select option to Model.count(*params)
128     #
129     # <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
130     #
131     def paginate(collection_id, options={})
132       Pagination.validate_options!(collection_id, options, true)
133       paginator_and_collection_for(collection_id, options)
134     end
135
136     # These methods become class methods on any controller 
137     module ClassMethods
138       # Creates a +before_filter+ which automatically paginates an Active
139       # Record model for all actions in a controller (or certain actions if
140       # specified with the <tt>:actions</tt> option).
141       #
142       # +options+ are the same as PaginationHelper#paginate, with the addition 
143       # of:
144       # <tt>:actions</tt>:: an array of actions for which the pagination is
145       #                     active. Defaults to +nil+ (i.e., every action)
146       def paginate(collection_id, options={})
147         Pagination.validate_options!(collection_id, options, false)
148         module_eval do
149           before_filter :create_paginators_and_retrieve_collections
150           OPTIONS[self] ||= Hash.new
151           OPTIONS[self][collection_id] = options
152         end
153       end
154     end
155
156     def create_paginators_and_retrieve_collections #:nodoc:
157       Pagination::OPTIONS[self.class].each do |collection_id, options|
158         next unless options[:actions].include? action_name if
159           options[:actions]
160
161         paginator, collection = 
162           paginator_and_collection_for(collection_id, options)
163
164         paginator_name = "@#{options[:singular_name]}_pages"
165         self.instance_variable_set(paginator_name, paginator)
166
167         collection_name = "@#{collection_id.to_s}"
168         self.instance_variable_set(collection_name, collection)     
169       end
170     end
171   
172     # Returns the total number of items in the collection to be paginated for
173     # the +model+ and given +conditions+. Override this method to implement a
174     # custom counter.
175     def count_collection_for_pagination(model, options)
176       collection = model.joins(options[:join] || options[:joins])
177       collection = collection.where(options[:conditions])
178       collection = collection.includes(options[:include])
179
180       if options[:group]
181         collection = collection.select(options[:group]).distinct
182       elsif options[:count]
183         collection = collection.select(options[:count])
184       end
185
186       collection.count
187     end
188     
189     # Returns a collection of items for the given +model+ and +options[conditions]+,
190     # ordered by +options[order]+, for the current page in the given +paginator+.
191     # Override this method to implement a custom finder.
192     def find_collection_for_pagination(model, options, paginator)
193       collection = model.joins(options[:join] || options[:joins])
194       collection = collection.where(options[:conditions])
195       collection = collection.order(options[:order_by] || options[:order])
196       collection = collection.includes(options[:include])
197       collection = collection.group(options[:group])
198
199       if options[:select]
200         collection = collection.select(options[:select])
201       end
202          
203       collection.offset(paginator.current.offset).limit(options[:per_page])
204     end
205   
206     protected :create_paginators_and_retrieve_collections,
207               :count_collection_for_pagination,
208               :find_collection_for_pagination
209
210     def paginator_and_collection_for(collection_id, options) #:nodoc:
211       klass = options[:class_name].constantize
212       page  = params[options[:parameter]]
213       count = count_collection_for_pagination(klass, options)
214       paginator = Paginator.new(self, count, options[:per_page], page)
215       collection = find_collection_for_pagination(klass, options, paginator)
216     
217       return paginator, collection 
218     end
219       
220     private :paginator_and_collection_for
221
222     # A class representing a paginator for an Active Record collection.
223     class Paginator
224       include Enumerable
225
226       # Creates a new Paginator on the given +controller+ for a set of items
227       # of size +item_count+ and having +items_per_page+ items per page.
228       # Raises ArgumentError if items_per_page is out of bounds (i.e., less
229       # than or equal to zero). The page CGI parameter for links defaults to
230       # "page" and can be overridden with +page_parameter+.
231       def initialize(controller, item_count, items_per_page, current_page=1)
232         raise ArgumentError, 'must have at least one item per page' if
233           items_per_page <= 0
234
235         @controller = controller
236         @item_count = item_count || 0
237         @items_per_page = items_per_page
238         @pages = {}
239         
240         self.current_page = current_page
241       end
242       attr_reader :controller, :item_count, :items_per_page
243       
244       # Sets the current page number of this paginator. If +page+ is a Page
245       # object, its +number+ attribute is used as the value; if the page does 
246       # not belong to this Paginator, an ArgumentError is raised.
247       def current_page=(page)
248         if page.is_a? Page
249           raise ArgumentError, 'Page/Paginator mismatch' unless
250             page.paginator == self
251         end
252         page = page.to_i
253         @current_page_number = has_page_number?(page) ? page : 1
254       end
255
256       # Returns a Page object representing this paginator's current page.
257       def current_page
258         @current_page ||= self[@current_page_number]
259       end
260       alias current :current_page
261
262       # Returns a new Page representing the first page in this paginator.
263       def first_page
264         @first_page ||= self[1]
265       end
266       alias first :first_page
267
268       # Returns a new Page representing the last page in this paginator.
269       def last_page
270         @last_page ||= self[page_count] 
271       end
272       alias last :last_page
273
274       # Returns the number of pages in this paginator.
275       def page_count
276         @page_count ||= @item_count.zero? ? 1 :
277                           (q,r=@item_count.divmod(@items_per_page); r==0? q : q+1)
278       end
279
280       alias length :page_count
281
282       # Returns true if this paginator contains the page of index +number+.
283       def has_page_number?(number)
284         number >= 1 and number <= page_count
285       end
286
287       # Returns a new Page representing the page with the given index
288       # +number+.
289       def [](number)
290         @pages[number] ||= Page.new(self, number)
291       end
292
293       # Successively yields all the paginator's pages to the given block.
294       def each(&block)
295         page_count.times do |n|
296           yield self[n+1]
297         end
298       end
299
300       # A class representing a single page in a paginator.
301       class Page
302         include Comparable
303
304         # Creates a new Page for the given +paginator+ with the index
305         # +number+. If +number+ is not in the range of valid page numbers or
306         # is not a number at all, it defaults to 1.
307         def initialize(paginator, number)
308           @paginator = paginator
309           @number = number.to_i
310           @number = 1 unless @paginator.has_page_number? @number
311         end
312         attr_reader :paginator, :number
313         alias to_i :number
314
315         # Compares two Page objects and returns true when they represent the 
316         # same page (i.e., their paginators are the same and they have the
317         # same page number).
318         def ==(page)
319           return false if page.nil?
320           @paginator == page.paginator and 
321             @number == page.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 <=>(page)
329           raise ArgumentError unless @paginator == page.paginator
330           @number <=> page.number
331         end
332
333         # Returns the item offset for the first item in this page.
334         def offset
335           @paginator.items_per_page * (@number - 1)
336         end
337         
338         # Returns the number of the first item displayed.
339         def first_item
340           offset + 1
341         end
342         
343         # Returns the number of the last item displayed.
344         def last_item
345           [@paginator.items_per_page * @number, @paginator.item_count].min
346         end
347
348         # Returns true if this page is the first page in the paginator.
349         def first?
350           self == @paginator.first
351         end
352
353         # Returns true if this page is the last page in the paginator.
354         def last?
355           self == @paginator.last
356         end
357
358         # Returns a new Page object representing the page just before this
359         # page, or nil if this is the first page.
360         def previous
361           if first? then nil else @paginator[@number - 1] end
362         end
363
364         # Returns a new Page object representing the page just after this
365         # page, or nil if this is the last page.
366         def next
367           if last? then nil else @paginator[@number + 1] end
368         end
369
370         # Returns a new Window object for this page with the specified 
371         # +padding+.
372         def window(padding=2)
373           Window.new(self, padding)
374         end
375
376         # Returns the limit/offset array for this page.
377         def to_sql
378           [@paginator.items_per_page, offset]
379         end
380         
381         def to_param #:nodoc:
382           @number.to_s
383         end
384       end
385
386       # A class for representing ranges around a given page.
387       class Window
388         # Creates a new Window object for the given +page+ with the specified
389         # +padding+.
390         def initialize(page, padding=2)
391           @paginator = page.paginator
392           @page = page
393           self.padding = padding
394         end
395         attr_reader :paginator, :page
396
397         # Sets the window's padding (the number of pages on either side of the
398         # window page).
399         def padding=(padding)
400           @padding = padding < 0 ? 0 : padding
401           # Find the beginning and end pages of the window
402           @first = @paginator.has_page_number?(@page.number - @padding) ?
403             @paginator[@page.number - @padding] : @paginator.first
404           @last =  @paginator.has_page_number?(@page.number + @padding) ?
405             @paginator[@page.number + @padding] : @paginator.last
406         end
407         attr_reader :padding, :first, :last
408
409         # Returns an array of Page objects in the current window.
410         def pages
411           (@first.number..@last.number).to_a.collect! {|n| @paginator[n]}
412         end
413         alias to_a :pages
414       end
415     end
416
417   end
418 end