module Kaminari::PageScopeMethods

Public Instance Methods

current_page() click to toggle source

Current page number

# File lib/kaminari/models/page_scope_methods.rb, line 47
def current_page
  offset_without_padding = offset_value
  offset_without_padding -= @_padding if defined?(@_padding) && @_padding
  offset_without_padding = 0 if offset_without_padding < 0

  (offset_without_padding / limit_value) + 1
rescue ZeroDivisionError
  raise ZeroPerPageOperation, "Current page was incalculable. Perhaps you called .per(0)?"
end
current_per_page() click to toggle source

Current per-page number

# File lib/kaminari/models/page_scope_methods.rb, line 58
def current_per_page
  ActiveSupport::Deprecation.warn '#current_per_page is deprecated and will be removed in the next major ' \
                                  'version. Please use #limit_value instead.'

  limit_value
  # (defined?(@_per) && @_per) || default_per_page
end
first_page?() click to toggle source

First page of the collection?

# File lib/kaminari/models/page_scope_methods.rb, line 77
def first_page?
  current_page == 1
end
last_page?() click to toggle source

Last page of the collection?

# File lib/kaminari/models/page_scope_methods.rb, line 82
def last_page?
  current_page == total_pages
end
max_paginates_per(new_max_per_page) click to toggle source
# File lib/kaminari/models/page_scope_methods.rb, line 21
def max_paginates_per(new_max_per_page)
  @_max_per_page = new_max_per_page

  per (defined?(@_per) && @_per) || default_per_page, max_per_page: new_max_per_page
end
next_page() click to toggle source

Next page number in the collection

# File lib/kaminari/models/page_scope_methods.rb, line 67
def next_page
  current_page + 1 unless last_page? || out_of_range?
end
out_of_range?() click to toggle source

Out of range of the collection?

# File lib/kaminari/models/page_scope_methods.rb, line 87
def out_of_range?
  current_page > total_pages
end
padding(num) click to toggle source
# File lib/kaminari/models/page_scope_methods.rb, line 27
def padding(num)
  num = num.to_i
  raise ArgumentError, "padding must not be negative" if num < 0
  @_padding = num
  offset(offset_value + @_padding)
end
per(num, max_per_page: nil) click to toggle source

Specify the per_page value for the preceding page scope

Model.page(3).per(10)
# File lib/kaminari/models/page_scope_methods.rb, line 7
def per(num, max_per_page: nil)
  max_per_page ||= ((defined?(@_max_per_page) && @_max_per_page) || self.max_per_page)
  @_per = (num || default_per_page).to_i
  if (n = num.to_i) < 0 || !(/^\d/ =~ num.to_s)
    self
  elsif n.zero?
    limit(n)
  elsif max_per_page && (max_per_page < n)
    limit(max_per_page).offset(offset_value / limit_value * max_per_page)
  else
    limit(n).offset(offset_value / limit_value * n)
  end
end
prev_page() click to toggle source

Previous page number in the collection

# File lib/kaminari/models/page_scope_methods.rb, line 72
def prev_page
  current_page - 1 unless first_page? || out_of_range?
end
total_pages() click to toggle source

Total number of pages

# File lib/kaminari/models/page_scope_methods.rb, line 35
def total_pages
  count_without_padding = total_count
  count_without_padding -= @_padding if defined?(@_padding) && @_padding
  count_without_padding = 0 if count_without_padding < 0

  total_pages_count = (count_without_padding.to_f / limit_value).ceil
  max_pages && (max_pages < total_pages_count) ? max_pages : total_pages_count
rescue FloatDomainError
  raise ZeroPerPageOperation, "The number of total pages was incalculable. Perhaps you called .per(0)?"
end