document_hydrator 0.1.0 → 0.1.1

data/HISTORY.markdown

@@ -0,0 +1,5 @@
+# Version 0.1.1
+- Bug fix: handle nil object IDs
+
+# Version 0.1.0
+- Initial release

data/README.markdown

@@ -12,6 +12,21 @@ guaranteed to be called at most once during any given invocation of
 DocumentHydrator, ensuring efficient hydration of multiple
 subdocuments.
 
+## Installation
+Install the gem:
+
+    gem install document_hydrator
+
+Require the library:
+
+    require 'document_hydrator'
+
+If you want to use the optional MongoDB collection hydrator, make
+sure you require the MongoDB driver first:
+
+    require 'mongo'
+    require 'document_hydrator'
+
 ## Hydration Procs
 Hydration procs are responsible for transforming an array of document
 references into a hash that maps those references to their

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/document_hydrator.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{document_hydrator}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Greg Spurrier"]
-  s.date = %q{2011-06-19}
+  s.date = %q{2011-10-03}
   s.description = %q{DocumentHydrator takes a document, represented as a Ruby Hash, and efficiently updates it so that embedded references to other documents are replaced with their corresponding subdocuments.}
   s.email = %q{greg.spurrier@gmail.com}
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".autotest",
     ".rspec",
     "Gemfile",
+    "HISTORY.markdown",
     "LICENSE.txt",
     "README.markdown",
     "Rakefile",

data/lib/document_hydrator.rb

@@ -64,11 +64,15 @@ module DocumentHydrator
             step = step.sub(/_id(s?)$/, '')
             step = Inflector.pluralize(step) if $1 == 's'
           end
-          if subdocument.kind_of?(Array)
-            document[step] = subdocument.map {|id| dehydrated_documents[id] }
-          else
-            document[step] = dehydrated_documents[subdocument]
-          end
+          document[step] =
+            case subdocument
+            when Array
+              subdocument.map {|id| dehydrated_documents[id] }
+            when nil
+              nil
+            else
+              dehydrated_documents[subdocument]
+            end
         else
           # Keep on stepping
           if subdocument.kind_of?(Array)

data/spec/document_hydrator_spec.rb

@@ -18,7 +18,7 @@ describe DocumentHydrator do
       end
     end
   end
-  
+
   before(:each) do
     Dummy.reset_invocation_count
     @hydration_proc = lambda { |ids| Dummy.ids_to_document_hash(ids) }
@@ -51,6 +51,13 @@ describe DocumentHydrator do
       end
     end
 
+    context 'with a nil id' do
+      it 'leaves the id as nil' do
+        orig = { 'key1' => 37, 'user' => nil}
+        DocumentHydrator.hydrate_document(orig.dup, 'user', @hydration_proc).should == orig
+      end
+    end
+
     context 'with a compound path to an array of ids' do
       it 'replaces the array with an array of hydrated documents' do
         orig = { 'key1' => 37, 'foo' => { 'users' => [27, 39] } }
@@ -123,6 +130,18 @@ describe DocumentHydrator do
         }
         DocumentHydrator.hydrate_document(orig.dup, 'user_id', @hydration_proc).should == expected
       end
+
+      it "removes the '_id' suffix during hydration event when id is nil" do
+        orig = {
+          'key1' => 37,
+          'user_id' => nil
+        }
+        expected = {
+          'key1' => 37,
+          'user' => nil
+        }
+        DocumentHydrator.hydrate_document(orig.dup, 'user_id', @hydration_proc).should == expected
+      end
     end
 
     context "with a path whose terminal key ends with '_ids'" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: document_hydrator
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Greg Spurrier
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-19 00:00:00 -07:00
+date: 2011-10-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -179,6 +179,7 @@ files:
 - .autotest
 - .rspec
 - Gemfile
+- HISTORY.markdown
 - LICENSE.txt
 - README.markdown
 - Rakefile