mongoid_identity_map 0.0.1 → 0.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - rbx
+  - jruby

data/README.md

@@ -0,0 +1,28 @@
+Mongoid Identity Map
+====================
+
+## About [![Build Status](http://travis-ci.org/gcirne/mongoid_identity_map.png)](http://travis-ci.org/gcirne/mongoid_identity_map)
+
+Mongoid Identity Map is a simple and transparent Identity Map implementation for the Mongoid ODM.
+
+[Mongoid](http://mongoid.org)
+
+[Identity Map pattern](http://martinfowler.com/eaaCatalog/identityMap.html)
+
+## Installation
+
+In Gemfile:
+
+    gem "mongoid_identity_map"
+
+## Configuration
+
+Add rack middleware `MongoidIdentityMap::ClearMiddleware` for clearing identity map after each request.
+
+When using this gem in a Rails app this is done automatically.
+
+## Current Limitations
+
+Currently, it's an all or nothing deal. It is not possible to turn the identiy map on or off on a class (Mongoid::Document) basis.
+
+Identity map is applied only on Mongoid's Collection find_one method. The find method doesn't have the identity map applied.

data/Rakefile

@@ -3,3 +3,5 @@ require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid_identity_map.rb

@@ -1,5 +1,5 @@
 require "mongoid_identity_map/clear_middleware"
-require "mongoid_identity_map/current_thread_hash"
+require "mongoid_identity_map/thread_local_hash"
 require "mongoid_identity_map/identity_map"
 require "mongoid_identity_map/identity_mappable"
-
+require "mongoid_identity_map/railtie" if defined?(Rails)

data/lib/mongoid_identity_map/clear_middleware.rb

@@ -6,7 +6,7 @@ module MongoidIdentityMap
     
     def call(env)
       res = @app.call(env)
-      CurrentThreadHash.clear
+      IdentityMap.clear
       res
     end
   end

data/lib/mongoid_identity_map/identity_map.rb

@@ -3,7 +3,11 @@ module MongoidIdentityMap
 
     class << self
       def fetch(selector)
-        CurrentThreadHash.get(selector) || CurrentThreadHash.set(selector, yield)
+        ThreadLocalHash.get(selector) || ThreadLocalHash.set(selector, yield)
+      end
+
+      def clear
+        ThreadLocalHash.clear
       end
     end
     

data/lib/mongoid_identity_map/railtie.rb

@@ -0,0 +1,7 @@
+module MongoidIdentityMap
+  class Railtie < Rails::Railtie
+    initializer "mongoid_identity_map.initializer" do |app|
+      app.middleware.use MongoidIdentityMap::ClearMiddleware
+    end
+  end
+end

data/lib/mongoid_identity_map/{current_thread_hash.rb → thread_local_hash.rb}

@@ -1,12 +1,12 @@
 module MongoidIdentityMap
-  class CurrentThreadHash
+  class ThreadLocalHash
     class << self
       def get(key)
-        current_thread_hash[key]
+        thread_local_hash[key]
       end
       
       def set(key, value)
-        current_thread_hash[key] = value
+        thread_local_hash[key] = value
       end
       
       def clear
@@ -15,7 +15,7 @@ module MongoidIdentityMap
       
       private
       
-      def current_thread_hash
+      def thread_local_hash
         Thread.current[:mongoid_identity_map_current_thread_hash] ||= Hash.new
       end
     end

data/lib/mongoid_identity_map/version.rb

@@ -1,3 +1,3 @@
 module MongoidIdentityMap
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/mongoid_identity_map.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |s|
   s.email       = ["gcirne@gmail.com"]
   s.homepage    = "http://rubygems.org/gems/mongoid_identity_map"
   s.summary     = "IdentityMap for Mongoid"
-  s.description = "Simple and transparent IdentityMap implementation for Mongoid"
+  s.description = "Simple and transparent Identity Map implementation for Mongoid"
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "mongoid_identity_map"
 
-  s.add_dependency "activesupport", "~> 3.0.0"
-  s.add_dependency "mongoid", "~> 2.0.0"
+  s.add_dependency "activesupport", "~> 3.0"
+  s.add_dependency "mongoid", "~> 2.0"
 
   s.add_development_dependency "bson_ext", ">= 1.3.0"
   s.add_development_dependency "bundler", ">= 1.0.0"

data/spec/mongoid_identity_map/clear_middleware_spec.rb

@@ -14,7 +14,7 @@ describe MongoidIdentityMap::ClearMiddleware do
   end
   
   it "should clear identity map" do
-    MongoidIdentityMap::CurrentThreadHash.should_receive(:clear)
+    MongoidIdentityMap::IdentityMap.should_receive(:clear)
     @clear_middleware.call(@env)
   end
 end

data/spec/mongoid_identity_map/identity_map_spec.rb

@@ -7,9 +7,15 @@ describe MongoidIdentityMap::IdentityMap do
   end
   
   describe ".fetch" do
+    let (:fetch) do
+      MongoidIdentityMap::IdentityMap.fetch(@selector) do
+        Model.collection.find_one_without_identity_map(@selector)
+      end
+    end
+
     context "when document doesn't exist in identity map" do
       before do
-        MongoidIdentityMap::CurrentThreadHash.stub!(:get).with(@selector).and_return(nil)
+        MongoidIdentityMap::ThreadLocalHash.stub!(:get).with(@selector).and_return(nil)
         Model.collection.stub!(:find_one_without_identity_map).with(@selector).and_return(@model)
       end
 
@@ -19,14 +25,14 @@ describe MongoidIdentityMap::IdentityMap do
       end
 
       it "should set document in identity map" do
-        MongoidIdentityMap::CurrentThreadHash.stub!(:set).with(@selector, @model)
+        MongoidIdentityMap::ThreadLocalHash.should_receive(:set).with(@selector, @model)
         fetch
       end
     end
 
     context "when document exists in identity map" do
       before do
-        MongoidIdentityMap::CurrentThreadHash.stub!(:get).with(@selector).and_return(@model)
+        MongoidIdentityMap::ThreadLocalHash.stub!(:get).with(@selector).and_return(@model)
       end
 
       it "should return document from identity map" do
@@ -38,11 +44,12 @@ describe MongoidIdentityMap::IdentityMap do
         fetch
       end
     end
+  end
 
-    def fetch
-      MongoidIdentityMap::IdentityMap.fetch(@selector) do
-        Model.collection.find_one_without_identity_map(@selector)
-      end
+  describe ".clear" do
+    it "should clear identity map" do
+      MongoidIdentityMap::ThreadLocalHash.should_receive(:clear)
+      MongoidIdentityMap::IdentityMap.clear
     end
   end
 end

data/spec/mongoid_identity_map/thread_local_hash_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe MongoidIdentityMap::ThreadLocalHash do
+  describe ".set and .get" do
+    it "should set and get key based value" do
+      MongoidIdentityMap::ThreadLocalHash.set(:key, "value")
+      
+      Thread.new do
+        MongoidIdentityMap::ThreadLocalHash.set(:key, "value2")
+        MongoidIdentityMap::ThreadLocalHash.get(:key).should == "value2"
+      end.join
+      
+      MongoidIdentityMap::ThreadLocalHash.get(:key).should == "value"
+    end
+  end
+  
+  describe ".clear" do
+    it "should clear" do
+      MongoidIdentityMap::ThreadLocalHash.set(:key, "value")
+      
+      Thread.new do
+        MongoidIdentityMap::ThreadLocalHash.set(:key, "value")
+        MongoidIdentityMap::ThreadLocalHash.clear
+        MongoidIdentityMap::ThreadLocalHash.get(:key).should be_nil
+      end.join
+      
+      MongoidIdentityMap::ThreadLocalHash.get(:key).should == "value"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,6 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   
   config.before(:each) do
-    MongoidIdentityMap::CurrentThreadHash.clear
+    MongoidIdentityMap::IdentityMap.clear
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Guilherme Cirne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-29 00:00:00 -03:00
+date: 2011-05-02 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,7 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,8 +42,7 @@ dependencies:
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        version: "2.0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -92,7 +90,7 @@ dependencies:
         version: 2.5.0
   type: :development
   version_requirements: *id005
-description: Simple and transparent IdentityMap implementation for Mongoid
+description: Simple and transparent Identity Map implementation for Mongoid
 email: 
 - gcirne@gmail.com
 executables: []
@@ -104,19 +102,22 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
+- README.md
 - Rakefile
 - lib/mongoid_identity_map.rb
 - lib/mongoid_identity_map/clear_middleware.rb
-- lib/mongoid_identity_map/current_thread_hash.rb
 - lib/mongoid_identity_map/identity_map.rb
 - lib/mongoid_identity_map/identity_mappable.rb
+- lib/mongoid_identity_map/railtie.rb
+- lib/mongoid_identity_map/thread_local_hash.rb
 - lib/mongoid_identity_map/version.rb
 - mongoid_identity_map.gemspec
 - spec/mongoid_identity_map/clear_middleware_spec.rb
-- spec/mongoid_identity_map/current_thread_hash_spec.rb
 - spec/mongoid_identity_map/identity_map_spec.rb
 - spec/mongoid_identity_map/identity_mappable_spec.rb
+- spec/mongoid_identity_map/thread_local_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/model.rb
 has_rdoc: true

data/spec/mongoid_identity_map/current_thread_hash_spec.rb

@@ -1,30 +0,0 @@
-require "spec_helper"
-
-describe MongoidIdentityMap::CurrentThreadHash do
-  describe ".set and .get" do
-    it "should set and get key based value" do
-      MongoidIdentityMap::CurrentThreadHash.set(:key, "value")
-      
-      Thread.new do
-        MongoidIdentityMap::CurrentThreadHash.set(:key, "value2")
-        MongoidIdentityMap::CurrentThreadHash.get(:key).should == "value2"
-      end.join
-      
-      MongoidIdentityMap::CurrentThreadHash.get(:key).should == "value"
-    end
-  end
-  
-  describe ".clear" do
-    it "should clear" do
-      MongoidIdentityMap::CurrentThreadHash.set(:key, "value")
-      
-      Thread.new do
-        MongoidIdentityMap::CurrentThreadHash.set(:key, "value")
-        MongoidIdentityMap::CurrentThreadHash.clear
-        MongoidIdentityMap::CurrentThreadHash.get(:key).should be_nil
-      end.join
-      
-      MongoidIdentityMap::CurrentThreadHash.get(:key).should == "value"
-    end
-  end
-end