rails_cursor_pagination 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff75c17ca149149eba59773520bc6690c7f0c5a86066d3783f68314e03a58e8e
+  data.tar.gz: bb0a908d6a7c204da69851ac3bb83dad64d829dc9f0ac955d33c5164231fb0e7
+SHA512:
+  metadata.gz: 5bfc9913cb0232569b0ca322e0b50dbf6a591f79ef7c97baf1dd3fd1850e5875163fa9468d91532a576b4e3bd36126a39ec835f531b6a4d29b308acaebcbaf2b
+  data.tar.gz: 4f4624b26ce65bd8a70f18602931b5d5a2209ce9b912babed5bba534bfffeef06da0fbd287461a4aa5cc58bc18e6217c8ba7232e6fc71ba4ba3f369125514fcb

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+These are the latest changes on the project's `master` branch that have not yet been released.
+
+<!---
+  If you submit a pull request for this gem, please add a summary of your changes here.
+  This will ensure that they're also mentioned in the next release description.
+  Follow the same format as previous releases by categorizing your feature into "Added", "Changed", "Deprecated", "Removed", "Fixed", or "Security".
+--->
+
+## [0.1.3] - 2021-03-17
+
+### Changed
+- Make the gem publicly available via github.com/xing/rails_cursor_pagination and release it to Rubygems.org
+- Reference changelog file in the gemspec instead of the general releases Github tab
+
+### Removed
+- Remove bulk from release: The previous gem releases contained files like the content of the `bin` folder or the Gemfile used for testing. Since this is not useful for gem users, adjust the gemspec file accordingly. 
+
+## [0.1.2] - 2021-02-04
+
+### Fixed
+- Pagination for relations in which a custom `SELECT` does not contain cursor-relevant fields like `:id` or the field specified via `order_by`
+
+## [0.1.1] - 2021-01-21 
+
+### Added
+- Add support for handling `nil` for `order` and `order_by` values as if they were not passed
+
+### Fixed
+- Pagination for relations that use a custom `SELECT`
+
+## [0.1.0-pre] - 2021-01-12
+
+### Add
+- First version of the gem, including pagination, custom ordering by column and sort-order.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mail@nicolasfricke.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 XING GmbH & Co. KG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,380 @@
+# RailsCursorPagination
+
+This library allows to paginate through an `ActiveRecord` relation using cursor pagination.
+It also supports ordering by any column on the relation in either ascending or descending order.
+
+Cursor pagination allows to paginate results and gracefully deal with deletions / additions on previous pages.
+Where a regular limit / offset pagination would jump in results if a record on a previous page gets deleted or added while requesting the next page, cursor pagination just returns the records following the one identified in the request.
+
+To learn more about cursor pagination, check out the _"How does it work?"_ section below.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_cursor_pagination'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install rails_cursor_pagination
+```
+
+## Usage
+
+Using it is very straight forward by just interfacing with the `RailsCursorPagination::Paginator` class.
+
+Let's assume we have an `ActiveRecord` model called `Post` of which we want to fetch some data and then paginate through it.
+Therefore, we first apply our scopes, `where` clauses or other functionality as usual:
+
+```ruby
+posts = Post.where(author: 'Jane')
+```
+
+And then we pass these posts to our paginator to fetch the first response page:
+
+```ruby
+RailsCursorPagination::Paginator.new(posts).fetch(with_total: true)
+```
+
+This will return a data structure similar to the following:
+```
+{
+  total: 42,
+  page_info: {
+    has_previous_page: false,
+    has_next_page: true,
+    start_cursor: "MQ==",
+    end_cursor: "MTA="
+  },
+  page: [
+    { cursor: "MQ==", data: #<Post:0x00007fd7071b2ea8 @id=1> },
+    { cursor: "Mg==", data: #<Post:0x00007fd7071bb738 @id=2> },
+    ...,
+    { cursor: "MTA=", data: #<Post:0x00007fd707238260 @id=10> }
+  ]
+}
+```
+
+Note that any ordering of the relation at this stage will be ignored by the gem.
+Take a look at the next section _"Ordering"_ to see how you can have an order different than ascending IDs.
+Read the _"The passed relation"_ to learn more about the relation that can be passed to the paginator.
+
+As you saw in the request, `with_total` is an option.
+If omitted, or set to `false`, the resulting hash will lack the `:total` key, but this will also cause one DB query less.
+It is therefore recommended to only pass `with_total: true` when requested by the user.
+So in the next examples we will also leave it away.
+
+To then get the next result page, you simply need to pass the last cursor of the returned page item via:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, after: 'MTA=')
+  .fetch
+```
+
+This will then fetch the next result page.
+You can also just as easily paginate to previous pages by using `before` instead of `after` and using the first cursor of the current page.
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, before: "MTE=")
+  .fetch
+```
+
+By default, this will always return up to 10 results.
+But you can also specify how many records should be returned.
+You can pass `first: 2` to get the very first 2 records of the relation:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, first: 2)
+  .fetch
+```
+
+Then, you can also combine `first` with `after` to get the first X records after a given one:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, first: 2, after: 'MTA=')
+  .fetch
+```
+
+Or you can combine `before` with `last` to get the last X records before a given one:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, last: 2, before: 'MTA=')
+  .fetch
+```
+
+### Ordering
+
+As said, this gem ignores any previous ordering added to the passed relation.
+But you can still paginate through relations with an order different than by ascending IDs.
+
+### The `order` parameter
+
+The first option you can pass is the `order` parameter.
+It allows you to order the relation in reverse, descending.
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, order: :desc)
+  .fetch
+```
+
+The default is `:asc`, therefore this doesn't need to be passed.
+
+### The `order_by` parameter
+
+However, you can also specify a different column to order the results by.
+Therefore, the `order_by` parameter needs to be passed.
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, order_by: :author)
+  .fetch
+```
+
+This will now order the records ascending by the `:author` field.
+You can also combine the two:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(posts, order_by: :author, order: :desc)
+  .fetch
+```
+
+This will then sort the results by the author field in a descending order.
+Of course, this can both be combined with `first`, `last`, `before`, and `after`.
+
+**Important:**
+If your app regularly orders by another column, you might want to add a database index for this.
+Say that your order column is `author` then your index should be on `CONCAT(author, '-', id)`.
+
+Please take a look at the _"How does it work?"_ to find out more why this is necessary.
+
+### Configuration options
+
+You can also change the default page size to a value that better fits the needs of your application.
+So if a user doesn't request a given `first` or `last` value, the default amount of records is being returned.
+
+To change the default, simply add an initializer to your app that does the following:
+
+```ruby
+RailsCursorPagination.configure do |config|
+  config.default_page_size = 50
+end
+```
+
+This would set the default page size to 50.
+                       
+### The passed relation
+
+The relation passed to the `RailsCursorPagination::Paginator` needs to be an instance of an `ActiveRecord::Relation`.
+So if you e.g. have a `Post` model that inherits from `ActiveRecord::Base`, you can initialize your paginator like this:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(Post.all)
+```
+
+This would then paginate over all post records in your database.
+              
+#### Limiting the paginated records
+
+As shown above, you can also apply `.where` clauses to filter your records before pagination:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(Post.where(author: 'Jane'))
+```
+
+This would only paginate over Jane's records.
+         
+#### Limiting the queried fields 
+
+You can also use `.select` to limit the fields that are requested from the database.
+If, for example, your post contains a very big `content` field that you don't want to return on the paginated index endpoint, you can select to only get the fields relevant to you:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(Post.select(:id, :author))
+```
+
+One important thing to note is that the ID of the record _will always be returned_, whether you selected it or not.
+This is due to how the cursor is generated.
+It requires the record's ID to always be present.
+Therefore, even if it is not selected by you, it will be added to the query.
+
+The same goes for any field that is specified via `order_by:`, this field is also required for building the cursor and will therefore automatically be requested from the database.
+
+## How does it work?
+
+The _cursor_ that we use for the `before` or `after` query encodes a value that uniquely identifies a given row _for the requested order_.
+Then, based on this cursor, you can request the _"`n` **first** records **after** the cursor"_ (forward-pagination) or the _"`n` **last** records **before** the cursor"_ (backward-pagination).
+
+As an example, assume we have a table called "posts" with this data:
+
+| id | author |
+|----|--------|
+| 1  | Jane   |
+| 2  | John   |
+| 3  | John   |
+| 4  | Jane   |
+| 5  | Jane   |
+| 6  | John   |
+| 7  | John   |
+
+Now if we make a basic request without any `first`/`after`, `last`/`before`, custom `order` or `order_by` column, this will just request the first page of this relation.
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(relation)
+  .fetch
+```
+
+Assume that our default page size here is 2 and we would get a query like this:
+
+```sql
+SELECT *
+FROM "posts"
+ORDER BY "posts"."id" ASC
+LIMIT 2
+```
+
+This will return the first page of results, containing post #1 and #2.
+Since no custom order is defined, each item in the returned collection will have a cursor that only encodes the record's ID.
+
+If we want to now request the next page, we can pass in the cursor of record #2 which would be `"Mg=="`.
+So now we can request the next page by calling:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(relation, first: 2, after: "Mg==")
+  .fetch
+```
+
+And this will decode the given cursor and issue a query like:
+
+```sql
+SELECT *
+FROM "posts"
+WHERE "posts"."id" > 2
+ORDER BY "posts"."id" ASC
+LIMIT 2
+```
+
+Which would return posts #3 and #4.
+If we now want to paginate back, we can request the posts that came before the first post, whose cursor would be `"Mw=="`:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(relation, last: 2, before: "Mw==")
+  .fetch
+```
+
+Since we now paginate backward, the resulting SQL query needs to be flipped around to get the last two records that have an ID smaller than the given one:
+
+```sql
+SELECT *
+FROM "posts"
+WHERE "posts"."id" < 3
+ORDER BY "posts"."id" DESC
+LIMIT 2
+```
+
+This would return posts #2 and #1.
+Since we still requested them in ascending order, the result will be reversed before it is returned.
+
+Now, in case that the user wants to order by a column different than the ID, we require this information in our cursor.
+Therefore, when requesting the first page like this:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(relation, order_by: :author)
+  .fetch
+```
+
+This will issue the following SQL query:
+
+```sql
+SELECT *
+FROM "posts"
+ORDER BY CONCAT(author, '-', "posts"."id") ASC
+LIMIT 2
+```
+
+As you can see, this will now order by a concatenation of the requested column, a dash `-`, and the ID column.
+Ordering only the author is not enough since we cannot know if the custom column only has unique values.
+And we need to guarantee the correct order of ambiguous records independent of the direction of ordering.
+This unique order is the basis of being able to paginate forward and backward repeatedly and getting the correct records.
+
+The query will then return records #1 and #4.
+But the cursor for these records will also be different to the previous query where we ordered by ID only.
+It is important that the cursor encodes all the data we need to uniquely identify a row and filter based upon it.
+Therefore, we need to encode the same information as we used for the ordering in our SQL query.
+Hence, the cursor for pagination with a custom column contains a tuple of data, the first record being the custom order column followed by the record's ID.
+
+Therefore, the cursor of record #4 will encode `['Jane', 4]`, which yields this cursor: `"WyJKYW5lIiw0XQ=="`.
+
+If we now want to request the next page via:
+
+```ruby
+RailsCursorPagination::Paginator
+  .new(relation, order_by: :author, first: 2, after: "WyJKYW5lIiw0XQ==")
+  .fetch
+```
+
+We get this SQL query:
+
+```sql
+SELECT *
+FROM "posts"
+WHERE CONCAT(author, '-', "posts"."id") > 'Jane-4'
+ORDER BY CONCAT(author, '-', "posts"."id") ASC
+LIMIT 2
+```
+
+You can see how the cursor is being translated into the WHERE clause to uniquely identify the row and properly filter based on this.
+We will get the records #5 and #2 as response.
+
+As you can see, when using a custom `order_by`, the concatenation is used for both filtering and ordering.
+Therefore, it is recommended to add an index for columns that are frequently used for ordering.
+In our test case we would want to add an index for `CONCAT(author, '-', id)`.
+
+## Development
+
+Make sure you have MySQL installed on your machine and create a database with the name `rails_cursor_pagination_testing`.
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xing/rails_cursor_pagination.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/xing/rails_cursor_pagination/blob/master/CODE_OF_CONDUCT.md).
+
+If you open a pull request, please make sure to also document your changes in the `CHANGELOG.md`.
+This way, your change can be properly announced in the next release.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsCursorPagination project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/xing/rails_cursor_pagination/blob/master/CODE_OF_CONDUCT.md).

data/lib/rails_cursor_pagination.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# This library allows to paginate through a passed relation using a cursor
+# and first/after or last/before parameters. It also supports ordering by
+# any column on the relation in either ascending or descending order.
+#
+# Cursor pagination allows to paginate results and gracefully deal with
+# deletions / additions on previous pages. Where a regular limit / offset
+# pagination would jump in results if a record on a previous page gets deleted
+# or added while requesting the next page, cursor pagination just returns the
+# records following the one identified in the request.
+#
+# How this works is that it uses a "cursor", which is an encoded value that
+# uniquely identifies a given row for the requested order. Then, based on
+# this cursor, you can request the "n FIRST records AFTER the cursor"
+# (forward-pagination) or the "n LAST records BEFORE the cursor" (backward-
+# pagination).
+#
+# As an example, assume we have a table called "posts" with this data:
+#
+#     | id | author |
+#     |----|--------|
+#     | 1  | Jane   |
+#     | 2  | John   |
+#     | 3  | John   |
+#     | 4  | Jane   |
+#     | 5  | Jane   |
+#     | 6  | John   |
+#     | 7  | John   |
+#
+# Now if we make a basic request without any `first`/`after`, `last`/`before`,
+# custom `order` or `order_by` column, this will just request the first page
+# of this relation.
+#
+#     RailsCursorPagination::Paginator
+#       .new(relation)
+#       .fetch
+#
+# Assume that our default page size here is 2 and we would get a query like
+# this:
+#
+#     SELECT *
+#     FROM "posts"
+#     ORDER BY "posts"."id" ASC
+#     LIMIT 2
+#
+# This will return the first page of results, containing post #1 and #2. Since
+# no custom order is defined, each item in the returned collection will have a
+# cursor that only encodes the record's ID.
+#
+# If we want to now request the next page, we can pass in the cursor of record
+# #2 which would be "Mg==". So now we can request the next page by calling:
+#
+#     RailsCursorPagination::Paginator
+#       .new(relation, first: 2, after: "Mg==")
+#       .fetch
+#
+# And this will decode the given cursor and issue a query like:
+#
+#     SELECT *
+#     FROM "posts"
+#     WHERE "posts"."id" > 2
+#     ORDER BY "posts"."id" ASC
+#     LIMIT 2
+#
+# Which would return posts #3 and #4. If we now want to paginate back, we can
+# request the posts that came before the first post, whose cursor would be
+# "Mw==":
+#
+#     RailsCursorPagination::Paginator
+#       .new(relation, last: 2, before: "Mw==")
+#       .fetch
+#
+# Since we now paginate backward, the resulting SQL query needs to be flipped
+# around to get the last two records that have an ID smaller than the given
+# one:
+#
+#     SELECT *
+#     FROM "posts"
+#     WHERE "posts"."id" < 3
+#     ORDER BY "posts"."id" DESC
+#     LIMIT 2
+#
+# This would return posts #2 and #1. Since we still requested them in
+# ascending order, the result will be reversed before it is returned.
+#
+# Now, in case that the user wants to order by a column different than the ID,
+# we require this information in our cursor. Therefore, when requesting the
+# first page like this:
+#
+#     RailsCursorPagination::Paginator
+#       .new(relation, order_by: :author)
+#       .fetch
+#
+# This will issue the following SQL query:
+#
+#     SELECT *
+#     FROM "posts"
+#     ORDER BY CONCAT(author, '-', "posts"."id") ASC
+#     LIMIT 2
+#
+# As you can see, this will now order by a concatenation of the requested
+# column, a dash `-`, and the ID column. Ordering only the author is not
+# enough since we cannot know if the custom column only has unique values.
+# And we need to guarantee the correct order of ambiguous records independent
+# of the direction of ordering. This unique order is the basis of being able
+# to paginate forward and backward repeatedly and getting the correct records.
+#
+# The query will then return records #1 and #4. But the cursor for these
+# records will also be different to the previous query where we ordered by ID
+# only. It is important that the cursor encodes all the data we need to
+# uniquely identify a row and filter based upon it. Therefore, we need to
+# encode the same information as we used for the ordering in our SQL query.
+# Hence, the cursor for pagination with a custom column contains a tuple of
+# data, the first record being the custom order column followed by the
+# record's ID.
+#
+# Therefore, the cursor of record #4 will encode `['Jane', 4]`, which yields
+# this cursor: "WyJKYW5lIiw0XQ==".
+#
+# If we now want to request the next page via:
+#
+#     RailsCursorPagination::Paginator
+#       .new(relation, order_by: :author, first: 2, after: "WyJKYW5lIiw0XQ==")
+#       .fetch
+#
+# We get this SQL query:
+#
+#     SELECT *
+#     FROM "posts"
+#     WHERE CONCAT(author, '-', "posts"."id") > 'Jane-4'
+#     ORDER BY CONCAT(author, '-', "posts"."id") ASC
+#     LIMIT 2
+#
+# You can see how the cursor is being translated into the WHERE clause to
+# uniquely identify the row and properly filter based on this. We will get
+# the records #5 and #2 as response.
+#
+# As you can see, when using a custom `order_by`, the concatenation is used
+# for both filtering and ordering. Therefore, it is recommended to add an
+# index for columns that are frequently used for ordering. In our test case
+# we would want to add an index for `CONCAT(author, '-', id)`.
+#
+module RailsCursorPagination
+  class Error < StandardError; end
+
+  require_relative 'rails_cursor_pagination/version'
+
+  require_relative 'rails_cursor_pagination/configuration'
+
+  require_relative 'rails_cursor_pagination/paginator'
+
+  class << self
+    # Allows to configure this gem. Currently supported configuration values
+    # are:
+    #  * default_page_size - defines how many items are returned when not
+    #                        passing an explicit `first` or `last` parameter
+    #
+    # Usage:
+    #
+    #    RailsCursorPagination.configure do |config|
+    #      config.default_page_size = 42
+    #    end
+    #
+    # @yield [config] Yields a block to configure the gem as explained above
+    # @yieldparam config [RailsCursorPagination::Configuration]
+    #   Configuration instance that can be used to set up this gem
+    def configure(&_block)
+      yield(Configuration.instance)
+    end
+  end
+end

data/lib/rails_cursor_pagination/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module RailsCursorPagination
+  # Configuration class to set the default gem settings. Accessible via
+  # `RailsCursorPagination.configure`.
+  #
+  # Usage:
+  #
+  #    RailsCursorPagination.configure do |config|
+  #      config.default_page_size = 42
+  #    end
+  #
+  class Configuration
+    include Singleton
+
+    attr_accessor :default_page_size
+
+    # Ensure the default values are set on first initialization
+    def initialize
+      reset!
+    end
+
+    # Reset all values to their defaults
+    def reset!
+      @default_page_size = 10
+    end
+  end
+end

data/lib/rails_cursor_pagination/paginator.rb

@@ -0,0 +1,464 @@
+# frozen_string_literal: true
+
+module RailsCursorPagination
+  # Use this Paginator class to effortlessly paginate through ActiveRecord
+  # relations using cursor pagination. For more details on how this works,
+  # read the top-level documentation of the `RailsCursorPagination` module.
+  #
+  # Usage:
+  #     RailsCursorPagination::Paginator
+  #       .new(relation, order_by: :author, first: 2, after: "WyJKYW5lIiw0XQ==")
+  #       .fetch
+  #
+  class Paginator
+    # Generic error that gets raised when invalid parameters are passed to the
+    # Paginator initializer
+    class ParameterError < Error; end
+
+    # Error that gets raised if a cursor given as `before` or `after` parameter
+    # cannot be properly parsed
+    class InvalidCursorError < ParameterError; end
+
+    # Create a new instance of the `RailsCursorPagination::Paginator`
+    #
+    # @param relation [ActiveRecord::Relation]
+    #   Relation that will be paginated.
+    # @param first [Integer, nil]
+    #   Number of records to return in a forward pagination. Can be combined
+    #   with `after`.
+    # @param after [String, nil]
+    #   Cursor to paginate forward from. Can be combined with `first`.
+    # @param last [Integer, nil]
+    #   Number of records to return. Must be used together with `before`.
+    # @param before [String, nil]
+    #   Cursor to paginate upto (excluding). Can be combined with `last`.
+    # @param order_by [Symbol, String, nil]
+    #   Column to order by. If none is provided, will default to ID column.
+    #   NOTE: this will cause an SQL `CONCAT` query. Therefore, you might want
+    #   to add an index to your database: `CONCAT(<order_by_field>, '-', id)`
+    # @param order [Symbol, nil]
+    #   Ordering to apply, either `:asc` or `:desc`. Defaults to `:asc`.
+    #
+    # @raise [RailsCursorPagination::Paginator::ParameterError]
+    #   If any parameter is not valid
+    def initialize(relation, first: nil, after: nil, last: nil, before: nil,
+                   order_by: nil, order: nil)
+      order_by ||= :id
+      order ||= :asc
+
+      ensure_valid_params!(relation, first, after, last, before, order)
+
+      @order_field = order_by
+      @order_direction = order
+      @relation = relation
+
+      @cursor = before || after
+      @is_forward_pagination = before.blank?
+
+      @page_size =
+        first ||
+        last ||
+        RailsCursorPagination::Configuration.instance.default_page_size
+
+      @memos = {}
+    end
+
+    # Get the paginated result, including the actual `page` with its data items
+    # and cursors as well as some meta data in `page_info` and an optional
+    # `total` of records across all pages.
+    #
+    # @param with_total [TrueClass, FalseClass]
+    # @return [Hash] with keys :page, :page_info, and optional :total
+    def fetch(with_total: false)
+      {
+        **(with_total ? { total: total } : {}),
+        page_info: page_info,
+        page: page
+      }
+    end
+
+    private
+
+    # Ensure that the parameters of this service are valid. Otherwise raise
+    # a `RailsCursorPagination::Paginator::ParameterError`.
+    #
+    # @param relation [ActiveRecord::Relation]
+    #   Relation that will be paginated.
+    # @param first [Integer, nil]
+    #   Optional, must be positive, cannot be combined with `last`
+    # @param after [String, nil]
+    #   Optional, cannot be combined with `before`
+    # @param last [Integer, nil]
+    #   Optional, must be positive, requires `before`, cannot be combined
+    #   with `first`
+    # @param before [String, nil]
+    #   Optional, cannot be combined with `after`
+    # @param order [Symbol]
+    #   Optional, must be :asc or :desc
+    #
+    # @raise [RailsCursorPagination::Paginator::ParameterError]
+    #   If any parameter is not valid
+    def ensure_valid_params!(relation, first, after, last, before, order)
+      unless relation.is_a?(ActiveRecord::Relation)
+        raise ParameterError,
+              'The first argument must be an ActiveRecord::Relation, but was '\
+              "the #{relation.class} `#{relation.inspect}`"
+      end
+      unless %i[asc desc].include?(order)
+        raise ParameterError,
+              "`order` must be either :asc or :desc, but was `#{order}`"
+      end
+      if first.present? && last.present?
+        raise ParameterError, '`first` cannot be combined with `last`'
+      end
+      if before.present? && after.present?
+        raise ParameterError, '`before` cannot be combined with `after`'
+      end
+      if last.present? && before.blank?
+        raise ParameterError, '`last` must be combined with `before`'
+      end
+      if first.present? && first.negative?
+        raise ParameterError, "`first` cannot be negative, but was `#{first}`"
+      end
+      if last.present? && last.negative?
+        raise ParameterError, "`last` cannot be negative, but was `#{last}`"
+      end
+
+      true
+    end
+
+    # Get meta information about the current page
+    #
+    # @return [Hash]
+    def page_info
+      {
+        has_previous_page: previous_page?,
+        has_next_page: next_page?,
+        start_cursor: start_cursor,
+        end_cursor: end_cursor
+      }
+    end
+
+    # Get the records for the given page along with their cursors
+    #
+    # @return [Array<Hash>] List of hashes, each with a `cursor` and `data`
+    def page
+      records.map do |item|
+        {
+          cursor: cursor_for_record(item),
+          data: item
+        }
+      end
+    end
+
+    # Get the total number of records in the given relation
+    #
+    # @return [Integer]
+    def total
+      memoize(:total) { @relation.size }
+    end
+
+    # Check if the pagination direction is forward
+    #
+    # @return [TrueClass, FalseClass]
+    def paginate_forward?
+      @is_forward_pagination
+    end
+
+    # Check if the user requested to order on a field different than the ID. If
+    # a different field was requested, we have to change our pagination logic to
+    # accommodate for this.
+    #
+    # @return [TrueClass, FalseClass]
+    def custom_order_field?
+      @order_field.downcase.to_sym != :id
+    end
+
+    # Check if there is a page before the current one.
+    #
+    # @return [TrueClass, FalseClass]
+    def previous_page?
+      if paginate_forward?
+        # When paginating forward, we can only have a previous page if we were
+        # provided with a cursor and there were records discarded after applying
+        # this filter. These records would have to be on previous pages.
+        @cursor.present? && filtered_and_sorted_relation.size < total
+      else
+        # When paginating backwards, if we managed to load one more record than
+        # requested, this record will be available on the previous page.
+        @page_size < limited_relation_plus_one.size
+      end
+    end
+
+    # Check if there is another page after the current one.
+    #
+    # @return [TrueClass, FalseClass]
+    def next_page?
+      if paginate_forward?
+        # When paginating forward, if we managed to load one more record than
+        # requested, this record will be available on the next page.
+        @page_size < limited_relation_plus_one.size
+      else
+        # When paginating backward, if applying our cursor reduced the number
+        # records returned, we know that the missing records will be on
+        # subsequent pages.
+        filtered_and_sorted_relation.size < total
+      end
+    end
+
+    # Load the correct records and return them in the right order
+    #
+    # @return [Array<ActiveRecord>]
+    def records
+      records = limited_relation_plus_one.first(@page_size)
+
+      paginate_forward? ? records : records.reverse
+    end
+
+    # Apply limit to filtered and sorted relation that contains one item more
+    # than the user-requested page size. This is useful for determining if there
+    # is an additional page available without having to do a separate DB query.
+    #
+    # @return [ActiveRecord::Relation]
+    def limited_relation_plus_one
+      memoize :limited_relation_plus_one do
+        filtered_and_sorted_relation.limit(@page_size + 1)
+      end
+    end
+
+    # Cursor of the first record on the current page
+    #
+    # @return [String, nil]
+    def start_cursor
+      return if page.empty?
+
+      page.first[:cursor]
+    end
+
+    # Cursor of the last record on the current page
+    #
+    # @return [String, nil]
+    def end_cursor
+      return if page.empty?
+
+      page.last[:cursor]
+    end
+
+    # Get the order we need to apply to our SQL query. In case we are paginating
+    # backwards, this has to be the inverse of what the user requested, since
+    # our database can only apply the limit to following records. In the case of
+    # backward pagination, we then reverse the order of the loaded records again
+    # in `#records` to return them in the right order to the user.
+    #
+    # Examples:
+    #  - first 2 after 4 ascending
+    #    -> SELECT * FROM table WHERE id > 4 ODER BY id ASC LIMIT 2
+    #  - first 2 after 4 descending                      ^ as requested
+    #    -> SELECT * FROM table WHERE id < 4 ODER BY id DESC LIMIT 2
+    #  but:                                              ^ as requested
+    #  - last 2 before 4 ascending
+    #    -> SELECT * FROM table WHERE id < 4 ODER BY id DESC LIMIT 2
+    #  - last 2 before 4 descending                      ^ reversed
+    #    -> SELECT * FROM table WHERE id > 4 ODER BY id ASC LIMIT 2
+    #                                                    ^ reversed
+    #
+    # @return [Symbol] Either :asc or :desc
+    def pagination_sorting
+      return @order_direction if paginate_forward?
+
+      @order_direction == :asc ? :desc : :asc
+    end
+
+    # Get the right operator to use in the SQL WHERE clause for filtering based
+    # on the given cursor. This is dependent on the requested order and
+    # pagination direction.
+    #
+    # If we paginate forward and want ascending records, or if we paginate
+    # backward and want descending records we need records that have a higher
+    # value than our cursor.
+    #
+    # On the contrary, if we paginate forward but want descending records, or
+    # if we paginate backwards and want ascending records, we need them to have
+    # lower values than our cursor.
+    #
+    # Examples:
+    #  - first 2 after 4 ascending
+    #    -> SELECT * FROM table WHERE id > 4 ODER BY id ASC LIMIT 2
+    #  - last 2 before 4 descending      ^ records with higher value than cursor
+    #    -> SELECT * FROM table WHERE id > 4 ODER BY id ASC LIMIT 2
+    #  but:                              ^ records with higher value than cursor
+    #  - first 2 after 4 descending
+    #    -> SELECT * FROM table WHERE id < 4 ODER BY id DESC LIMIT 2
+    #  - last 2 before 4 ascending       ^ records with lower value than cursor
+    #    -> SELECT * FROM table WHERE id < 4 ODER BY id DESC LIMIT 2
+    #                                    ^ records with lower value than cursor
+    #
+    # @return [String] either '<' or '>'
+    def filter_operator
+      if paginate_forward?
+        @order_direction == :asc ? '>' : '<'
+      else
+        @order_direction == :asc ? '<' : '>'
+      end
+    end
+
+    # The value our relation is filtered by. This is either just the cursor's ID
+    # if we use the default order, or it is the combination of the custom order
+    # field's value and its ID, joined by a dash.
+    #
+    # @return [Integer, String]
+    def filter_value
+      return decoded_cursor_id unless custom_order_field?
+
+      "#{decoded_cursor_field}-#{decoded_cursor_id}"
+    end
+
+    # Generate a cursor for the given record and ordering field. The cursor
+    # encodes all the data required to then paginate based on it with the given
+    # ordering field.
+    #
+    # If we only order by ID, the cursor doesn't need to include any other data.
+    # But if we order by any other field, the cursor needs to include both the
+    # value from this other field as well as the records ID to resolve the order
+    # of duplicates in the non-ID field.
+    #
+    # @param record [ActiveRecord] Model instance for which we want the cursor
+    # @return [String]
+    def cursor_for_record(record)
+      unencoded_cursor =
+        if custom_order_field?
+          [record[@order_field], record.id]
+        else
+          record.id
+        end
+
+      Base64.strict_encode64(unencoded_cursor.to_json)
+    end
+
+    # Decode the provided cursor. Either just returns the cursor's ID or in case
+    # of pagination on any other field, returns a tuple of first the cursor
+    # record's other field's value followed by its ID.
+    #
+    # @return [Integer, Array]
+    def decoded_cursor
+      memoize(:decoded_cursor) { JSON.parse(Base64.strict_decode64(@cursor)) }
+    rescue ArgumentError, JSON::ParserError
+      raise InvalidCursorError,
+            "The given cursor `#{@cursor.inspect}` could not be decoded"
+    end
+
+    # Return the ID of the cursor's record. In case we use an ordering by ID,
+    # this is all the data the cursor encodes. Otherwise, it's the second
+    # element of the tuple encoded by the cursor.
+    #
+    # @return [Integer]
+    def decoded_cursor_id
+      return decoded_cursor unless decoded_cursor.is_a? Array
+
+      decoded_cursor.last
+    end
+
+    # Return the value of the cursor's record's custom order field. Only exists
+    # if the cursor was generated by a query with a custom order field.
+    # Otherwise the cursor would only encode the ID and not be an array.
+
+    # @raise [InvalidCursorError] in case the cursor is not a tuple
+    # @return [Object]
+    def decoded_cursor_field
+      unless decoded_cursor.is_a? Array
+        raise InvalidCursorError,
+              "The given cursor `#{@cursor}` was decoded as "\
+              "`#{decoded_cursor.inspect}` but could not be parsed"
+      end
+
+      decoded_cursor.first
+    end
+
+    # The SQL identifier of the column we need to consider for both ordering and
+    # filtering.
+    #
+    # In case we have a custom field order, this is a concatenation
+    # of the custom order field and the ID column joined by a dash. This is to
+    # ensure uniqueness of records even if they might have duplicates in the
+    # custom order field. If we don't have a custom order, it just returns a
+    # reference to the table's ID column.
+    #
+    # This uses the fully qualified and escaped reference to the ID column to
+    # prevent ambiguity in case of a query that uses JOINs and therefore might
+    # have multiple ID columns.
+    #
+    # @return [String]
+    def sql_column
+      memoize :sql_column do
+        escaped_table_name = @relation.quoted_table_name
+        escaped_id_column = @relation.connection.quote_column_name(:id)
+
+        id_column = "#{escaped_table_name}.#{escaped_id_column}"
+
+        sql =
+          if custom_order_field?
+            "CONCAT(#{@order_field}, '-', #{id_column})"
+          else
+            id_column
+          end
+
+        Arel.sql(sql)
+      end
+    end
+
+    # Ensure that the relation has the ID column and any potential `order_by`
+    # column selected. These are required to generate the record's cursor and
+    # therefore it's crucial that they are part of the selected fields.
+    #
+    # @return [ActiveRecord::Relation]
+    def relation_with_cursor_fields
+      return @relation if @relation.select_values.blank?
+
+      relation = @relation
+
+      unless @relation.select_values.include?(:id)
+        relation = relation.select(:id)
+      end
+
+      if custom_order_field? && !@relation.select_values.include?(@order_field)
+        relation = relation.select(@order_field)
+      end
+
+      relation
+    end
+
+    # The given relation with the right ordering applied. Takes custom order
+    # columns as well as custom direction and pagination into account.
+    #
+    # @return [ActiveRecord::Relation]
+    def sorted_relation
+      relation_with_cursor_fields
+        .reorder(sql_column => pagination_sorting.upcase)
+    end
+
+    # Applies the filtering based on the provided cursor and order column to the
+    # sorted relation.
+    #
+    # @return [ActiveRecord::Relation]
+    def filtered_and_sorted_relation
+      memoize :filtered_and_sorted_relation do
+        next sorted_relation if @cursor.blank?
+
+        sorted_relation.where "#{sql_column} #{filter_operator} ?", filter_value
+      end
+    end
+
+    # Ensures that given block is only executed exactly once and on subsequent
+    # calls returns result from first execution. Useful for memoizing methods.
+    #
+    # @param key [Symbol]
+    #   Name or unique identifier of the method that is being memoized
+    # @yieldreturn [Object]
+    # @return [Object] Whatever the block returns
+    def memoize(key, &_block)
+      return @memos[key] if @memos.key?(key)
+
+      @memos[key] = yield
+    end
+  end
+end

data/lib/rails_cursor_pagination/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsCursorPagination
+  VERSION = '0.1.3'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rails_cursor_pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Nicolas Fricke
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This library is an implementation of cursor pagination for ActiveRecord
+  relations. Where a regular limit & offset pagination has issues with items that
+  are being deleted from or added to the collection on previous pages, cursor pagination
+  will continue to offer a stable set regardless of changes to the base relation.
+email:
+- mail@nicolasfricke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/rails_cursor_pagination.rb
+- lib/rails_cursor_pagination/configuration.rb
+- lib/rails_cursor_pagination/paginator.rb
+- lib/rails_cursor_pagination/version.rb
+homepage: https://github.com/xing/rails_cursor_pagination
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xing/rails_cursor_pagination
+  source_code_uri: https://github.com/xing/rails_cursor_pagination
+  changelog_uri: https://github.com/xing/rails_cursor_pagination/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Add cursor pagination to your ActiveRecord backed application.
+test_files: []