mongo-fixture 0.0.5 → 0.1.0

data/README.md

@@ -2,7 +2,7 @@ Mongo::Fixture
 ===============
 [![Build Status](https://secure.travis-ci.org/Fetcher/mongo-fixture.png)](http://travis-ci.org/Fetcher/mongo-fixture) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Fetcher/mongo-fixture)
 
-Just like Rails 2 fixtures, but for [MongoDB][mongo-db] (using the standard [mongo connector Gem][mongo-gem] ).
+Similar to Rails 2 fixtures, but for [MongoDB][mongo-db] (using the standard [mongo connector Gem][mongo-gem] ).
 
 [mongo-db]: http://www.mongodb.org/
 [mongo-gem]: http://rubygems.org/gems/mongo
@@ -10,6 +10,39 @@ Just like Rails 2 fixtures, but for [MongoDB][mongo-db] (using the standard [mon
 Show off
 ========
 
+### Single collection 
+
+Assuming you have a fixture for the collection `messages` with:
+```yaml
+# test/fixtures/some_data/messages.yaml
+yesterday_afternoon:
+  text: Honey, pizza tonight?
+  sent: 2012-09-11
+today_morning:
+  text: Nice date yesterday, how about next week?
+  sent: 2012-09-12
+```
+
+You can write a brief ruby script and insert the data into your mongo db:
+```ruby
+require 'mongo'
+require 'mongo-fixture'
+
+DB = Mongo::Connection.new.db 'messages-db' # An example connetion setup
+
+# Insert the fixture into the database
+fixture_some_data = Mongo::Fixture.new :some_data, DB
+
+# You can now query the fixture for the data that was sent into the DB
+fixture_some_data.messages.yesterday_afternoon.text # => "Honey, pizza tonight?"
+```
+
+The fixture is identified by the name of the folder containing the fixture YAML files. The default folder is `test/fixtures`.
+
+As you can see, each record is preceded by a name, in this case `yesterday_afternoon` and `today_morning`. This names never get inserted into the database, they are just references for making it easier to access the fixture's information.
+
+### Associations
+
 Assuming you have a fixture for the collection users with:
 ```yaml
 # test/fixtures/simple/users.yaml
@@ -27,16 +60,31 @@ and for messages:
 ```yaml
 # test/fixtures/simple/messages.yaml
 greeting:
-  sender_id: 1
-  receiver_id: 2
+  sender:
+    users: john
+  receiver:
+    users: jane
   text: Hi Jane! Long time no see.
 long_time:
-  sender_id: 2
-  receiver_id: 1
+  sender:
+    users: jane
+  receiver:
+    users: john
   text: John! Long time indeed. How are you doing?
 ```
 
-and the ruby script
+Mongo Fixture will automatically insert the object id (`_id` field in the database) for the referenced users. The Mongo Fixture syntax specifies that:
+
+```yaml
+  sender:
+    users: john
+```
+
+is a reference to the record named `john` in the collection `users`.
+
+> Currently Mongo Fixture does not support references from one collection to another _and back_ from that collection to the first one.
+
+For example given the ruby script:
 
 ```ruby
 # script.rb
@@ -54,7 +102,7 @@ fixture.users.john.name     # => "John"
 fixture.rollback            # returns users and messages to pristine status (#drop)
 
 
-fixture = Mongo::Fixture.new :simple, DB, false    # The `false` flag prevent the constructor to automatically push
+fixture = Mongo::Fixture.new :simple, DB, false    # The `false` flag prevent the constructor from automatically pushing
                                                    # the fixture into the database
                                                     
 fixture.check               # Will fail if the user or messages collection
@@ -68,7 +116,29 @@ fixture.rollback            # Don't forget to rollback
 
 ...naturally, `mongo-fixture` makes a lot more sense within some testing framework.
 
-> **Note**: As of version 0.0.1, the `test/fixtures` path for fixtures is not configurable. Will solve soon.
+### Many to many associations
+
+As is custom in Mongo, a many-to-many association is implemented by passing an array of ids to a field in any of the records to associate. Mongo Fixture supports this. For example:
+
+```yaml
+message:
+  sender:
+    users: john
+  receivers:
+    users: [mary, sue, harry, jack]
+  text: Meeting tonight guys?
+```
+
+will insert into the `receivers` field an array with the `_id`s of the referenced users.
+
+Changing fixtures directory
+---------------------------
+
+```ruby
+require 'mongo-fixture'
+
+Mongo::Fixture.path = 'fixtures' # Now fixtures will be required from `fixtures/`
+```
 
 Installation
 ------------
@@ -83,6 +153,10 @@ And then execute:
 
     bundle
 
+Future
+------
+
+- Dump from a database to fixtures! This would be awesome.
 
 ## License
 

data/features/stepdefs/configurable_fixtures_folder/the_folder_is_now_just_fixtures.rb

@@ -0,0 +1,3 @@
+When /^I set the fixtures path as "(.*?)"$/ do |path|
+  Mongo::Fixture.path = path
+end

data/features/support/hooks.rb

@@ -3,4 +3,5 @@ After do
     @DB[collection].drop
   end
   Fast.dir.remove! :test, :fixtures
-end
+  Mongo::Fixture.path = 'test/fixtures'
+end

data/lib/mongo-fixture.rb

@@ -12,11 +12,16 @@ module Mongo
   class Fixture
     ## Class methods
     
-    # Returns the current path to the fixtures folder
+    # @return [String] Returns the current path to the fixtures folder
     def self.path
       @@path ||= "test/fixtures"
     end
 
+    # Sets the current path to the fixtures folder
+    def self.path= the_path
+      @@path = the_path
+    end
+
     ## Instance methods
     
     # Initializes the fixture handler

data/lib/mongo-fixture/version.rb

@@ -1,5 +1,5 @@
 module Mongo
   class Fixture
-    VERSION = "0.0.5"
+    VERSION = "0.1.0"
   end
 end

data/spec/mongo/fixture/inserter_spec.rb

@@ -54,8 +54,7 @@ describe Mongo::Fixture::Inserter do
         fixture = double 'fixture', :data => {}, :rollback => nil
         ins = Mongo::Fixture::Inserter.new fixture
         expect { ins.simplify @base_hash
-        }.to raise_error Mongo::Fixture::ReferencedRecordNotFoundError, 
-          "This fixture does not include data for the collections [raw,not_processed]"
+        }.to raise_error Mongo::Fixture::ReferencedRecordNotFoundError
       end
 
       it "should call #resolve_field_hash with the data hash" do
@@ -332,8 +331,7 @@ describe Mongo::Fixture::Inserter do
           fixture = stub 'fixture', :data => { :collection => "", :another_collection => ""}
           inserter = Mongo::Fixture::Inserter.new fixture
           expect { inserter.resolve_field_hash data
-          }.to raise_error Mongo::Fixture::ReferencedRecordNotFoundError,
-            "This fixture does not include data for the collections [users,comments]"
+          }.to raise_error Mongo::Fixture::ReferencedRecordNotFoundError
         end
       end
     end

data/spec/mongo/fixture_spec.rb

@@ -7,6 +7,17 @@ describe Mongo::Fixture do
     end
   end
 
+  describe ".path=" do
+    it 'should set the path with the passed string' do
+      Mongo::Fixture.path = "fixtures"
+      Mongo::Fixture.path.should == "fixtures"
+    end
+
+    after do
+      Mongo::Fixture.path = 'test/fixtures'
+    end
+  end
+
   describe ".new" do
     context "a symbol is sent representing a fixture" do
       it "should call load" do  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo-fixture
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -91,6 +91,7 @@ files:
 - Rakefile
 - features/configurable_fixtures_folder.feature
 - features/play_around_with_fixtures.feature
+- features/stepdefs/configurable_fixtures_folder/the_folder_is_now_just_fixtures.rb
 - features/stepdefs/play_around_with_fixtures/background.rb
 - features/stepdefs/play_around_with_fixtures/create_a_simple_fixture_push_it_and_rollback.rb
 - features/stepdefs/play_around_with_fixtures/misconfigured_password_field.rb
@@ -115,27 +116,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -421222579
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -421222579
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Flexible fixtures for the MongoDB Gem inspired in Rails 2 fixtures
 test_files:
 - features/configurable_fixtures_folder.feature
 - features/play_around_with_fixtures.feature
+- features/stepdefs/configurable_fixtures_folder/the_folder_is_now_just_fixtures.rb
 - features/stepdefs/play_around_with_fixtures/background.rb
 - features/stepdefs/play_around_with_fixtures/create_a_simple_fixture_push_it_and_rollback.rb
 - features/stepdefs/play_around_with_fixtures/misconfigured_password_field.rb
@@ -144,3 +140,4 @@ test_files:
 - spec/mongo/fixture/inserter_spec.rb
 - spec/mongo/fixture_spec.rb
 - spec/spec_helper.rb
+has_rdoc: