Jbuilder extension that makes easier to use pagination according to the JSON API conventions.
Forked from: https://github.com/bacarini/jbuilder_pagination
This gem is actively used in production and is stable. If you have any issues please feel free to open them!
JbuilderPaginationPlus
relies on a paginated collection with the methods current_page
, total_pages
,
and size
, such as are supported by both Kaminari
or WillPaginate.
Add this line to your application's Gemfile:
gem 'jbuilder_pagination_plus', require: 'jbuilder/pagination'
And then execute:
$ bundle
Or install it yourself as:
$ gem install jbuilder_pagination_plus
Import the Pagination
module in your controller
class ApplicationController < ActionController::API
include Pagination
end
#array
@posts = paginate Kaminari.paginate_array([1, 2, 3])
#active_record
@posts = paginate Post
#array
@posts = [1,2,3].paginate(page: 3, per_page: 1)
#active_record
@posts = Post.page(3).per_page(1)
And then in your *.json.jbuilder
json.links do
json.pages! @posts, url: "http://example.com/posts", query_parameters: { additional: 'parameters' }
end
json.data do
# Whatever your data is
end
# {
# "links": {
# "self": "http://example.com/posts?page[number]=3&page[size]=1&additional=parameters",
# "first": "http://example.com/posts?page[number]=1&page[size]=1&additional=parameters",
# "prev": "http://example.com/posts?page[number]=2&page[size]=1&additional=parameters",
# "next": "http://example.com/posts?page[number]=4&page[size]=1&additional=parameters",
# "last": "http://example.com/posts?page[number]=13&page[size]=1&additional=parameters"
# },
# "data": {
# ...
# }
# }
The options url
and query_parameters
are optional.
In case there is no pagination at all, links
will be omitted.
If you want to keep the original query parameters passed in you could do something this:
json.links do
json.pages! @posts, url: request.original_url, query_parameters: { images: params[:images] }
end
json.data do
# Whatever your data is
end
jbuilder_pagination_plus will deep merge query parameters with the original request parameters.
If that's not what you need then you can get the url using rails helpers:
json.links do
json.pages! @posts, url: posts_url
end
json.data do
# Whatever your data is
end
If you need pagination but don't want the performance penalty of counting all of the records, you can use
to generate links without generating a last
url. This should be compatible with Kaminari
's
without_count
scope which can be used to paginate without issuing a COUNT(*)
query.
json.links do
json.pages_no_count! @posts, url: posts_url
end
json.data do
# Whatever your data is
end
The pages!
method will automatically switch to no_count
mode if it detects that the collection
doesn't respond properly to a total_pages
method call.
After checking out the repo, run bin/setup
to install dependencies.
Then, run bin/console
for an interactive prompt that will allow you to experiment.
To run tests, run rake spec
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request