libmemcached_store 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg/
+*.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

@@ -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/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "libmemcached_store"
+    gemspec.version = '0.2.0'
+    gemspec.summary = "ActiveSupport::Cache wrapper for libmemcached "
+    gemspec.description = "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."
+    gemspec.email = "packagethief@gmail.com"
+    gemspec.homepage = "http://github.com/37signals/libmemcached_store"
+    gemspec.authors = ["Jeffrey Hardy"]
+    gemspec.add_runtime_dependency 'memcached'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the libmemcached_store plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  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/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,127 @@
+require 'memcached'
+
+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
+
+      DEFAULT_OPTIONS = {
+        :distribution => :consistent,
+        :no_block => true,
+        :failover => true
+      }
+
+      def initialize(*addresses)
+        addresses.flatten!
+        options = addresses.extract_options!
+        addresses = %w(localhost) if addresses.empty?
+
+        @addresses = addresses
+        @cache = Memcached.new(@addresses, options.reverse_merge(DEFAULT_OPTIONS))
+        extend ActiveSupport::Cache::Strategy::LocalCache
+      end
+
+      def read(key, options = nil)
+        super
+        @cache.get(key, marshal?(options))
+      rescue Memcached::NotFound
+        nil
+      rescue Memcached::Error => e
+        log_error(e)
+        nil
+      end
+
+      def read_multi(*keys)
+        read(keys) || {}
+      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)
+        super
+        method = (options && options[:unless_exist]) ? :add : :set
+        @cache.send(method, key, value, expires_in(options), marshal?(options))
+        true
+      rescue Memcached::Error => e
+        log_error(e)
+        false
+      end
+
+      def delete(key, options = nil)
+        super
+        @cache.delete(key)
+        true
+      rescue Memcached::NotFound
+        nil  
+      rescue Memcached::Error => e
+        log_error(e)
+        false
+      end
+
+      def exist?(key, options = nil)
+        !read(key, options).nil?
+      end
+
+      def increment(key, amount=1)
+        log 'incrementing', key, amount
+        @cache.incr(key, amount)
+      rescue Memcached::Error
+        nil
+      end
+
+      def decrement(key, amount=1)
+        log 'decrementing', key, amount
+        @cache.decr(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 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/test/libmemcached_store_test.rb

@@ -0,0 +1,76 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'memcached'
+
+require File.dirname(__FILE__) + '/../lib/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
+
+class LibmemcachedStoreTest < Test::Unit::TestCase
+  def setup
+    @store = ActiveSupport::Cache.lookup_store :libmemcached_store
+  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
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: libmemcached_store
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jeffrey Hardy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcached
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |-
+  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.
+email: packagethief@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- lib/active_support/cache/compressed_libmemcached_store.rb
+- lib/active_support/cache/libmemcached_store.rb
+- test/libmemcached_store_test.rb
+has_rdoc: true
+homepage: http://github.com/37signals/libmemcached_store
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveSupport::Cache wrapper for libmemcached
+test_files: 
+- test/libmemcached_store_test.rb