Class: PagedPaginator

Inherits:
JSONAPI::Paginator show all
Defined in:
lib/jsonapi/paginator.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from JSONAPI::Paginator

paginator_for

Constructor Details

#initialize(params) ⇒ PagedPaginator

Returns a new instance of PagedPaginator.



125
126
127
128
 
# File 'lib/jsonapi/paginator.rb', line 125

def initialize(params)
  parse_pagination_params(params)
  verify_pagination_params
end

Instance Attribute Details

#number ⇒ Object (readonly)

Returns the value of attribute number.



123
124
125
 
# File 'lib/jsonapi/paginator.rb', line 123

def number
  @number
end

#size ⇒ Object (readonly)

Returns the value of attribute size.



123
124
125
 
# File 'lib/jsonapi/paginator.rb', line 123

def size
  @size
end

Class Method Details

.requires_record_count ⇒ Object 



130
131
132
 
# File 'lib/jsonapi/paginator.rb', line 130

def self.requires_record_count
  true
end

Instance Method Details

#apply(relation, _order_options) ⇒ Object 



138
139
140
141
 
# File 'lib/jsonapi/paginator.rb', line 138

def apply(relation, _order_options)
  offset = (@number - 1) * @size
  relation.offset(offset).limit(@size)
end

#calculate_page_count(record_count) ⇒ Object 



134
135
136
 
# File 'lib/jsonapi/paginator.rb', line 134

def calculate_page_count(record_count)
  (record_count / @size.to_f).ceil
end

#links_page_params(options = {}) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/jsonapi/paginator.rb', line 143

def links_page_params(options = {})
  record_count = options[:record_count]
  page_count = calculate_page_count(record_count)

  links_page_params = {}

  links_page_params['first'] = {
    'number' => 1,
    'size' => @size
  }

  if @number > 1
    links_page_params['prev'] = {
      'number' => @number - 1,
      'size' => @size
    }
  end

  unless @number >= page_count
    links_page_params['next'] = {
      'number' => @number + 1,
      'size' => @size
    }
  end

  if record_count
    links_page_params['last'] = {
      'number' => page_count == 0 ? 1 : page_count,
      'size' => @size
    }
  end

  links_page_params
end