rails2_libmemcached_store 0.3.0

data/README

@@ -0,0 +1,47 @@
+= LibmemcachedStore
+
+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.
+
+== Prerequisites
+
+You'll need both the libmemcached client and the memcached gem:
+
+* http://tangent.org/552/libmemcached.html
+* http://blog.evanweaver.com/files/doc/fauna/memcached
+
+Make sure you install libmemcached first, before you try installing the gem. If
+you're using OS X, the easiest way to install libmemcached is through MacPorts:
+
+  sudo port install libmemcached
+
+For other platforms, download and extract the libmemcached tarball and install
+manually:
+
+  ./configure
+  make && sudo make install
+
+Once libmemcached is installed, install the memcached gem:
+
+  gem install memcached --no-rdoc --no-ri
+
+== Usage
+
+This is a drop-in replacement for the memcache store that ships with Rails. To
+enable, set the <tt>config.cache_store</tt> option to <tt>:libmemcached_store</tt>
+in the config for your environment
+
+  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:
+
+  config.cache_store = :libmemcached_store, %w(cache-01 cache-02 127.0.0.1:11212)
+
+== Props
+
+Thanks to Brian Aker (http://tangent.org) for creating libmemcached, and Evan
+Weaver (http://blog.evanweaver.com) for the Ruby wrapper.
+

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,182 @@
+require 'memcached'
+require 'digest/sha1'
+
+class Memcached
+  # The latest version of memcached (0.11) doesn't support hostnames with dashes
+  # in their names, so we overwrite it here to be more lenient.
+  def set_servers(servers)
+    [*servers].each_with_index do |server, index|
+      host, port = server.split(":")
+      Lib.memcached_server_add(@struct, host, port.to_i)
+    end
+  end
+end
+
+module ActiveSupport
+  module Cache
+    class LibmemcachedStore < Store
+      attr_reader :addresses
+
+      ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/n
+
+      DEFAULT_OPTIONS = {
+        :distribution => :consistent,
+        :no_block => true,
+        :failover => true
+      }
+
+      def initialize(*addresses)
+        addresses.flatten!
+        options = addresses.extract_options!
+        addresses = %w(localhost) if addresses.empty?
+
+        if options[:prefix_key]
+          @namespace_length = options[:prefix_key].length
+          @namespace_length += options[:prefix_delimiter].length if options[:prefix_delimiter]
+        else
+          @namespace_length = 0
+        end
+
+        @addresses = addresses
+        @cache = Memcached.new(@addresses, options.reverse_merge(DEFAULT_OPTIONS))
+        extend ActiveSupport::Cache::Strategy::LocalCache
+      end
+
+      def read(key, options = nil)
+        key = expanded_key(key)
+        super
+        @cache.get(escape_and_normalize(key), marshal?(options))
+      rescue Memcached::NotFound
+        nil
+      rescue Memcached::Error => e
+        log_error(e)
+        nil
+      end
+
+      def read_multi(*names)
+        names.flatten!
+        options = names.extract_options!
+
+        return {} if names.empty?
+
+        mapping = Hash[names.map {|name| [escape_and_normalize(expanded_key(name)), name] }]
+        raw_values = @cache.get(mapping.keys, marshal?(options))
+
+        values = {}
+        raw_values.each do |key, value|
+          values[mapping[key]] = value
+        end
+        values
+      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(key, value, options = nil)
+        key = expanded_key(key)
+        super
+        method = (options && options[:unless_exist]) ? :add : :set
+        @cache.send(method, escape_and_normalize(key), value, expires_in(options), marshal?(options))
+        true
+      rescue Memcached::Error => e
+        log_error(e)
+        false
+      end
+
+      def delete(key, options = nil)
+        key = expanded_key(key)
+        super
+        @cache.delete(escape_and_normalize(key))
+        true
+      rescue Memcached::NotFound
+        nil
+      rescue Memcached::Error => e
+        log_error(e)
+        false
+      end
+
+      def exist?(key, options = nil)
+        key = expanded_key(key)
+        !read(key, options).nil?
+      end
+
+      def increment(key, amount=1)
+        key = expanded_key(key)
+        log 'incrementing', key, amount
+        @cache.incr(escape_and_normalize(key), amount)
+      rescue Memcached::Error
+        nil
+      end
+
+      def decrement(key, amount=1)
+        key = expanded_key(key)
+        log 'decrementing', key, amount
+        @cache.decr(escape_and_normalize(key), amount)
+      rescue Memcached::Error
+        nil
+      end
+
+      def delete_matched(matcher, options = nil)
+        super
+        raise NotImplementedError
+      end
+
+      # Flushes all data in memory
+      def clear
+        @cache.flush
+      end
+
+      def stats
+        @cache.stats
+      end
+
+      # Resets server connections, forcing a reconnect. This is required in
+      # cases where processes fork, but continue sharing the same memcached
+      # connection. You want to call this after the fork to make sure the
+      # new process has its own connection.
+      def reset
+        @cache.reset
+      end
+
+      private
+
+        def escape_and_normalize(key)
+          key = key.to_s.dup.force_encoding("BINARY").gsub(ESCAPE_KEY_CHARS) { |match| "%#{match.getbyte(0).to_s(16).upcase}" }
+          key_length = key.length
+
+          return key if @namespace_length + key_length <= 250
+
+          max_key_length = 213 - @namespace_length
+          "#{key[0, max_key_length]}:md5:#{Digest::MD5.hexdigest(key)}"
+        end
+
+        def expanded_key(key) # :nodoc:
+          return key.cache_key.to_s if key.respond_to?(:cache_key)
+
+          case key
+          when Array
+            if key.size > 1
+              key = key.collect { |element| expanded_key(element) }
+            else
+              key = key.first
+            end
+          when Hash
+            key = key.sort_by { |k,_| k.to_s }.collect { |k, v| "#{k}=#{v}" }
+          end
+
+          key.to_param
+        end
+
+        def expires_in(options)
+          (options || {})[:expires_in] || 0
+        end
+
+        def marshal?(options)
+          !(options || {})[:raw]
+        end
+
+        def log_error(exception)
+          logger.error "MemcachedError (#{exception.inspect}): #{exception.message}" if logger && !@logger_off
+        end
+    end
+  end
+end

data/lib/libmemcached_store.rb

@@ -0,0 +1,2 @@
+require 'active_support/cache/libmemcached_store'
+require 'active_support/cache/compressed_libmemcached_store'

data/test/libmemcached_store_test.rb

@@ -0,0 +1,84 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'memcached'
+
+require File.dirname(__FILE__) + '/../lib/libmemcached_store'
+
+# Make it easier to get at the underlying cache options during testing.
+class ActiveSupport::Cache::LibmemcachedStore
+  delegate :options, :to => '@cache'
+end
+
+class LibmemcachedStoreTest < Test::Unit::TestCase
+  def setup
+    @store = ActiveSupport::Cache.lookup_store :libmemcached_store
+    @store.clear
+  end
+
+  def test_should_identify_cache_store
+    assert_kind_of ActiveSupport::Cache::LibmemcachedStore, @store
+  end
+
+  def test_should_set_server_addresses_to_localhost_if_none_are_given
+    assert_equal %w(localhost), @store.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_hashing_by_default
+    assert_equal :consistent, @store.options[:distribution]
+  end
+
+  def test_should_enable_non_blocking_io_by_default
+    assert_equal true, @store.options[:no_block]
+  end
+
+  def test_should_enable_server_failover_by_default
+    assert_equal true, @store.options[:auto_eject_hosts]
+  end
+
+  def test_should_allow_configuration_of_custom_options
+    options = {
+      :prefix_key => 'test',
+      :distribution => :modula,
+      :no_block => false,
+      :auto_eject_hosts => false
+    }
+
+    store = ActiveSupport::Cache.lookup_store :libmemcached_store, 'localhost', options
+
+    assert_equal 'test', store.instance_variable_get(:@cache).prefix_key
+    assert_equal :modula, store.options[:distribution]
+    assert_equal false, store.options[:no_block]
+    assert_equal false, store.options[:auto_eject_hosts]
+  end
+
+  def test_should_use_local_cache
+    @store.with_local_cache do
+      @store.write('key', 'value')
+      assert_equal 'value', @store.send(:local_cache).read('key')
+    end
+
+    assert_equal 'value', @store.read('key')
+  end
+
+  def test_should_read_multiple_keys
+     @store.write('a', 1)
+     @store.write('b', 2)
+
+     assert_equal({ 'a' => 1, 'b' => 2 }, @store.read_multi('a', 'b', 'c'))
+     assert_equal({}, @store.read_multi())
+   end
+
+  def test_should_fix_long_keys
+    key = ("0123456789" * 100).freeze
+    assert key.size > 250
+    @store.write(key, 1)
+    assert_equal 1, @store.read(key)
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rails2_libmemcached_store
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeffrey Hardy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !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: 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  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:
+- packagethief@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_support/cache/compressed_libmemcached_store.rb
+- lib/active_support/cache/libmemcached_store.rb
+- lib/libmemcached_store.rb
+- README
+- test/libmemcached_store_test.rb
+homepage: http://github.com/37signals/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'
+      segments:
+      - 0
+      hash: 2896348711499300858
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2896348711499300858
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ActiveSupport::Cache wrapper for libmemcached
+test_files:
+- test/libmemcached_store_test.rb