padrino-cache 0.10.0 → 0.10.1

data/lib/padrino-cache.rb

@@ -26,6 +26,7 @@ module Padrino
     #   Padrino.cache = Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1))
     #   Padrino.cache = Padrino::Cache::Store::Memcache.new(::Dalli::Client.new('127.0.0.1:11211', :exception_retry_limit => 1))
     #   Padrino.cache = Padrino::Cache::Store::Redis.new(::Redis.new(:host => '127.0.0.1', :port => 6379, :db => 0))
+    #   Padrino.cache = Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :username => 'username', :password => 'password', :size => 64, :max => 100, :collection => 'cache')
     #   Padrino.cache = Padrino::Cache::Store::Memory.new(50)
     #   Padrino.cache = Padrino::Cache::Store::File.new(/my/cache/path)
     #
@@ -69,6 +70,7 @@ module Padrino
       #   set :cache, Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1))
       #   set :cache, Padrino::Cache::Store::Memcache.new(::Dalli::Client.new('127.0.0.1:11211', :exception_retry_limit => 1))
       #   set :cache, Padrino::Cache::Store::Redis.new(::Redis.new(:host => '127.0.0.1', :port => 6379, :db => 0))
+      #   set :cache, Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :username => 'username', :password => 'password', :size => 64, :max => 100, :collection => 'cache')
       #   set :cache, Padrino::Cache::Store::Memory.new(50)
       #   set :cache, Padrino::Cache::Store::File.new(Padrino.root('tmp', app_name.to_s, 'cache')) # default choice
       #
@@ -93,4 +95,4 @@ module Padrino
       end
     end
   end # Cache
-end # Padrino
+end # Padrino

data/lib/padrino-cache/store.rb

@@ -7,6 +7,7 @@ module Padrino
       autoload :Memcache, 'padrino-cache/store/memcache'
       autoload :Memory,   'padrino-cache/store/memory'
       autoload :Redis,    'padrino-cache/store/redis'
+      autoload :Mongo,    'padrino-cache/store/mongo'
     end # Store
   end # Cache
-end # Padrino
+end # Padrino

data/lib/padrino-cache/store/mongo.rb

@@ -0,0 +1,109 @@
+module Padrino
+  module Cache
+    module Store
+      ##
+      # MongoDB Cache Store
+      #
+      class Mongo
+        ##
+        # Initialize Mongo store with client connection and optional username and password.
+        #
+        # ==== Examples
+        #   Padrino.cache = Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :username => 'username', :password => 'password', :size => 64, :max => 100, :collection => 'cache')
+        #   # or from your app
+        #   set :cache, Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :username => 'username', :password => 'password', :size => 64, :max => 100, :collection => 'cache')
+        #
+        def initialize(client, opts={})
+          @client = client
+          @options = {
+            :capped => true,
+            :collection => 'cache',
+            :size => 64,
+            :max => 100
+          }.merge(opts)
+
+          if @options[:username] && @options[:password]
+            @client.authenticate(@options[:username], @options[:password], true)
+          end
+          @backend = get_collection
+        end
+
+        ##
+        # Return the a value for the given key
+        #
+        # ==== Examples
+        #   # with MyApp.cache.set('records', records)
+        #   MyApp.cache.get('records')
+        #
+        def get(key)
+          doc = @backend.find_one(:_id => key, :expires_in => {'$gt' => Time.now.utc})
+          return nil if doc.nil?
+          Marshal.load(doc['value'].to_s) if doc['value'].present?
+        end
+
+        ##
+        # Set or update the value for a given key and optionally with an expire time
+        # Default expiry is Time.now + 86400s.
+        #
+        # ==== Examples
+        #   MyApp.cache.set('records', records)
+        #   MyApp.cache.set('records', records, :expires_in => 30) # => 30 seconds
+        #
+        def set(key, value, opts = nil)
+          key = key.to_s
+          value = BSON::Binary.new(Marshal.dump(value)) if value
+          if opts && opts[:expires_in]
+            expires_in = opts[:expires_in].to_i
+            expires_in = Time.now.utc + expires_in if expires_in < EXPIRES_EDGE
+          else
+            expires_in = Time.now.utc + EXPIRES_EDGE
+          end
+          @backend.update(
+            {:_id => key},
+            {:_id => key, :value => value, :expires_in => expires_in },
+            {:upsert => true})
+        end
+
+        ##
+        # Delete the value for a given key
+        #
+        # ==== Examples
+        #   # with: MyApp.cache.set('records', records)
+        #   MyApp.cache.delete('records')
+        #
+        def delete(key)
+          if not @options[:capped]
+            @backend.remove({:_id => key})
+          else
+            # Mongo will overwrite it with a simple object {_id: new ObjectId()}
+            @backend.update({:_id => key},{},{:upsert => true})
+          end
+        end
+
+        ##
+        # Reinitialize your cache
+        #
+        # ==== Examples
+        #   # with: MyApp.cache.set('records', records)
+        #   MyApp.cache.flush
+        #   MyApp.cache.get('records') # => nil
+        #
+        def flush
+          @backend.drop
+          @backend = get_collection
+        end
+
+        private
+        def get_collection
+          if @client.collection_names.include?(@options[:collection]) or !@options[:capped]
+            @client.collection @options[:collection]
+          else
+            @client.create_collection(@options[:collection], { :capped => @options[:capped],
+                                                               :size => @options[:size]*1024**2,
+                                                               :max => @options[:max] })
+          end
+        end
+      end # Mongo
+    end # Store
+  end # Cache
+end # Padrino

data/test/test_stores.rb

@@ -10,7 +10,7 @@ should 'set and get an object' do
   assert_equal "bar", Padrino.cache.get('val').bar
 end
 
-should 'set ang get a nil value' do
+should 'set and get a nil value' do
   Padrino.cache.set('val', nil)
   assert_equal nil, Padrino.cache.get('val')
 end
@@ -39,27 +39,6 @@ should 'delete a value' do
 end
 HERE_DOC
 
-begin
-  require 'memcached'
-  # we're just going to assume memcached is running on the default port
-  Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1)).set('ping','alive')
-
-  class TestMemcacheStore < Test::Unit::TestCase
-    def setup
-      Padrino.cache = Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1))
-      Padrino.cache.flush
-    end
-
-    def teardown
-      Padrino.cache.flush
-    end
-
-    eval COMMON_TESTS
-  end
-rescue LoadError
-  warn "Skipping memcached with memcached library tests"
-end
-
 begin
   require 'memcache'
   # we're just going to assume memcached is running on the default port
@@ -121,6 +100,25 @@ rescue LoadError
   warn "Skipping redis tests"
 end
 
+begin
+  require 'mongo'
+  Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino-cache_test'))
+  class TestMongoStore < Test::Unit::TestCase
+    def setup
+      Padrino.cache = Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino-cache_test'), {:size => 10, :collection => 'cache'})
+      Padrino.cache.flush
+    end
+
+    def teardown
+      Padrino.cache.flush
+    end
+
+    eval COMMON_TESTS
+  end
+rescue LoadError
+  warn "Skipping Mongo tests"
+end
+
 class TestFileStore < Test::Unit::TestCase
   def setup
     @apptmp = "#{Dir.tmpdir}/padrino-tests/#{UUID.new.generate}"
@@ -151,4 +149,4 @@ class TestInMemoryStore < Test::Unit::TestCase
     assert_equal nil, Padrino.cache.get('0')
     assert_equal '1', Padrino.cache.get('1')
   end
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: padrino-cache
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors: 
 - Padrino Team
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 -07:00
+date: 2011-08-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.10.0
+        version: 0.10.1
   type: :runtime
   version_requirements: *id001
 description: Caching support for memcached, page and fragment
@@ -49,6 +49,7 @@ files:
 - lib/padrino-cache/store/file.rb
 - lib/padrino-cache/store/memcache.rb
 - lib/padrino-cache/store/memory.rb
+- lib/padrino-cache/store/mongo.rb
 - lib/padrino-cache/store/redis.rb
 - padrino-cache.gemspec
 - test/helper.rb