localmemcache_store 0.0.2 → 0.0.4

data/README.rdoc

@@ -0,0 +1,67 @@
+NOT READY YET! COME BACK IN SOME DAYS.
+
+= LocalmemcacheStore
+
+LocalmemcacheStore[http://github.com/der-flo/localmemcache_store]
+is an ActiveSupport::Cache::Store implementation to be able to use
+Localmemcache[http://localmemcache.rubyforge.org/] in Rails.
+
+Localmemcache is an ultra-fast[http://localmemcache.rubyforge.org/#performance]
+and lightweight alternative to Memcached[http://www.danga.com/memcached/]
+for your Rails application.
+Localmemcache runs inside your Rails processes, so you don't need to
+run any extra daemons. The configuration is done inside your app and
+is an absolutely no-brainer.
+As the name says, the cache can only be shared on your local machine
+(at the time), but for your small apps scaling/networking often is
+not needed. Thanks to Rails'
+Cache::Store[http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html]
+interface, switching later is no big deal.
+
+Please read the requirements[http://www.danga.com/memcached/] of
+Localmemcache carefully!
+In production you should use a 64bit Linux variant.
+Developing on Mac OS X is okay, the missing sparse file support of
+HFS+ is not that problem as long as you have enough free space on your disk.
+
+== Installation and usage
+  Rails::Initializer.run do |config|
+    [...]
+    config.gem 'localmemcache_store', :source => 'http://gemcutter.org' 
+    config.cache_store = :localmemcache_store
+  end
+Next, install the gem:
+  $ sudo gem install localmemcache_store --source http://gemcutter.org
+
+*Done.* Now enjoy your superfast new cache store!
+
+== Configuration
+There are configuration defaults to start quickly, but you should consider
+these two parameters:
+* +:namespace+: Namespace to avoid name collisions when running multiple
+  Localmemcache environments on one machine. (Defaults to +:lmc_store+.)
+* +:size_mb+: Specify the cache size in megabytes. Since the memory is
+  used only virtually, you can feel free to use great values like 4096 ;-).
+  Remember that this eats up your address space on 32bit systems.
+  (Defaults to 128).
+A configuration could look like this:
+ config.cache_store = :localmemcache_store,
+                      { :namespace => 'testapp', :size_mb => 256 }
+
+== Further usage
+You can find a good Rails caching intro at
+RailsGuides[http://guides.rubyonrails.org/caching_with_rails.html],
+they do a better job than me ;-).
+
+The only specific enhancement with the ActiveSupport::Cache::Store
+implementation is the ability to use time based expiration in just the way the
+Memcached implementation does.
+See ActiveSupport::Cache::LocalmemcacheStore#write.
+
+== Feedback
+Please provide feedback! Your ideas, error reports and feature requests
+are very welcome. Please contact me via
+Github[http://github.com/der-flo/localmemcache_store].
+
+---
+Copyright (c) 2009 Florian Dütsch, released under the MIT license

data/lib/active_support/cache/localmemcache_store.rb

@@ -8,17 +8,26 @@ end
 module ActiveSupport::Cache
   class LocalmemcacheStore < Store
     
-    DataExpiresPair = Struct.new(:data, :expires_at)
-    
+    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.   
+    # * +:size_mb+: Size of the cache, defaults to +128+.
     def initialize options = {}
-      # TODO: Define default parameters
       options.reverse_merge!({
-        :namespace => :x,
-        :size_mb => 64
+        :namespace => :lmc_store,
+        :size_mb => 128
       })
-      @lmc = LocalMemCache::SharedObjectStorage.new options
+      @size_mb = options[:size_mb]
+      @lmc = LocalMemCache::ExpiryCache.new options
     end
 
+    # Reads a value by +name+.
+    #
+    # (options are ignored at the time)
     def read(name, options = nil)
       super
       data_expires_pair = @lmc[name]
@@ -29,13 +38,16 @@ module ActiveSupport::Cache
          data_expires_pair.expires_at <= Time.now
          
         # delete entry from database
-        @lmc.delete(name)
+        @lmc.hash.delete(name)
         nil
       else
         data_expires_pair.data
       end
     end
 
+    # Writes a +name+-+value+ pair to the cache.
+    # Useful options:
+    # * +:expires_in+: Number of seconds an entry is valid
     def write(name, value, options = {})
       super
       data = value.freeze
@@ -47,27 +59,33 @@ module ActiveSupport::Cache
       data
     end
 
+    # Delete a pair by key name
+    #
+    # (options are ignored at the time)
     def delete(name, options = nil)
       super
       @lmc.delete(name)
     end
 
+    # Delete all pair with key matching matcher
+    #
+    # (options are ignored at the time)
     def delete_matched(matcher, options = nil)
       super
-      # TODO: Performance?
       @lmc.each_pair do |key, value|
-        next unless key =~ matcher
-        @lmc.delete(key)
+        @lmc.delete(key) if key =~ matcher
       end
     end
 
-    def exist?(name,options = nil)
+    # Checks key for existance 
+    #
+    # (options are ignored at the time)
+    def exist?(name, options = nil)
       super
-      # TODO: Performance?
-      # Read the value and check for nil?
-      @lmc.keys.include?(name)
+      !@lmc[name].nil?
     end
 
+    # Clears the entire cache.
     def clear
       @lmc.clear
     end

data/test/localmemcache_store_test.rb

@@ -1,6 +1,5 @@
+require File.dirname(__FILE__) + '/test_helper'
 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
@@ -8,12 +7,12 @@ require 'active_support/cache/localmemcache_store'
 class LocalmemcacheStoreTest < ActiveSupport::TestCase
 
   def setup
-    @cache = ActiveSupport::Cache.lookup_store(:localmemcache_store)
+    @cache = ActiveSupport::Cache.lookup_store(:localmemcache_store, { :namespace => 'lmc_store_test' })
     @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
@@ -21,7 +20,7 @@ class LocalmemcacheStoreTest < ActiveSupport::TestCase
       assert_equal ret, value
     end
   end
-  
+
   test "read a cached value" do
     assert_nothing_raised do
       value = :value
@@ -29,7 +28,7 @@ class LocalmemcacheStoreTest < ActiveSupport::TestCase
       assert_equal value, @cache.read(:key)
     end
   end
-  
+
   test "entry expires" do
     value = :value
     @cache.write :key, value, :expires_in => 1.second
@@ -37,9 +36,9 @@ class LocalmemcacheStoreTest < ActiveSupport::TestCase
     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')

data/test/test_helper.rb

@@ -1,5 +1,6 @@
+require 'test/unit'
 require 'rubygems'
 require 'active_support'
 require 'active_support/test_case'
+require 'lib/active_support/cache/localmemcache_store'
 
-require File.dirname(__FILE__) + '/../rails/init.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: localmemcache_store
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors: 
 - "Florian D\xC3\xBCtsch (der_flo)"
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 +02:00
+date: 2009-10-27 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: localmemcache
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
 description: 
 email: mail@florian-duetsch.de
 executables: []
@@ -20,16 +29,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
 - MIT-LICENSE
-- Rakefile
-- README
-- TODOs.txt
+- README.rdoc
 - lib/active_support/cache/localmemcache_store.rb
 - lib/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
@@ -38,8 +44,8 @@ homepage: http://github.com/der-flo/localmemcache_store
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -61,5 +67,7 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A Rails cache store implementation for localmemcache
-test_files: []
-
+test_files: 
+- test/cache_store_behavior.rb
+- test/localmemcache_store_test.rb
+- test/test_helper.rb

data/README

@@ -1,16 +0,0 @@
-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

@@ -1,59 +0,0 @@
-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/**/*'
-]
-
-# TODO: Dependency
-
-spec = Gem::Specification.new do |s|
-  s.name = "localmemcache_store"
-  s.version = "0.0.2"
-  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

@@ -1,15 +0,0 @@
-Plugin
-* Better / more complete tests
-* Stuff from 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/tasks/localmemcache_store_tasks.rake

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