Removed support for Moped and fixed specs.

Author: dblock

.github/workflows/ci.yml

@@ -7,8 +7,6 @@ jobs:
     strategy:
       matrix:
         entry:
-          - { ruby: '2.6', mongodb: '4.4', mongoid: '3' }
-          - { ruby: '2.6', mongodb: '4.4', mongoid: '4' }
           - { ruby: '2.6', mongodb: '4.4', mongoid: '5' }
           - { ruby: '2.7', mongodb: '4.4', mongoid: '6' }
           - { ruby: '2.7', mongodb: '4.4', mongoid: '7' }

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-05 15:22:11 -0500 using RuboCop version 0.49.1.
+# on 2023-03-05 20:26:55 -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
@@ -13,37 +13,45 @@ Bundler/DuplicatedGem:
   Exclude:
     - 'Gemfile'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Exclude:
+    - 'lib/mongoid/scroll/errors/invalid_base64_cursor_error.rb'
+
 # Offense count: 1
 # Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
 Lint/UselessAccessModifier:
   Exclude:
     - 'lib/mongoid/scroll/cursor.rb'
 
-# Offense count: 6
+# Offense count: 7
 Metrics/AbcSize:
-  Max: 69
+  Max: 38
 
-# Offense count: 17
+# Offense count: 15
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 255
+  Max: 252
 
-# Offense count: 7
+# Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 163
+# Offense count: 127
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 222
 
-# Offense count: 7
+# Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 26
+  Max: 23
 
-# Offense count: 5
+# Offense count: 3
 Metrics/PerceivedComplexity:
   Max: 12
 
@@ -52,17 +60,17 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-    - 'examples/mongoid_scroll_feed.rb'
+    - 'examples/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.
@@ -71,12 +79,6 @@ Style/FileName:
   Exclude:
     - 'lib/mongoid-scroll.rb'
 
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/moped/scrollable.rb'
-
 # Offense count: 1
 Style/MultilineTernaryOperator:
   Exclude:

CHANGELOG.md

@@ -5,6 +5,7 @@
 * [#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).
 * Your contribution here.
 
 ### 0.3.7 (2021/06/01)

README.md

@@ -1,21 +1,36 @@
+- [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://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
 
-This gem supports Mongoid 3, 4, 5, 6, 7, Moped and Mongo-Ruby-Driver.
+This gem supports Mongoid 5, 6, and 7.
 
 ## 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
 
@@ -78,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.
@@ -183,11 +177,13 @@ cursor = Mongoid::Scroll::Cursor.from_record(record, { field_type: DateTime, fie
 Feed::Item.desc(:created_at).scroll(cursor) # Raises a Mongoid::Scroll::Errors::MismatchedSortFieldsError
 ```
 
-### Cursor Encoding
+### Standard Cursor
+
+The `Mongoid::Scroll::Base64EncodedCursor` 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
+### Base64 Encoded Cursor
 
-`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.
+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|

UPGRADING.md

@@ -4,18 +4,11 @@
 
 ### Mismatched Sort Fields
 
-`Mongoid::Criteria::Scrollable#scroll`, `Moped::Scrollable` and `Mongo::Scrollable` now raise a `Mongoid::Scroll::Errors::MismatchedSortFieldsError` when there are discrepancies between the cursor sort options and the original sort options.
-Make sure to avoid this case or to handle the new exception.
+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.
 
-```ruby
-cursor.field_name = "position" # Avoid this, it'll raise because on the following line the sort is by created_at
-Feed::Item.desc(:created_at).scroll(cursor)
-```
+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
-begin
-  Feed::Item.desc(:created_at).scroll(cursor)
-rescue Mongoid::Scroll::Errors::MismatchedSortFieldsError
-  # If cursor can be modified externally, handle the exception
-end
+cursor.field_name = "position" 
+Feed::Item.desc(:created_at).scroll(cursor)
 ```

examples/mongoid_scroll_feed.rb

@@ -4,14 +4,8 @@
 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!
 

examples/moped_scroll_feed.rb

@@ -15,6 +15,10 @@ en:
             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}."

lib/config/locales/en.yml

@@ -1,8 +1,10 @@
 module Mongo
   module Scrollable
     include Mongoid::Criteria::Scrollable::Fields
+    include Mongoid::Criteria::Scrollable::Cursors
 
-    def scroll(cursor = nil, options = nil, &_block)
+    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
@@ -12,7 +14,7 @@ def scroll(cursor = nil, options = nil, &_block)
       # 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(
@@ -25,7 +27,7 @@ def scroll(cursor = nil, options = nil, &_block)
       # 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

lib/mongo/scrollable.rb

@@ -10,6 +10,6 @@
 require 'mongoid/scroll/cursor'
 require 'mongoid/scroll/base64_encoded_cursor'
 require 'mongoid/criteria/scrollable/fields'
-require 'moped/scrollable' if Object.const_defined?(:Moped)
+require 'mongoid/criteria/scrollable/cursors'
 require 'mongo/scrollable' if Object.const_defined?(:Mongo)
 require 'mongoid/criteria/scrollable'