Skip to content
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.

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

WIP: Resource level pagination options #1048

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 35 additions & 13 deletions lib/jsonapi/paginator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ def paginator_for(paginator)
class OffsetPaginator < JSONAPI::Paginator
attr_reader :limit, :offset

def initialize(params)
def initialize(params, options = {})
@options = options
parse_pagination_params(params)
verify_pagination_params
end
Expand Down Expand Up @@ -89,15 +90,17 @@ def links_page_params(options = {})

private

attr_reader :options

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

@offset = validparams[:offset] ? validparams[:offset].to_i : 0
@limit = validparams[:limit] ? validparams[:limit].to_i : JSONAPI.configuration.default_page_size
@offset = (valid_params[:offset] || default_offset).to_i
@limit = (valid_params[:limit] || default_limit).to_i
else
fail JSONAPI::Exceptions::InvalidPageObject.new
end
Expand All @@ -117,12 +120,21 @@ def verify_pagination_params
fail JSONAPI::Exceptions::InvalidPageValue.new(:offset, @offset)
end
end

def default_offset
options.try(:[], :offset) || 0
end

def default_limit
options.try(:[], :limit) || JSONAPI.configuration.default_page_size
end
end

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

def initialize(params)
def initialize(params, options)
@options = options
parse_pagination_params(params)
verify_pagination_params
end
Expand Down Expand Up @@ -177,18 +189,20 @@ def links_page_params(options = {})

private

attr_reader :options

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

@size = validparams[:size] ? validparams[:size].to_i : JSONAPI.configuration.default_page_size
@number = validparams[:number] ? validparams[:number].to_i : 1
@number = (valid_params[:number] || default_page_number).to_i
@size = (valid_params[:size] || default_page_size).to_i
else
@size = JSONAPI.configuration.default_page_size
@number = params.to_i
@size = default_page_size
end
rescue ActionController::UnpermittedParameters => e
raise JSONAPI::Exceptions::PageParametersNotAllowed.new(e.params)
Expand All @@ -206,4 +220,12 @@ def verify_pagination_params
fail JSONAPI::Exceptions::InvalidPageValue.new(:number, @number)
end
end

def default_page_size
options.try(:[], :default_page_size) || JSONAPI.configuration.default_page_size
end

def default_page_number
options.try(:[], :default_page_number) || 1
end
end
8 changes: 7 additions & 1 deletion lib/jsonapi/request_parser.rb
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,13 @@ def parse_modify_relationship_action(modification_type, params, resource_klass)

def parse_pagination(resource_klass, page)
paginator_name = resource_klass._paginator
JSONAPI::Paginator.paginator_for(paginator_name).new(page) unless paginator_name == :none
return if paginator_name == :none

options = resource_klass._paginator_options
paginator = JSONAPI::Paginator.paginator_for(paginator_name)
arity = paginator.instance_method(:initialize).arity

arity == 2 ? paginator.new(page, options) : paginator.new(page)
end

def parse_fields(resource_klass, fields)
Expand Down
7 changes: 6 additions & 1 deletion lib/jsonapi/resource.rb
Original file line number Diff line number Diff line change
Expand Up @@ -806,8 +806,13 @@ def _paginator
@_paginator ||= JSONAPI.configuration.default_paginator
end

def paginator(paginator)
def _paginator_options
@_paginator_options ||= {}
end

def paginator(paginator, options = {})
@_paginator = paginator
@_paginator_options = options
end

def _record_accessor
Expand Down