MongoidCleaner is an alternative for DatabaseCleaner
for projects using MongoDB along with Mongoid.
Besides the truncate
strategy, this gem also provides faster drop
strategy.
DatabaseCleaner always served our needs well, unfortunately it didn't support MongoDB 3 running on Wired Tiger for quite some time, so we decided to build our own specialised solution.
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.
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.
Add this line to your application's Gemfile:
gem 'mongoid_cleaner'
And then execute:
$ bundle
Or install it yourself as:
$ gem install mongoid_cleaner
With rspec:
RSpec.configure do |config|
config.before(:suite) do
MongoidCleaner.strategy = :drop
end
config.around(:each) do |example|
MongoidCleaner.cleaning do
example.run
end
end
end
Without rspec:
MongoidCleaner.strategy = 'drop', { only: %w(users) }
MongoidCleaner.clean
# dirty mongo
MongoidCleaner.strategy = 'truncate', { except: %w(users) }
MongoidCleaner.clean
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Unit testing:
bundle exec rake test
Code style:
bundle exec rubocop
- Fork it ( https://github.com/td-berlin/mongoid_cleaner/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request