localmemcache_store 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Florian Dütsch
+
+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

@@ -0,0 +1,16 @@
+NOT READY YET! COME BACK IN SOME DAYS.
+
+
+LocalmemcacheStore
+==================
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'rubygems'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the localmemcache_store plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the localmemcache_store plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LocalmemcacheStore'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+################################################################################
+# GEM stuff
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+#  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "localmemcache_store"
+  s.version = "0.0.1"
+  s.author = "Florian Dütsch (der_flo)"
+  s.email = "mail@florian-duetsch.de"
+  s.homepage = "http://github.com/der-flo/localmemcache_store"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "A Rails cache store implementation for localmemcache"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/TODOs.txt

@@ -0,0 +1,15 @@
+Plugin
+* Better / more complete tests
+* Gemified version etc: http://guides.rubyonrails.org/plugins.html
+* Good default parameters for localmemcache configuration
+* Documentation! (README, Homepage, ...)
+* Some Rake tasks?
+* Statistics
+** Controller generator?
+** Via Rails Engines?
+
+Adjustment proposals for localmemcache
+* Do expiry handling inside the cache
+* Drop old entries instead of raising OutOfMemoryError
+* Add statistics: How much used / free memory?
+* delete_matched: Delete entries by regex

data/lib/active_support/cache/localmemcache_store.rb

@@ -0,0 +1,75 @@
+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)
+    
+    def initialize options = {}
+      # TODO: Define default parameters
+      options.reverse_merge!({
+        :namespace => :x,
+        :size_mb => 64
+      })
+      @lmc = LocalMemCache::SharedObjectStorage.new options
+    end
+
+    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.delete(name)
+        nil
+      else
+        data_expires_pair.data
+      end
+    end
+
+    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
+    end
+
+    def delete(name, options = nil)
+      super
+      @lmc.delete(name)
+    end
+
+    def delete_matched(matcher, options = nil)
+      super
+      # TODO: Performance?
+      @lmc.each_pair do |key, value|
+        next unless key =~ matcher
+        @lmc.delete(key)
+      end
+    end
+
+    def exist?(name,options = nil)
+      super
+      # TODO: Performance?
+      # Read the value and check for nil?
+      @lmc.keys.include?(name)
+    end
+
+    def clear
+      @lmc.clear
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'active_support/cache/localmemcache_store'

data/tasks/localmemcache_store_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :localmemcache_store do
+#   # Task goes here
+# end

data/test/cache_store_behavior.rb

@@ -0,0 +1,62 @@
+# Module borrowed from the Rails tests
+# http://github.com/rails/rails/blob/master/activesupport/test/caching_test.rb
+
+# Tests the base functionality that should be identical across all cache stores.
+module CacheStoreBehavior
+  def test_should_read_and_write_strings
+    @cache.write('foo', 'bar')
+    assert_equal 'bar', @cache.read('foo')
+  end
+ 
+  def test_should_read_and_write_hash
+    @cache.write('foo', {:a => "b"})
+    assert_equal({:a => "b"}, @cache.read('foo'))
+  end
+ 
+  def test_should_read_and_write_integer
+    @cache.write('foo', 1)
+    assert_equal 1, @cache.read('foo')
+  end
+ 
+  def test_should_read_and_write_nil
+    @cache.write('foo', nil)
+    assert_equal nil, @cache.read('foo')
+  end
+ 
+  def test_fetch_without_cache_miss
+    @cache.write('foo', 'bar')
+    assert_equal 'bar', @cache.fetch('foo') { 'baz' }
+  end
+ 
+  def test_fetch_with_cache_miss
+    assert_equal 'baz', @cache.fetch('foo') { 'baz' }
+  end
+ 
+  def test_fetch_with_forced_cache_miss
+    @cache.fetch('foo', :force => true) { 'bar' }
+  end
+ 
+  def test_increment
+    @cache.write('foo', 1, :raw => true)
+    assert_equal 1, @cache.read('foo', :raw => true).to_i
+    assert_equal 2, @cache.increment('foo')
+    assert_equal 2, @cache.read('foo', :raw => true).to_i
+    assert_equal 3, @cache.increment('foo')
+    assert_equal 3, @cache.read('foo', :raw => true).to_i
+  end
+ 
+  def test_decrement
+    @cache.write('foo', 3, :raw => true)
+    assert_equal 3, @cache.read('foo', :raw => true).to_i
+    assert_equal 2, @cache.decrement('foo')
+    assert_equal 2, @cache.read('foo', :raw => true).to_i
+    assert_equal 1, @cache.decrement('foo')
+    assert_equal 1, @cache.read('foo', :raw => true).to_i
+  end
+ 
+  def test_exist
+    @cache.write('foo', 'bar')
+    assert @cache.exist?('foo')
+    assert !@cache.exist?('bar')
+  end
+end

data/test/localmemcache_store_test.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/cache_store_behavior.rb'
+require 'test_helper'
+require 'active_support/cache/localmemcache_store'
+
+# Most tests borrowed from the Rails tests
+# http://github.com/rails/rails/blob/master/activesupport/test/caching_test.rb
+
+class LocalmemcacheStoreTest < ActiveSupport::TestCase
+
+  def setup
+    @cache = ActiveSupport::Cache.lookup_store(:localmemcache_store)
+    @cache.clear
+    @cache.silence!
+    @cache.logger = Logger.new("/dev/null")
+  end
+  
+  test "write a value to the cache" do
+    assert_nothing_raised do
+      value = :value
+      ret = @cache.write :key, value
+      assert_equal ret, value
+    end
+  end
+  
+  test "read a cached value" do
+    assert_nothing_raised do
+      value = :value
+      @cache.write :key, value
+      assert_equal value, @cache.read(:key)
+    end
+  end
+  
+  test "entry expires" do
+    value = :value
+    @cache.write :key, value, :expires_in => 1.second
+    assert_equal :value, @cache.read(:key)
+    sleep 2
+    assert_nil @cache.read(:key)
+  end
+  
+  include CacheStoreBehavior
+  
+  def test_store_objects_should_be_immutable
+    @cache.write('foo', 'bar')
+    @cache.read('foo').gsub!(/.*/, 'baz')
+    assert_equal 'bar', @cache.read('foo')
+  end
+
+  def test_stored_objects_should_not_be_frozen
+    @cache.write('foo', 'bar')
+    assert !@cache.read('foo').frozen?
+  end
+
+  def test_write_should_return_true_on_success
+    result = @cache.write('foo', 'bar')
+    assert_equal 'bar', @cache.read('foo') # make sure 'foo' was written
+    assert result
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+
+require File.dirname(__FILE__) + '/../rails/init.rb'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: localmemcache_store
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Florian D\xC3\xBCtsch (der_flo)"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-11 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mail@florian-duetsch.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib
+- MIT-LICENSE
+- pkg
+- rails
+- Rakefile
+- README
+- tasks
+- test
+- TODOs.txt
+- lib/active_support
+- lib/active_support/cache
+- lib/active_support/cache/localmemcache_store.rb
+- rails/init.rb
+- tasks/localmemcache_store_tasks.rake
+- test/cache_store_behavior.rb
+- test/localmemcache_store_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/der-flo/localmemcache_store
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A Rails cache store implementation for localmemcache
+test_files: []
+