mongo_store 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Stephen Eley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= MongoStore
+
+It's **ActiveSupport::Cache::MongoStore** -- if you know your Rails caching, _'nuff said._  
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Stephen Eley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_store"
+    gem.summary = %Q{ActiveSupport::Cache implementation for MongoDB}
+    gem.description = %Q{10gen keeps bragging that MongoDB, with its fast writes and memory-mapped architecture, is ideal for caching. This gem puts it to use in Rails.}
+    gem.email = "sfeley@gmail.com"
+    gem.homepage = "http://github.com/SFEley/mongo_store"
+    gem.authors = ["Stephen Eley"]
+    gem.add_dependency "mongo", ">= 0.18.3"
+    gem.add_dependency "activesupport", ">= 2.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "mocha", ">= 0.9"
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongo_store #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongo_store.rb

@@ -0,0 +1,77 @@
+require 'active_support'
+require 'mongo'
+
+module ActiveSupport
+  module Cache
+    class MongoStore < Store
+      attr_reader :collection
+      
+      # Returns a MongoDB cache store.  Takes several possible combinations of parameters.  In order of
+      # escalating guesswork:
+      #
+      # 1. *a Mongo::Collection object* - No guessing. The collection is used as the cache store.
+      # 2. *a collection name and a database name* - Mongo objects are created for both.  The default 'localhost:27017' connection is used.
+      # 3. *a collection name* - Uses either MongoMapper.database (if MongoMapper is defined in the app) or a DB with the same name.
+      # 4. *no parameters* - A collection named 'rails_cache' is created, using either MongoMapper.database (if MongoMapper is defined in the app) or a DB also named 'rails_cache'.
+      #
+      # Unless option 1 is used, indexes are created on the key and expiration fields. If you supply your own collection,
+      # you are also responsible for making your own indexes.
+      def initialize(collection = nil, db_name = nil)
+        @collection = case collection
+        when Mongo::Collection then collection
+        when String
+          make_collection(collection, db_name)
+        when nil
+          make_collection('rails_cache')
+        else
+          raise TypeError, "MongoStore parameters must be nil, a Mongo::Collection, or a collection name."
+        end
+      end
+      
+      # Inserts the value into the cache collection or updates the existing value.  The value must be a valid
+      # MongoDB type.  An *:expires_in* option may be provided, as with MemCacheStore.  If one is _not_ 
+      # provided, a default expiration of 1 year is used.
+      def write(key, value, options={})
+        super
+        expires = Time.now + (options[:expires_in] || 1.year)
+        collection.update({'key' => key}, {'$set' => {'value' => value, 'expires' => expires}}, :upsert => true)
+      end
+      
+      # Reads the value from the cache collection.
+      def read(key, options={})
+        super
+        if doc = collection.find_one('key' => key, 'expires' => {'$gt' => Time.now})
+          doc['value']
+        end
+      end
+        
+      # Takes the specified value out of the collection.
+      def delete(key, options={})
+        super
+        collection.remove({'key' => key})
+      end
+      
+      # With MongoDB, there's no difference between querying on an exact value or a regex.  Beautiful, huh?
+      alias_method :delete_matched, :delete
+      
+      private
+      def mongomapper?
+        Kernel.const_defined?(:MongoMapper) && MongoMapper.respond_to?(:database) && MongoMapper.database
+      end
+      
+      def make_collection(collection, db_name=nil)
+         if db_name
+           db = Mongo::DB.new(db_name, Mongo::Connection.new)
+         elsif mongomapper?
+           db = MongoMapper.database
+         else
+           db = Mongo::DB.new(collection, Mongo::Connection.new)
+         end
+        coll = db.create_collection(collection)
+        coll.create_index('key' => Mongo::ASCENDING, 'expires' => Mongo::DESCENDING)
+        coll
+      end
+        
+    end
+  end
+end

data/spec/mongo_store_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# Stubbing MongoMapper out so that we don't have to have it installed for testing
+class MongoMapper
+end
+    
+describe "MongoStore" do
+  describe "collection" do
+    it "can be specified as a Mongo::Collection object" do
+      db = Mongo::DB.new('mongo_store_test', Mongo::Connection.new)
+      coll = Mongo::Collection.new(db, 'foostore')
+      store = ActiveSupport::Cache.lookup_store(:mongo_store, coll)
+      store.collection.should == coll
+    end
+    
+    it "can take a collection name and a database name" do
+      store = ActiveSupport::Cache.lookup_store(:mongo_store, 'foo', 'bar')
+      store.collection.name.should == 'foo'
+      store.collection.db.name.should == 'bar'
+    end
+    
+    describe "with MongoMapper" do
+      before(:each) do
+        db = Mongo::DB.new('mappy', Mongo::Connection.new)
+        MongoMapper.expects(:database).twice.returns(db)
+      end
+      
+      it "can take a collection name" do
+        store = ActiveSupport::Cache.lookup_store(:mongo_store, 'happy')
+        store.collection.name.should == 'happy'
+        store.collection.db.name.should == 'mappy'
+      end
+        
+      it "defaults to a 'rails_cache' collection" do
+        store = ActiveSupport::Cache.lookup_store(:mongo_store)
+        store.collection.name.should == 'rails_cache'
+        store.collection.db.name.should == 'mappy'
+      end
+    end
+    
+    describe "without MongoMapper" do
+      it "can take a collection name" do
+        store = ActiveSupport::Cache.lookup_store(:mongo_store, 'yuna')
+        store.collection.name.should == 'yuna'
+        store.collection.db.name.should == 'yuna'
+      end
+        
+      it "defaults to a 'rails_cache' collection" do
+        store = ActiveSupport::Cache.lookup_store(:mongo_store)
+        store.collection.name.should == 'rails_cache'
+        store.collection.db.name.should == 'rails_cache'
+      end
+    end
+    
+    it "raises an exception if an unusable parameter is passed" do
+      lambda{ActiveSupport::Cache.lookup_store(:mongo_store, 5)}.should raise_error(TypeError)
+    end
+        
+    after(:all) do
+      c = Mongo::Connection.new
+      %w(bar mappy rails_cache yuna).each do |db|
+        c.drop_database(db)
+      end
+    end  
+  end
+  
+  describe "caching" do
+    before(:all) do
+      @store = ActiveSupport::Cache.lookup_store(:mongo_store, 'mongo_store_test')
+    end
+    
+    it "can write values" do
+      @store.write('fnord', 'I am vaguely disturbed.')
+      @store.collection.find_one(:key => 'fnord')['value'].should == "I am vaguely disturbed."
+    end
+    
+    it "can read values" do
+      @store.collection.insert({:key => 'yoo', :value => 'yar', :expires => 1.year.from_now})
+      @store.read('yoo').should == 'yar'
+    end
+    
+    it "can delete keys" do
+      @store.write('foo', 'bar')
+      @store.read('foo').should == 'bar'
+      @store.delete('foo')
+      @store.read('foo').should be_nil
+    end
+    
+    it "can delete keys matching a regular expression" do
+      @store.write('foo', 'bar')
+      @store.write('fodder', 'bother')
+      @store.write('yoo', 'yar')
+      # Initial state
+      @store.read('foo').should == 'bar'
+      @store.read('fodder').should == 'bother'
+      @store.read('yoo').should == 'yar'
+      # The work
+      @store.delete_matched /oo/
+      # Post state
+      @store.read('foo').should be_nil
+      @store.read('fodder').should == 'bother'
+      @store.read('yoo').should be_nil
+    end
+    
+    it "can expire a value with the :expires_in option" do
+      @store.write('ray', 'dar', :expires_in => 2.seconds)
+      @store.read('ray').should == 'dar'
+      sleep(3)
+      @store.read('ray').should be_nil
+    end
+    
+    after(:each) do
+      @store.collection.remove   # Clear our records
+    end
+    after(:all) do
+      c = Mongo::Connection.new
+      c.drop_database('mongo_store_test')
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongo_store'
+require 'spec'
+require 'spec/autorun'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_store
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Stephen Eley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 18
+        - 3
+        version: 0.18.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id004
+description: 10gen keeps bragging that MongoDB, with its fast writes and memory-mapped architecture, is ideal for caching. This gem puts it to use in Rails.
+email: sfeley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo_store.rb
+- spec/mongo_store_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/SFEley/mongo_store
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ActiveSupport::Cache implementation for MongoDB
+test_files: 
+- spec/mongo_store_spec.rb
+- spec/spec_helper.rb