Esse Pagy Extension

This gem is a esse plugin for the pagy pagination.

Documentation

Full guides, pagination examples, and API reference are published at gems.marcosz.com.br/esse-pagy — part of the marcosgz Ruby gem catalogue.

Installation

Add this line to your application's Gemfile:

gem 'esse-pagy'

And then execute:

$ bundle install

Pagy Version Compatibility

Pagy 43 reorganized its internals (it froze Pagy::DEFAULT, removed the Pagy::Backend mixin, and split paginators into Pagy::Offset/Keyset/Search), which is not backward compatible. esse-pagy releases track the supported Pagy major:

esse-pagy	Pagy	Ruby Version Required
>= 0.43	43.x	>= 3.1.0
<= 0.0.2	5.x – 9.x	>= 2.5.0 (5.x, 6.x), >= 3.1.0 (7.x–9.x)

If your app is still on Pagy 5–9, pin the previous esse-pagy release:

gem "esse-pagy", "~> 0.0.2"

For Pagy 43+:

gem "esse-pagy", ">= 0.43"

Usage

# Single index
query = UsersIndex.pagy_search(body: { ... })

# Multiple indexes
query = Esse.cluster.pagy_search(CitiesIndex, CountiesIndex, body: { ... })
query = Esse.cluster.pagy_search('esse_geos_*', body: { ... })

# paginate it
@pagy, @response = pagy_esse(collection, items: 10)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake none to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/esse-pagy.

License

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