Class: Cybertrain::Page
- Inherits:
-
Object
- Object
- Cybertrain::Page
- Defined in:
- cybertrain/pagination.rb
Overview
One page of an offset-paginated list: its 1-based number, its size, and
whether a newer (previous) and an older (next) page exist.
Relation#page returns it and windows the relation to the page’s rows,
which to_a / each then load as typed records:
@articles = Article.order("created_at DESC")
@page = @articles.page(params.page_number, per: 20)
# @articles.each { |a| ... } -- at most 20 Articles
The rows are not on the Page: a typed Page#rows would need a Page
class per model (generated, like ArticleRelation), while the relation
already returns typed records.
In a template, <%= paginate @page, articles_path %> renders the
Newer / Older links; @page.number, @page.next?, @page.prev?,
@page.per and @page.row_offset can be read too.
Instance Attribute Summary collapse
-
#number ⇒ Integer
readonly
The page’s number, from 1.
-
#per ⇒ Integer
readonly
The most rows on one page.
-
#row_offset ⇒ Integer
readonly
Named row_offset, not offset: the relations’
offset(n)returns a relation, and one method name with two return types corrupts inference under Spinel (spikes/NOTES.md rule 34).
Instance Method Summary collapse
-
#next? ⇒ Boolean
True when an older page (number + 1) has rows.
-
#next_number ⇒ Integer
The next page’s number (whether or not it exists).
-
#prev? ⇒ Boolean
True when this is not the first page.
-
#prev_number ⇒ Integer
The previous page’s number, never below 1.
Instance Attribute Details
#number ⇒ Integer (readonly)
Returns the page’s number, from 1.
29 30 31 |
# File 'cybertrain/pagination.rb', line 29 def number @number end |
#per ⇒ Integer (readonly)
Returns the most rows on one page.
33 34 35 |
# File 'cybertrain/pagination.rb', line 33 def per @per end |
#row_offset ⇒ Integer (readonly)
Named row_offset, not offset: the relations’ offset(n) returns a
relation, and one method name with two return types corrupts
inference under Spinel (spikes/NOTES.md rule 34).
40 41 42 |
# File 'cybertrain/pagination.rb', line 40 def row_offset @row_offset end |
Instance Method Details
#next? ⇒ Boolean
Returns true when an older page (number + 1) has rows.
54 55 56 |
# File 'cybertrain/pagination.rb', line 54 def next? @more end |
#next_number ⇒ Integer
Returns the next page’s number (whether or not it exists).
66 67 68 |
# File 'cybertrain/pagination.rb', line 66 def next_number @number + 1 end |
#prev? ⇒ Boolean
Returns true when this is not the first page.
60 61 62 |
# File 'cybertrain/pagination.rb', line 60 def prev? @number > 1 end |
#prev_number ⇒ Integer
Returns the previous page’s number, never below 1.
72 73 74 |
# File 'cybertrain/pagination.rb', line 72 def prev_number @number > 1 ? @number - 1 : 1 end |