mongoid-scroll 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57a1e903af68213f7d6552ca5dc91515ef599fcd
-  data.tar.gz: f957cb76b0556ba653b2a56d030850c07ed995c6
+  metadata.gz: 3c6aed40600433d3619cdc8839f6a2ad2da3b9c7
+  data.tar.gz: fbe2257d54b98c8aff1d8163f2a4dc15071c7d92
 SHA512:
-  metadata.gz: e4df4fa326bfb87fa7cb41e577e4cf22010415e2cedaa74f52a7b789f72143bcc2f5c6074f3823f95705c3090fef4a75d7b365d3274a8ff640105d429918b08f
-  data.tar.gz: cacbb8b7577052c47fac14aa4401117dfb6c05a788e900d252fac0c565d49c24b6512deb87c02f69ab3803ce4348820bdfe78e6f99309516be5d45cc9bf66229
+  metadata.gz: 4936c9a792ec9950a4bbd5c02c8fcc89cedc44cd1900737d6e20106ad3810f1d27b7aa9bbb230f58177a2dd10ac251bfbaec4674a5e31855c5f5bf450fd7dfbf
+  data.tar.gz: 5f087846be5d4870975de8841872320a6e0ce441b568e4db28526a2bb715264b92b7089aa70df9adb615d3f735b8079847472e55e9c8cd75cd0eca4b33cd01ca

data/.rubocop.yml

@@ -4,5 +4,3 @@ AllCops:
   Exclude:
     - vendor/**/*
     - gemfiles/vendor/**/*
-
-

data/.rubocop_todo.yml

@@ -1,31 +1,43 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-09-27 11:32:40 -0700 using RuboCop version 0.43.0.
+# on 2018-03-13 23:29:51 +0100 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
+# Configuration parameters: Include.
+# Include: **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
 # Offense count: 6
 Metrics/AbcSize:
   Max: 67
 
-# Offense count: 6
+# Offense count: 14
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 216
+
+# Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 114
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# Offense count: 121
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 170
+  Max: 172
 
 # Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 25
 
-# Offense count: 4
+# Offense count: 3
 Metrics/PerceivedComplexity:
   Max: 11
 
@@ -36,7 +48,7 @@ Style/Documentation:
     - 'test/**/*'
     - 'examples/mongoid_scroll_feed.rb'
     - 'lib/mongo/scrollable.rb'
-    - 'lib/mongoid/criterion/scrollable.rb'
+    - 'lib/mongoid/criteria/scrollable.rb'
     - 'lib/mongoid/scroll/cursor.rb'
     - 'lib/mongoid/scroll/errors/base.rb'
     - 'lib/mongoid/scroll/errors/invalid_cursor_error.rb'
@@ -46,27 +58,21 @@ Style/Documentation:
     - 'lib/moped/scrollable.rb'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Style/FileName:
   Exclude:
     - 'lib/mongoid-scroll.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/mongoid/criterion/scrollable.rb'
     - 'lib/moped/scrollable.rb'
 
-# Offense count: 7
+# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
 # SupportedStyles: compact, exploded
 Style/RaiseArgs:
   EnforcedStyle: compact
-
-# Offense count: 1
-# Configuration parameters: SupportedStyles.
-# SupportedStyles: snake_case, normalcase, non_integer
-Style/VariableNumber:
-  EnforcedStyle: normalcase

data/.travis.yml

@@ -26,3 +26,10 @@ matrix:
         - bundle exec danger
 
 bundler_args: --without development
+
+addons:
+  apt:
+    sources:
+      - mongodb-3.4-precise
+    packages:
+      - mongodb-org-server

data/CHANGELOG.md

@@ -1,50 +1,46 @@
-0.3.5 (2016/09/27)
-------------------
+### 0.3.6 (2018/05/01)
+
+* [#18](https://github.com/mongoid/mongoid-scroll/pull/18): Fix mongoid scroll without block returning wrong criteria - [@asgerb](https://github.com/asgerb).
+* [#15](https://github.com/mongoid/mongoid-scroll/pull/15): Use MongoDB 3.4 in testing and fix tests w/ WiredTiger storage engine - [@dblock](https://github.com/dblock).
+* [#14](https://github.com/mongoid/mongoid-scroll/pull/14): Allow scrolling by foreign key - [@joeyAghion](https://github.com/joeyAghion).
+
+### 0.3.5 (2016/09/27)
 
 * [#11](https://github.com/mongoid/mongoid-scroll/pull/11): Compatibility with Mongoid 6 - [@dblock](https://github.com/dblock).
 * [#12](https://github.com/mongoid/mongoid-scroll/pull/12): Added Danger, PR linter - [@dblock](https://github.com/dblock).
 
-0.3.4 (2015/10/22)
-------------------
+### 0.3.4 (2015/10/22)
 
 * Added support for [mongo-ruby-driver](https://github.com/mongodb/mongo-ruby-driver), `Mongo::Collection::View` - [@dblock](https://github.com/dblock).
 
-0.3.3 (2015/09/17)
-------------------
+### 0.3.3 (2015/09/17)
 
 * Compatibility with Mongoid 5 - [@dblock](https://github.com/dblock).
 
-0.3.2 (2015/8/8)
-----------------
+### 0.3.2 (2015/8/8)
 
 * [#7](https://github.com/mongoid/mongoid-scroll/pull/7): Fix: pre-merge cursor criteria fields - [@sweir27](https://github.com/sweir27).
 
-0.3.1 (2015/7/27)
------------------
+### 0.3.1 (2015/7/27)
 
 * Compatibility with Mongoid 5.x beta - [@dblock](https://github.com/dblock).
 * [#4](https://github.com/mongoid/mongoid-scroll/pull/4): Fix: support chaining `$or` criteria - [@sweir27](https://github.com/sweir27).
 * [#5](https://github.com/mongoid/mongoid-scroll/pull/5): Fix: embeddable objects now returned in pagination - [@sweir27](https://github.com/sweir27).
 
-0.3.0 (2014/1/7)
-----------------
+### 0.3.0 (2014/1/7)
 
 * Compatibility with Mongoid 4.x - [@dblock](https://github.com/dblock).
 * Implemeneted Rubocop, Ruby linter - [@dblock](https://github.com/dblock).
 
-0.2.1 (2013/3/21)
------------------
+### 0.2.1 (2013/3/21)
 
 * Fix: scroll over a collection that has duplicate values while data is being modified in a way that causes a change in the natural sort order - [@dblock](https://github.com/dblock).
 
-0.2.0 (2013/3/14)
------------------
+### 0.2.0 (2013/3/14)
 
 * Extended `Moped::Query` with `scroll` - [@dblock](https://github.com/dblock).
 * `Mongoid::Scroll::Cursor.from_record` can now be called with either a Mongoid field or `field_type` and `field_name` in the `options` hash - [@dblock](https://github.com/dblock).
 
-0.1.0 (2013/2/14)
------------------
+### 0.1.0 (2013/2/14)
 
 * Initial public release, extends `Mongoid::Criteria` with `scroll` - [@dblock](https://github.com/dblock).
-

data/Gemfile

@@ -5,6 +5,8 @@ gemspec
 case version = ENV['MONGOID_VERSION'] || '~> 6.0'
 when 'HEAD'
   gem 'mongoid', github: 'mongodb/mongoid'
+when /7/
+  gem 'mongoid', github: 'mongodb/mongoid', branch: '7.0-dev'
 when /6/
   gem 'mongoid', '~> 6.0'
 when /5/
@@ -18,11 +20,12 @@ else
 end
 
 group :development, :test do
-  gem 'rake'
   gem 'bundler'
-  gem 'rspec', '~> 3.0'
-  gem 'rspec-its'
+  gem 'database_cleaner'
   gem 'faker'
-  gem 'rubocop', '0.43.0'
   gem 'mongoid-danger', '~> 0.1.0', require: false
+  gem 'rake'
+  gem 'rspec', '~> 3.0'
+  gem 'rspec-its'
+  gem 'rubocop', '0.49.1'
 end

data/RELEASING.md

@@ -1,7 +1,7 @@
 Releasing Mongoid::Scroll
 =========================
 
-There're no particular rules about when to release mongoid-scroll. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+There're no particular rules about when to release mongoid-scroll. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
 
 ### Release
 
@@ -22,11 +22,10 @@ Increment the version, modify [lib/mongoid/scroll/version.rb](lib/mongoid/scroll
 Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
 
 ```
-0.4.0 (2014-01-27)
-==================
+### 0.4.0 (2018/12/24)
 ```
 
-Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
 
 Commit your changes.
 
@@ -52,15 +51,14 @@ Pushed mongoid-scroll 0.4.0 to rubygems.org.
 Add the next release to [CHANGELOG.md](CHANGELOG.md).
 
 ```
-Next Release
-============
+### Next Release
 
 * Your contribution here.
 ```
 
 Increment the minor version, modify [lib/mongoid-scroll/version.rb](lib/mongoid-scroll/version.rb).
 
-Comit your changes.
+Commit your changes.
 
 ```
 git add CHANGELOG.md lib/mongoid-scroll/version.rb

data/Rakefile

@@ -24,4 +24,4 @@ task :spec
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/lib/mongoid-scroll.rb

@@ -9,4 +9,4 @@ require 'mongoid/scroll/errors'
 require 'mongoid/scroll/cursor'
 require 'moped/scrollable' if Object.const_defined?(:Moped)
 require 'mongo/scrollable' if Object.const_defined?(:Mongo)
-require 'mongoid/criterion/scrollable'
+require 'mongoid/criteria/scrollable'

data/lib/mongoid/criteria/scrollable.rb

@@ -0,0 +1,81 @@
+module Mongoid
+  class Criteria
+    module Scrollable
+      def scroll(cursor = nil, &_block)
+        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_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)
+          end
+        else
+          cursor_criteria
+        end
+      end
+
+      private
+
+      def raise_multiple_sort_fields_error
+        raise Mongoid::Scroll::Errors::MultipleSortFieldsError.new(sort: criteria.options.sort)
+      end
+
+      def multiple_sort_fields?
+        options.sort && options.sort.keys.size != 1
+      end
+
+      def no_sort_option?
+        options.sort.blank? || options.sort.empty?
+      end
+
+      def default_sort
+        asc(:_id)
+      end
+
+      def scroll_field(criteria)
+        criteria.options.sort.keys.first
+      end
+
+      def scroll_direction(criteria)
+        criteria.options.sort.values.first.to_i
+      end
+
+      def build_cursor_options(criteria)
+        {
+          field_type: scroll_field_type(criteria),
+          field_name: scroll_field(criteria),
+          direction: scroll_direction(criteria)
+        }
+      end
+
+      def new_cursor(cursor, cursor_options)
+        Mongoid::Scroll::Cursor.new(cursor, cursor_options)
+      end
+
+      def build_cursor_criteria(criteria, cursor)
+        cursor_criteria = criteria.dup
+        cursor_criteria.selector = { '$and' => [criteria.selector, cursor.criteria] }
+        cursor_criteria
+      end
+
+      def cursor_from_record(record, cursor_options)
+        Mongoid::Scroll::Cursor.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
+      end
+    end
+  end
+end
+
+Mongoid::Criteria.send(:include, Mongoid::Criteria::Scrollable)

data/lib/mongoid/scroll/cursor.rb

@@ -14,7 +14,7 @@ module Mongoid
         compare_direction = direction == 1 ? '$gt' : '$lt'
         cursor_criteria = { field_name => { compare_direction => mongo_value } } if mongo_value
         tiebreak_criteria = { field_name => mongo_value, :_id => { compare_direction => tiebreak_id } } if mongo_value && tiebreak_id
-        cursor_selector = if Mongoid::Compatibility::Version.mongoid6?
+        cursor_selector = if Mongoid::Compatibility::Version.mongoid6? || Mongoid::Compatibility::Version.mongoid7?
                             Mongoid::Criteria::Queryable::Selector.new
                           else
                             Origin::Selector.new

data/lib/mongoid/scroll/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Scroll
-    VERSION = '0.3.5'.freeze
+    VERSION = '0.3.6'.freeze
   end
 end

data/spec/mongo/collection_view_spec.rb

@@ -1,124 +1,126 @@
 require 'spec_helper'
 
-describe Mongo::Collection::View do
-  context 'scrollable' do
-    subject do
-      Mongoid.default_client['feed_items'].find
-    end
-    it ':scroll' do
-      expect(subject).to respond_to(:scroll)
-    end
-  end
-  context 'with multiple sort fields' do
-    subject do
-      Mongoid.default_client['feed_items'].find.sort(name: 1, value: -1)
-    end
-    it 'raises Mongoid::Scroll::Errors::MultipleSortFieldsError' do
-      expect { subject.scroll }.to raise_error Mongoid::Scroll::Errors::MultipleSortFieldsError,
-                                               /You're attempting to scroll over data with a sort order that includes multiple fields: name, value./
-    end
-  end
-  context 'with no sort' do
-    subject do
-      Mongoid.default_client['feed_items'].find
+if Object.const_defined?(:Mongo)
+  describe Mongo::Collection::View do
+    context 'scrollable' do
+      subject do
+        Mongoid.default_client['feed_items'].find
+      end
+      it ':scroll' do
+        expect(subject).to respond_to(:scroll)
+      end
     end
-    it 'adds a default sort by _id' do
-      expect(subject.scroll.sort).to eq('_id' => 1)
+    context 'with multiple sort fields' do
+      subject do
+        Mongoid.default_client['feed_items'].find.sort(name: 1, value: -1)
+      end
+      it 'raises Mongoid::Scroll::Errors::MultipleSortFieldsError' do
+        expect { subject.scroll }.to raise_error Mongoid::Scroll::Errors::MultipleSortFieldsError,
+                                                 /You're attempting to scroll over data with a sort order that includes multiple fields: name, value./
+      end
     end
-  end
-  context 'with data' do
-    before :each do
-      10.times do |i|
-        Mongoid.default_client['feed_items'].insert_one(
-          a_string: i.to_s,
-          a_integer: i,
-          a_datetime: DateTime.mongoize(DateTime.new(2013, i + 1, 21, 1, 42, 3, 'UTC')),
-          a_date: Date.mongoize(Date.new(2013, i + 1, 21)),
-          a_time: Time.mongoize(Time.at(Time.now.to_i + i))
-        )
+    context 'with no sort' do
+      subject do
+        Mongoid.default_client['feed_items'].find
+      end
+      it 'adds a default sort by _id' do
+        expect(subject.scroll.sort).to eq('_id' => 1)
       end
     end
-    context 'default' do
-      it 'scrolls all' do
-        records = []
-        Mongoid.default_client['feed_items'].find.scroll do |record, _next_cursor|
-          records << record
+    context 'with data' do
+      before :each do
+        10.times do |i|
+          Mongoid.default_client['feed_items'].insert_one(
+            a_string: i.to_s,
+            a_integer: i,
+            a_datetime: DateTime.mongoize(DateTime.new(2013, i + 1, 21, 1, 42, 3, 'UTC')),
+            a_date: Date.mongoize(Date.new(2013, i + 1, 21)),
+            a_time: Time.mongoize(Time.at(Time.now.to_i + i))
+          )
         end
-        expect(records.size).to eq 10
-        expect(records).to eq Mongoid.default_client['feed_items'].find.to_a
       end
-    end
-    { a_string: String, a_integer: Integer, a_date: Date, a_datetime: DateTime }.each_pair do |field_name, field_type|
-      context field_type do
-        it 'scrolls all with a block' do
+      context 'default' do
+        it 'scrolls all' do
           records = []
-          Mongoid.default_client['feed_items'].find.sort(field_name => 1).scroll(nil, field_type: field_type) do |record, _next_cursor|
+          Mongoid.default_client['feed_items'].find.scroll do |record, _next_cursor|
             records << record
           end
           expect(records.size).to eq 10
           expect(records).to eq Mongoid.default_client['feed_items'].find.to_a
         end
-        it 'scrolls all with a break' do
+      end
+      { a_string: String, a_integer: Integer, a_date: Date, a_datetime: DateTime }.each_pair do |field_name, field_type|
+        context field_type do
+          it 'scrolls all with a block' do
+            records = []
+            Mongoid.default_client['feed_items'].find.sort(field_name => 1).scroll(nil, field_type: field_type) do |record, _next_cursor|
+              records << record
+            end
+            expect(records.size).to eq 10
+            expect(records).to eq Mongoid.default_client['feed_items'].find.to_a
+          end
+          it 'scrolls all with a break' do
+            records = []
+            cursor = nil
+            Mongoid.default_client['feed_items'].find.sort(field_name => 1).limit(5).scroll(nil, field_type: field_type) do |record, next_cursor|
+              records << record
+              cursor = next_cursor
+            end
+            expect(records.size).to eq 5
+            Mongoid.default_client['feed_items'].find.sort(field_name => 1).scroll(cursor, field_type: field_type) do |record, next_cursor|
+              records << record
+              cursor = next_cursor
+            end
+            expect(records.size).to eq 10
+            expect(records).to eq Mongoid.default_client['feed_items'].find.to_a
+          end
+          it 'scrolls in descending order' do
+            records = []
+            Mongoid.default_client['feed_items'].find.sort(field_name => -1).limit(3).scroll(nil, field_type: field_type, field_name: field_name) do |record, _next_cursor|
+              records << record
+            end
+            expect(records.size).to eq 3
+            expect(records).to eq Mongoid.default_client['feed_items'].find.sort(field_name => -1).limit(3).to_a
+          end
+          it 'map' do
+            record = Mongoid.default_client['feed_items'].find.limit(3).scroll(nil, field_type: field_type, field_name: field_name).map { |r| r }.last
+            cursor = Mongoid::Scroll::Cursor.from_record(record, field_type: field_type, field_name: field_name)
+            expect(cursor).to_not be nil
+            expect(cursor.to_s.split(':')).to eq [
+              Mongoid::Scroll::Cursor.transform_field_value(field_type, field_name, record[field_name.to_s]).to_s,
+              record['_id'].to_s
+            ]
+          end
+        end
+      end
+    end
+    context 'with overlapping data', if: MongoDB.mmapv1? do
+      before :each do
+        3.times { Feed::Item.create! a_integer: 5 }
+        Feed::Item.first.update_attributes!(name: Array(1000).join('a'))
+      end
+      it 'natural order is different from order by id' do
+        # natural order isn't necessarily going to be the same as _id order
+        # if a document is updated and grows in size, it may need to be relocated and
+        # thus cause the natural order to change
+        expect(Feed::Item.order_by('$natural' => 1).to_a).to_not eq Feed::Item.order_by(_id: 1).to_a
+      end
+      [{ a_integer: 1 }, { a_integer: -1 }].each do |sort_order|
+        it "scrolls by #{sort_order}" do
           records = []
           cursor = nil
-          Mongoid.default_client['feed_items'].find.sort(field_name => 1).limit(5).scroll(nil, field_type: field_type) do |record, next_cursor|
+          Mongoid.default_client['feed_items'].find.sort(sort_order).limit(2).scroll do |record, next_cursor|
             records << record
             cursor = next_cursor
           end
-          expect(records.size).to eq 5
-          Mongoid.default_client['feed_items'].find.sort(field_name => 1).scroll(cursor, field_type: field_type) do |record, next_cursor|
-            records << record
-            cursor = next_cursor
-          end
-          expect(records.size).to eq 10
-          expect(records).to eq Mongoid.default_client['feed_items'].find.to_a
-        end
-        it 'scrolls in descending order' do
-          records = []
-          Mongoid.default_client['feed_items'].find.sort(field_name => -1).limit(3).scroll(nil, field_type: field_type, field_name: field_name) do |record, _next_cursor|
+          expect(records.size).to eq 2
+          Mongoid.default_client['feed_items'].find.sort(sort_order).scroll(cursor) do |record, _next_cursor|
             records << record
           end
           expect(records.size).to eq 3
-          expect(records).to eq Mongoid.default_client['feed_items'].find.sort(field_name => -1).limit(3).to_a
-        end
-        it 'map' do
-          record = Mongoid.default_client['feed_items'].find.limit(3).scroll(nil, field_type: field_type, field_name: field_name).map { |r| r }.last
-          cursor = Mongoid::Scroll::Cursor.from_record(record, field_type: field_type, field_name: field_name)
-          expect(cursor).to_not be nil
-          expect(cursor.to_s.split(':')).to eq [
-            Mongoid::Scroll::Cursor.transform_field_value(field_type, field_name, record[field_name.to_s]).to_s,
-            record['_id'].to_s
-          ]
-        end
-      end
-    end
-  end
-  context 'with overlapping data' do
-    before :each do
-      3.times { Feed::Item.create! a_integer: 5 }
-      Feed::Item.first.update_attributes!(name: Array(1000).join('a'))
-    end
-    it 'natural order is different from order by id' do
-      # natural order isn't necessarily going to be the same as _id order
-      # if a document is updated and grows in size, it may need to be relocated and
-      # thus cause the natural order to change
-      expect(Feed::Item.order_by('$natural' => 1).to_a).to_not eq Feed::Item.order_by(_id: 1).to_a
-    end
-    [{ a_integer: 1 }, { a_integer: -1 }].each do |sort_order|
-      it "scrolls by #{sort_order}" do
-        records = []
-        cursor = nil
-        Mongoid.default_client['feed_items'].find.sort(sort_order).limit(2).scroll do |record, next_cursor|
-          records << record
-          cursor = next_cursor
-        end
-        expect(records.size).to eq 2
-        Mongoid.default_client['feed_items'].find.sort(sort_order).scroll(cursor) do |record, _next_cursor|
-          records << record
+          expect(records).to eq Mongoid.default_client['feed_items'].find.sort(sort_order.merge(_id: sort_order[:a_integer])).to_a
         end
-        expect(records.size).to eq 3
-        expect(records).to eq Mongoid.default_client['feed_items'].find.sort(sort_order.merge(_id: sort_order[:a_integer])).to_a
       end
     end
   end
-end if Object.const_defined?(:Mongo)
+end

data/spec/mongoid/criteria_spec.rb

@@ -13,6 +13,7 @@ describe Mongoid::Criteria do
                                                /You're attempting to scroll over data with a sort order that includes multiple fields: name, value./
     end
   end
+
   context 'with no sort' do
     subject do
       Feed::Item.all
@@ -42,7 +43,30 @@ describe Mongoid::Criteria do
         expect(records.size).to eq 10
         expect(records).to eq Feed::Item.all.to_a
       end
+      it 'does not change original criteria' do
+        criteria = Feed::Item.where(:a_time.gt => Time.new(2013, 7, 22, 1, 2, 3))
+        original_criteria = criteria.dup
+        criteria.limit(2).scroll
+        expect(criteria).to eq original_criteria
+        cursor = nil
+        criteria.limit(2).scroll(cursor) do |_record, next_cursor|
+          cursor = next_cursor
+        end
+        criteria.scroll(cursor) do |_record, next_cursor|
+          cursor = next_cursor
+        end
+        expect(criteria).to eq original_criteria
+      end
     end
+
+    context 'with a foreign key' do
+      it 'sorts by object id' do
+        records = []
+        Feed::Item.asc('publisher_id').scroll { |r, _| records << r }
+        expect(records).not_to be_empty
+      end
+    end
+
     { a_string: String, a_integer: Integer, a_date: Date, a_datetime: DateTime }.each_pair do |field_name, field_type|
       context field_type do
         it 'scrolls all with a block' do
@@ -68,6 +92,17 @@ describe Mongoid::Criteria do
           expect(records.size).to eq 10
           expect(records).to eq Feed::Item.all.to_a
         end
+        it 'scrolls from a cursor' do
+          last_record = nil
+          cursor = nil
+          Feed::Item.asc(field_name).limit(5).scroll do |record, next_cursor|
+            last_record = record
+            cursor = next_cursor
+          end
+          sixth_item = Feed::Item.asc(field_name).to_a[5]
+          from_item = Feed::Item.asc(field_name).scroll(cursor).to_a.first
+          expect(from_item).to eq sixth_item
+        end
         it 'scrolls in descending order' do
           records = []
           Feed::Item.desc(field_name).limit(3).scroll do |record, _next_cursor|
@@ -160,7 +195,7 @@ describe Mongoid::Criteria do
       expect(records.map(&:name)).to eq ['embedded']
     end
   end
-  context 'with overlapping data' do
+  context 'with overlapping data', if: MongoDB.mmapv1? do
     before :each do
       3.times { Feed::Item.create! a_integer: 5 }
       Feed::Item.first.update_attributes!(name: Array(1000).join('a'))

data/spec/mongoid/scroll_cursor_spec.rb

@@ -124,7 +124,7 @@ describe Mongoid::Scroll::Cursor do
     end
   end
   context 'an array field cursor' do
-    let(:feed_item) { Feed::Item.create!(a_array: %w(x y)) }
+    let(:feed_item) { Feed::Item.create!(a_array: %w[x y]) }
     it 'is not supported' do
       expect do
         Mongoid::Scroll::Cursor.from_record feed_item, field_name: 'a_array', field_type: Array

data/spec/moped/query_spec.rb

@@ -1,124 +1,126 @@
 require 'spec_helper'
 
-describe Moped::Query do
-  context 'scrollable' do
-    subject do
-      Mongoid.default_session['feed_items'].find
-    end
-    it ':scroll' do
-      expect(subject).to respond_to(:scroll)
-    end
-  end
-  context 'with multiple sort fields' do
-    subject do
-      Mongoid.default_session['feed_items'].find.sort(name: 1, value: -1)
-    end
-    it 'raises Mongoid::Scroll::Errors::MultipleSortFieldsError' do
-      expect { subject.scroll }.to raise_error Mongoid::Scroll::Errors::MultipleSortFieldsError,
-                                               /You're attempting to scroll over data with a sort order that includes multiple fields: name, value./
-    end
-  end
-  context 'with no sort' do
-    subject do
-      Mongoid.default_session['feed_items'].find
+if Object.const_defined?(:Moped)
+  describe Moped::Query do
+    context 'scrollable' do
+      subject do
+        Mongoid.default_session['feed_items'].find
+      end
+      it ':scroll' do
+        expect(subject).to respond_to(:scroll)
+      end
     end
-    it 'adds a default sort by _id' do
-      expect(subject.scroll.operation.selector['$orderby']).to eq(_id: 1)
+    context 'with multiple sort fields' do
+      subject do
+        Mongoid.default_session['feed_items'].find.sort(name: 1, value: -1)
+      end
+      it 'raises Mongoid::Scroll::Errors::MultipleSortFieldsError' do
+        expect { subject.scroll }.to raise_error Mongoid::Scroll::Errors::MultipleSortFieldsError,
+                                                 /You're attempting to scroll over data with a sort order that includes multiple fields: name, value./
+      end
     end
-  end
-  context 'with data' do
-    before :each do
-      10.times do |i|
-        Mongoid.default_session['feed_items'].insert(
-          a_string: i.to_s,
-          a_integer: i,
-          a_datetime: DateTime.mongoize(DateTime.new(2013, i + 1, 21, 1, 42, 3, 'UTC')),
-          a_date: Date.mongoize(Date.new(2013, i + 1, 21)),
-          a_time: Time.mongoize(Time.at(Time.now.to_i + i))
-        )
+    context 'with no sort' do
+      subject do
+        Mongoid.default_session['feed_items'].find
+      end
+      it 'adds a default sort by _id' do
+        expect(subject.scroll.operation.selector['$orderby']).to eq(_id: 1)
       end
     end
-    context 'default' do
-      it 'scrolls all' do
-        records = []
-        Mongoid.default_session['feed_items'].find.scroll do |record, _next_cursor|
-          records << record
+    context 'with data' do
+      before :each do
+        10.times do |i|
+          Mongoid.default_session['feed_items'].insert(
+            a_string: i.to_s,
+            a_integer: i,
+            a_datetime: DateTime.mongoize(DateTime.new(2013, i + 1, 21, 1, 42, 3, 'UTC')),
+            a_date: Date.mongoize(Date.new(2013, i + 1, 21)),
+            a_time: Time.mongoize(Time.at(Time.now.to_i + i))
+          )
         end
-        expect(records.size).to eq 10
-        expect(records).to eq Mongoid.default_session['feed_items'].find.to_a
       end
-    end
-    { a_string: String, a_integer: Integer, a_date: Date, a_datetime: DateTime }.each_pair do |field_name, field_type|
-      context field_type do
-        it 'scrolls all with a block' do
+      context 'default' do
+        it 'scrolls all' do
           records = []
-          Mongoid.default_session['feed_items'].find.sort(field_name => 1).scroll(nil, field_type: field_type) do |record, _next_cursor|
+          Mongoid.default_session['feed_items'].find.scroll do |record, _next_cursor|
             records << record
           end
           expect(records.size).to eq 10
           expect(records).to eq Mongoid.default_session['feed_items'].find.to_a
         end
-        it 'scrolls all with a break' do
+      end
+      { a_string: String, a_integer: Integer, a_date: Date, a_datetime: DateTime }.each_pair do |field_name, field_type|
+        context field_type do
+          it 'scrolls all with a block' do
+            records = []
+            Mongoid.default_session['feed_items'].find.sort(field_name => 1).scroll(nil, field_type: field_type) do |record, _next_cursor|
+              records << record
+            end
+            expect(records.size).to eq 10
+            expect(records).to eq Mongoid.default_session['feed_items'].find.to_a
+          end
+          it 'scrolls all with a break' do
+            records = []
+            cursor = nil
+            Mongoid.default_session['feed_items'].find.sort(field_name => 1).limit(5).scroll(nil, field_type: field_type) do |record, next_cursor|
+              records << record
+              cursor = next_cursor
+            end
+            expect(records.size).to eq 5
+            Mongoid.default_session['feed_items'].find.sort(field_name => 1).scroll(cursor, field_type: field_type) do |record, next_cursor|
+              records << record
+              cursor = next_cursor
+            end
+            expect(records.size).to eq 10
+            expect(records).to eq Mongoid.default_session['feed_items'].find.to_a
+          end
+          it 'scrolls in descending order' do
+            records = []
+            Mongoid.default_session['feed_items'].find.sort(field_name => -1).limit(3).scroll(nil, field_type: field_type, field_name: field_name) do |record, _next_cursor|
+              records << record
+            end
+            expect(records.size).to eq 3
+            expect(records).to eq Mongoid.default_session['feed_items'].find.sort(field_name => -1).limit(3).to_a
+          end
+          it 'map' do
+            record = Mongoid.default_session['feed_items'].find.limit(3).scroll(nil, field_type: field_type, field_name: field_name).map { |r| r }.last
+            cursor = Mongoid::Scroll::Cursor.from_record(record, field_type: field_type, field_name: field_name)
+            expect(cursor).to_not be nil
+            expect(cursor.to_s.split(':')).to eq [
+              Mongoid::Scroll::Cursor.transform_field_value(field_type, field_name, record[field_name.to_s]).to_s,
+              record['_id'].to_s
+            ]
+          end
+        end
+      end
+    end
+    context 'with overlapping data', if: MongoDB.mmapv1? do
+      before :each do
+        3.times { Feed::Item.create! a_integer: 5 }
+        Feed::Item.first.update_attributes!(name: Array(1000).join('a'))
+      end
+      it 'natural order is different from order by id' do
+        # natural order isn't necessarily going to be the same as _id order
+        # if a document is updated and grows in size, it may need to be relocated and
+        # thus cause the natural order to change
+        expect(Feed::Item.order_by('$natural' => 1).to_a).to_not eq Feed::Item.order_by(_id: 1).to_a
+      end
+      [{ a_integer: 1 }, { a_integer: -1 }].each do |sort_order|
+        it "scrolls by #{sort_order}" do
           records = []
           cursor = nil
-          Mongoid.default_session['feed_items'].find.sort(field_name => 1).limit(5).scroll(nil, field_type: field_type) do |record, next_cursor|
+          Mongoid.default_session['feed_items'].find.sort(sort_order).limit(2).scroll do |record, next_cursor|
             records << record
             cursor = next_cursor
           end
-          expect(records.size).to eq 5
-          Mongoid.default_session['feed_items'].find.sort(field_name => 1).scroll(cursor, field_type: field_type) do |record, next_cursor|
-            records << record
-            cursor = next_cursor
-          end
-          expect(records.size).to eq 10
-          expect(records).to eq Mongoid.default_session['feed_items'].find.to_a
-        end
-        it 'scrolls in descending order' do
-          records = []
-          Mongoid.default_session['feed_items'].find.sort(field_name => -1).limit(3).scroll(nil, field_type: field_type, field_name: field_name) do |record, _next_cursor|
+          expect(records.size).to eq 2
+          Mongoid.default_session['feed_items'].find.sort(sort_order).scroll(cursor) do |record, _next_cursor|
             records << record
           end
           expect(records.size).to eq 3
-          expect(records).to eq Mongoid.default_session['feed_items'].find.sort(field_name => -1).limit(3).to_a
-        end
-        it 'map' do
-          record = Mongoid.default_session['feed_items'].find.limit(3).scroll(nil, field_type: field_type, field_name: field_name).map { |r| r }.last
-          cursor = Mongoid::Scroll::Cursor.from_record(record, field_type: field_type, field_name: field_name)
-          expect(cursor).to_not be nil
-          expect(cursor.to_s.split(':')).to eq [
-            Mongoid::Scroll::Cursor.transform_field_value(field_type, field_name, record[field_name.to_s]).to_s,
-            record['_id'].to_s
-          ]
-        end
-      end
-    end
-  end
-  context 'with overlapping data' do
-    before :each do
-      3.times { Feed::Item.create! a_integer: 5 }
-      Feed::Item.first.update_attributes!(name: Array(1000).join('a'))
-    end
-    it 'natural order is different from order by id' do
-      # natural order isn't necessarily going to be the same as _id order
-      # if a document is updated and grows in size, it may need to be relocated and
-      # thus cause the natural order to change
-      expect(Feed::Item.order_by('$natural' => 1).to_a).to_not eq Feed::Item.order_by(_id: 1).to_a
-    end
-    [{ a_integer: 1 }, { a_integer: -1 }].each do |sort_order|
-      it "scrolls by #{sort_order}" do
-        records = []
-        cursor = nil
-        Mongoid.default_session['feed_items'].find.sort(sort_order).limit(2).scroll do |record, next_cursor|
-          records << record
-          cursor = next_cursor
-        end
-        expect(records.size).to eq 2
-        Mongoid.default_session['feed_items'].find.sort(sort_order).scroll(cursor) do |record, _next_cursor|
-          records << record
+          expect(records).to eq Mongoid.default_session['feed_items'].find.sort(sort_order.merge(_id: sort_order[:a_integer])).to_a
         end
-        expect(records.size).to eq 3
-        expect(records).to eq Mongoid.default_session['feed_items'].find.sort(sort_order.merge(_id: sort_order[:a_integer])).to_a
       end
     end
   end
-end if Object.const_defined?(:Moped)
+end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rubygems'
 require 'rspec'
 require 'rspec/its'
+require 'database_cleaner'
 require 'mongoid-scroll'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each do |f|
@@ -17,9 +18,9 @@ end
 RSpec.configure do |config|
   config.before :all do
     Mongoid.logger.level = Logger::INFO
-    Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
+    Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5? || Mongoid::Compatibility::Version.mongoid6?
   end
   config.before :each do
-    Mongoid.purge!
+    DatabaseCleaner.clean
   end
 end

data/spec/support/feed/item.rb

@@ -10,6 +10,10 @@ module Feed
     field :a_time, type: Time
     field :a_array, type: Array
 
-    embeds_many :embedded_items
+    embeds_many :embedded_items, class_name: 'Feed::EmbeddedItem'
+
+    publisher_options = { class_name: 'Feed::Publisher' }
+    publisher_options[:optional] = true if Mongoid::Compatibility::Version.mongoid6? || Mongoid::Compatibility::Version.mongoid7?
+    belongs_to :publisher, publisher_options
   end
 end

data/spec/support/feed/publisher.rb

@@ -0,0 +1,9 @@
+module Feed
+  class Publisher
+    include Mongoid::Document
+
+    field :name, type: String
+
+    has_many :items
+  end
+end

data/spec/support/mongodb.rb

@@ -0,0 +1,9 @@
+module MongoDB
+  def self.mmapv1?
+    if Mongoid.respond_to?(:default_session)
+      Mongoid.default_session.command(serverStatus: 1)['storageEngine']['name'] == 'mmapv1'
+    else
+      Mongoid.default_client.command(serverStatus: 1).first['storageEngine']['name'] == 'mmapv1'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-scroll
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Daniel Doubrovkine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -77,7 +77,7 @@ files:
 - lib/config/locales/en.yml
 - lib/mongo/scrollable.rb
 - lib/mongoid-scroll.rb
-- lib/mongoid/criterion/scrollable.rb
+- lib/mongoid/criteria/scrollable.rb
 - lib/mongoid/scroll/cursor.rb
 - lib/mongoid/scroll/errors.rb
 - lib/mongoid/scroll/errors/base.rb
@@ -97,6 +97,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/feed/embedded_item.rb
 - spec/support/feed/item.rb
+- spec/support/feed/publisher.rb
+- spec/support/mongodb.rb
 homepage: http://github.com/mongoid/mongoid-scroll
 licenses:
 - MIT
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Mongoid extensions to enable infinite scroll.

data/lib/mongoid/criterion/scrollable.rb

@@ -1,35 +0,0 @@
-module Mongoid
-  module Criterion
-    module Scrollable
-      def scroll(cursor = nil, &_block)
-        criteria = self
-        # we don't support scrolling over a criteria with multiple fields
-        if criteria.options[:sort] && criteria.options[:sort].keys.size != 1
-          raise Mongoid::Scroll::Errors::MultipleSortFieldsError.new(sort: criteria.options[:sort])
-        elsif !criteria.options.key?(:sort) || criteria.options[:sort].empty?
-          # introduce a default sort order if there's none
-          criteria = criteria.asc(:_id)
-        end
-        # scroll field and direction
-        scroll_field = criteria.options[:sort].keys.first
-        scroll_direction = criteria.options[:sort].values.first.to_i
-        # scroll cursor from the parameter, with value and tiebreak_id
-        field = criteria.klass.fields[scroll_field.to_s]
-        cursor_options = { field_type: field.type, field_name: scroll_field, direction: scroll_direction }
-        cursor = cursor.is_a?(Mongoid::Scroll::Cursor) ? cursor : Mongoid::Scroll::Cursor.new(cursor, cursor_options)
-        # scroll
-        if block_given?
-          cursor_criteria = criteria.dup
-          cursor_criteria.selector = { '$and' => [criteria.selector, cursor.criteria] }
-          cursor_criteria.order_by(_id: scroll_direction).each do |record|
-            yield record, Mongoid::Scroll::Cursor.from_record(record, cursor_options)
-          end
-        else
-          criteria
-        end
-      end
-    end
-  end
-end
-
-Mongoid::Criteria.send(:include, Mongoid::Criterion::Scrollable)