Class: Sunspot::Search::PaginatedCollection

Inherits:

Object

• Object
• Sunspot::Search::PaginatedCollection

show all

Defined in:

sunspot/lib/sunspot/search/paginated_collection.rb

Instance Attribute Summary (collapse)

• - (Object) current_page readonly

  Returns the value of attribute current_page.

• - (Object) per_page (also: #limit_value) readonly

  Returns the value of attribute per_page.

• - (Object) total_count (also: #total_entries) readonly

  Returns the value of attribute total_count.

Instance Method Summary (collapse)

• - (Boolean) first_page?
• - (PaginatedCollection) initialize(collection, page, per_page, total) constructor

  A new instance of PaginatedCollection.

• - (Boolean) last_page?
• - (Object) next_page
• - (Object) offset
• - (Boolean) out_of_bounds?
• - (Object) previous_page
• - (Object) total_pages (also: #num_pages)

11
12
13
14
15
16

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 11

def initialize(collection, page, per_page, total)
  @collection   = collection
  @current_page = page
  @per_page     = per_page
  @total_count  = total
end

49
50
51

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 49

def method_missing(method, *args, &block)
  @collection.send(method, *args, &block)
end

7
8
9

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 7

def current_page
  @current_page
end

7
8
9

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 7

def per_page
  @per_page
end

7
8
9

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 7

def total_count
  @total_count
end

23
24
25

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 23

def first_page?
  current_page == 1
end

27
28
29

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 27

def last_page?
  current_page >= total_pages
end

35
36
37

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 35

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

43
44
45

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 43

def offset
  (current_page - 1) * per_page
end

39
40
41

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 39

def out_of_bounds?
  current_page > total_pages
end

31
32
33

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 31

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

18
19
20

# File 'sunspot/lib/sunspot/search/paginated_collection.rb', line 18

def total_pages
  (total_count.to_f / per_page).ceil
end