class Paginator

Constants

VERSION

Attributes

count[R]
per_page[R]

Public Class Methods

new(count, per_page, &select) click to toggle source

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)

# File lib/active_scaffold/paginator.rb, line 21
def initialize(count, per_page, &select)
  @count = count
  @per_page = per_page
  raise MissingSelectError, 'Must provide block to select data for each page' unless select
  @select = select
end

Public Instance Methods

each() { |item| ... } click to toggle source

Iterate through pages

# File lib/active_scaffold/paginator.rb, line 44
def each
  each_with_index do |item, _|
    yield item
  end
end
each_with_index() { |page(number), number - 1| ... } click to toggle source

Iterate through pages with indices

# File lib/active_scaffold/paginator.rb, line 51
def each_with_index
  1.upto(number_of_pages) do |number|
    yield(page(number), number - 1)
  end
end
first() click to toggle source

First page object

# File lib/active_scaffold/paginator.rb, line 34
def first
  page 1
end
last() click to toggle source

Last page object

# File lib/active_scaffold/paginator.rb, line 39
def last
  page number_of_pages
end
number_of_pages() click to toggle source

Total number of pages

# File lib/active_scaffold/paginator.rb, line 29
def number_of_pages
  (@count / @per_page).to_i + ((@count % @per_page).positive? ? 1 : 0)
end
page(number) click to toggle source

Retrieve page object by number

# File lib/active_scaffold/paginator.rb, line 58
def page(number)
  number = [1, number.to_i].max
  Page.new(self, number) do
    offset = (number - 1) * @per_page
    args = [offset]
    args << @per_page if @select.arity == 2
    @select.call(*args)
  end
end