Class: Paginator
- Defined in:
- lib/active_scaffold/paginator.rb,
lib/active_scaffold/extensions/paginator_extensions.rb
Defined Under Namespace
Classes: ArgumentError, MissingCountError, MissingSelectError, Page
Constant Summary collapse
- VERSION =
'1.0.9'
Instance Attribute Summary collapse
-
#count ⇒ Object
readonly
Returns the value of attribute count.
-
#per_page ⇒ Object
readonly
Returns the value of attribute per_page.
Instance Method Summary collapse
-
#each ⇒ Object
Iterate through pages.
-
#each_with_index ⇒ Object
Iterate through pages with indices.
-
#first ⇒ Object
First page object.
-
#infinite? ⇒ Boolean
Is this an “infinite” paginator.
-
#initialize(count, per_page, &select) ⇒ Paginator
constructor
Instantiate a new Paginator object.
-
#last ⇒ Object
Last page object.
-
#number_of_pages ⇒ Object
Total number of pages.
-
#number_of_pages_with_infinite ⇒ Object
Total number of pages.
-
#page(number) ⇒ Object
Retrieve page object by number.
Constructor Details
#initialize(count, per_page, &select) ⇒ Paginator
Instantiate a new Paginator object
Provide:
-
A total count of the number of objects to paginate
-
The number of objects in each page
-
A block that returns the array of items
-
The block is passed the item offset (and the number of items to show per page, for convenience, if the arity is 2)
-
22 23 24 25 26 27 28 |
# File 'lib/active_scaffold/paginator.rb', line 22 def initialize(count, per_page, &select) @count, @per_page = count, per_page unless select raise MissingSelectError, "Must provide block to select data for each page" end @select = select end |
Instance Attribute Details
#count ⇒ Object (readonly)
Returns the value of attribute count.
11 12 13 |
# File 'lib/active_scaffold/paginator.rb', line 11 def count @count end |
#per_page ⇒ Object (readonly)
Returns the value of attribute per_page.
11 12 13 |
# File 'lib/active_scaffold/paginator.rb', line 11 def per_page @per_page end |
Instance Method Details
#each ⇒ Object
Iterate through pages
46 47 48 49 50 |
# File 'lib/active_scaffold/paginator.rb', line 46 def each each_with_index do |item, index| yield item end end |
#each_with_index ⇒ Object
Iterate through pages with indices
53 54 55 56 57 |
# File 'lib/active_scaffold/paginator.rb', line 53 def each_with_index 1.upto(number_of_pages) do |number| yield(page(number), number - 1) end end |
#first ⇒ Object
First page object
36 37 38 |
# File 'lib/active_scaffold/paginator.rb', line 36 def first page 1 end |
#infinite? ⇒ Boolean
Is this an “infinite” paginator
12 13 14 |
# File 'lib/active_scaffold/extensions/paginator_extensions.rb', line 12 def infinite? @count.nil? end |
#last ⇒ Object
Last page object
41 42 43 |
# File 'lib/active_scaffold/paginator.rb', line 41 def last page number_of_pages end |
#number_of_pages ⇒ Object
Total number of pages
31 32 33 |
# File 'lib/active_scaffold/paginator.rb', line 31 def number_of_pages (@count / @per_page).to_i + (@count % @per_page > 0 ? 1 : 0) end |
#number_of_pages_with_infinite ⇒ Object
Total number of pages
6 7 8 |
# File 'lib/active_scaffold/extensions/paginator_extensions.rb', line 6 def number_of_pages_with_infinite number_of_pages_without_infinite unless infinite? end |
#page(number) ⇒ Object
Retrieve page object by number
60 61 62 63 64 65 66 67 68 |
# File 'lib/active_scaffold/paginator.rb', line 60 def page(number) number = (n = number.to_i) > 0 ? n : 1 Page.new(self, number, lambda { offset = (number - 1) * @per_page args = [offset] args << @per_page if @select.arity == 2 @select.call(*args) }) end |