Pagy

Pagy is the ultimate pagination gem that outperforms the others in each and every benchmark and comparison.

Benchmarks

The best way to quickly get an idea about Pagy is comparing it to the other well known gems.

The values shown in the charts below have been recorded while each gem was producing the exact same output: same environment conditions, same task, just different gems (see the Detailed Gems Comparison)

Faster

Less Memory

Simpler

More Efficient

The IPS/Kb ratio is calculated out of speed (IPS) and Memory (Kb): it shows how well each gem uses any Kb of memory it allocates/consumes.

Features

Straightforward Code

Pagy is just ~100 lines of simple ruby, organized in 3 flat modules very easy to understand and use (see more...)
No dependencies: it produces its own HTML, URLs, pluralization and interpolation with its own specialized and fast code (see why...)
100% of its methods are public API, accessible and overridable right where you use them (no need of monkey-patching)
100% test coverage for core code and extras

Totally Agnostic

It doesn't need to know anything about your models, ORM or storage, so it doesn't add any code to them (see why...)
It works with all kinds of collections, even pre-paginated, records, Arrays, JSON data... and just whatever you can count (see how...)
It works with all Rack frameworks (Rails, Sinatra, Padrino, ecc.) out of the box (see more...)
It works with any possible non-Rack environment by just overriding one or two two-lines methods (see more...)

Unlike the other gems

It works with collections/scopes that already used limit and offset (see how...)
It works with helpers or templates (see more...)
It raises real Pagy::OutOfRangeError exceptions that you can rescue from (see how...) or use the out_of_range extra for a few ready to use common behaviors
It does not impose any difficult-to-override logic or output (see why...)

Easy to use

You can use Pagy in a quite familiar way:

Paginate your collection in some controller:

@pagy, @records = pagy(Product.some_scope)

Render the navigation links with a super-fast helper in some view:

<%== pagy_nav(@pagy) %>

Or - if you prefer - render the navigation links with a template:

<%== render 'pagy/nav', locals: {pagy: @pagy} %>

(see Quick Start for more details)

Easy to extend

Use the official extras, or write your own in just a few lines.

Array Extra

Paginate arrays efficiently avoiding expensive array-wrapping and without any overriding. (see more...)

Bootstrap Extra

Nav helper and templates for Bootstrap pagination. (see more...)

Bulma Extra

Nav helper and templates for Bulma CSS pagination. (see more...)

Compact Extra

An alternative UI that combines the pagination feature with the navigation info in one compact element. (see more...)

Items Extra

Allow the client to request a custom number of items per page with a ready to use selector UI. (see more...)

Materialize Extra

Nav helper for Materialize CSS pagination. (see more...)

Out Of Range Extra

Allow for easy handling of out of range pages (see more...)

Responsive Extra

On resize, the number of page links will adapt in real-time to the available window or container width. (see more...)

Trim Extra

Remove the page=1 param from the first page URL.

Chat Support and Feedback

Chat on Gitter

Useful Links

Please Star and Share!

Pagy is young and needs to be known, and you can really help, even with just a click on the star, or sharing a tweet with friends and collegues. Thank you!

Help Wanted

Pagy is a fresh project and your help would be great. If you like it, you have a few options to contribute:

Create an issue if anything should be improved/fixed
Submit a pull request to improve Pagy
Write a Tutorial or a "How To" topic
Submit some cool extra

Branches and Pull Requests

master is the latest rubygem-published release (plus changes that don't affect the actual gem behavior, e.g. doc, tests). You should use it as the base branch for pull requests, because it will not be force-rebased.

dev is the development branch that is kept rebased on top of master, so expect it to be force-rebased (i.e. do not use it as the base for your commits). Use dev as a preview for trying the new code that will be merged in the next release, but please, don't use it as the base branch for pull requests.

License

The gem is available as open source under the terms of the MIT License.

archonic / pagy