Skip to content

Move the OffsetPaginator and the PagedPaginator into the JSONAPI namespace #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robbiewain wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Move the OffsetPaginator and the PagedPaginator into the JSONAPI namespace #672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
268 changes: 134 additions & 134 deletions lib/jsonapi/paginator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,185 +21,185 @@ def requires_record_count
end

def paginator_for(paginator)
paginator_class_name = "#{paginator.to_s.camelize}Paginator"
paginator_class_name = "JSONAPI::#{paginator.to_s.camelize}Paginator"
paginator_class_name.safe_constantize if paginator_class_name
end
end
end
end

class OffsetPaginator < JSONAPI::Paginator
attr_reader :limit, :offset

def initialize(params)
parse_pagination_params(params)
verify_pagination_params
end

def self.requires_record_count
true
end

def apply(relation, _order_options)
relation.offset(@offset).limit(@limit)
end

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

links_page_params['first'] = {
'offset' => 0,
'limit' => @limit
}
class OffsetPaginator < JSONAPI::Paginator
attr_reader :limit, :offset

if @offset > 0
previous_offset = @offset - @limit
def initialize(params)
parse_pagination_params(params)
verify_pagination_params
end

previous_offset = 0 if previous_offset < 0
def self.requires_record_count
true
end

links_page_params['prev'] = {
'offset' => previous_offset,
'limit' => @limit
}
def apply(relation, _order_options)
relation.offset(@offset).limit(@limit)
end

next_offset = @offset + @limit
def links_page_params(options = {})
record_count = options[:record_count]
links_page_params = {}

unless next_offset >= record_count
links_page_params['next'] = {
'offset' => next_offset,
links_page_params['first'] = {
'offset' => 0,
'limit' => @limit
}
end

if record_count
last_offset = record_count - @limit
if @offset > 0
previous_offset = @offset - @limit

last_offset = 0 if last_offset < 0
previous_offset = 0 if previous_offset < 0

links_page_params['last'] = {
'offset' => last_offset,
'limit' => @limit
}
end
links_page_params['prev'] = {
'offset' => previous_offset,
'limit' => @limit
}
end

links_page_params
end
next_offset = @offset + @limit

private
unless next_offset >= record_count
links_page_params['next'] = {
'offset' => next_offset,
'limit' => @limit
}
end

def parse_pagination_params(params)
if params.nil?
@offset = 0
@limit = JSONAPI.configuration.default_page_size
elsif params.is_a?(ActionController::Parameters)
validparams = params.permit(:offset, :limit)
if record_count
last_offset = record_count - @limit

@offset = validparams[:offset] ? validparams[:offset].to_i : 0
@limit = validparams[:limit] ? validparams[:limit].to_i : JSONAPI.configuration.default_page_size
else
fail JSONAPI::Exceptions::InvalidPageObject.new
end
rescue ActionController::UnpermittedParameters => e
raise JSONAPI::Exceptions::PageParametersNotAllowed.new(e.params)
end
last_offset = 0 if last_offset < 0

def verify_pagination_params
if @limit < 1
fail JSONAPI::Exceptions::InvalidPageValue.new(:limit, @limit)
elsif @limit > JSONAPI.configuration.maximum_page_size
fail JSONAPI::Exceptions::InvalidPageValue.new(:limit, @limit,
"Limit exceeds maximum page size of #{JSONAPI.configuration.maximum_page_size}.")
end
links_page_params['last'] = {
'offset' => last_offset,
'limit' => @limit
}
end

if @offset < 0
fail JSONAPI::Exceptions::InvalidPageValue.new(:offset, @offset)
links_page_params
end
end
end

class PagedPaginator < JSONAPI::Paginator
attr_reader :size, :number
private

def initialize(params)
parse_pagination_params(params)
verify_pagination_params
end
def parse_pagination_params(params)
if params.nil?
@offset = 0
@limit = JSONAPI.configuration.default_page_size
elsif params.is_a?(ActionController::Parameters)
validparams = params.permit(:offset, :limit)

def self.requires_record_count
true
end
@offset = validparams[:offset] ? validparams[:offset].to_i : 0
@limit = validparams[:limit] ? validparams[:limit].to_i : JSONAPI.configuration.default_page_size
else
fail JSONAPI::Exceptions::InvalidPageObject.new
end
rescue ActionController::UnpermittedParameters => e
raise JSONAPI::Exceptions::PageParametersNotAllowed.new(e.params)
end

def apply(relation, _order_options)
offset = (@number - 1) * @size
relation.offset(offset).limit(@size)
end
def verify_pagination_params
if @limit < 1
fail JSONAPI::Exceptions::InvalidPageValue.new(:limit, @limit)
elsif @limit > JSONAPI.configuration.maximum_page_size
fail JSONAPI::Exceptions::InvalidPageValue.new(:limit, @limit,
"Limit exceeds maximum page size of #{JSONAPI.configuration.maximum_page_size}.")
end

def links_page_params(options = {})
record_count = options[:record_count]
page_count = (record_count / @size.to_f).ceil
if @offset < 0
fail JSONAPI::Exceptions::InvalidPageValue.new(:offset, @offset)
end
end
end

links_page_params = {}
class PagedPaginator < JSONAPI::Paginator
attr_reader :size, :number

links_page_params['first'] = {
'number' => 1,
'size' => @size
}
def initialize(params)
parse_pagination_params(params)
verify_pagination_params
end

if @number > 1
links_page_params['prev'] = {
'number' => @number - 1,
'size' => @size
}
def self.requires_record_count
true
end

unless @number >= page_count
links_page_params['next'] = {
'number' => @number + 1,
'size' => @size
}
def apply(relation, _order_options)
offset = (@number - 1) * @size
relation.offset(offset).limit(@size)
end

if record_count
links_page_params['last'] = {
'number' => page_count == 0 ? 1 : page_count,
def links_page_params(options = {})
record_count = options[:record_count]
page_count = (record_count / @size.to_f).ceil

links_page_params = {}

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

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

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

def parse_pagination_params(params)
if params.nil?
@number = 1
@size = JSONAPI.configuration.default_page_size
elsif params.is_a?(ActionController::Parameters)
validparams = params.permit(:number, :size)
if record_count
links_page_params['last'] = {
'number' => page_count == 0 ? 1 : page_count,
'size' => @size
}
end

@size = validparams[:size] ? validparams[:size].to_i : JSONAPI.configuration.default_page_size
@number = validparams[:number] ? validparams[:number].to_i : 1
else
@size = JSONAPI.configuration.default_page_size
@number = params.to_i
links_page_params
end
rescue ActionController::UnpermittedParameters => e
raise JSONAPI::Exceptions::PageParametersNotAllowed.new(e.params)
end

def verify_pagination_params
if @size < 1
fail JSONAPI::Exceptions::InvalidPageValue.new(:size, @size)
elsif @size > JSONAPI.configuration.maximum_page_size
fail JSONAPI::Exceptions::InvalidPageValue.new(:size, @size,
"size exceeds maximum page size of #{JSONAPI.configuration.maximum_page_size}.")
private

def parse_pagination_params(params)
if params.nil?
@number = 1
@size = JSONAPI.configuration.default_page_size
elsif params.is_a?(ActionController::Parameters)
validparams = params.permit(:number, :size)

@size = validparams[:size] ? validparams[:size].to_i : JSONAPI.configuration.default_page_size
@number = validparams[:number] ? validparams[:number].to_i : 1
else
@size = JSONAPI.configuration.default_page_size
@number = params.to_i
end
rescue ActionController::UnpermittedParameters => e
raise JSONAPI::Exceptions::PageParametersNotAllowed.new(e.params)
end

if @number < 1
fail JSONAPI::Exceptions::InvalidPageValue.new(:number, @number)
def verify_pagination_params
if @size < 1
fail JSONAPI::Exceptions::InvalidPageValue.new(:size, @size)
elsif @size > JSONAPI.configuration.maximum_page_size
fail JSONAPI::Exceptions::InvalidPageValue.new(:size, @size,
"size exceeds maximum page size of #{JSONAPI.configuration.maximum_page_size}.")
end

if @number < 1
fail JSONAPI::Exceptions::InvalidPageValue.new(:number, @number)
end
end
end
end
Loading