Class: Paginator

Inherits:
Object show all
Includes:
Enumerable
Defined in:
lib/vendor/paginator.rb

Defined Under Namespace

Classes: ArgumentError, MissingCountError, MissingSelectError, Page

Constant Summary collapse

VERSION = 
'1.1.1'

Instance Attribute Summary collapse

Instance Method Summary collapse

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)



24
25
26
27
28
29
30
 
# File 'lib/vendor/paginator.rb', line 24

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.



13
14
15
 
# File 'lib/vendor/paginator.rb', line 13

def count
  @count
end

#per_page ⇒ Object (readonly)

Returns the value of attribute per_page.



13
14
15
 
# File 'lib/vendor/paginator.rb', line 13

def per_page
  @per_page
end

Instance Method Details

#each ⇒ Object 



47
48
49
50
51
 
# File 'lib/vendor/paginator.rb', line 47

def each
  1.upto(number_of_pages) do |number|
    yield page(number)
  end
end

#first ⇒ Object

First page object



38
39
40
 
# File 'lib/vendor/paginator.rb', line 38

def first
  page 1
end

#last ⇒ Object

Last page object



43
44
45
 
# File 'lib/vendor/paginator.rb', line 43

def last
  page number_of_pages
end

#number_of_pages ⇒ Object

Total number of pages



33
34
35
 
# File 'lib/vendor/paginator.rb', line 33

def number_of_pages
   (@count / @per_page).to_i + (@count % @per_page > 0 ? 1 : 0)
end

#page(number) ⇒ Object

Retrieve page object by number



54
55
56
57
58
59
60
61
62
 
# File 'lib/vendor/paginator.rb', line 54

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