localmemcache_store 0.0.6 → 0.0.7

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/lib/active_support/cache/localmemcache_store.rb

@@ -1,20 +1,11 @@
-begin
-  gem 'localmemcache', '>=0.4.3'
-  require 'localmemcache'
-rescue LoadError
-  raise '"localmemcache>=0.4.3" gem is not installed!'
-end
-
 module ActiveSupport::Cache
   class LocalmemcacheStore < Store
-    
-    DataExpiresPair = Struct.new(:data, :expires_at) #:nodoc:
 
     # Useful options:
     # * +:namespace+: Namespace to avoid name collisions, defaults to
     #   +:lmc_store+.
     #
-    #   This is escpecially useful if to run seperated caches on one machine.   
+    #   This is especially useful if to run separated caches on one machine.   
     # * +:size_mb+: Size of the cache, defaults to +64+.
     def initialize options = {}
       options.reverse_merge!({
@@ -22,7 +13,7 @@ module ActiveSupport::Cache
         :size_mb => 64
       })
       @size_mb = options[:size_mb]
-      @lmc = LocalMemCache::ExpiryCache.new options
+      @cache = ExpiryCache.new options
     end
 
     # Reads a value by +name+.
@@ -30,19 +21,7 @@ module ActiveSupport::Cache
     # (options are ignored at the time)
     def read(name, options = nil)
       super
-      data_expires_pair = @lmc[name]
-      return nil unless data_expires_pair
-      
-      # entry expired?
-      if data_expires_pair.expires_at &&
-         data_expires_pair.expires_at <= Time.now
-         
-        # delete entry from database
-        @lmc.hash.delete(name)
-        nil
-      else
-        data_expires_pair.data
-      end
+      @cache.read name
     end
 
     # Writes a +name+-+value+ pair to the cache.
@@ -50,13 +29,7 @@ module ActiveSupport::Cache
     # * +:expires_in+: Number of seconds an entry is valid
     def write(name, value, options = {})
       super
-      data = value.freeze
-      expires_in = options[:expires_in]
-      expires_at = if expires_in && expires_in.to_i > 0
-        Time.now + expires_in.to_i
-      end
-      @lmc[name] = DataExpiresPair.new(data, expires_at)
-      data
+      @cache.write name, value, options[:expires_in]
     end
 
     # Delete a pair by key name
@@ -64,7 +37,7 @@ module ActiveSupport::Cache
     # (options are ignored at the time)
     def delete(name, options = nil)
       super
-      @lmc.delete(name)
+      @cache.delete name
     end
 
     # Delete all pair with key matching matcher
@@ -72,9 +45,7 @@ module ActiveSupport::Cache
     # (options are ignored at the time)
     def delete_matched(matcher, options = nil)
       super
-      @lmc.each_pair do |key, value|
-        @lmc.delete(key) if key =~ matcher
-      end
+      @cache.delete_matched matcher
     end
 
     # Checks key for existance 
@@ -82,18 +53,18 @@ module ActiveSupport::Cache
     # (options are ignored at the time)
     def exist?(name, options = nil)
       super
-      @lmc.has_key?(name)
+      @cache.has_key?(name)
     end
 
     # Clears the entire cache.
     def clear
-      @lmc.clear
+      @cache.clear
     end
 
     # Returns the status of the cache in form of a hash. Elements are:
     # +:free_bytes+, +:used_bytes+, +:total_bytes+ and +:usage+
     def status
-      s = @lmc.hash.shm_status
+      s = @cache.shm_status
       s[:usage] = s[:used_bytes].to_f / s[:total_bytes].to_f
       s
     end

data/lib/expiry_cache.rb

@@ -0,0 +1,144 @@
+begin
+  gem 'localmemcache', '>=0.4.4'
+  require 'localmemcache'
+rescue LoadError
+  raise '"localmemcache>=0.4.4" gem is not installed!'
+end
+
+class ExpiryCache
+
+  class Entry < Struct.new(:data, :expires_at)
+    def expired?
+      expires_at && expires_at <= Time.now
+    end
+  end
+
+  def initialize(options = {})
+    opts = {
+      :expiration_check_interval => 1_000
+    }.merge(options)
+    @cache = LocalMemCache::SharedObjectStorage.new opts
+    @expiration_check_interval = opts[:expiration_check_interval]
+    @expiration_check_counter = 0
+  end
+
+  def has_key? key
+    verify_key_not_expired key
+    @cache.has_key? key
+  end
+
+  def clear
+    @cache.clear
+  end
+  def shm_status
+    @cache.shm_status
+  end
+  
+  def read key
+    do_expiration_check
+    entry = @cache[key]
+
+    # return if nothing in cache
+    return nil unless entry
+    
+    # entry expired?
+    if verify_entry_not_expired(key, entry)
+      entry.data
+    else
+      nil
+    end
+  end
+
+  def write key, value, expires_in = nil
+    do_expiration_check
+
+    value.freeze
+
+    # calculate expiration
+    expires_at = if expires_in && expires_in.to_i > 0
+      Time.now + expires_in.to_i
+    end
+
+    # store data
+    if expires_at.nil? || expires_at > Time.now
+      entry = Entry.new(value, expires_at)
+      safe_write key, entry
+    end
+
+    value
+  end
+  
+  def delete key
+    @cache.delete key
+  end
+  
+  def delete_matched matcher
+    @cache.each_pair do |key, value|
+      @cache.delete(key) if key =~ matcher
+    end
+  end
+
+  private
+
+  def verify_key_not_expired key
+    entry = @cache[key]
+    verify_entry_not_expired(key, entry) if entry
+  end
+  def verify_entry_not_expired key, entry
+    if entry.expired?
+      @cache.delete(key)
+      false
+    else
+      true
+    end
+  end
+  
+  def do_expiration_check
+    @expiration_check_counter += 1
+    return unless @expiration_check_counter >= @expiration_check_interval
+    @expiration_check_counter = 0
+    expire_random_entries
+  end
+
+  def expire_random_entries count = 1_000
+    [count, @cache.size].min.times do
+      key, entry = @cache.random_pair
+      break if key.nil?
+      verify_entry_not_expired key, entry
+    end
+  end
+
+  def expire_some_entries count = 100
+    count = [count, @cache.size].min
+    @cache.each_pair do |key, entry|
+      break if count <= 0
+      count -= 1 unless verify_entry_not_expired(key, entry)
+    end
+  end
+
+  # TODO: Performance?
+  def safe_write key, entry
+    random_tries = 10
+    some_tries = 10
+    cleared = false
+    begin
+      @cache[key] = entry
+    rescue LocalMemCache::MemoryPoolFull
+      if random_tries > 0
+        random_tries -= 1
+        expire_random_entries
+        retry
+      elsif some_tries > 0
+        some_tries -= 1
+        expire_some_entries
+        retry
+    else
+        raise if cleared
+        @cache.clear
+        cleared = true
+        retry
+      end
+    end
+    entry
+  end
+end

data/lib/localmemcache_store.rb

@@ -1,3 +1,4 @@
 unless defined? ActiveSupport::Cache::LocalmemcacheStore
+  require 'expiry_cache'
   require 'active_support/cache/localmemcache_store'
 end

data/test/expiry_cache_test.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ExpiryCacheTest < ActiveSupport::TestCase
+
+  def setup
+    @cache = ExpiryCache.new(:namespace => 'expiry_cache_test', :size_mb => 16)
+    @cache.clear
+  end
+
+  def expire_entries_test method
+    1.upto(10) { |i| @cache.write(i, 'x' * 1_000, 1.second) }
+    used = @cache.shm_status[:used_bytes]
+    sleep 2
+    @cache.send method
+    assert_operator used, :>, @cache.shm_status[:used_bytes]
+  end
+  
+  test "expiration by expire_random_entries" do
+    expire_entries_test :expire_random_entries
+  end
+  test "expiration by expire_some_entries" do
+    expire_entries_test :expire_some_entries
+  end
+  
+  test "automatic deletion of some expired entries" do
+    @cache.write :foo, :bar, 1.second
+    sleep 2
+    used = @cache.shm_status[:used_bytes]
+    999.times { @cache.write :baz, :baz }
+    assert_operator used, :>, @cache.shm_status[:used_bytes]
+  end
+  
+  test "safe_write with full pool" do
+    five_mb = 1_024 * 1_024 * 5 
+    @cache.write :foo, 'x' * five_mb, 1.second
+    sleep 2
+    assert_nothing_raised do
+      @cache.write :bar, 'x' * five_mb
+    end
+  end
+  
+  test "safe_write with full pool and no chance to random expire entries" do
+    five_mb = 1_024 * 1_024 * 5 
+    @cache.write :foo, 'x' * five_mb, 1.second
+    1.upto(50_000) { |i| @cache.write i, 'x' }
+    assert_nothing_raised do
+      @cache.write :bar, 'x' * five_mb
+    end
+  end
+  
+  test "safe_write with full pool and no expirable entries" do
+    five_mb = 1_024 * 1_024 * 5 
+    @cache.write :foo, 'x' * five_mb
+    sleep 2
+    assert_nothing_raised do
+      @cache.write :bar, 'x' * five_mb
+    end
+  end
+end

data/test/localmemcache_store_test.rb

@@ -7,7 +7,8 @@ require File.dirname(__FILE__) + '/cache_store_behavior.rb'
 class LocalmemcacheStoreTest < ActiveSupport::TestCase
 
   def setup
-    @cache = ActiveSupport::Cache.lookup_store(:localmemcache_store, { :namespace => 'lmc_store_test' })
+    @cache = ActiveSupport::Cache.lookup_store(:localmemcache_store,
+      { :namespace => 'lmc_store_test' })
     @cache.clear
     @cache.silence!
     @cache.logger = Logger.new("/dev/null")
@@ -36,6 +37,30 @@ class LocalmemcacheStoreTest < ActiveSupport::TestCase
     sleep 2
     assert_nil @cache.read(:key)
   end
+  
+  test "delete an entry" do
+    @cache.write :key, :value
+    @cache.delete :key
+    assert_nil @cache.read(:key)
+  end
+  
+  test "entry exists" do
+    assert !@cache.exist?(:foo)
+    @cache.write :foo, :bar
+    assert @cache.exist?(:foo)
+  end
+  
+  test "delete entries by regex" do
+    @cache.write :foo1, :bar
+    @cache.write :foo2, :bar
+    @cache.write :baz, :bar
+
+    @cache.delete_matched /^foo/
+    
+    assert !@cache.exist?(:foo1)
+    assert !@cache.exist?(:foo2)
+    assert @cache.exist?(:baz)
+  end
 
   include CacheStoreBehavior
 
@@ -71,5 +96,4 @@ class LocalmemcacheStoreTest < ActiveSupport::TestCase
   test "status has usage" do
     assert_not_nil @cache.status[:usage]
   end
-
 end

data/test/test_helper.rb

@@ -2,5 +2,6 @@ require 'test/unit'
 require 'rubygems'
 require 'active_support'
 require 'active_support/test_case'
-require 'lib/active_support/cache/localmemcache_store'
+require 'lib/localmemcache_store'
+#require 'lib/active_support/cache/localmemcache_store'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: localmemcache_store
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - "Florian D\xC3\xBCtsch (der_flo)"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +01:00
+date: 2009-11-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.3
+        version: 0.4.4
     version: 
 description: 
 email: mail@florian-duetsch.de
@@ -33,10 +33,13 @@ extra_rdoc_files:
 files: 
 - MIT-LICENSE
 - README.rdoc
+- VERSION
 - lib/active_support/cache/localmemcache_store.rb
+- lib/expiry_cache.rb
 - lib/localmemcache_store.rb
 - rails/init.rb
 - test/cache_store_behavior.rb
+- test/expiry_cache_test.rb
 - test/localmemcache_store_test.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -69,5 +72,6 @@ specification_version: 3
 summary: A Rails cache store implementation for localmemcache
 test_files: 
 - test/cache_store_behavior.rb
+- test/expiry_cache_test.rb
 - test/localmemcache_store_test.rb
 - test/test_helper.rb