dalli 0.9.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mike Perham
+
+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/Performance.md

@@ -0,0 +1,24 @@
+Performance
+====================
+
+Caching is all about performance, so I carefully track Dalli performance to ensure no regressions.
+
+	Testing 1.8.5 with ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-darwin10.4.0]
+	                                     user     system      total        real
+	set:plain:memcache-client        1.600000   0.390000   1.990000 (  2.020491)
+	set:ruby:memcache-client         1.680000   0.390000   2.070000 (  2.108217)
+	get:plain:memcache-client        1.740000   0.250000   1.990000 (  2.018315)
+	get:ruby:memcache-client         1.790000   0.250000   2.040000 (  2.065529)
+	multiget:ruby:memcache-client    0.800000   0.090000   0.890000 (  0.914336)
+	missing:ruby:memcache-client     1.480000   0.250000   1.730000 (  1.761555)
+	mixed:ruby:memcache-client       3.470000   0.640000   4.110000 (  4.195236)
+
+	Testing 0.1.0 with ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-darwin10.4.0]
+	                                     user     system      total        real
+	set:plain:dalli                  0.430000   0.180000   0.610000 (  1.051395)
+	set:ruby:dalli                   0.490000   0.180000   0.670000 (  1.124848)
+	get:plain:dalli                  0.490000   0.210000   0.700000 (  1.141887)
+	get:ruby:dalli                   0.540000   0.200000   0.740000 (  1.188353)
+	multiget:ruby:dalli              0.510000   0.200000   0.710000 (  0.772860)
+	missing:ruby:dalli               0.450000   0.210000   0.660000 (  1.070748)
+	mixed:ruby:dalli                 1.050000   0.390000   1.440000 (  2.304933)

data/README.md

@@ -0,0 +1,75 @@
+Dalli
+=========
+
+Dalli is a high performance pure Ruby client for accessing memcached servers.  It works with memcached 1.4+ only as it uses the newer binary protocol.  The API tries to be mostly compatible with memcache-client with the goal being to make it a drop-in replacement for Rails.
+
+The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
+
+Dalli's development is sponsored by [NorthScale](http://www.northscale.com/).  Many thanks to them!
+
+
+Design
+------------
+
+I decided to write Dalli after maintaining memcache-client for the last two years for a few specific reasons:
+
+ 0. The code is mostly old and gross.  The bulk of the code is a single 1000 line .rb file.
+ 1. It has a lot of options that are infrequently used which complicate the codebase.
+ 2. The implementation has no single point to attach monitoring hooks.
+ 3. Uses the old text protocol, which hurts raw performance.
+
+So a few notes.  Dalli:
+
+ 0. uses the exact same algorithm to choose a server so existing memcached clusters with TBs of data will work identically to memcache-client.
+ 1. is approximately 20% faster than memcache-client (which itself was heavily optimized) in Ruby 1.9.2.
+ 2. contains explicit "chokepoint" methods which handle all requests; these can be hooked into by monitoring tools (NewRelic, Rack::Bug, etc) to track memcached usage.
+ 3. comes with hooks to replace memcache-client in Rails.
+
+
+Installation and Usage
+------------------------
+
+    gem install dalli
+
+    require 'dalli'
+    dc = Dalli::Client.new('localhost:11211')
+    dc.set('abc', 123)
+    value = dc.get('abc')
+
+
+Usage with Rails
+---------------------------
+
+In your Gemfile:
+
+    gem 'dalli'
+
+In `config/environments/production.rb`.  Note that we are also setting a reasonable default for maximum cache entry lifetime (one day), enabling compression for large values, and namespacing all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values.
+
+	require 'active_support/cache/dalli_store'
+    config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
+        :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true, :compress_threshold => 64.kilobytes
+
+
+Features and Changes
+------------------------
+
+memcache-client allowed developers to store either raw or marshalled values with each API call.  I feel this is needless complexity; Dalli allows you to control marshalling per-Client with the `:marshal => false` flag but you cannot explicitly set the raw flag for each API call.  By default, marshalling is enabled.
+
+I've removed support for key namespaces and automatic pruning of keys longer than 250 characters.  ActiveSupport::Cache implements these features so there is little need for Dalli to reinvent them.
+
+By default, Dalli is thread-safe.  Disable thread-safety at your own peril.
+
+Note that Dalli does not require ActiveSupport or Rails.  You can safely use it in your own Ruby projects.
+
+
+Author
+----------
+
+Mike Perham, mperham@gmail.com, [mikeperham.com](http://mikeperham.com), [@mperham](http://twitter.com/mperham)  If you like and use this project, please give me a recommendation at [WWR](http://workingwithrails.com/person/10797-mike-perham).  Happy caching!
+
+
+Copyright
+-----------
+
+Copyright (c) 2010 Mike Perham. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/dalli.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'dalli/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{dalli}
+  s.version = Dalli::VERSION
+
+  s.authors = ["Mike Perham"]
+  s.date = %q{2010-08-19}
+  s.description = %q{High performance memcached client for Ruby}
+  s.email = %q{mperham@gmail.com}
+  s.files = Dir.glob("lib/**/*") + [
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "Gemfile",
+     "dalli.gemspec",
+     "Performance.md",
+  ]
+  s.homepage = %q{http://github.com/mperham/dalli}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.summary = %q{High performance memcached client for Ruby}
+  s.test_files = Dir.glob("test/**/*")
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<rails>, [">= 3.0.0.rc"])
+  s.add_development_dependency(%q<memcache-client>, [">= 1.8.5"])
+end
+

data/lib/active_support/cache/dalli_store.rb

@@ -0,0 +1,177 @@
+begin
+  require 'dalli'
+rescue LoadError => e
+  $stderr.puts "You don't have dalli installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+require 'digest/md5'
+
+module ActiveSupport
+  module Cache
+    # A cache store implementation which stores data in Memcached:
+    # http://www.danga.com/memcached/
+    #
+    # DalliStore implements the Strategy::LocalCache strategy which implements
+    # an in memory cache inside of a block.
+    class DalliStore < Store
+      module Response # :nodoc:
+        STORED      = "STORED\r\n"
+        NOT_STORED  = "NOT_STORED\r\n"
+        EXISTS      = "EXISTS\r\n"
+        NOT_FOUND   = "NOT_FOUND\r\n"
+        DELETED     = "DELETED\r\n"
+      end
+
+      ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/
+
+      def self.build_mem_cache(*addresses)
+        addresses = addresses.flatten
+        options = addresses.extract_options!
+        addresses = ["localhost:11211"] if addresses.empty?
+        Dalli::Client.new(addresses, options)
+      end
+
+      # Creates a new DalliStore object, with the given memcached server
+      # addresses. Each address is either a host name, or a host-with-port string
+      # in the form of "host_name:port". For example:
+      #
+      #   ActiveSupport::Cache::DalliStore.new("localhost", "server-downstairs.localnetwork:8229")
+      #
+      # If no addresses are specified, then DalliStore will connect to
+      # localhost port 11211 (the default memcached port).
+      #
+      def initialize(*addresses)
+        addresses = addresses.flatten
+        options = addresses.extract_options!
+        super(options)
+
+        if addresses.first.respond_to?(:get)
+          @data = addresses.first
+        else
+          mem_cache_options = options.dup
+          UNIVERSAL_OPTIONS.each{|name| mem_cache_options.delete(name)}
+          @data = self.class.build_mem_cache(*(addresses + [mem_cache_options]))
+        end
+
+        extend Strategy::LocalCache
+        extend LocalCacheWithRaw
+      end
+
+      # Reads multiple keys from the cache using a single call to the
+      # servers for all keys. Options can be passed in the last argument.
+      def read_multi(*names)
+        options = names.extract_options!
+        options = merged_options(options)
+        keys_to_names = names.inject({}){|map, name| map[escape_key(namespaced_key(name, options))] = name; map}
+        raw_values = @data.get_multi(keys_to_names.keys)
+        values = {}
+        raw_values.each do |key, value|
+          entry = deserialize_entry(value)
+          values[keys_to_names[key]] = entry.value unless entry.expired?
+        end
+        values
+      end
+
+      # Increment a cached value. This method uses the memcached incr atomic
+      # operator and can only be used on values written with the :raw option.
+      # Calling it on a value not stored with :raw will initialize that value
+      # to zero.
+      def increment(name, amount = 1, options = nil) # :nodoc:
+        options = merged_options(options)
+        response = instrument(:increment, name, :amount => amount) do
+          @data.incr(escape_key(namespaced_key(name, options)), amount)
+        end
+        response == Response::NOT_FOUND ? nil : response.to_i
+      rescue Dalli::DalliError
+        nil
+      end
+
+      # Decrement a cached value. This method uses the memcached decr atomic
+      # operator and can only be used on values written with the :raw option.
+      # Calling it on a value not stored with :raw will initialize that value
+      # to zero.
+      def decrement(name, amount = 1, options = nil) # :nodoc:
+        options = merged_options(options)
+        response = instrument(:decrement, name, :amount => amount) do
+          @data.decr(escape_key(namespaced_key(name, options)), amount)
+        end
+        response == Response::NOT_FOUND ? nil : response.to_i
+      rescue Dalli::DalliError
+        nil
+      end
+
+      # Clear the entire cache on all memcached servers. This method should
+      # be used with care when using a shared cache.
+      def clear(options = nil)
+        @data.flush_all
+      end
+
+      # Get the statistics from the memcached servers.
+      def stats
+        @data.stats
+      end
+
+      protected
+        # Read an entry from the cache.
+        def read_entry(key, options) # :nodoc:
+          deserialize_entry(@data.get(escape_key(key)))
+        rescue Dalli::DalliError => e
+          logger.error("DalliError (#{e}): #{e.message}") if logger
+          nil
+        end
+
+        # Write an entry to the cache.
+        def write_entry(key, entry, options) # :nodoc:
+          method = options && options[:unless_exist] ? :add : :set
+          value = options[:raw] ? entry.value.to_s : entry
+          expires_in = options[:expires_in].to_i
+          if expires_in > 0 && !options[:raw]
+            # Set the memcache expire a few minutes in the future to support race condition ttls on read
+            expires_in += 5.minutes
+          end
+          @data.send(method, escape_key(key), value, expires_in)
+        rescue Dalli::DalliError => e
+          logger.error("DalliError (#{e}): #{e.message}") if logger
+          false
+        end
+
+        # Delete an entry from the cache.
+        def delete_entry(key, options) # :nodoc:
+          @data.delete(escape_key(key))
+        rescue Dalli::DalliError => e
+          logger.error("DalliError (#{e}): #{e.message}") if logger
+          false
+        end
+
+      private
+        def escape_key(key)
+          key = key.to_s.gsub(ESCAPE_KEY_CHARS){|match| "%#{match.getbyte(0).to_s(16).upcase}"}
+          key = "#{key[0, 213]}:md5:#{Digest::MD5.hexdigest(key)}" if key.size > 250
+          key
+        end
+
+        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
+
+      # Provide support for raw values in the local cache strategy.
+      module LocalCacheWithRaw # :nodoc:
+        protected
+          def write_entry(key, entry, options) # :nodoc:
+            retval = super
+            if options[:raw] && local_cache && retval
+              raw_entry = Entry.new(entry.value.to_s)
+              raw_entry.expires_at = entry.expires_at
+              local_cache.write_entry(key, raw_entry, options)
+            end
+            retval
+          end
+      end
+    end
+  end
+end

data/lib/dalli.rb

@@ -0,0 +1,25 @@
+require 'dalli/client'
+require 'dalli/ring'
+require 'dalli/server'
+require 'dalli/version'
+require 'dalli/options'
+
+require 'logger'
+
+module Dalli
+  # socket communication error
+  class DalliError < RuntimeError; end
+  class NetworkError < DalliError; end
+
+  def self.logger
+    @logger ||= begin
+      (defined?(Rails) && Rails.logger) ||
+      (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER) ||
+      (l = Logger.new(STDOUT); l.level = Logger::INFO; l)
+    end
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/dalli/client.rb

@@ -0,0 +1,122 @@
+module Dalli
+  class Client
+    
+    ##
+    # Dalli::Client is the main class which developers will use to interact with
+    # the memcached server.  Usage:
+    # <pre>
+    # Dalli::Client.new(['localhost:11211:10', 'cache-2.example.com:11211:5', '192.168.0.1:22122:5'], 
+    #                   :threadsafe => false, :marshal => false)
+    # </pre>
+    # servers is an Array of "host:port:weight" where weight allows you to distribute cache unevenly.
+    # Both weight and port are optional.
+    #
+    # Options:
+    #   :threadsafe - ensure that only one thread is actively using a socket at a time. Default: true.
+    #   :marshal - ensure that the value you store is exactly what is returned.  Otherwise you can see this:
+    #        set('abc', 123)
+    #        get('abc') ==> '123'  (Note you set an Integer but got back a String)
+    #      Default: true.
+    #
+    def initialize(servers, options={})
+      @ring = Dalli::Ring.new(
+        Array(servers).map do |s| 
+          Dalli::Server.new(s)
+        end
+      )
+      @ring.threadsafe! unless options[:threadsafe] == false
+      self.extend(Dalli::Marshal) unless options[:marshal] == false
+    end
+    
+    #
+    # The standard memcached instruction set
+    #
+
+    def get(key)
+      resp = perform(:get, key)
+      (!resp || resp == 'Not found') ? nil : deserialize(resp)
+    end
+
+    def get_multi(*keys)
+      @ring.lock do
+        keys.flatten.each do |key|
+          perform(:getkq, key)
+        end
+        values = @ring.servers.inject({}) { |hash, s| hash.merge!(s.request(:noop)); hash }
+        values.inject(values) { |memo, (k,v)| memo[k] = deserialize(v); memo }
+      end
+    end
+    
+    def set(key, value, ttl=0)
+      perform(:set, key, serialize(value), ttl)
+    end
+    
+    def add(key, value, ttl=0)
+      perform(:add, key, serialize(value), ttl)
+    end
+
+    def replace(key, value, ttl=0)
+      perform(:replace, key, serialize(value), ttl)
+    end
+
+    def delete(key)
+      perform(:delete, key)
+    end
+
+    def append(key, value)
+      perform(:append, key, value)
+    end
+
+    def prepend(key, value)
+      perform(:prepend, key, value)
+    end
+
+    def flush(delay=0)
+      time = -delay
+      @ring.servers.map { |s| s.request(:flush, time += delay) }
+    end
+
+    def flush_all
+      flush(0)
+    end
+
+    def incr(key, amt)
+      perform(:incr, key, amt)
+    end
+
+    def decr(key, amt)
+      perform(:decr, key, amt)
+    end
+
+    def stats
+      @ring.servers.inject({}) { |memo, s| memo["#{s.hostname}:#{s.port}"] = s.request(:stats); memo }
+    end
+
+    def close
+      @ring.servers.map { |s| s.close }
+    end
+
+    private
+
+    def serialize(value)
+      value.to_s
+    end
+    
+    def deserialize(value)
+      value
+    end
+
+    def perform(op, *args)
+      key = args.first
+      validate_key(key)
+      server = @ring.server_for_key(key)
+      server.request(op, *args)
+    end
+    
+    def validate_key(key)
+      raise ArgumentError, "illegal character in key #{key.inspect}" if key =~ /\s/
+      raise ArgumentError, "key cannot be blank" if key.nil? || key.strip.size == 0
+      raise ArgumentError, "key too long #{key.inspect}" if key.length > 250
+    end
+  end
+end