mongo_populator 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-# 0.1.1 (September 15th, 2011)
+# 0.2.0 (September 14th, 2011)
+
+* an attribute set to nil (directly or randomly via an array) will not appear in the resulting document.
+
+# 0.1.1 (September 14th, 2011)
 
 * remove required minimum RubyGems version
 

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    mongo_populator (0.1.1)
+      mongo (~> 1.3.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bson (1.3.1)
+    diff-lcs (1.1.3)
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    mongo (1.3.1)
+      bson (>= 1.3.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.10.0)
+  mongo
+  mongo_populator!
+  rspec (~> 2.6.0)

data/README.md

@@ -15,7 +15,7 @@ This gem adds a "populate" method to a `Mongo::Collection`. Pass the number of d
 
     db = Mongo::Connection.new("localhost", 27017).db("test-db")    
     
-    article_collection = db.collection('article')
+    article_collection = db.collection('articles')
     article_collection.populate(100) do |article|
       article.title       = MongoPopulator.words(4..6).capitalize
       article.slug        = article.title.downcase.tr(' ','-')
@@ -24,9 +24,11 @@ This gem adds a "populate" method to a `Mongo::Collection`. Pass the number of d
       article.body        = MongoPopulator.paragraphs(5..7)
     end
 
+### Relationships
+
 Unlike the original Populator, we are letting MongoDB set each ObjectId. This makes setting up relationships only slightly more laborious.
 
-    article_collection = db.collection('article')
+    article_collection = db.collection('articles')
     article_collection.populate(100) do |article|
       ...
     end
@@ -40,14 +42,20 @@ Unlike the original Populator, we are letting MongoDB set each ObjectId. This ma
       comment.article = article_ids
     end
 
-That will create an average of 10 comments for each article. Embedded documents are not yet supported.
+That will create an average of 10 related comments for each article. 
+
+### Shuffle through set of values
 
 Passing a range or array of values will randomly select one.
 
+    ...
     person.gender = ['male', 'female']
+    ...
 
 This will create 1000 to 5000 men or women with the annual income between 10,000 and 200,000.
 
+### Fake values
+
 If you need to generate fake data, there are a few methods to do this.
 
     MongoPopulator.words(3) # generates 3 random words separated by spaces
@@ -57,12 +65,32 @@ If you need to generate fake data, there are a few methods to do this.
 
 For fancier data generation, try the [Faker gem](http://faker.rubyforge.org).
 
+### JSON-specific structures
+
 To persist arrays in your documents, use either #items to save a certain number of items randomly selected from a set, or #array to save a specific array.
 
     MongoPopulator.items(1..5, %w(ape bear cat dog elephant firefox)) # populates array with provided terms
     MongoPopulator.items(10..20) # populates array with random words
     MongoPopulator.array('red', 'green', 'blue') # saves `['red', 'green', 'blue']` exactly
 
+Setting an attribute to nil prevents that attribute being set. 
+
+    ...
+    address.state = nil if address.country != "United States"
+    ...
+
+So, to support conditional setting of an attribute, pass it an array with one or more nils as elements.
+
+    ...
+    user.creds = ['M.D.', 'J.D.', 'N.D.', nil, nil]  
+    ...
+
+~40% of users will not have credentials.
+
+## TODO
+
+* Support singular and multiple embedded documents
+
 ## Development
 
 Problems or questions? Add an [issue on GitHub](https://github.com/bak/mongo_populator/issues) or fork the project and send a pull request.

data/lib/mongo_populator/record.rb

@@ -19,7 +19,7 @@ module MongoPopulator
 
     def method_missing(sym, *args, &block)
       name = sym.to_s
-      if name.include? '='
+      if name.include?('=') && args.first
         @attributes[name.sub('=', '').to_sym] = MongoPopulator.interpret_value(args.first)
       else
         @attributes[sym]

data/spec/{README.rdoc → README.md}

@@ -1,5 +1,5 @@
-= Running Populator Specs
+# Running Populator Specs
 
 To run the specs, make sure you have mongo running on localhost port 27017, and
 
-  rake spec
+    rake spec

data/spec/mongo_populator/collection_additions_spec.rb

@@ -21,6 +21,13 @@ describe MongoPopulator::CollectionAdditions do
     @collection.distinct('name').last.should == "foo"
   end
 
+  it "should not set an attribute if passed nil" do
+    @collection.populate(1) do |record|
+      record.monkey = nil
+    end
+    @collection.distinct('monkey').should be_empty
+  end
+
   after(:each) do
     @collection.drop
   end

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: mongo_populator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
 - Benjamin Cullen-Kerney
-- Ryan Bates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-14 00:00:00.000000000Z
+date: 2011-09-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &70201274816400 !ruby/object:Gem::Requirement
+  requirement: &70136711178880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,10 @@ dependencies:
         version: 1.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *70201274816400
+  version_requirements: *70136711178880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70201274815720 !ruby/object:Gem::Requirement
+  requirement: &70136711178220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +32,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70201274815720
+  version_requirements: *70136711178220
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70201274815040 !ruby/object:Gem::Requirement
+  requirement: &70136711177400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +43,7 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *70201274815040
+  version_requirements: *70136711177400
 description: Mass populate MongoDB.
 email: ben.kerney -> gmail.com
 executables: []
@@ -61,10 +60,11 @@ files:
 - spec/mongo_populator/factory_spec.rb
 - spec/mongo_populator/random_spec.rb
 - spec/mongo_populator/record_spec.rb
-- spec/README.rdoc
+- spec/README.md
 - spec/spec_helper.rb
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - Rakefile
 - README.md
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongo_populator
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Mass populate MongoDB.