mongoid-scroll 0.3.2 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 49f6957fe1cfab726fa346c141eb979487590912
-  data.tar.gz: e791fd49a8bf4aa187aaccb5222ada9f1e0dcf89
+SHA256:
+  metadata.gz: 976d59e1ce7d21c024936f21e58be085fa096260c8ee38b4c0d6f70d35145449
+  data.tar.gz: 389db57d4b31efa2114f9c3f5f86545f691a2db96de1d3aaad5ff995a0b02f45
 SHA512:
-  metadata.gz: 5cdf23a3ee65c76874d71ff8d78cb948c478e8f75b53cc930717493d2bc7ebc13b3787c06c4527eec197bd241b7b7ac4f62ca4ce5eb01cf67f56e54b2438a17b
-  data.tar.gz: 9606b19764c8aa3a578e1f7b7f278d9cc4f1ce1849aaa5de5804024dd9a7399b9a4d337febe88dea7f415692268ea1c171091ca6eff0bcc467f15f3f1799d7e3
+  metadata.gz: f4929b559f25512c5ebe9a66519f018e834a2678e60c4062047bbdeb466d87b1c99be3a23b157f1c331c61d39bb5627f2ff4eef13158c697596755adf9eea927
+  data.tar.gz: bd8df34a05b1861472d6710e96c58104af9f0873fffc6cbb4191c91d4eab2c42bb739c0c8a522a92d61eb8898f3ace07adbccd48b40396f2330831cb4c014426

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -1,57 +1,78 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-08-08 11:38:01 -0400 using RuboCop version 0.33.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: 5
+# Offense count: 6
+# Configuration parameters: Include.
+# Include: **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 6
 Metrics/AbcSize:
-  Max: 70
+  Max: 67
+
+# Offense count: 14
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 216
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 83
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 121
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
 Metrics/LineLength:
-  Max: 170
+  Max: 172
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 26
+  Max: 25
 
 # Offense count: 3
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 11
 
-# Offense count: 13
+# Offense count: 10
 Style/Documentation:
   Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
     - 'examples/mongoid_scroll_feed.rb'
-    - 'lib/mongoid/criterion/scrollable.rb'
+    - 'lib/mongo/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'
     - '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/mongoid/scroll/mongoid.rb'
-    - 'lib/mongoid/scroll/version.rb'
     - 'lib/moped/scrollable.rb'
-    - 'spec/support/feed/embedded_item.rb'
-    - 'spec/support/feed/item.rb'
 
 # Offense count: 1
-# Configuration parameters: Exclude.
+# 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: 6
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/moped/scrollable.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
+# SupportedStyles: compact, exploded
 Style/RaiseArgs:
   EnforcedStyle: compact

data/.travis.yml

@@ -1,18 +1,37 @@
 services:
   - mongodb
 
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
-  - jruby-19mode
-  - rbx-2
-
-env:
-  - MONGOID_VERSION=3
-  - MONGOID_VERSION=4
-  - MONGOID_VERSION=5.0.0.beta
-
 language: ruby
 
 cache: bundler
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+matrix:
+  include:
+    - rvm: 2.3.1
+      env: MONGOID_VERSION=3
+    - rvm: 2.3.1
+      env: MONGOID_VERSION=4
+    - rvm: 2.3.1
+      env: MONGOID_VERSION=5
+    - rvm: 2.3.1
+      env: MONGOID_VERSION=6
+    - rvm: 2.3.1
+      env: MONGOID_VERSION=7
+    - rvm: 2.3.1
+      env: MONGOID_VERSION=HEAD
+    - rvm: 2.3.1
+      script:
+        - bundle exec danger
+
+bundler_args: --without development
+
+addons:
+  apt:
+    sources:
+      - mongodb-3.4-precise
+    packages:
+      - mongodb-org-server

data/CHANGELOG.md

@@ -1,34 +1,50 @@
-0.3.2 (8/8/2015)
-----------------
+### 0.3.7 (2021/06/01)
 
-* [#7](https://github.com/dblock/mongoid-scroll/pull/7): Fix: pre-merge cursor criteria fields - [@sweir27](https://github.com/sweir27).
+* [#22](https://github.com/mongoid/mongoid-scroll/pull/22): Compatibility with Mongoid 7 - [@asgerb](https://github.com/asgerb).
 
-0.3.1 (7/27/2015)
------------------
+### 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)
+
+* 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)
+
+* Compatibility with Mongoid 5 - [@dblock](https://github.com/dblock).
+
+### 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)
 
 * Compatibility with Mongoid 5.x beta - [@dblock](https://github.com/dblock).
-* [#4](https://github.com/dblock/mongoid-scroll/pull/4): Fix: support chaining `$or` criteria - [@sweir27](https://github.com/sweir27).
-* [#5](https://github.com/dblock/mongoid-scroll/pull/5): Fix: embeddable objects now returned in pagination - [@sweir27](https://github.com/sweir27).
+* [#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 (1/7/2014)
-----------------
+### 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 (3/21/2013)
------------------
+### 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 (3/14/2013)
------------------
+### 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 (2/14/2013)
------------------
+### 0.1.0 (2013/2/14)
 
 * Initial public release, extends `Mongoid::Criteria` with `scroll` - [@dblock](https://github.com/dblock).
-

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(gem: 'mongoid-danger')

data/Gemfile

@@ -2,20 +2,23 @@ source 'http://rubygems.org'
 
 gemspec
 
-case version = ENV['MONGOID_VERSION'] || '~> 4.0'
-when /4/
-  gem 'mongoid', '~> 4.0'
-when /3/
-  gem 'mongoid', '~> 3.1'
-else
-  gem 'mongoid', version
+case version = ENV['MONGOID_VERSION'] || '~> 7.0'
+when 'HEAD' then gem 'mongoid', github: 'mongodb/mongoid'
+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
 end
 
 group :development, :test do
-  gem 'rake'
   gem 'bundler'
+  gem 'database_cleaner', '~> 1.8.5'
+  gem 'faker'
+  gem 'mongoid-danger', '~> 0.1.0', require: false
+  gem 'rake'
   gem 'rspec', '~> 3.0'
   gem 'rspec-its'
-  gem 'faker'
-  gem 'rubocop', '0.33.0'
+  gem 'rubocop', '0.49.1'
 end

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2012 Daniel Doubrovkine, Artsy Inc.
+Copyright (c) 2013-2015 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,18 +1,17 @@
 Mongoid::Scroll
 ===============
 
-[![Gem Version](http://img.shields.io/gem/v/mongoid-scroll.svg)](http://badge.fury.io/rb/mongoid-scroll)
-[![Build Status](http://img.shields.io/travis/dblock/mongoid-scroll.svg)](https://travis-ci.org/dblock/mongoid-scroll)
-[![Dependency Status](https://gemnasium.com/dblock/mongoid-scroll.svg)](https://gemnasium.com/dblock/mongoid-scroll)
-[![Code Climate](https://codeclimate.com/github/dblock/mongoid-scroll.svg)](https://codeclimate.com/github/dblock/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)
+[![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` and `Moped::Query`.
+Mongoid extension that enables infinite scrolling for `Mongoid::Criteria`, `Moped::Query` and `Mongo::Collection::View`.
 
 Compatibility
 -------------
 
-This gem supports Mongoid 3, 4 and 5 beta.
+This gem supports Mongoid 3, 4, 5, 6, 7, Moped and Mongo-Ruby-Driver.
 
 Demo
 ----
@@ -85,9 +84,9 @@ Feed::Item.desc(:position).scroll(saved_cursor) do |record, next_cursor|
 end
 ```
 
-### Moped
+### Moped (Mongoid 3 and 4)
 
-Scroll and save a cursor to the last item. You must also supply a `field_type` of the sort criteria.
+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
@@ -106,6 +105,27 @@ session[:feed_items].find.sort(position: -1).limit(5).scroll(saved_cursor, { fie
 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.
+
+```ruby
+saved_cursor = nil
+client[: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
+```
+
 Indexes and Performance
 -----------------------
 
@@ -164,6 +184,6 @@ Fork the project. Make your feature addition or bug fix with tests. Send a pull
 Copyright and License
 ---------------------
 
-MIT License, see [LICENSE](http://github.com/dblock/mongoid-scroll/raw/master/LICENSE.md) for details.
+MIT License, see [LICENSE](http://github.com/mongoid/mongoid-scroll/raw/master/LICENSE.md) for details.
 
-(c) 2013 [Daniel Doubrovkine](http://github.com/dblock), based on code by [Frank Macreery](http://github.com/macreery), [Artsy Inc.](http://artsy.net)
+(c) 2013-2015 [Daniel Doubrovkine](http://github.com/dblock), based on code by [Frank Macreery](http://github.com/macreery), [Artsy Inc.](http://artsy.net)

data/RELEASING.md

@@ -0,0 +1,67 @@
+Releasing Mongoid::Scroll
+=========================
+
+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
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/mongoid/mongoid-scroll) for all supported platforms.
+
+Increment the version, modify [lib/mongoid/scroll/version.rb](lib/mongoid/scroll/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.4.1` to `0.4.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.4.1` to `0.5.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.4.0 (2018/12/24)
+```
+
+Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid-scroll/version.rb
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+mongoid-scroll 0.4.0 built to pkg/mongoid-scroll-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed mongoid-scroll 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.4.1 (Next)
+
+* Your contribution here.
+```
+
+Increment the minor version, modify [lib/mongoid-scroll/version.rb](lib/mongoid-scroll/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid-scroll/version.rb
+git commit -m "Preparing for next release, 0.4.1."
+git push origin master
+```

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/examples/mongo_ruby_driver_scroll_feed.rb

@@ -0,0 +1,45 @@
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'mongoid-scroll'
+require 'faker'
+
+raise 'No Mongo Ruby Driver' unless Object.const_defined?(:Mongo)
+
+Mongo::Logger.logger = Logger.new($stdout)
+Mongo::Logger.logger.level = Logger::INFO
+
+Mongoid.connect_to 'mongoid_scroll_demo'
+Mongoid.purge!
+
+# total items to insert
+total_items = 20
+# a MongoDB query will be executed every scroll_by items
+scroll_by = 7
+
+# insert items with a position out-of-order
+rands = (0..total_items).to_a.sort { rand }[0..total_items]
+total_items.times do
+  Mongoid.default_client['feed_items'].insert_one(title: Faker::Lorem.sentence, position: rands.pop)
+end
+
+Mongoid.default_client['feed_items'].indexes.create_one(position: 1, _id: 1)
+
+total_shown = 0
+next_cursor = nil
+loop do
+  current_cursor = next_cursor
+  next_cursor = nil
+  Mongoid.default_client['feed_items'].find.limit(scroll_by).sort(position: 1).scroll(current_cursor, field_type: Integer, field_name: 'position') do |item, cursor|
+    puts "#{item['position']}: #{item['title']}"
+    next_cursor = cursor
+    total_shown += 1
+  end
+  break unless next_cursor
+  # destroy an item just for the heck of it, scroll is not affected
+  item = Mongoid.default_client['feed_items'].find.sort(position: 1).first
+  Mongoid.default_client['feed_items'].find(_id: item['_id']).delete_one
+end
+
+# this will be 20
+puts "Shown #{total_shown} items."