memcache-client 1.7.7 → 1.7.8

data/FAQ.rdoc

@@ -27,5 +27,5 @@ You can increase the timeout or disable them completely with the following confi
 
 The latest version of memcached-client is anywhere from 33% to 100% slower than memcached in various benchmarks.  Keep in mind this means that 10,000 get requests take 1.8 sec instead of 1.2 seconds.
 In practice, memcache-client is unlikely to be a bottleneck in your system but there is always going
-to be an overhead to pure Ruby.  memcache-client does have the advantage of built-in integration into 
+to be an overhead to pure Ruby.  memcache-client does have the advantage of built-in integration into
 Rails and should work on non-MRI platforms: JRuby, MacRuby, etc.

data/History.rdoc

@@ -1,6 +1,12 @@
+= 1.7.8 (2010-02-03)
+
+* Fix issue where autofix_keys logic did not account for namespace length. (menno)
+* Fix issue when using memcache-client without rubygems. (anvar)
+* Fix issue when using the cas method with raw=true (Takahiro Kikumoto)
+
 = 1.7.7 (2009-11-24)
 
-* Fix invalid delete request in memcached 1.4.x.  The expiry parameter to MemCache#delete is 
+* Fix invalid delete request in memcached 1.4.x.  The expiry parameter to MemCache#delete is
   now ignored as memcached 1.4.x has dropped support for this feature.
 
 = 1.7.6 (2009-11-03)
@@ -39,15 +45,15 @@
 
 = 1.7.1 (2009-03-28)
 
-* Performance optimizations: 
-  * Rely on higher performance operating system socket timeouts for low-level socket 
+* Performance optimizations:
+  * Rely on higher performance operating system socket timeouts for low-level socket
     read/writes where possible, instead of the (slower) SystemTimer or (slowest,
     unreliable) Timeout libraries.
-  * the native binary search is back!  The recent performance tuning made the binary search 
-    a bottleneck again so it had to return.  It uses RubyInline to compile the native extension and 
+  * the native binary search is back!  The recent performance tuning made the binary search
+    a bottleneck again so it had to return.  It uses RubyInline to compile the native extension and
     silently falls back to pure Ruby if anything fails.  Make sure you run:
     `gem install RubyInline` if you want ultimate performance.
-  * the changes make memcache-client 100% faster than 1.7.0 in my performance test on Ruby 1.8.6: 
+  * the changes make memcache-client 100% faster than 1.7.0 in my performance test on Ruby 1.8.6:
     15 sec -> 8 sec.
 * Fix several logging issues.
 
@@ -58,7 +64,7 @@
   - append
   - prepend
   - replace
-  
+
   Append and prepend only work with raw data since it makes no sense to concatenate two Marshalled
   values together.  The cas functionality should be considered a prototype.  Since I don't have an
   application which uses +cas+, I'm not sure what semantic sugar the API should provide.  Should it
@@ -119,17 +125,17 @@ and work on JRuby and Ruby 1.8.5 when the native code fails to compile.
 
 = 1.6.1 (2009-01-28)
 
-* Add option to disable socket timeout support.  Socket timeout has a significant performance 
-  penalty (approx 3x slower than without in Ruby 1.8.6).  You can turn off the timeouts if you 
+* Add option to disable socket timeout support.  Socket timeout has a significant performance
+  penalty (approx 3x slower than without in Ruby 1.8.6).  You can turn off the timeouts if you
   need absolute performance, but by default timeouts are enabled. The performance
   penalty is much lower in Ruby 1.8.7, 1.9 and JRuby.  (mperham)
 
-* Add option to disable server failover.  Failover can lead to "split-brain" caches that 
+* Add option to disable server failover.  Failover can lead to "split-brain" caches that
   return stale data. (mperham)
 
 * Implement continuum binary search in native code for performance reasons.  Pure ruby
   is available for platforms like JRuby or Rubinius which can't use C extensions. (mperham)
-  
+
 * Fix #add with raw=true (iamaleksey)
 
 = 1.6.0

data/README.rdoc

@@ -39,7 +39,7 @@ gem installed.
 
 == Questions?
 
-memcache-client is maintained by Mike Perham and was originally written by Bob Cottrell, 
+memcache-client is maintained by Mike Perham and was originally written by Bob Cottrell,
 Eric Hodel and the seattle.rb crew.
 
 Email::        mailto:mperham@gmail.com

data/Rakefile

@@ -14,18 +14,17 @@ begin
     s.has_rdoc = true
     s.files = FileList["[A-Z]*", "{lib,test}/**/*", 'performance.txt']
     s.test_files = FileList["test/test_*.rb"]
-    s.rubyforge_project = 'seattlerb'
   end
-
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it for jeweler-related tasks with: sudo gem install jeweler"
 end
 
 
 Rake::RDocTask.new do |rd|
-	rd.main = "README.rdoc"
-	rd.rdoc_files.include("README.rdoc", "FAQ.rdoc", "History.rdoc", "lib/memcache.rb")
-	rd.rdoc_dir = 'doc'
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "FAQ.rdoc", "History.rdoc", "lib/memcache.rb")
+  rd.rdoc_dir = 'doc'
 end
 
 Rake::TestTask.new do |t|

data/VERSION.yml

@@ -1,4 +1,4 @@
---- 
-:patch: 7
+---
+:patch: 8
 :major: 1
 :minor: 7

data/lib/memcache.rb

@@ -3,6 +3,7 @@ $TESTING = defined?($TESTING) && $TESTING
 require 'socket'
 require 'thread'
 require 'zlib'
+require 'yaml'
 require 'digest/sha1'
 require 'net/protocol'
 
@@ -82,13 +83,13 @@ class MemCache
   # The hash is only used on keys longer than 250 characters, or containing spaces,
   # to avoid impacting performance unnecesarily.
   #
-  # In theory, your code should generate correct keys when calling memcache, 
+  # In theory, your code should generate correct keys when calling memcache,
   # so it's your responsibility and you should try to fix this problem at its source.
   #
   # But if that's not possible, enable this option and memcache-client will give you a hand.
-  
+
   attr_reader :autofix_keys
-  
+
   ##
   # The servers this client talks to.  Play at your own peril.
 
@@ -136,7 +137,7 @@ class MemCache
   #                   set/add/delete/incr/decr significantly.
   #   [:check_size]   Raises a MemCacheError if the value to be set is greater than 1 MB, which
   #                   is the maximum key size for the standard memcached server.  Defaults to true.
-  #   [:autofix_keys] If a key is longer than 250 characters or contains spaces, 
+  #   [:autofix_keys] If a key is longer than 250 characters or contains spaces,
   #                   use an SHA1 hash instead, to prevent collisions on truncated keys.
   # Other options are ignored.
 
@@ -260,7 +261,7 @@ class MemCache
   end
 
   ##
-  # Performs a +get+ with the given +key+.  If 
+  # Performs a +get+ with the given +key+.  If
   # the value does not exist and a block was given,
   # the block will be called and the result saved via +add+.
   #
@@ -405,7 +406,7 @@ class MemCache
     (value, token) = gets(key, raw)
     return nil unless value
     updated = yield value
-    value = Marshal.dump updated unless raw
+    value = raw ? updated : Marshal.dump(updated)
 
     with_server(key) do |server, cache_key|
       logger.debug { "cas #{key} to #{server.inspect}: #{value.to_s.size}" } if logger
@@ -451,7 +452,7 @@ class MemCache
       end
     end
   end
-  
+
   ##
   # Add +key+ to the cache with value +value+ that expires in +expiry+
   # seconds, but only if +key+ already exists in the cache.
@@ -667,17 +668,24 @@ class MemCache
   # requested.
 
   def make_cache_key(key)
-    if @autofix_keys and (key =~ /\s/ or (key.length + (namespace.nil? ? 0 : namespace.length)) > 250)
+    if @autofix_keys && (key =~ /\s/ || key_length(key) > 250)
       key = "#{Digest::SHA1.hexdigest(key)}-autofixed"
     end
 
-    if namespace.nil? then
+    if namespace.nil?
       key
     else
       "#{@namespace}#{@namespace_separator}#{key}"
     end
   end
 
+  ##
+  # Calculate length of the key, including the namespace and namespace-separator.
+
+  def key_length(key)
+    key.length + (namespace.nil? ? 0 : ( namespace.length + (@namespace_separator.nil? ? 0 : @namespace_separator.length) ) )
+  end
+
   ##
   # Returns an interoperable hash value for +key+.  (I think, docs are
   # sketchy for down servers).
@@ -705,7 +713,7 @@ class MemCache
       break unless failover
       hkey = hash_for "#{try}#{key}"
     end
-    
+
     raise MemCacheError, "No servers available"
   end
 

data/lib/memcache_util.rb

@@ -1,12 +1,12 @@
 ##
 # A utility wrapper around the MemCache client to simplify cache access.  All
 # methods silently ignore MemCache errors.
-# 
+#
 # This API is deprecated, please use the Rails.cache API or your own wrapper API
 # around MemCache.
 
 module Cache
-  
+
   ##
   # Try to return a logger object that does not rely
   # on ActiveRecord for logging.

data/test/test_benchmark.rb

@@ -17,7 +17,7 @@ class TestBenchmark < Test::Unit::TestCase
     # which is a constant penalty that both clients have to pay
     @value = []
     @marshalled = Marshal.dump(@value)
-    
+
     @opts = [
       ['127.0.0.1:11211', 'localhost:11211'],
       {
@@ -31,16 +31,16 @@ class TestBenchmark < Test::Unit::TestCase
     @key3 = "Long"*40
     @key4 = "Medium"*8
     # 5 and 6 are only used for multiget miss test
-    @key5 = "Medium2"*8 
-    @key6 = "Long3"*40 
+    @key5 = "Medium2"*8
+    @key6 = "Long3"*40
   end
 
   def test_benchmark
     Benchmark.bm(31) do |x|
-    
+
       n = 2500
 #      n = 1000
-    
+
       @m = MemCache.new(*@opts)
       x.report("set:plain:memcache-client") do
         n.times do
@@ -52,7 +52,7 @@ class TestBenchmark < Test::Unit::TestCase
           @m.set @key3, @marshalled, 0, true
         end
       end
-    
+
       @m = MemCache.new(*@opts)
       x.report("set:ruby:memcache-client") do
         n.times do
@@ -64,7 +64,7 @@ class TestBenchmark < Test::Unit::TestCase
           @m.set @key3, @value
         end
       end
-    
+
       @m = MemCache.new(*@opts)
       x.report("get:plain:memcache-client") do
         n.times do
@@ -76,7 +76,7 @@ class TestBenchmark < Test::Unit::TestCase
           @m.get @key3, true
         end
       end
-    
+
       @m = MemCache.new(*@opts)
       x.report("get:ruby:memcache-client") do
         n.times do
@@ -96,7 +96,7 @@ class TestBenchmark < Test::Unit::TestCase
           @m.get_multi @key1, @key2, @key3, @key4, @key5, @key6
         end
       end
-    
+
       @m = MemCache.new(*@opts)
       x.report("missing:ruby:memcache-client") do
         n.times do
@@ -108,7 +108,7 @@ class TestBenchmark < Test::Unit::TestCase
           begin @m.get @key3; rescue; end
         end
       end
-          
+
       @m = MemCache.new(*@opts)
       x.report("mixed:ruby:memcache-client") do
         n.times do

data/test/test_mem_cache.rb

@@ -19,7 +19,7 @@ class MemCache
 
   attr_writer :namespace
   attr_writer :autofix_keys
-  
+
 end
 
 class FakeSocket
@@ -54,11 +54,11 @@ class Test::Unit::TestCase
       assert true
     end
   end
-  
+
   def memcached_running?
     TCPSocket.new('localhost', 11211) rescue false
   end
-  
+
   def xprofile(name, &block)
     a = Time.now
     block.call
@@ -76,7 +76,7 @@ class Test::Unit::TestCase
     end
     time
   end
-  
+
 end
 
 class FakeServer
@@ -168,7 +168,7 @@ class TestMemCache < Test::Unit::TestCase
       assert same_count > 700
     end
   end
-  
+
   def test_get_multi_with_server_failure
     @cache = MemCache.new 'localhost:1', :namespace => 'my_namespace', :logger => nil #Logger.new(STDOUT)
     s1 = FakeServer.new
@@ -211,11 +211,11 @@ class TestMemCache < Test::Unit::TestCase
     assert s1.alive?
     assert !s2.alive?
   end
-  
+
   def test_cache_get_without_failover
     s1 = FakeServer.new
     s2 = FakeServer.new
-    
+
     s1.socket.data.write "VALUE foo 0 14\r\n\004\b\"\0170123456789\r\n"
     s1.socket.data.rewind
     s2.socket.data.write "bogus response\r\nbogus response\r\n"
@@ -336,7 +336,7 @@ class TestMemCache < Test::Unit::TestCase
   def test_multithread_error
     server = FakeServer.new
     server.multithread = false
-    
+
     @cache = MemCache.new(['localhost:1'], :multithread => false)
 
     server.socket.data.write "bogus response\r\nbogus response\r\n"
@@ -489,7 +489,7 @@ class TestMemCache < Test::Unit::TestCase
     value = @cache.fetch('key', 1)
     assert_equal nil, value
   end
-  
+
   def test_fetch_miss
     server = FakeServer.new
     server.socket.data.write "END\r\n"
@@ -725,29 +725,37 @@ class TestMemCache < Test::Unit::TestCase
     hash = Digest::SHA1.hexdigest(key)
     @cache.namespace = nil
     assert_equal key, @cache.make_cache_key(key)
+  end
 
+  def test_make_cache_key_with_autofix
     @cache.autofix_keys = true
 
     @cache.namespace = "my_namespace"
     assert_equal 'my_namespace:key', @cache.make_cache_key('key')
     @cache.namespace = nil
     assert_equal 'key', @cache.make_cache_key('key')
-    
+
     key = "keys with more than two hundred and fifty characters can cause problems, because they get truncated and start colliding with each other. It's not a common occurrence, but when it happens is very hard to debug. the autofix option takes care of that for you"
     hash = Digest::SHA1.hexdigest(key)
     @cache.namespace = "my_namespace"
     assert_equal "my_namespace:#{hash}-autofixed", @cache.make_cache_key(key)
     @cache.namespace = nil
     assert_equal "#{hash}-autofixed", @cache.make_cache_key(key)
-    
+
     key = "a short key with spaces"
     hash = Digest::SHA1.hexdigest(key)
     @cache.namespace = "my_namespace"
     assert_equal "my_namespace:#{hash}-autofixed", @cache.make_cache_key(key)
     @cache.namespace = nil
     assert_equal "#{hash}-autofixed", @cache.make_cache_key(key)
+
+    # namespace + separator + key > 250
+    key = 'k' * 240
+    hash = Digest::SHA1.hexdigest(key)
+    @cache.namespace = 'n' * 10
+    assert_equal "#{@cache.namespace}:#{hash}-autofixed", @cache.make_cache_key(key)
   end
-  
+
   def test_servers
     server = FakeServer.new
     @cache.servers = []
@@ -864,7 +872,7 @@ class TestMemCache < Test::Unit::TestCase
     @cache.servers << server
 
     @cache.prepend 'key', 'value'
-    
+
     dumped = Marshal.dump('value')
 
     expected = "prepend my_namespace:key 0 0 5\r\nvalue\r\n"
@@ -879,7 +887,7 @@ class TestMemCache < Test::Unit::TestCase
     @cache.servers << server
 
     @cache.append 'key', 'value'
-    
+
     expected = "append my_namespace:key 0 0 5\r\nvalue\r\n"
     assert_equal expected, server.socket.written.string
   end
@@ -892,7 +900,7 @@ class TestMemCache < Test::Unit::TestCase
     @cache.servers << server
 
     @cache.replace 'key', 'value', 150
-    
+
     dumped = Marshal.dump('value')
 
     expected = "replace my_namespace:key 0 150 #{dumped.length}\r\n#{dumped}\r\n"
@@ -907,7 +915,7 @@ class TestMemCache < Test::Unit::TestCase
     @cache.servers << server
 
     @cache.add 'key', 'value'
-    
+
     dumped = Marshal.dump('value')
 
     expected = "add my_namespace:key 0 0 #{dumped.length}\r\n#{dumped}\r\n"
@@ -982,9 +990,9 @@ class TestMemCache < Test::Unit::TestCase
     server = FakeServer.new
     @cache.servers = []
     @cache.servers << server
-    
+
     @cache.delete 'key'
-    
+
     expected = "delete my_namespace:key\r\n"
     assert_equal expected, server.socket.written.string
   end
@@ -993,9 +1001,9 @@ class TestMemCache < Test::Unit::TestCase
     server = FakeServer.new
     @cache.servers = []
     @cache.servers << server
-    
+
     @cache.delete 'key', 300
-    
+
     expected = "delete my_namespace:key\r\n"
     assert_equal expected, server.socket.written.string
   end
@@ -1042,7 +1050,7 @@ class TestMemCache < Test::Unit::TestCase
 
     assert_match(/flush_all\r\n/, socket.written.string)
   end
-  
+
   def test_flush_all_for_real
     requirement(memcached_running?, 'A real memcached server must be running for testing flush_all') do
       cache = MemCache.new "localhost:11211", :namespace => "test_flush_all"