mongoid_cleaner 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdc85738b916058da39a76bb73892bafd80e3c58
-  data.tar.gz: 2e37d7083ae4c4eb0d9ff567197c71bed6a5defe
+  metadata.gz: 0d8c7375290440e533630aba4b66a36217cd933b
+  data.tar.gz: a74702cb43805411e46c4b3f681d383e0f7b6bb9
 SHA512:
-  metadata.gz: eaf57c59b37c224831b08daeba6bf308a4d8f2f46599fce644567b5f68824cef628d0439d30f4773f5ca9da451143366ee598593e120b7b82ffba92b902f0369
-  data.tar.gz: 47c7a47d4244a2af40f6e2c95d0b65bf2cf14e49d6fae34142399ec6d2d796bc4f2c953d4f40775d53d7a25292774843c75d233773de90af05b2eb1c34eb9dbc
+  metadata.gz: 6f57547909b9fa0bc81f0529b7679f56dc454a9e0724a32caca262e7d4325fa7012410cb9c2f597e994ae6e7286dc51c7fbfe5bf12a22842436dd325e24aa376
+  data.tar.gz: b6ff6fcc604dfd3fc398f078e016af7b42477cfbd2e165411f264ac69e84077b48f18447917a01a165ca8a9cb148f84667fbea344f7e9bf014d586dcf92449ee

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  Exclude:
+    - '**/vendor/**/*'

data/.travis.yml

@@ -4,6 +4,9 @@ cache:
   - bundler
 before_install:
   - gem update --remote bundler
+gemfile:
+  - gemfiles/mongoid4.gemfile
+  - gemfiles/mongoid5.gemfile
 env:
   matrix:
     - MONGODB=3.0.3 CONFIG="--config /tmp/mongodb-wiredtiger.conf"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+Mon Oct 19 18:30:13 2015 +0200 Laurent Arnoud <laurent.arnoud@td-berlin.com>
+
+* Mongoid 5 compatibility, thanks to: Maik Kempe <mkempe@bitaculous.com>

data/README.md

@@ -1,16 +1,23 @@
 # MongoidCleaner
+[![Build Status](https://travis-ci.org/td-berlin/mongoid_cleaner.svg)](https://travis-ci.org/td-berlin/mongoid_cleaner)
 
-![Build Status](https://magnum.travis-ci.com/td-berlin/mongoid_cleaner.svg?token=1Pjyqv334JwTadXqcays&branch=master)
+MongoidCleaner is an alternative for [DatabaseCleaner](https://github.com/DatabaseCleaner/database_cleaner)
+for projects using [MongoDB](https://www.mongodb.org/) along with [Mongoid](http://mongoid.org/en/mongoid/index.html).
+Besides the `truncate` strategy, this gem also provides faster `drop` strategy. It runs with Mongoid versions 4 and 5.
 
-MongoidCleaner with drop and truncation strategy
 
 ## Why?
 
-* [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner) exists
-but it don't support [MongoDB 3](https://github.com/DatabaseCleaner/database_cleaner/issues/348).
+DatabaseCleaner always served our needs well, unfortunately it didn't support [MongoDB 3 running on Wired Tiger](https://github.com/DatabaseCleaner/database_cleaner/pull/343)
+for quite some time, so we decided to build our own specialised solution.
 
-* Also we discovered that droping collection is more faster than truncation
-  strategy.
+Also, removing all the documents from a collection requires much more work: Freeing the document's storage, clearing the index entries that point to the document, etc..
+The benefit of simply dropping a collection is that it is much faster.
+
+## Possible drawbacks
+
+We haven't experienced any problems so far, but dropping a collection will also remove the collections indexes.
+Feel free to report any issues related to that.
 
 ## Installation
 

data/gemfiles/mongoid4.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'mongoid', '~> 4'
+
+gemspec path: "../"

data/gemfiles/mongoid5.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'mongoid', '~> 5'
+
+gemspec path: "../"

data/lib/mongoid_cleaner/version.rb

@@ -1,4 +1,4 @@
 # :nodoc:
 module MongoidCleaner
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/mongoid_cleaner.rb

@@ -8,6 +8,10 @@ module MongoidCleaner
   class << self
     attr_reader :strategy
 
+    def mongoid_version
+      @mongoid_version ||= Mongoid::VERSION.split('.').first.to_i
+    end
+
     def available_strategies
       @available_strategies ||= %w(truncate drop)
     end
@@ -28,14 +32,24 @@ module MongoidCleaner
       @session ||= Mongoid.default_session
     end
 
-    # @return Array mongoid collections
-    def collections
+    # return with mongoid 5 `Mongo::Operation::Result`
+    # return with mongoid 4 `BSON::Document`
+    def collections_filter
       session.command(
         listCollections: 1,
         filter: {
           name:
           { '$not' => /.?system\.|\$/ }
-        })['cursor']['firstBatch'].map { |c| c['name'] }
+        })
+    end
+
+    # @return Array mongoid collections names
+    def collections
+      if mongoid_version > 4
+        collections_filter.first[:cursor][:firstBatch].map { |c| c['name'] }
+      else
+        collections_filter['cursor']['firstBatch'].map { |c| c['name'] }
+      end
     end
 
     def collections_with_options
@@ -56,7 +70,11 @@ module MongoidCleaner
 
     # @return Boolean
     def truncate
-      collections_with_options.each { |c| session[c].find.remove_all }
+      if mongoid_version > 4
+        collections_with_options.each { |c| session[c].find.delete_many }
+      else
+        collections_with_options.each { |c| session[c].find.remove_all }
+      end
       true
     end
 

data/mongoid_cleaner.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '~> 0.31'
-  spec.add_dependency 'mongoid', '~> 4.0'
+  spec.add_dependency 'mongoid', '>= 4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_cleaner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - TD Dashboys
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,14 @@ dependencies:
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 description: 
@@ -74,12 +74,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - configs/mongodb-wiredtiger.conf
+- gemfiles/mongoid4.gemfile
+- gemfiles/mongoid5.gemfile
 - lib/mongoid_cleaner.rb
 - lib/mongoid_cleaner/version.rb
 - mongoid_cleaner.gemspec
@@ -103,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: MongoidCleaner with drop and truncation strategy