mongoid_seeder 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid_seeder (0.0.3)
+    mongoid_seeder (0.0.4)
       mixlib-config (~> 1.1)
       mongoid (~> 3.1)
       mongoid-shell (= 0.2.0)
@@ -27,7 +27,7 @@ GEM
       i18n
       mongoid
     moped (1.5.1)
-    multi_json (1.8.0)
+    multi_json (1.8.1)
     origin (1.1.0)
     rake (10.1.0)
     tzinfo (0.3.37)

data/README.md

@@ -1,6 +1,6 @@
 # MongoidSeeder
 
-TODO: Write a gem description
+Provides basic behavior to seed data while using Mongoid.
 
 ## Installation
 
@@ -18,7 +18,164 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Place an output of `mongodump` in `db/seed_data/`.  This will be used to seed your database.  *View the Custom Behavior section to learn how to override this path.*
+
+### Rake Task
+
+#### Rails
+
+In rails, add this to `db/seeds.rb` to bootstrap the default seed rake tasks:
+
+```ruby
+require 'mongoid_seeder'
+
+puts "Loading Seed Data"
+
+if some_condition_to_decide_to_seed_or_not
+  puts "Importing data at #{MongoidSeeder.db_path}\n"
+  MongoidSeeder.seed
+  puts "\nFinished.\n"
+else
+  puts "Data already exists, no need to seed."
+end
+```
+
+#### Ruby
+
+If you are not using rails, or would like more functionality with rake, add the following to `lib/tasks/db.rake`:
+
+```ruby
+namespace :db do
+  desc 'Seed the database'
+  task :seed => :prepare do
+    puts "Loading Seed Data"
+
+    if some_condition_to_decide_to_seed_or_not
+      MongoidSeeder.seed
+      puts "Importing data at #{MongoidSeeder.db_path}"
+    else
+      puts "Data already exists, no need to seed."
+    end
+  end
+
+  desc 'Drops the database'
+  task :drop => :prepare do
+    MongoidSeeder.drop
+  end
+
+  desc 'Dumps the database to the seed location'
+  task :dump => :prepare do
+    MongoidSeeder.dump
+    puts "Dumping data to #{MongoidSeeder.db_path}"
+  end
+
+  desc 'Drops db and seeds it'
+  task :reseed => [:drop, :seed]
+
+  task :prepare do
+    require 'mongoid_seeder'
+    # Do stuff to setup your app environment
+  end
+end
+```
+
+### Rspec
+
+Use within your rspec tests like so:
+
+```ruby
+require 'mongoid_seeder'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    MongoidSeeder.before_suite
+  end
+
+  config.before(:each) do
+    MongoidSeeder.before_each
+  end
+
+  config.after(:each) do
+    MongoidSeeder.after_each
+  end
+
+  config.after(:suite) do
+    MongoidSeeder.after_suite
+  end
+end
+```
+
+### Cucumber
+
+```ruby
+require 'mongoid_seeder'
+
+Before do
+  MongoidSeeder.before_suite unless @cucumber_started # Only happen once
+  @cucumber_started = true
+  MongoidSeeder.before_each
+end
+
+After do
+  MongoidSeeder.after_each
+end
+
+at_exit do
+  MongoidSeeder.after_suite
+end
+```
+
+## Default Behavior
+
+By default these methods run the following:
+
+Method | Default Behavior
+---|---
+`before_suite` | Seeds the database
+`before_each` | no-op
+`after_each` | no-op
+`after_suite` | Drops the database
+
+## Custom Behavior
+
+### Bootstrapping the mongoid seeder
+
+To bootstrap the seeder with custom configuration, place all configuration in a file located at `config/mongoid_seeder.rb`.  This file will be loaded when the seeder is ran if it exists.
+
+### DB Path
+
+You can configure the location where the seed data is stored by doing the following:
+
+```ruby
+require_relative '../config/environment'
+
+MongoidSeeder::Config.seed_dir = "/path/to/my/seeds"
+```
+
+You may want to do this if you want to use different sets of seed data for different environments.
+
+### Callback Methods
+
+*The default behavior cannot be overridden, you can only prepend to the behavior*
+
+This means that you can add additional steps to be ran for each method if you would like.
+
+```
+MongoidSeeder::Config.before_suite = -> do
+  MyApp.load_env
+end
+
+# Must use old lambda syntax because of the argument
+# This will drop all collections that includes "v2" in the collection name
+# after each test is ran
+MongoidSeeder::Config.condition_to_drop_collection = lambda do |a|
+  a.name.include?('v2')
+end
+```
+
+## Owners
+
+Developed by [@coffeencoke](http://github.com/coffeencoke), [@dcameronmauch](http://github.com/dcameronmauch), devs on a team at [Asynchrony](http://asynchrony.com).
 
 ## Contributing
 

data/lib/mongoid_seeder.rb

@@ -47,6 +47,6 @@ module MongoidSeeder
   end
 
   def self.after_tests
-    Mongoid.session(:default).collections.select{|a| Config.condition_to_drop_collection.call(a) }.each(&:drop)
+    Mongoid.session(:default).collections.select{|a| Config.condition_to_drop_collection.call(a) }.each{|a| a.where.remove_all }
   end
 end

data/lib/mongoid_seeder/version.rb

@@ -1,3 +1,3 @@
 module MongoidSeeder
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_seeder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -951118916329851109
+      hash: 4468195172537555349
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -951118916329851109
+      hash: 4468195172537555349
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25