rails3_libmemcached_store 0.4.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.swp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+gemfile:
+  - gemfiles/rails30.gemfile
+  - gemfiles/rails31.gemfile
+  - gemfiles/rails32.gemfile

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 37signals
+
+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.md

@@ -0,0 +1,66 @@
+# LibmemcachedStore
+
+An ActiveSupport cache store that uses the C-based libmemcached client through Evan Weaver's Ruby/SWIG wrapper, [memcached](https://github.com/evan/memcached). libmemcached is fast (fastest memcache client for Ruby), lightweight, and supports consistent hashing, non-blocking IO, and graceful server failover.
+
+This cache is designed for Rails 3+ applications.
+
+## Prerequisites
+
+You'll need the memcached gem installed:
+
+```ruby  
+gem install memcached
+```
+
+or in your Gemfile  
+
+```ruby
+gem 'memcached'
+```
+
+There are no other dependencies.
+
+## Installation
+
+Just add to your Gemfile
+
+```ruby
+gem 'rails3_libmemcached_store'
+```
+
+and you're set.
+
+## Usage
+
+This is a drop-in replacement for the memcache store that ships with Rails. To
+enable, set the `config.cache_store` option to `libmemcached_store`
+in the config for your environment
+
+```ruby
+config.cache_store = :libmemcached_store
+```
+
+If no servers are specified, localhost is assumed. You can specify a list of
+server addresses, either as hostnames or IP addresses, with or without a port
+designation. If no port is given, 11211 is assumed:
+
+```ruby
+config.cache_store = :libmemcached_store, %w(cache-01 cache-02 127.0.0.1:11212)
+```
+
+Other options are passed directly to the memcached client
+  
+```ruby
+config.cache_store = :libmemcached_store, '127.0.0.1:11211', :default_ttl => 3600, :compress => true
+```
+
+You can also use `:libmemcached_store` to store your application sessions
+
+```ruby
+config.session_store = :libmemcached_store, :namespace => '_session', :expire_after => 1800
+```
+
+## Props
+
+Thanks to Brian Aker ([http://tangent.org](http://tangent.org)) for creating libmemcached, and Evan
+Weaver ([http://blog.evanweaver.com](http://blog.evanweaver.com)) for the Ruby wrapper.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = false
+  t.verbose = true
+end
+
+desc 'Generate documentation for the libmemcached_store plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LibmemcachedStore'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/gemfiles/rails30.gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'activesupport', '~> 3.0.0'
+gem 'actionpack', '~> 3.0.0'
+gem 'mocha'
+
+gemspec :path => '../'

data/gemfiles/rails31.gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'activesupport', '~> 3.1.0'
+gem 'actionpack', '~> 3.1.0'
+gem 'mocha'
+
+gemspec :path => '../'

data/gemfiles/rails32.gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'activesupport', '~> 3.2.0'
+gem 'actionpack', '~> 3.2.0'
+gem 'mocha'
+
+gemspec :path => '../'

data/lib/action_dispatch/session/libmemcached_store.rb

@@ -0,0 +1,81 @@
+require 'memcached'
+require 'rack/session/abstract/id'
+
+module ActionDispatch
+  module Session
+    class LibmemcachedStore < AbstractStore
+
+      DEFAULT_OPTIONS = Rack::Session::Abstract::ID::DEFAULT_OPTIONS.merge(:prefix_key => 'rack:session', :memcache_server => 'localhost:11211')
+
+      def initialize(app, options = {})
+        options[:expire_after] ||= options[:expires]
+        super
+        @mutex = Mutex.new
+        @pool = options[:cache] || Memcached.new(@default_options[:memcache_server], @default_options)
+      end
+
+      private
+
+      def generate_sid
+        loop do
+          sid = super
+          begin
+            @pool.get(sid)
+          rescue Memcached::NotFound
+            break sid
+          end
+        end
+      end
+
+      def get_session(env, sid)
+        sid ||= generate_sid
+        session = with_lock(env, {}) do
+          begin
+            @pool.get(sid)
+          rescue Memcached::NotFound
+            {}
+          end
+        end
+        [sid, session]
+      end
+
+      def set_session(env, session_id, new_session, options = {})
+        expiry  = options[:expire_after]
+        expiry = expiry.nil? ? 0 : expiry + 1
+
+        with_lock(env, false) do
+          @pool.set(session_id, new_session, expiry)
+          session_id
+        end
+      end
+
+      def destroy_session(env, session_id, options = {})
+        with_lock(env, nil) do
+          @pool.delete(session_id)
+          generate_sid unless options[:drop]
+        end
+      end
+
+      #
+      # Deprecated since Rails 3.1.0
+      #
+      def destroy(env)
+        if sid = current_session_id(env)
+          with_lock(env, false) do
+            @pool.delete(sid)
+          end
+        end 
+      end
+
+      def with_lock(env, default)
+        @mutex.lock if env['rack.multithread']
+        yield
+      rescue Memcached::Error => e
+        default
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+
+    end
+  end
+end

data/lib/active_support/cache/compressed_libmemcached_store.rb

@@ -0,0 +1,15 @@
+module ActiveSupport
+  module Cache
+    class CompressedLibmemcachedStore < LibmemcachedStore
+      def read(name, options = {})
+        if value = super(name, (options || {}).merge(:raw => true))
+          Marshal.load(ActiveSupport::Gzip.decompress(value))
+        end
+      end
+
+      def write(name, value, options = {})
+        super(name, ActiveSupport::Gzip.compress(Marshal.dump(value)), (options || {}).merge(:raw => true))
+      end
+    end
+  end
+end

data/lib/active_support/cache/libmemcached_store.rb

@@ -0,0 +1,135 @@
+require 'memcached'
+
+class ActiveSupport::Cache::Entry
+  # In 3.0 all values returned from Rails.cache.read are frozen.
+  # This makes sense for an in-memory store storing object references,
+  # but for a marshalled store we should be able to modify things.
+  # Starting with 3.2, values are not frozen anymore.
+  def value_with_dup
+    result = value_without_dup
+    result.frozen? && result.duplicable? ? result.dup : result
+  end
+  alias_method_chain :value, :dup
+end
+
+module ActiveSupport
+  module Cache
+    class LibmemcachedStore < Store
+      attr_reader :addresses
+
+      DEFAULT_OPTIONS = {
+        :distribution => :consistent_ketama,
+        :binary_protocol => true
+      }
+
+      def initialize(*addresses)
+        addresses.flatten!
+        @options = addresses.extract_options!
+        @addresses = addresses
+        @cache = Memcached.new(@addresses, @options.reverse_merge(DEFAULT_OPTIONS))
+      end
+
+      def increment(key, amount = 1, options = nil)
+        instrument(:increment, key, amount: amount) do
+          @cache.incr(key, amount)
+        end
+      rescue Memcached::Error
+        nil
+      end
+
+      def decrement(key, amount = 1, options = nil)
+        instrument(:decrement, key, amount: amount) do
+          @cache.decr(key, amount)
+        end
+      rescue Memcached::Error
+        nil
+      end
+
+      #
+      # Optimize read_multi to only make one call to memcached
+      # server.
+      #
+      def read_multi(*names)
+        options = names.extract_options!
+        options = merged_options(options)
+
+        return {} if names.empty?
+
+        keys_to_names = Hash[names.map {|name| [namespaced_key(name, options), name] }]
+        raw_values = @cache.get(keys_to_names.keys, false)
+
+        values = {}
+        raw_values.each do |key, value|
+          entry = deserialize_entry(value)
+          values[keys_to_names[key]] = entry.value unless entry.expired?
+        end
+        values
+      end
+
+      def clear
+        @cache.flush
+      end
+
+      def stats
+        @cache.stats
+      end
+
+      protected
+
+      def read_entry(key, options = nil)
+        deserialize_entry(@cache.get(key, false))
+      rescue Memcached::NotFound
+        nil
+      rescue Memcached::Error => e
+        log_error(e)
+        nil
+      end
+
+      # Set the key to the given value. Pass :unless_exist => true if you want to
+      # skip setting a key that already exists.
+      def write_entry(key, entry, options = nil)
+        method = (options && options[:unless_exist]) ? :add : :set
+        value = options[:raw] ? entry.value.to_s : entry
+
+        @cache.send(method, key, value, expires_in(options), marshal?(options))
+        true
+      rescue Memcached::Error => e
+        log_error(e)
+        false
+      end
+
+      def delete_entry(key, options = nil)
+        @cache.delete(key)
+        true
+      rescue Memcached::NotFound
+        false
+      rescue Memcached::Error => e
+        log_error(e)
+        false
+      end
+
+      private
+      def deserialize_entry(raw_value)
+        if raw_value
+          entry = Marshal.load(raw_value) rescue raw_value
+          entry.is_a?(Entry) ? entry : Entry.new(entry)
+        else
+          nil
+        end
+      end
+
+      def expires_in(options)
+        (options || {})[:expires_in].to_i
+      end
+
+      def marshal?(options)
+        !(options || {})[:raw]
+      end
+
+      def log_error(exception)
+        return unless logger && logger.error?
+        logger.error "MemcachedError (#{exception.inspect}): #{exception.message}"
+      end
+    end
+  end
+end

data/lib/libmemcached_store.rb

@@ -0,0 +1,3 @@
+require 'active_support/cache/libmemcached_store'
+require 'active_support/cache/compressed_libmemcached_store'
+require 'action_dispatch/session/libmemcached_store'

data/lib/version.rb

@@ -0,0 +1,3 @@
+module LibmemcachedStore
+  VERSION = "0.4.0".freeze
+end

data/libmemcached_store.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails3_libmemcached_store"
+  s.version     = LibmemcachedStore::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "ActiveSupport 3+ cache store for the C-based libmemcached client"
+  s.email       = "cocchi.c@gmail.com"
+  s.homepage    = "http://github.com/ccocchi/libmemcached_store"
+  s.description = %q{An ActiveSupport cache store that uses the C-based libmemcached client through
+      Evan Weaver's Ruby/SWIG wrapper, memcached. libmemcached is fast, lightweight,
+      and supports consistent hashing, non-blocking IO, and graceful server failover.}
+  s.authors     = ["Christopher Cocchi-Perrier", "Ben Hutton", "Jeffrey Hardy"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("memcached", ">= 0")
+
+  s.add_development_dependency('rack')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('activesupport', '>= 3')
+  s.add_development_dependency('actionpack', '>= 3')
+end
+

data/test/action_dispatch/abstract_unit.rb

@@ -0,0 +1,43 @@
+require 'active_support'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'action_controller'
+require 'action_dispatch/routing'
+require 'action_dispatch/middleware/head'
+require 'action_dispatch/testing/assertions'
+require 'action_dispatch/testing/test_process'
+require 'action_dispatch/testing/integration'
+
+SharedTestRoutes = ActionDispatch::Routing::RouteSet.new
+
+class RoutedRackApp
+  attr_reader :routes
+
+  def initialize(routes, &blk)
+    @routes = routes
+    @stack = ActionDispatch::MiddlewareStack.new(&blk).build(@routes)
+  end
+
+  def call(env)
+    @stack.call(env)
+  end
+end
+
+class ActionDispatch::IntegrationTest < ActiveSupport::TestCase
+  def self.build_app(routes = nil)
+    RoutedRackApp.new(routes || ActionDispatch::Routing::RouteSet.new) do |middleware|
+      if defined?(ActionDispatch::PublicExceptions)
+        middleware.use "ActionDispatch::ShowExceptions", ActionDispatch::PublicExceptions.new("/dev/null")
+        middleware.use "ActionDispatch::DebugExceptions"
+      else
+        middleware.use "ActionDispatch::ShowExceptions"
+      end
+      middleware.use "ActionDispatch::Callbacks"
+      middleware.use "ActionDispatch::ParamsParser"
+      middleware.use "ActionDispatch::Cookies"
+      middleware.use "ActionDispatch::Flash"
+      middleware.use "ActionDispatch::Head"
+      yield(middleware) if block_given?
+    end
+  end
+end

data/test/action_dispatch/libmemcached_store_test.rb

@@ -0,0 +1,200 @@
+require 'test_helper'
+require File.expand_path('../abstract_unit', __FILE__)
+require 'action_dispatch/session/libmemcached_store'
+
+class LibMemcachedStoreTest < ActionDispatch::IntegrationTest
+  class TestController < ActionController::Base
+    def no_session_access
+      head :ok
+    end
+
+    def set_session_value
+      session[:foo] = "bar"
+      head :ok
+    end
+
+    def set_serialized_session_value
+      session[:foo] = SessionAutoloadTest::Foo.new
+      head :ok
+    end
+
+    def get_session_value
+      render :text => "foo: #{session[:foo].inspect}"
+    end
+
+    def get_session_id
+      render :text => "#{request.session_options[:id]}"
+    end
+
+    def call_reset_session
+      session[:bar]
+      reset_session
+      session[:bar] = "baz"
+      head :ok
+    end
+
+    def self._routes
+      SharedTestRoutes
+    end
+  end
+
+  def test_setting_and_getting_session_value
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: "bar"', response.body
+    end
+  end
+
+  def test_getting_nil_session_value
+    with_test_route_set do
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+    end
+  end
+
+  def test_getting_session_value_after_session_reset
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+      session_cookie = cookies.send(:hash_for)['_session_id']
+
+      get '/call_reset_session'
+      assert_response :success
+      assert_not_equal [], headers['Set-Cookie']
+
+      cookies << session_cookie # replace our new session_id with our old, pre-reset session_id
+
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body, "data for this session should have been obliterated from memcached"
+    end
+  end
+
+  def test_getting_from_nonexistent_session
+    with_test_route_set do
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+      assert_nil cookies['_session_id'], "should only create session on write, not read"
+    end
+  end
+
+  def test_setting_session_value_after_session_reset
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+      session_id = cookies['_session_id']
+
+      get '/call_reset_session'
+      assert_response :success
+      assert_not_equal [], headers['Set-Cookie']
+
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+
+      get '/get_session_id'
+      assert_response :success
+      assert_not_equal session_id, response.body
+    end
+  end
+
+  def test_getting_session_id
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+      session_id = cookies['_session_id']
+
+      get '/get_session_id'
+      assert_response :success
+      assert_equal session_id, response.body, "should be able to read session id without accessing the session hash"
+    end
+  end
+
+  def test_deserializes_unloaded_class
+    with_test_route_set do
+      with_autoload_path "session_autoload_test" do
+        get '/set_serialized_session_value'
+        assert_response :success
+        assert cookies['_session_id']
+      end
+      with_autoload_path "session_autoload_test" do
+        get '/get_session_id'
+        assert_response :success
+      end
+      with_autoload_path "session_autoload_test" do
+        get '/get_session_value'
+        assert_response :success
+        assert_equal 'foo: #<SessionAutoloadTest::Foo bar:"baz">', response.body, "should auto-load unloaded class"
+      end
+    end
+  end
+
+  def test_doesnt_write_session_cookie_if_session_id_is_already_exists
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+
+      get '/get_session_value'
+      assert_response :success
+      assert_equal nil, headers['Set-Cookie'], "should not resend the cookie again if session_id cookie is already exists"
+    end
+  end
+
+  def test_prevents_session_fixation
+    with_test_route_set do
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+      session_id = cookies['_session_id']
+
+      reset!
+
+      get '/set_session_value', :_session_id => session_id
+      assert_response :success
+      assert_not_equal session_id, cookies['_session_id']
+    end
+  end
+
+  private
+
+  def with_test_route_set
+    with_routing do |set|
+      set.draw do
+        match ':action', :to => TestController
+      end
+
+      @app = self.class.build_app(set) do |middleware|
+        middleware.use ActionDispatch::Session::LibmemcachedStore, :key => '_session_id'
+        middleware.delete "ActionDispatch::ShowExceptions"
+      end
+
+      yield
+    end
+  end
+
+  def with_autoload_path(path)
+    path = File.join(File.dirname(__FILE__), "../fixtures", path)
+    if ActiveSupport::Dependencies.autoload_paths.include?(path)
+      yield
+    else
+      begin
+        ActiveSupport::Dependencies.autoload_paths << path
+        yield
+      ensure
+        ActiveSupport::Dependencies.autoload_paths.reject! {|p| p == path}
+        ActiveSupport::Dependencies.clear
+      end
+    end
+  end
+end

data/test/active_support/libmemcached_store_test.rb

@@ -0,0 +1,351 @@
+require 'test_helper'
+require 'memcached'
+require 'active_support'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/object/duplicable'
+require 'active_support/cache/libmemcached_store'
+
+# Make it easier to get at the underlying cache options during testing.
+class ActiveSupport::Cache::LibmemcachedStore
+  delegate :options, :to => '@cache'
+end
+
+module CacheStoreBehavior
+  def test_should_read_and_write_strings
+    assert_equal true, @cache.write('foo', 'bar')
+    assert_equal 'bar', @cache.read('foo')
+  end
+
+  def test_should_overwrite
+    @cache.write('foo', 'bar')
+    @cache.write('foo', 'baz')
+    assert_equal 'baz', @cache.read('foo')
+  end
+
+  def test_fetch_without_cache_miss
+    @cache.write('foo', 'bar')
+    @cache.expects(:write).never
+    assert_equal 'bar', @cache.fetch('foo') { 'baz' }
+  end
+
+  def test_fetch_with_cache_miss
+    @cache.expects(:write).with('foo', 'baz', @cache.options)
+    assert_equal 'baz', @cache.fetch('foo') { 'baz' }
+  end
+
+  def test_fetch_with_forced_cache_miss
+    @cache.write('foo', 'bar')
+    @cache.expects(:read).never
+    @cache.expects(:write).with('foo', 'bar', @cache.options.merge(:force => true))
+    @cache.fetch('foo', :force => true) { 'bar' }
+  end
+
+  def test_fetch_with_cached_nil
+    @cache.write('foo', nil)
+    @cache.expects(:write).never
+    assert_nil @cache.fetch('foo') { 'baz' }
+  end
+
+  def test_should_read_and_write_hash
+    assert_equal true, @cache.write('foo', {:a => "b"})
+    assert_equal({:a => "b"}, @cache.read('foo'))
+  end
+
+  def test_should_read_and_write_integer
+    assert_equal true, @cache.write('foo', 1)
+    assert_equal 1, @cache.read('foo')
+  end
+
+  def test_should_read_and_write_nil
+    assert_equal true, @cache.write('foo', nil)
+    assert_equal nil, @cache.read('foo')
+  end
+
+  def test_should_read_and_write_false
+    assert @cache.write('foo', false)
+    if ActiveSupport::VERSION::MAJOR == 3 && ActiveSupport::VERSION::MINOR == 0
+      assert_equal nil, @cache.read('foo')
+    else
+      assert_equal false, @cache.read('foo')
+    end
+  end
+
+  def test_read_multi
+    @cache.write('foo', 'bar')
+    @cache.write('fu', 'baz')
+    @cache.write('fud', 'biz')
+    assert_equal({"foo" => "bar", "fu" => "baz"}, @cache.read_multi('foo', 'fu'))
+  end
+
+  def test_read_multi_with_expires
+    @cache.write('foo', 'bar', :expires_in => 0.001)
+    @cache.write('fu', 'baz')
+    @cache.write('fud', 'biz')
+    sleep(0.002)
+    assert_equal({"fu" => "baz"}, @cache.read_multi('foo', 'fu'))
+  end
+
+  def test_read_and_write_compressed_small_data
+    @cache.write('foo', 'bar', :compress => true)
+    raw_value = @cache.send(:read_entry, 'foo', {}).raw_value
+    assert_equal 'bar', @cache.read('foo')
+    value = Marshal.load(raw_value) rescue raw_value
+    assert_equal 'bar', value
+  end
+
+  def test_read_and_write_compressed_large_data
+    @cache.write('foo', 'bar', :compress => true, :compress_threshold => 2)
+    raw_value = @cache.send(:read_entry, 'foo', {}).raw_value
+    assert_equal 'bar', @cache.read('foo')
+    assert_equal 'bar', Marshal.load(Zlib::Inflate.inflate(raw_value))
+  end
+
+  def test_read_and_write_compressed_nil
+    @cache.write('foo', nil, :compress => true)
+    assert_nil @cache.read('foo')
+  end
+
+  def test_cache_key
+    obj = Object.new
+    def obj.cache_key
+      :foo
+    end
+    @cache.write(obj, "bar")
+    assert_equal "bar", @cache.read("foo")
+  end
+
+  def test_param_as_cache_key
+    obj = Object.new
+    def obj.to_param
+      "foo"
+    end
+    @cache.write(obj, "bar")
+    assert_equal "bar", @cache.read("foo")
+  end
+
+  def test_array_as_cache_key
+    @cache.write([:fu, "foo"], "bar")
+    assert_equal "bar", @cache.read("fu/foo")
+  end
+
+  def test_hash_as_cache_key
+    @cache.write({:foo => 1, :fu => 2}, "bar")
+    assert_equal "bar", @cache.read("foo=1/fu=2")
+  end
+
+  def test_keys_are_case_sensitive
+    @cache.write("foo", "bar")
+    assert_nil @cache.read("FOO")
+  end
+
+  def test_exist
+    @cache.write('foo', 'bar')
+    assert_equal true, @cache.exist?('foo')
+    assert_equal false, @cache.exist?('bar')
+  end
+
+  def test_nil_exist
+    @cache.write('foo', nil)
+    assert_equal true, @cache.exist?('foo')
+  end
+
+  def test_delete
+    @cache.write('foo', 'bar')
+    assert @cache.exist?('foo')
+    assert_equal true, @cache.delete('foo')
+    assert !@cache.exist?('foo')
+  end
+
+  def test_delete_with_unexistent_key
+    @cache.expects(:log_error).never
+    assert !@cache.exist?('foo')
+    assert_equal false, @cache.delete('foo')
+  end
+
+  def test_read_should_return_a_different_object_id_each_time_it_is_called
+    @cache.write('foo', 'bar')
+    refute_equal @cache.read('foo').object_id, @cache.read('foo').object_id
+  end
+
+  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_original_store_objects_should_not_be_immutable
+    bar = 'bar'
+    @cache.write('foo', bar)
+    assert_equal 'baz', bar.gsub!(/r/, 'z')
+  end
+
+  def test_expires_in
+    time = Time.local(2008, 4, 24)
+    Time.stubs(:now).returns(time)
+
+    @cache.write('foo', 'bar', :expires_in => 45)
+    assert_equal 'bar', @cache.read('foo')
+
+    Time.stubs(:now).returns(time + 30)
+    assert_equal 'bar', @cache.read('foo')
+
+    Time.stubs(:now).returns(time + 61)
+    assert_nil @cache.read('foo')
+  end
+
+  def test_expires_in_as_activesupport_duration
+    time = Time.local(2012, 02, 03)
+    Time.stubs(:now).returns(time)
+
+    @cache.write('foo', 'bar', :expires_in => 1.minute)
+    assert_equal 'bar', @cache.read('foo')
+
+    Time.stubs(:now).returns(time + 30)
+    assert_equal 'bar', @cache.read('foo')
+
+    Time.stubs(:now).returns(time + 61)
+    assert_nil @cache.read('foo')
+  end
+
+  def test_expires_in_as_float
+    time = Time.local(2012, 02, 03)
+    Time.stubs(:now).returns(time)
+
+    @cache.write('foo', 'bar', :expires_in => 60.0)
+    assert_equal 'bar', @cache.read('foo')
+
+    Time.stubs(:now).returns(time + 30)
+    assert_equal 'bar', @cache.read('foo')
+
+    Time.stubs(:now).returns(time + 61)
+    assert_nil @cache.read('foo')
+  end
+
+  def test_race_condition_protection
+    time = Time.now
+    @cache.write('foo', 'bar', :expires_in => 60)
+    Time.stubs(:now).returns(time + 61)
+    result = @cache.fetch('foo', :race_condition_ttl => 10) do
+      assert_equal 'bar', @cache.read('foo')
+      "baz"
+    end
+    assert_equal "baz", result
+  end
+
+  def test_race_condition_protection_is_limited
+    time = Time.now
+    @cache.write('foo', 'bar', :expires_in => 60)
+    Time.stubs(:now).returns(time + 71)
+    result = @cache.fetch('foo', :race_condition_ttl => 10) do
+      assert_equal nil, @cache.read('foo')
+      "baz"
+    end
+    assert_equal "baz", result
+  end
+
+  def test_race_condition_protection_is_safe
+    time = Time.now
+    @cache.write('foo', 'bar', :expires_in => 60)
+    Time.stubs(:now).returns(time + 61)
+    begin
+      @cache.fetch('foo', :race_condition_ttl => 10) do
+        assert_equal 'bar', @cache.read('foo')
+        raise ArgumentError.new
+      end
+    rescue ArgumentError
+    end
+    assert_equal "bar", @cache.read('foo')
+    Time.stubs(:now).returns(time + 71)
+    assert_nil @cache.read('foo')
+  end
+
+  def test_crazy_key_characters
+    crazy_key = "#/:*(<+=> )&$%@?;'\"\'`~-"
+    assert_equal true, @cache.write(crazy_key, "1", :raw => true)
+    assert_equal "1", @cache.read(crazy_key)
+    assert_equal "1", @cache.fetch(crazy_key)
+    assert_equal true, @cache.delete(crazy_key)
+    assert_equal "2", @cache.fetch(crazy_key, :raw => true) { "2" }
+    assert_equal 3, @cache.increment(crazy_key)
+    assert_equal 2, @cache.decrement(crazy_key)
+  end
+
+  # def test_really_long_keys
+  #   key = ""
+  #   900.times{key << "x"}
+  #   assert @cache.write(key, "bar")
+  #   assert_equal "bar", @cache.read(key)
+  #   assert_equal "bar", @cache.fetch(key)
+  #   assert_nil @cache.read("#{key}x")
+  #   assert_equal({key => "bar"}, @cache.read_multi(key))
+  #   assert @cache.delete(key)
+  # end
+end
+
+module CacheIncrementDecrementBehavior
+  def test_increment
+    @cache.write('foo', 1, :raw => true)
+    assert_equal 1, @cache.read('foo').to_i
+    assert_equal 2, @cache.increment('foo')
+    assert_equal 2, @cache.read('foo').to_i
+    assert_equal 3, @cache.increment('foo')
+    assert_equal 3, @cache.read('foo').to_i
+  end
+
+  def test_decrement
+    @cache.write('foo', 3, :raw => true)
+    assert_equal 3, @cache.read('foo').to_i
+    assert_equal 2, @cache.decrement('foo')
+    assert_equal 2, @cache.read('foo').to_i
+    assert_equal 1, @cache.decrement('foo')
+    assert_equal 1, @cache.read('foo').to_i
+  end
+end
+
+class LibmemcachedStoreTest < MiniTest::Unit::TestCase
+  include CacheStoreBehavior
+  include CacheIncrementDecrementBehavior
+
+  def setup
+    @cache = ActiveSupport::Cache.lookup_store(:libmemcached_store, :expires_in => 60)
+    @cache.clear
+    @cache.silence!
+  end
+
+  def test_should_identify_cache_store
+    assert_kind_of ActiveSupport::Cache::LibmemcachedStore, @cache
+  end
+
+  def test_should_set_server_addresses_to_nil_if_none_are_given
+    assert_equal [], @cache.addresses
+  end
+
+  def test_should_set_custom_server_addresses
+    store = ActiveSupport::Cache.lookup_store :libmemcached_store, 'localhost', '192.168.1.1'
+    assert_equal %w(localhost 192.168.1.1), store.addresses
+  end
+
+  def test_should_enable_consistent_ketema_hashing_by_default
+    assert_equal :consistent_ketama, @cache.options[:distribution]
+  end
+
+  def test_should_not_enable_non_blocking_io_by_default
+    assert_equal false, @cache.options[:no_block]
+  end
+
+  def test_should_not_enable_server_failover_by_default
+    assert_nil @cache.options[:failover]
+  end
+
+  def test_should_allow_configuration_of_custom_options
+    options = {
+      :tcp_nodelay => true,
+      :distribution => :modula
+    }
+
+    store = ActiveSupport::Cache.lookup_store :libmemcached_store, 'localhost', options
+
+    assert_equal :modula, store.options[:distribution]
+    assert_equal true, store.options[:tcp_nodelay]
+  end
+end

data/test/fixtures/session_autoload_test.rb

@@ -0,0 +1,10 @@
+module SessionAutoloadTest
+  class Foo
+    def initialize(bar='baz')
+      @bar = bar
+    end
+    def inspect
+      "#<#{self.class} bar:#{@bar.inspect}>"
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] = "test"
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'minitest/autorun'
+require 'mocha'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: rails3_libmemcached_store
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Cocchi-Perrier
+- Ben Hutton
+- Jeffrey Hardy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memcached
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+description: ! "An ActiveSupport cache store that uses the C-based libmemcached client
+  through\n      Evan Weaver's Ruby/SWIG wrapper, memcached. libmemcached is fast,
+  lightweight,\n      and supports consistent hashing, non-blocking IO, and graceful
+  server failover."
+email: cocchi.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gemfiles/rails30.gemfile
+- gemfiles/rails31.gemfile
+- gemfiles/rails32.gemfile
+- lib/action_dispatch/session/libmemcached_store.rb
+- lib/active_support/cache/compressed_libmemcached_store.rb
+- lib/active_support/cache/libmemcached_store.rb
+- lib/libmemcached_store.rb
+- lib/version.rb
+- libmemcached_store.gemspec
+- test/action_dispatch/abstract_unit.rb
+- test/action_dispatch/libmemcached_store_test.rb
+- test/active_support/libmemcached_store_test.rb
+- test/fixtures/session_autoload_test.rb
+- test/test_helper.rb
+homepage: http://github.com/ccocchi/libmemcached_store
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ActiveSupport 3+ cache store for the C-based libmemcached client
+test_files:
+- test/action_dispatch/abstract_unit.rb
+- test/action_dispatch/libmemcached_store_test.rb
+- test/active_support/libmemcached_store_test.rb
+- test/fixtures/session_autoload_test.rb
+- test/test_helper.rb