mongoid-scroll 0.3.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976d59e1ce7d21c024936f21e58be085fa096260c8ee38b4c0d6f70d35145449
-  data.tar.gz: 389db57d4b31efa2114f9c3f5f86545f691a2db96de1d3aaad5ff995a0b02f45
+  metadata.gz: 73c44f9f9dcdc554e3f0ab2701cb4c87822bdf905bd7212e6bb59ea66e6a454d
+  data.tar.gz: 6e2abaa7d08e7bf0dfb914fc26b51b1d835526c8d0b1bc75fb0577adf06edb8d
 SHA512:
-  metadata.gz: f4929b559f25512c5ebe9a66519f018e834a2678e60c4062047bbdeb466d87b1c99be3a23b157f1c331c61d39bb5627f2ff4eef13158c697596755adf9eea927
-  data.tar.gz: bd8df34a05b1861472d6710e96c58104af9f0873fffc6cbb4191c91d4eab2c42bb739c0c8a522a92d61eb8898f3ace07adbccd48b40396f2330831cb4c014426
+  metadata.gz: ea72567b1edb2d8df27dc309d685804a8f199ff060ad93cb64ef01b6fd098a4ae7f677242375a89875bbdb8f8104f238cb6d79fb667799b5e90c297ce96d0e6f
+  data.tar.gz: ab22160efc873bf42430292047661de3b532a0629326dbfdc93a2ef49bc64207725b405472410171e96e6f997e5a23fc5914698b488a4fd1cacb29021bd70261

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        entry:
+          - { ruby: '2.6', mongodb: '4.4', mongoid: '5' }
+          - { ruby: '3.2', mongodb: '6.0', mongoid: '5' }
+          - { ruby: '2.7', mongodb: '4.4', mongoid: '6' }
+          - { ruby: '2.7', mongodb: '4.4', mongoid: '7' }
+          - { ruby: '3.0', mongodb: '4.4', mongoid: '6' }
+          - { ruby: '3.0', mongodb: '4.4', mongoid: '7' }
+          - { ruby: '3.2', mongodb: '5.0', mongoid: '7' }
+          - { ruby: '3.2', mongodb: '6.0', mongoid: '7' }
+          - { ruby: '3.1', mongodb: '4.4', mongoid: '8' }
+          - { ruby: '3.2', mongodb: '5.0', mongoid: '8' }
+          - { ruby: '3.2', mongodb: '6.0', mongoid: '8' }
+    name: test (ruby=${{ matrix.entry.ruby }}, mongodb=${{ matrix.entry.mongodb }}), mongoid=${{ matrix.entry.mongoid }})
+    env:
+      MONGOID_VERSION: ${{ matrix.entry.mongoid }}
+    steps:
+      - name: Set up MongoDB ${{ matrix.entry.mongodb }}
+        uses: supercharge/mongodb-github-action@1.8.0
+        with:
+          mongodb-version: ${{ matrix.entry.mongodb }}
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.entry.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/danger.yml

@@ -0,0 +1,17 @@
+name: PR Linter
+on: [pull_request]
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: |
+          # Personal access token for dangerpr-bot - public, but base64 encoded to avoid tripping up GitHub
+          TOKEN=$(echo -n Z2hwX0xNQ3VmanBFeTBvYkZVTWh6NVNqVFFBOEUxU25abzBqRUVuaAo= | base64 --decode)
+          DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/.rubocop_todo.yml

@@ -1,47 +1,52 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-13 23:29:51 +0100 using RuboCop version 0.49.1.
+# on 2023-03-07 08:58:13 -0500 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 6
+# Offense count: 5
 # Configuration parameters: Include.
 # Include: **/Gemfile, **/gems.rb
 Bundler/DuplicatedGem:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 6
+# Offense count: 8
 Metrics/AbcSize:
-  Max: 67
+  Max: 38
 
-# Offense count: 14
+# Offense count: 18
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 216
+  Max: 258
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 103
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
-  Max: 11
+  Max: 13
 
-# Offense count: 121
+# Offense count: 146
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 172
+  Max: 252
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 25
+  Max: 23
 
-# Offense count: 3
+# Offense count: 4
 Metrics/PerceivedComplexity:
-  Max: 11
+  Max: 12
 
-# Offense count: 10
+# Offense count: 11
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -49,13 +54,14 @@ Style/Documentation:
     - 'examples/mongoid_scroll_feed.rb'
     - 'lib/mongo/scrollable.rb'
     - 'lib/mongoid/criteria/scrollable.rb'
+    - 'lib/mongoid/scroll/base_cursor.rb'
     - 'lib/mongoid/scroll/cursor.rb'
     - 'lib/mongoid/scroll/errors/base.rb'
+    - 'lib/mongoid/scroll/errors/invalid_base64_cursor_error.rb'
     - 'lib/mongoid/scroll/errors/invalid_cursor_error.rb'
     - 'lib/mongoid/scroll/errors/multiple_sort_fields_error.rb'
     - 'lib/mongoid/scroll/errors/no_such_field_error.rb'
     - 'lib/mongoid/scroll/errors/unsupported_field_type_error.rb'
-    - 'lib/moped/scrollable.rb'
 
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
@@ -65,12 +71,11 @@ Style/FileName:
     - 'lib/mongoid-scroll.rb'
 
 # Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
+Style/MultilineTernaryOperator:
   Exclude:
-    - 'lib/moped/scrollable.rb'
+    - 'lib/mongoid/scroll/cursor.rb'
 
-# Offense count: 1
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
 # SupportedStyles: compact, exploded

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 1.0.0 (2023/03/08)
+
+* [#25](https://github.com/mongoid/mongoid-scroll/pull/25): Compatibility with Ruby 3 - [@leamotta](https://github.com/leamotta).
+* [#25](https://github.com/mongoid/mongoid-scroll/pull/25): Replace Travis CI with GHA - [@leamotta](https://github.com/leamotta).
+* [#29](https://github.com/mongoid/mongoid-scroll/pull/29): Add ability to include the current record to the cursor - [@FabienChaynes](https://github.com/FabienChaynes).
+* [#30](https://github.com/mongoid/mongoid-scroll/pull/30): Prevent discrepancy between the original sort and the cursor sort - [@FabienChaynes](https://github.com/FabienChaynes).
+* [#32](https://github.com/mongoid/mongoid-scroll/pull/32): Add Base64 serialization for cursors - [@FabienChaynes](https://github.com/FabienChaynes).
+* [#33](https://github.com/mongoid/mongoid-scroll/pull/33): Removed support for Mongoid 3, 4 and Moped - [@dblock](https://github.com/dblock).
+* [#34](https://github.com/mongoid/mongoid-scroll/pull/34): Added support for Mongoid 8 - [@dblock](https://github.com/dblock).
+
 ### 0.3.7 (2021/06/01)
 
 * [#22](https://github.com/mongoid/mongoid-scroll/pull/22): Compatibility with Mongoid 7 - [@asgerb](https://github.com/asgerb).

data/Gemfile

@@ -4,19 +4,20 @@ gemspec
 
 case version = ENV['MONGOID_VERSION'] || '~> 7.0'
 when 'HEAD' then gem 'mongoid', github: 'mongodb/mongoid'
+when /8/    then gem 'mongoid', '~> 8.0'
 when /7/    then gem 'mongoid', '~> 7.0'
 when /6/    then gem 'mongoid', '~> 6.0'
-when /5/    then gem 'mongoid', '~> 5.0'
-when /4/    then gem 'mongoid', '~> 4.0'
-when /3/    then gem 'mongoid', '~> 3.1'
-else             gem 'mongoid', version
+when /5/    then
+  gem 'bigdecimal', '1.3.5'
+  gem 'mongoid', '~> 5.0'
+else gem 'mongoid', version
 end
 
 group :development, :test do
   gem 'bundler'
   gem 'database_cleaner', '~> 1.8.5'
   gem 'faker'
-  gem 'mongoid-danger', '~> 0.1.0', require: false
+  gem 'mongoid-danger', '~> 0.2.0', require: false
   gem 'rake'
   gem 'rspec', '~> 3.0'
   gem 'rspec-its'

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2015 Daniel Doubrovkine, Artsy Inc.
+Copyright (c) 2013-2023 Daniel Doubrovkine, Artsy Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,27 +1,38 @@
-Mongoid::Scroll
-===============
+- [Mongoid::Scroll](#mongoidscroll)
+  - [Compatibility](#compatibility)
+  - [Demo](#demo)
+  - [The Problem](#the-problem)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Mongoid](#mongoid)
+    - [Mongo-Ruby-Driver (Mongoid 5)](#mongo-ruby-driver-mongoid-5)
+  - [Indexes and Performance](#indexes-and-performance)
+  - [Cursors](#cursors)
+    - [Standard Cursor](#standard-cursor)
+    - [Base64 Encoded Cursor](#base64-encoded-cursor)
+  - [Contributing](#contributing)
+  - [Copyright and License](#copyright-and-license)
+
+# Mongoid::Scroll
 
 [![Gem Version](https://badge.fury.io/rb/mongoid-scroll.svg)](https://badge.fury.io/rb/mongoid-scroll)
-[![Build Status](https://travis-ci.org/mongoid/mongoid-scroll.svg?branch=master)](https://travis-ci.org/mongoid/mongoid-scroll)
+[![Build Status](https://github.com/mongoid/mongoid-scroll/actions/workflows/ci.yml/badge.svg)](https://github.com/mongoid/mongoid-scroll/actions/workflows/ci.yml)
 [![Dependency Status](https://gemnasium.com/mongoid/mongoid-scroll.svg)](https://gemnasium.com/mongoid/mongoid-scroll)
 [![Code Climate](https://codeclimate.com/github/mongoid/mongoid-scroll.svg)](https://codeclimate.com/github/mongoid/mongoid-scroll)
 
-Mongoid extension that enables infinite scrolling for `Mongoid::Criteria`, `Moped::Query` and `Mongo::Collection::View`.
+Mongoid extension that enables infinite scrolling for `Mongoid::Criteria` and `Mongo::Collection::View`.
 
-Compatibility
--------------
+## Compatibility
 
-This gem supports Mongoid 3, 4, 5, 6, 7, Moped and Mongo-Ruby-Driver.
+This gem supports Mongoid 5, 6, 7 and 8.
 
-Demo
-----
+## Demo
 
 Check out [shows on artsy.net](http://artsy.net/shows). Keep scrolling down.
 
-There're also two code samples for Mongoid and Moped in [examples](examples). Run `bundle exec ruby examples/mongoid_scroll_feed.rb`.
+There're also two code samples for Mongoid in [examples](examples). Run `bundle exec ruby examples/mongoid_scroll_feed.rb`.
 
-The Problem
------------
+## The Problem
 
 Traditional pagination does not work when data changes between paginated requests, which makes it unsuitable for infinite scroll behaviors.
 
@@ -30,8 +41,7 @@ Traditional pagination does not work when data changes between paginated request
 
 The solution implemented by the `scroll` extension paginates data using a cursor, giving you the ability to restart pagination where you left it off. This is a non-trivial problem when combined with sorting over non-unique record fields, such as timestamps.
 
-Installation
-------------
+## Installation
 
 Add the gem to your Gemfile and run `bundle install`.
 
@@ -39,8 +49,7 @@ Add the gem to your Gemfile and run `bundle install`.
 gem 'mongoid-scroll'
 ```
 
-Usage
------
+## Usage
 
 ### Mongoid
 
@@ -84,27 +93,6 @@ Feed::Item.desc(:position).scroll(saved_cursor) do |record, next_cursor|
 end
 ```
 
-### Moped (Mongoid 3 and 4)
-
-Scroll a `Moped::Query` and save a cursor to the last item. You must also supply a `field_type` of the sort criteria.
-
-```ruby
-saved_cursor = nil
-session[:feed_items].find.sort(position: -1).limit(5).scroll(nil, { field_type: DateTime }) do |record, next_cursor|
-  # each record, one-by-one
-  saved_cursor = next_cursor
-end
-```
-
-Resume iterating using the previously saved cursor.
-
-```ruby
-session[:feed_items].find.sort(position: -1).limit(5).scroll(saved_cursor, { field_type: DateTime }) do |record, next_cursor|
-  # each record, one-by-one
-  saved_cursor = next_cursor
-end
-```
-
 ### Mongo-Ruby-Driver (Mongoid 5)
 
 Scroll a `Mongo::Collection::View` and save a cursor to the last item. You must also supply a `field_type` of the sort criteria.
@@ -126,8 +114,7 @@ session[:feed_items].find.sort(position: -1).limit(5).scroll(saved_cursor, { fie
 end
 ```
 
-Indexes and Performance
------------------------
+## Indexes and Performance
 
 A query without a cursor is identical to a query without a scroll.
 
@@ -159,8 +146,7 @@ module Feed
 end
 ```
 
-Cursors
--------
+## Cursors
 
 You can use `Mongoid::Scroll::Cursor.from_record` to generate a cursor. A cursor points at the last record of the previous iteration and unlike MongoDB cursors will not expire.
 
@@ -176,14 +162,41 @@ You can also a `field_name` and `field_type` instead of a Mongoid field.
 cursor = Mongoid::Scroll::Cursor.from_record(record, { field_type: DateTime, field_name: "position" })
 ```
 
-Contributing
-------------
+When the `include_current` option is set to `true`, the cursor will include the record it points to:
+
+```ruby
+record = Feed::Item.desc(:position).limit(3).last
+cursor = Mongoid::Scroll::Cursor.from_record(record, { field: Feed::Item.fields["position"], include_current: true })
+Feed::Item.asc(:position).limit(1).scroll(cursor).first # record
+```
+
+If the `field_name`, `field_type` or `direction` options you specify when creating the cursor are different from the original criteria, a `Mongoid::Scroll::Errors::MismatchedSortFieldsError` will be raised.
+
+```ruby
+cursor = Mongoid::Scroll::Cursor.from_record(record, { field_type: DateTime, field_name: "position" })
+Feed::Item.desc(:created_at).scroll(cursor) # Raises a Mongoid::Scroll::Errors::MismatchedSortFieldsError
+```
+
+### Standard Cursor
+
+The `Mongoid::Scroll::Cursor` encodes a value and a tiebreak ID separated by `:`, and does not include other options, such as scroll direction. Take extra care not to pass a cursor into a scroll with different options. 
+
+### Base64 Encoded Cursor
+
+The `Mongoid::Scroll::Base64EncodedCursor` can be used instead of `Mongoid::Scroll::Cursor` to generate a base64-encoded string (using RFC 4648) containing all the information needed to rebuild a cursor.
+
+```ruby
+Feed::Item.desc(:position).limit(5).scroll(Mongoid::Scroll::Base64EncodedCursor) do |record, next_cursor|
+   # next_cursor is of type Mongoid::Scroll::Base64EncodedCursor
+end
+```
+
+## Contributing
 
 Fork the project. Make your feature addition or bug fix with tests. Send a pull request. Bonus points for topic branches.
 
-Copyright and License
----------------------
+## Copyright and License
 
 MIT License, see [LICENSE](http://github.com/mongoid/mongoid-scroll/raw/master/LICENSE.md) for details.
 
-(c) 2013-2015 [Daniel Doubrovkine](http://github.com/dblock), based on code by [Frank Macreery](http://github.com/macreery), [Artsy Inc.](http://artsy.net)
+(c) 2013-2023 [Daniel Doubrovkine](http://github.com/dblock), based on code by [Frank Macreery](http://github.com/macreery), [Artsy Inc.](http://artsy.net)

data/RELEASING.md

@@ -12,7 +12,7 @@ bundle install
 rake
 ```
 
-Check that the last build succeeded in [Travis CI](https://travis-ci.org/mongoid/mongoid-scroll) for all supported platforms.
+Check that the last build succeeded in [Github Actions](https://github.com/mongoid/mongoid-scroll/actions) for all supported platforms.
 
 Increment the version, modify [lib/mongoid/scroll/version.rb](lib/mongoid/scroll/version.rb).
 

data/UPGRADING.md

@@ -0,0 +1,14 @@
+# Upgrading
+
+## Upgrading to >= 1.0.0
+
+### Mismatched Sort Fields
+
+Both `Mongoid::Criteria::Scrollable#scroll` and `Mongo::Scrollable` now raise a `Mongoid::Scroll::Errors::MismatchedSortFieldsError` when there are discrepancies between the cursor sort options and the original sort options.
+
+For example, the following code will now raise a `MismatchedSortFieldsError` because we set a different field name (`position`) from the `created_at` field used to sort in `scroll`.
+
+```ruby
+cursor.field_name = "position" 
+Feed::Item.desc(:created_at).scroll(cursor)
+```

data/examples/mongoid_scroll_feed.rb

@@ -4,14 +4,8 @@ Bundler.setup(:default, :development)
 require 'mongoid-scroll'
 require 'faker'
 
-if defined?(Moped)
-  Moped.logger = Logger.new($stdout)
-  Moped.logger.level = Logger::DEBUG
-else
-  Mongoid.logger.level = Logger::INFO
-  Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
-end
-
+Mongoid.logger.level = Logger::INFO
+Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
 Mongoid.connect_to 'mongoid_scroll_demo'
 Mongoid.purge!
 

data/lib/config/locales/en.yml

@@ -7,10 +7,18 @@ en:
             message: "Scrolling over a criteria with multiple fields is not supported."
             summary: "You're attempting to scroll over data with a sort order that includes multiple fields: %{sort}."
             resolution: "Simplify the sort order to a single field."
+          mismatched_sort_fields:
+            message: "Specifying different sort fields than the original sort is not supported."
+            summary: "You're attempting to scroll over data with a sort order that differs between the cursor and the original criteria: %{diff}."
+            resolution: "Don't update the cursor sort options."
           invalid_cursor:
             message: "The cursor supplied is invalid."
             summary: "The cursor supplied is invalid: %{cursor}."
             resolution: "Cursors must be in the form 'value:tiebreak_id'."
+          invalid_base64_cursor:
+            message: "The cursor supplied is invalid."
+            summary: "The cursor supplied is invalid: %{cursor}."
+            resolution: "Cursors must be a base64-encoded string."
           no_such_field:
             message: "Invalid field."
             summary: "The field supplied in the cursor does not exist: %{field}."

data/lib/mongo/scrollable.rb

@@ -1,6 +1,10 @@
 module Mongo
   module Scrollable
-    def scroll(cursor = nil, options = nil, &_block)
+    include Mongoid::Criteria::Scrollable::Fields
+    include Mongoid::Criteria::Scrollable::Cursors
+
+    def scroll(cursor_or_type = nil, options = nil, &_block)
+      cursor, cursor_type = cursor_and_type(cursor_or_type)
       view = self
       # we don't support scrolling over a view with multiple fields
       raise Mongoid::Scroll::Errors::MultipleSortFieldsError.new(sort: view.sort) if view.sort && view.sort.keys.size != 1
@@ -10,7 +14,8 @@ module Mongo
       # scroll cursor from the parameter, with value and tiebreak_id
       options = { field_type: BSON::ObjectId } unless options
       cursor_options = { field_name: scroll_field, direction: scroll_direction }.merge(options)
-      cursor = cursor.is_a?(Mongoid::Scroll::Cursor) ? cursor : Mongoid::Scroll::Cursor.new(cursor, cursor_options)
+      cursor = cursor && cursor.is_a?(cursor_type) ? cursor : cursor_type.new(cursor, cursor_options)
+      raise_mismatched_sort_fields_error!(cursor, cursor_options) if different_sort_fields?(cursor, cursor_options)
       # make a view
       view = Mongo::Collection::View.new(
         view.collection,
@@ -22,7 +27,7 @@ module Mongo
       # scroll
       if block_given?
         view.each do |record|
-          yield record, Mongoid::Scroll::Cursor.from_record(record, cursor_options)
+          yield record, cursor_type.from_record(record, cursor_options)
         end
       else
         view

data/lib/mongoid/criteria/scrollable/cursors.rb

@@ -0,0 +1,18 @@
+module Mongoid
+  class Criteria
+    module Scrollable
+      # Shared by *::Scrollable modules
+      module Cursors
+        private
+
+        def cursor_and_type(cursor_or_type)
+          cursor = cursor_or_type.is_a?(Class) ? nil : cursor_or_type
+          cursor_type = cursor_or_type.is_a?(Class) ? cursor_or_type : nil
+          cursor_type ||= cursor.class if cursor.is_a?(Mongoid::Scroll::BaseCursor)
+          cursor_type ||= Mongoid::Scroll::Cursor
+          [cursor, cursor_type]
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/criteria/scrollable/fields.rb

@@ -0,0 +1,21 @@
+module Mongoid
+  class Criteria
+    module Scrollable
+      # Shared by *::Scrollable modules
+      module Fields
+        private
+
+        def raise_mismatched_sort_fields_error!(cursor, criteria_cursor_options)
+          diff = cursor.sort_options.reject { |k, v| criteria_cursor_options[k] == v }
+          raise Mongoid::Scroll::Errors::MismatchedSortFieldsError.new(diff: diff)
+        end
+
+        def different_sort_fields?(cursor, criteria_cursor_options)
+          criteria_cursor_options[:field_type] = criteria_cursor_options[:field_type].to_s
+          criteria_cursor_options[:field_name] = criteria_cursor_options[:field_name].to_s
+          criteria_cursor_options != cursor.sort_options
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/criteria/scrollable.rb

@@ -1,16 +1,21 @@
 module Mongoid
   class Criteria
     module Scrollable
-      def scroll(cursor = nil, &_block)
+      include Mongoid::Criteria::Scrollable::Fields
+      include Mongoid::Criteria::Scrollable::Cursors
+
+      def scroll(cursor_or_type = nil, &_block)
+        cursor, cursor_type = cursor_and_type(cursor_or_type)
         raise_multiple_sort_fields_error if multiple_sort_fields?
         criteria = dup
         criteria.merge!(default_sort) if no_sort_option?
         cursor_options = build_cursor_options(criteria)
-        cursor = cursor.is_a?(Mongoid::Scroll::Cursor) ? cursor : new_cursor(cursor, cursor_options)
+        cursor = cursor.is_a?(cursor_type) ? cursor : new_cursor(cursor_type, cursor, cursor_options)
+        raise_mismatched_sort_fields_error!(cursor, cursor_options) if different_sort_fields?(cursor, cursor_options)
         cursor_criteria = build_cursor_criteria(criteria, cursor)
         if block_given?
           cursor_criteria.order_by(_id: scroll_direction(criteria)).each do |record|
-            yield record, cursor_from_record(record, cursor_options)
+            yield record, cursor_from_record(cursor_type, record, cursor_options)
           end
         else
           cursor_criteria
@@ -51,8 +56,8 @@ module Mongoid
         }
       end
 
-      def new_cursor(cursor, cursor_options)
-        Mongoid::Scroll::Cursor.new(cursor, cursor_options)
+      def new_cursor(cursor_type, cursor, cursor_options)
+        cursor_type.new(cursor, cursor_options)
       end
 
       def build_cursor_criteria(criteria, cursor)
@@ -61,18 +66,14 @@ module Mongoid
         cursor_criteria
       end
 
-      def cursor_from_record(record, cursor_options)
-        Mongoid::Scroll::Cursor.from_record(record, cursor_options)
+      def cursor_from_record(cursor_type, record, cursor_options)
+        cursor_type.from_record(record, cursor_options)
       end
 
       def scroll_field_type(criteria)
         scroll_field = scroll_field(criteria)
         field = criteria.klass.fields[scroll_field.to_s]
-        field.foreign_key? && field.object_id_field? ? bson_type : field.type
-      end
-
-      def bson_type
-        Mongoid::Compatibility::Version.mongoid3? ? Moped::BSON::ObjectId : BSON::ObjectId
+        field.foreign_key? && field.object_id_field? ? BSON::ObjectId : field.type
       end
     end
   end

data/lib/mongoid/scroll/base64_encoded_cursor.rb

@@ -0,0 +1,40 @@
+require 'base64'
+require 'json'
+
+module Mongoid
+  module Scroll
+    # Allows to serializer/deserialize the cursor using RFC 4648
+    class Base64EncodedCursor < BaseCursor
+      def initialize(value, options = {})
+        options = extract_field_options(options)
+        if value
+          begin
+            parsed = ::JSON.parse(::Base64.strict_decode64(value))
+          rescue
+            raise Mongoid::Scroll::Errors::InvalidBase64CursorError.new(cursor: value)
+          end
+          super parse_field_value(parsed['field_type'], parsed['field_name'], parsed['value']), {
+            field_type: parsed['field_type'],
+            field_name: parsed['field_name'],
+            direction: parsed['direction'],
+            include_current: parsed['include_current'],
+            tiebreak_id: parsed['tiebreak_id'] && !parsed['tiebreak_id'].empty? ? BSON::ObjectId.from_string(parsed['tiebreak_id']) : nil
+          }
+        else
+          super nil, options
+        end
+      end
+
+      def to_s
+        Base64.strict_encode64({
+          value: transform_field_value(field_type, field_name, value),
+          field_type: field_type.to_s,
+          field_name: field_name,
+          direction: direction,
+          include_current: include_current,
+          tiebreak_id: tiebreak_id && tiebreak_id.to_s
+        }.to_json)
+      end
+    end
+  end
+end