Module: Sequel::Dataset::Pagination

Defined in:
lib/sequel/extensions/pagination.rb

Overview

Holds methods that only relate to paginated datasets. Paginated dataset have pages starting at 1 (page 1 is offset 0, page 1 is offset page_size).

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#current_page ⇒ Object

The current page of the dataset, starting at 1 and not 0.



70
71
72
 
# File 'lib/sequel/extensions/pagination.rb', line 70

def current_page
  @current_page
end

#page_count ⇒ Object

The number of pages in the dataset before pagination, of which this paginated dataset is one. Empty datasets are considered to have a single page.



67
68
69
 
# File 'lib/sequel/extensions/pagination.rb', line 67

def page_count
  @page_count
end

#page_size ⇒ Object

The number of records per page (the final page may have fewer than this number of records).



62
63
64
 
# File 'lib/sequel/extensions/pagination.rb', line 62

def page_size
  @page_size
end

#pagination_record_count ⇒ Object

The total number of records in the dataset before pagination.



73
74
75
 
# File 'lib/sequel/extensions/pagination.rb', line 73

def pagination_record_count
  @pagination_record_count
end

Instance Method Details

#current_page_record_count ⇒ Object

Returns the number of records in the current page



86
87
88
89
90
91
92
93
 
# File 'lib/sequel/extensions/pagination.rb', line 86

def current_page_record_count
  return 0 if @current_page > @page_count
  
  a = 1 + (@current_page - 1) * @page_size
  b = a + @page_size - 1
  b = @pagination_record_count if b > @pagination_record_count
  b - a + 1
end

#current_page_record_range ⇒ Object

Returns the record range for the current page



76
77
78
79
80
81
82
83
 
# File 'lib/sequel/extensions/pagination.rb', line 76

def current_page_record_range
  return (0..0) if @current_page > @page_count
  
  a = 1 + (@current_page - 1) * @page_size
  b = a + @page_size - 1
  b = @pagination_record_count if b > @pagination_record_count
  a..b
end

#first_page? ⇒ Boolean

Returns true if the current page is the first page

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/sequel/extensions/pagination.rb', line 96

def first_page?
  @current_page == 1
end

#last_page? ⇒ Boolean

Returns true if the current page is the last page

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/sequel/extensions/pagination.rb', line 101

def last_page?
  @current_page == @page_count
end

#next_page ⇒ Object

Returns the next page number or nil if the current page is the last page



106
107
108
 
# File 'lib/sequel/extensions/pagination.rb', line 106

def next_page
  current_page < page_count ? (current_page + 1) : nil
end

#page_range ⇒ Object

Returns the page range



111
112
113
 
# File 'lib/sequel/extensions/pagination.rb', line 111

def page_range
  1..page_count
end

#prev_page ⇒ Object

Returns the previous page number or nil if the current page is the first



116
117
118
 
# File 'lib/sequel/extensions/pagination.rb', line 116

def prev_page
  current_page > 1 ? (current_page - 1) : nil
end

#set_pagination_info(page_no, page_size, record_count) ⇒ Object

Sets the pagination info for this paginated dataset, and returns self.



121
122
123
124
125
126
127
128
 
# File 'lib/sequel/extensions/pagination.rb', line 121

def set_pagination_info(page_no, page_size, record_count)
  @current_page = page_no
  @page_size = page_size
  @pagination_record_count = record_count
  @page_count = (record_count / page_size.to_f).ceil
  @page_count = 1 if @page_count == 0
  self
end