adapter-mongo 0.5.5 → 0.5.6

data/Guardfile

@@ -4,6 +4,7 @@ guard 'bundler' do
 end
 
 guard 'rspec', :version => 2 do
+  watch('spec/support/shared_mongo_adapter.rb') { 'spec' }
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/adapter/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -22,6 +22,42 @@ puts 'Should be nil: ' + adapter.read('foo').inspect
 puts 'Should be bar: ' + adapter.fetch('foo', 'bar')
 ```
 
+## Flavors
+
+There are two adapters included with this gem -- `:mongo` and `:mongo_atomic`. `:mongo` assumes that you are writing the full document each time. `:mongo_atomic` allows for partially updating documents. The difference is best shown with a bit of code.
+
+```ruby
+require 'adapter/mongo_atomic'
+
+key            = BSON::ObjectId.new
+full_doc       = {'a' => 'c', 'b' => 'd'}
+partial_doc    = {'a' => 'z'}
+client         = Mongo::Connection.new.db('adapter')['testing']
+adapter        = Adapter[:mongo].new(client)
+atomic_adapter = Adapter[:mongo_atomic].new(client)
+
+adapter.clear
+atomic_adapter.clear
+
+adapter.write(key, full_doc)
+adapter.write(key, partial_doc)
+
+doc = adapter.read(key)
+doc.delete('_id')
+
+# full doc must always be written with :mongo adapter
+puts 'Should be {"a"=>"z"}: ' + doc.inspect
+
+atomic_adapter.write(key, full_doc)
+atomic_adapter.write(key, partial_doc)
+
+doc = atomic_adapter.read(key)
+doc.delete('_id')
+
+# partial updates can be written with atomic adapter as $set is used
+puts 'Should be {"a"=>"z", "b"=>"d"}: ' + doc.inspect
+```
+
 See examples/ or specs/ for more usage.
 
 ## Contributing

data/examples/mongo_atomic.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'pathname'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'adapter/mongo_atomic'
+
+key            = BSON::ObjectId.new
+full_doc       = {'a' => 'c', 'b' => 'd'}
+partial_doc    = {'a' => 'z'}
+client         = Mongo::Connection.new.db('adapter')['testing']
+adapter        = Adapter[:mongo].new(client)
+atomic_adapter = Adapter[:mongo_atomic].new(client)
+
+adapter.clear
+atomic_adapter.clear
+
+adapter.write(key, full_doc)
+adapter.write(key, partial_doc)
+
+doc = adapter.read(key)
+doc.delete('_id')
+
+# full doc must always be written with :mongo adapter
+puts 'Should be {"a"=>"z"}: ' + doc.inspect
+
+atomic_adapter.write(key, full_doc)
+atomic_adapter.write(key, partial_doc)
+
+doc = atomic_adapter.read(key)
+doc.delete('_id')
+
+# partial updates can be written with atomic adapter as $set is used
+puts 'Should be {"a"=>"z", "b"=>"d"}: ' + doc.inspect

data/examples/object_for_key.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'pathname'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'adapter/mongo'
+
+key     = BSON::OrderedHash['s' => 1, 'n' => 1]
+client  = Mongo::Connection.new.db('adapter')['testing']
+adapter = Adapter[:mongo].new(client)
+adapter.clear
+
+adapter.write(key, :v => 1)
+
+doc = adapter.read(key)
+
+puts doc.inspect

data/lib/adapter/mongo.rb

@@ -24,7 +24,12 @@ module Adapter
     end
 
     def key_for(key)
-      key.is_a?(BSON::ObjectId) ? key : super
+      case key
+      when BSON::ObjectId, Hash
+        key
+      else
+        super
+      end
     end
 
     def encode(value)
@@ -38,4 +43,4 @@ module Adapter
   end
 end
 
-Adapter.define(:mongo, Adapter::Mongo)
+Adapter.define(:mongo, Adapter::Mongo)

data/lib/adapter/mongo/version.rb

@@ -1,5 +1,5 @@
 module Adapter
   module Mongo
-    VERSION = "0.5.5"
+    VERSION = "0.5.6"
   end
 end

data/spec/helper.rb

@@ -1,4 +1,5 @@
 $:.unshift(File.expand_path('../../lib', __FILE__))
+$:.unshift(File.expand_path('../', __FILE__))
 
 require 'rubygems'
 require 'bundler'
@@ -9,54 +10,7 @@ require 'adapter/spec/an_adapter'
 require 'adapter/spec/types'
 require 'adapter-mongo'
 
-shared_examples_for "a mongo adapter" do
-  it_should_behave_like 'an adapter'
-
-  Adapter::Spec::Types.each do |type, (key, key2)|
-    it "writes Object values to keys that are #{type}s like a Hash" do
-      adapter[key] = {:foo => :bar}
-      # mongo knows hashes and can serialize symbol values
-      adapter[key].should == {'_id' => 'key', 'foo' => :bar}
-    end
-  end
-
-  it "allows using object id's as keys in correct type" do
-    id = BSON::ObjectId.new
-    adapter.write(id, 'ham')
-    client.find_one('_id' => id).should_not be_nil
-    adapter.read(id).should == 'ham'
-  end
-
-  it "stores hashes right in document" do
-    adapter.write('foo', 'steak' => 'bacon')
-    client.find_one('_id' => 'foo').should == {'_id' => 'foo', 'steak' => 'bacon'}
-  end
-
-  describe "with safe option" do
-    before do
-      client.ensure_index([['email', 1]], :unique => true)
-      @adapter = Adapter[adapter_name].new(client, :safe => true)
-    end
-
-    after do
-      client.drop_index('email_1')
-    end
-
-    it "does not raise operation failure on write if operation succeeds" do
-      adapter.write(BSON::ObjectId.new, {'email' => 'john@orderedlist.com'})
-      lambda {
-        adapter.write(BSON::ObjectId.new, {'email' => 'steve@orderedlist.com'})
-      }.should_not raise_error(Mongo::OperationFailure)
-    end
-
-    it "raises operation failure on write if operation fails" do
-      adapter.write(BSON::ObjectId.new, {'email' => 'john@orderedlist.com'})
-      lambda {
-        adapter.write(BSON::ObjectId.new, {'email' => 'john@orderedlist.com'})
-      }.should raise_error(Mongo::OperationFailure)
-    end
-  end
-end
+require 'support/shared_mongo_adapter'
 
 RSpec.configure do |c|
 

data/spec/support/shared_mongo_adapter.rb

@@ -0,0 +1,62 @@
+shared_examples_for "a mongo adapter" do
+  it_should_behave_like 'an adapter'
+
+  Adapter::Spec::Types.each do |type, (key, key2)|
+    it "writes Object values to keys that are #{type}s like a Hash" do
+      adapter[key] = {:foo => :bar}
+      # mongo knows hashes and can serialize symbol values
+      adapter[key].should == {'_id' => 'key', 'foo' => :bar}
+    end
+  end
+
+  it "allows using object id's as keys in correct type" do
+    id = BSON::ObjectId.new
+    adapter.write(id, 'ham')
+    client.find_one('_id' => id).should_not be_nil
+    adapter.read(id).should == 'ham'
+  end
+
+  it "allows using ordered hashes as keys" do
+    key = BSON::OrderedHash['d', 1, 'n', 1]
+    adapter.write(key, 'ham')
+    client.find_one('_id' => key).should_not be_nil
+    adapter.read(key).should == 'ham'
+  end
+
+  it "allows using hashes as keys" do
+    key = {:d => 1}
+    adapter.write(key, 'ham')
+    client.find_one('_id' => key).should_not be_nil
+    adapter.read(key).should == 'ham'
+  end
+
+  it "stores hashes right in document" do
+    adapter.write('foo', 'steak' => 'bacon')
+    client.find_one('_id' => 'foo').should == {'_id' => 'foo', 'steak' => 'bacon'}
+  end
+
+  describe "with safe option" do
+    before do
+      client.ensure_index([['email', 1]], :unique => true)
+      @adapter = Adapter[adapter_name].new(client, :safe => true)
+    end
+
+    after do
+      client.drop_index('email_1')
+    end
+
+    it "does not raise operation failure on write if operation succeeds" do
+      adapter.write(BSON::ObjectId.new, {'email' => 'john@orderedlist.com'})
+      lambda {
+        adapter.write(BSON::ObjectId.new, {'email' => 'steve@orderedlist.com'})
+      }.should_not raise_error(Mongo::OperationFailure)
+    end
+
+    it "raises operation failure on write if operation fails" do
+      adapter.write(BSON::ObjectId.new, {'email' => 'john@orderedlist.com'})
+      lambda {
+        adapter.write(BSON::ObjectId.new, {'email' => 'john@orderedlist.com'})
+      }.should raise_error(Mongo::OperationFailure)
+    end
+  end
+end

metadata

@@ -1,62 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: adapter-mongo
-version: !ruby/object:Gem::Version 
-  hash: 1
+version: !ruby/object:Gem::Version
+  version: 0.5.6
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 5
-  version: 0.5.5
 platform: ruby
-authors: 
+authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adapter
+  requirement: &70364766280940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 5
-        version: "0.5"
-  version_requirements: *id001
-  name: adapter
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70364766280940
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: &70364766280440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        version: "1.5"
-  version_requirements: *id002
-  name: mongo
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70364766280440
 description: Adapter for mongo
-email: 
+email:
 - nunemaker@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -66,6 +49,8 @@ files:
 - Rakefile
 - adapter-mongo.gemspec
 - examples/mongo.rb
+- examples/mongo_atomic.rb
+- examples/object_for_key.rb
 - lib/adapter-mongo.rb
 - lib/adapter/mongo.rb
 - lib/adapter/mongo/version.rb
@@ -73,40 +58,39 @@ files:
 - spec/helper.rb
 - spec/mongo_atomic_spec.rb
 - spec/mongo_spec.rb
-homepage: ""
+- spec/support/shared_mongo_adapter.rb
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3131877323408847219
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 3131877323408847219
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Adapter for mongo
-test_files: 
+test_files:
 - spec/helper.rb
 - spec/mongo_atomic_spec.rb
 - spec/mongo_spec.rb
+- spec/support/shared_mongo_adapter.rb