memcached 1.0.7 → 1.1

data/lib/memcached.rb

@@ -24,7 +24,6 @@ class Memcached
   VERSION = File.read("#{File.dirname(__FILE__)}/../CHANGELOG")[/v([\d\.]+)\./, 1]
 end
 
-require 'memcached/integer'
 require 'memcached/exceptions'
 require 'memcached/behaviors'
 require 'memcached/auth'

data/lib/memcached/memcached.rb

@@ -91,7 +91,7 @@ Valid option parameters are:
 <tt>:default_weight</tt>:: The weight to use if <tt>:ketama_weighted</tt> is <tt>true</tt>, but no weight is specified for a server.
 <tt>:hash_with_prefix_key</tt>:: Whether to include the prefix when calculating which server a key falls on. Defaults to <tt>true</tt>.
 <tt>:use_udp</tt>:: Use the UDP protocol to reduce connection overhead. Defaults to false.
-<tt>:binary_protocol</tt>:: Use the binary protocol to reduce query processing overhead. Defaults to false.
+<tt>:binary_protocol</tt>:: Use the binary protocol. Defaults to false. Please note that using the binary protocol is usually <b>slower</b> than the ASCII protocol.
 <tt>:sort_hosts</tt>:: Whether to force the server list to stay sorted. This defeats consistent hashing and is rarely useful.
 <tt>:verify_key</tt>:: Validate keys before accepting them. Never disable this.
 
@@ -120,7 +120,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     end
 
     instance_eval { send(:extend, Experimental) } if options[:experimental_features]
- 
+
     options[:binary_protocol] = true if options[:credentials] != nil
 
     # Force :buffer_requests to use :no_block
@@ -303,7 +303,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
 
   # Set a key/value pair. Accepts a String <tt>key</tt> and an arbitrary Ruby object. Overwrites any existing value on the server.
   #
-  # Accepts an optional <tt>ttl</tt> value to specify the maximum lifetime of the key on the server. <tt>ttl</tt> can be either an integer number of seconds, or a Time elapsed time object. <tt>0</tt> means no ttl. Note that there is no guarantee that the key will persist as long as the <tt>ttl</tt>, but it will not persist longer.
+  # Accepts an optional <tt>ttl</tt> value to specify the maximum lifetime of the key on the server, in seconds. <tt>ttl</tt> must be a <tt>FixNum</tt>. <tt>0</tt> means no ttl. Note that there is no guarantee that the key will persist as long as the <tt>ttl</tt>, but it will not persist longer.
   #
   # Also accepts a <tt>marshal</tt> value, which defaults to <tt>true</tt>. Set <tt>marshal</tt> to <tt>false</tt> if you want the <tt>value</tt> to be set directly.
   #
@@ -319,7 +319,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
       retry if e.instance_of?(ClientError) && !tries
       raise unless tries < options[:exception_retry_limit] && should_retry(e)
       tries += 1
-      retry 
+      retry
     end
   end
 
@@ -335,7 +335,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
       tries ||= 0
       raise unless tries < options[:exception_retry_limit] && should_retry(e)
       tries += 1
-      retry 
+      retry
     end
   end
 
@@ -352,7 +352,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     tries ||= 0
     raise unless tries < options[:exception_retry_limit] && should_retry(e)
     tries += 1
-    retry 
+    retry
   end
 
   # Decrement a key's value. The parameters and exception behavior are the same as <tt>increment</tt>.
@@ -364,7 +364,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     tries ||= 0
     raise unless tries < options[:exception_retry_limit] && should_retry(e)
     tries += 1
-    retry 
+    retry
   end
 
   #:stopdoc:
@@ -384,7 +384,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
       tries ||= 0
       raise unless tries < options[:exception_retry_limit] && should_retry(e)
       tries += 1
-      retry 
+      retry
     end
   end
 
@@ -401,7 +401,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     tries ||= 0
     raise unless tries < options[:exception_retry_limit] && should_retry(e)
     tries += 1
-    retry 
+    retry
   end
 
   # Prepends a string to a key's value. The parameters and exception behavior are the same as <tt>append</tt>.
@@ -415,7 +415,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     tries ||= 0
     raise unless tries < options[:exception_retry_limit] && should_retry(e)
     tries += 1
-    retry 
+    retry
   end
 
   # Reads a key's value from the server and yields it to a block. Replaces the key's value with the result of the block as long as the key hasn't been updated in the meantime, otherwise raises <b>Memcached::NotStored</b>. Accepts a String <tt>key</tt> and a block.
@@ -434,9 +434,9 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
       tries_for_get ||= 0
       raise unless tries_for_get < options[:exception_retry_limit] && should_retry(e)
       tries_for_get += 1
-      retry 
+      retry
     end
-    
+
     cas = @struct.result.cas
 
     value = Marshal.load(value) if marshal
@@ -452,7 +452,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
       tries_for_cas ||= 0
       raise unless tries_for_cas < options[:exception_retry_limit] && should_retry(e)
       tries_for_cas += 1
-      retry 
+      retry
     end
   end
 
@@ -470,7 +470,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     tries ||= 0
     raise unless tries < options[:exception_retry_limit] && should_retry(e)
     tries += 1
-    retry 
+    retry
   end
 
   # Flushes all key/value pairs from all the servers.
@@ -482,7 +482,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     tries ||= 0
     raise unless tries < options[:exception_retry_limit] && should_retry(e)
     tries += 1
-    retry 
+    retry
   end
 
 ### Getters

data/memcached.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{memcached}
-  s.version = "1.0.7"
+  s.version = "1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email = %q{}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = ["BENCHMARKS", "CHANGELOG", "LICENSE", "README", "TODO", "lib/memcached.rb", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/experimental.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb"]
-  s.files = ["BENCHMARKS", "CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "TODO", "ext/extconf.rb", "ext/libmemcached-0.32.tar.gz", "ext/libmemcached-2.patch", "ext/libmemcached-3.patch", "ext/libmemcached-4.patch", "ext/libmemcached-5.patch", "ext/libmemcached-6.patch", "ext/libmemcached.patch", "ext/rlibmemcached.i", "ext/rlibmemcached_wrap.c", "ext/sasl.patch", "lib/memcached.rb", "lib/memcached/auth.rb", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/experimental.rb", "lib/memcached/integer.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb", "memcached.gemspec", "test/profile/benchmark.rb", "test/profile/profile.rb", "test/profile/valgrind.rb", "test/setup.rb", "test/teardown.rb", "test/test_helper.rb", "test/unit/binding_test.rb", "test/unit/memcached_experimental_test.rb", "test/unit/memcached_test.rb", "test/unit/rails_test.rb"]
+  s.files = ["BENCHMARKS", "CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "TODO", "ext/extconf-make.rb", "ext/extconf.rb", "ext/libmemcached-0.32.tar.gz", "ext/libmemcached-2.patch", "ext/libmemcached-3.patch", "ext/libmemcached-4.patch", "ext/libmemcached-5.patch", "ext/libmemcached-6.patch", "ext/libmemcached.patch", "ext/rlibmemcached.i", "ext/rlibmemcached_wrap.c", "ext/sasl.patch", "lib/memcached.rb", "lib/memcached/auth.rb", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/experimental.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb", "test/profile/benchmark.rb", "test/profile/profile.rb", "test/profile/valgrind.rb", "test/setup.rb", "test/teardown.rb", "test/test_helper.rb", "test/unit/binding_test.rb", "test/unit/memcached_experimental_test.rb", "test/unit/memcached_test.rb", "test/unit/rails_test.rb", "memcached.gemspec"]
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/memcached/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Memcached", "--main", "README"]
   s.require_paths = ["lib", "ext"]

data/test/profile/benchmark.rb

@@ -1,7 +1,7 @@
 
 HERE = File.dirname(__FILE__)
 $LOAD_PATH << "#{HERE}/../../lib/"
-UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','memcached') 
+UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','memcached')
 
 require 'memcached'
 require 'benchmark'
@@ -14,12 +14,13 @@ puts `ruby -v`
 puts `env | egrep '^RUBY'`
 puts "Ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
 
-[ ["memcached", "memcached"], 
-  ["remix-stash", "remix/stash"], 
+[ ["memcached", "memcached"],
+  ["remix-stash", "remix/stash"],
   # ["astro-remcached", "remcached"], # Clobbers the "Memcached" constant
   ["memcache-client", "memcache"],
   ["kgio", "kgio"],
-  ["dalli","dalli"]].each do |gem_name, requirement|
+  ["dalli","dalli"]
+  ].each do |gem_name, requirement|
   require requirement
   gem gem_name
   puts "Loaded #{gem_name} #{Gem.loaded_specs[gem_name].version.to_s rescue nil}"
@@ -47,7 +48,7 @@ class Dalli::ClientCompat < Dalli::Client
   def prepend(*args)
     super
   rescue Dalli::DalliError
-  end  
+  end
 end
 
 class Bench
@@ -55,12 +56,13 @@ class Bench
   def initialize(loops = nil, stack_depth = nil)
     @loops = (loops || 20000).to_i
     @stack_depth = (stack_depth || 0).to_i
-    
+
+    puts "PID is #{Process.pid}"
     puts "Loops is #{@loops}"
     puts "Stack depth is #{@stack_depth}"
-        
+
     @m_value = Marshal.dump(
-      @small_value = ["testing"])    
+      @small_value = ["testing"])
     @m_large_value = Marshal.dump(
       @large_value = [{"test" => "1", "test2" => "2", Object.new => "3", 4 => 4, "test5" => 2**65}] * 2048)
 
@@ -74,26 +76,26 @@ class Bench
       @k4 = "Medium" * 8,
       @k5 = "Medium2" * 8,
       @k6 = "Long3" * 40]
-    
+
     reset_servers
     reset_clients
-    
-    Benchmark.bm(36) do |x| 
-      @benchmark = x 
+
+    Benchmark.bm(36) do |x|
+      @benchmark = x
     end
   end
 
   def run(level = @stack_depth)
     level > 0 ? run(level - 1) : run_without_recursion
   end
-  
+
   private
-  
+
   def reset_servers
     system("ruby #{HERE}/../setup.rb")
     sleep(1)
   end
-  
+
   def reset_clients
     @clients = {
        "libm:ascii" => Memcached::Rails.new(
@@ -113,34 +115,43 @@ class Bench
          :no_block => true, :buffer_requests => true, :namespace => "namespace", :binary_protocol => true),
        "mclient:ascii" => MemCache.new(['127.0.0.1:43042', '127.0.0.1:43043']),
        "stash:bin" => Remix::Stash.new(:root),
-       "dalli:bin" => Dalli::ClientCompat.new(['127.0.0.1:43042', '127.0.0.1:43043'], :marshal => false, :threadsafe => false)}
+       "dalli:bin" => Dalli::ClientCompat.new(['127.0.0.1:43042', '127.0.0.1:43043'], :marshal => false, :threadsafe => false)
+       }
   end
-  
-  
-  def benchmark_clients(test_name, clients = @clients)
-    clients.keys.sort.each do |client_name|
+
+  def benchmark_clients(test_name, populate_keys = true)
+    @clients.keys.sort.each do |client_name|
       next if client_name == "stash" and test_name == "set-large" # Don't let stash break the world
-      client = clients[client_name]
+      client = @clients[client_name]
       begin
+        if populate_keys
+          client.set @k1, @m_value, 0, true
+          client.set @k2, @m_value, 0, true
+          client.set @k3, @m_value, 0, true
+        else
+          client.delete @k1
+          client.delete @k2
+          client.delete @k3
+        end
         yield client
         @benchmark.report("#{test_name}: #{client_name}") { @loops.times { yield client } }
       rescue Exception => e
-        puts "#{test_name}:#{client_name} => #{e.inspect}"
+        puts "#{test_name}: #{client_name} => #{e.inspect}" if ENV["DEBUG"]
         reset_clients
       end
     end
     puts
   end
-  
+
   def benchmark_hashes(hashes, test_name)
     hashes.each do |hash_name, int|
       @m = Memcached::Rails.new(:hash => hash_name)
       @benchmark.report("#{test_name}:#{hash_name}") do
         (@loops * 5).times { yield int }
       end
-    end  
+    end
   end
-  
+
   def run_without_recursion
     benchmark_clients("set") do |c|
       c.set @k1, @m_value, 0, true
@@ -153,47 +164,47 @@ class Bench
       c.get @k2, true
       c.get @k3, true
     end
-    
+
     benchmark_clients("get-multi") do |c|
       c.get_multi @keys, true
     end
-    
+
     benchmark_clients("append") do |c|
       c.append @k1, @m_value
       c.append @k2, @m_value
       c.append @k3, @m_value
-    end    
+    end
 
     benchmark_clients("prepend") do |c|
       c.prepend @k1, @m_value
       c.prepend @k2, @m_value
       c.prepend @k3, @m_value
-    end       
-  
-    benchmark_clients("delete") do |c|    
+    end
+
+    benchmark_clients("delete") do |c|
       c.delete @k1
       c.delete @k2
       c.delete @k3
     end
-    
-    benchmark_clients("get-missing") do |c|
+
+    benchmark_clients("get-missing", false) do |c|
       c.get @k1
       c.get @k2
       c.get @k3
     end
 
-    benchmark_clients("append-missing") do |c|
+    benchmark_clients("append-missing", false) do |c|
       c.append @k1, @m_value
       c.append @k2, @m_value
       c.append @k3, @m_value
     end
 
-    benchmark_clients("prepend-missing") do |c|
+    benchmark_clients("prepend-missing", false) do |c|
       c.prepend @k1, @m_value
       c.prepend @k2, @m_value
       c.prepend @k3, @m_value
     end
-    
+
     benchmark_clients("set-large") do |c|
       c.set @k1, @m_large_value, 0, true
       c.set @k2, @m_large_value, 0, true
@@ -205,14 +216,14 @@ class Bench
       c.get @k2, true
       c.get @k3, true
     end
-     
+
     benchmark_hashes(Memcached::HASH_VALUES, "hash") do |i|
       Rlibmemcached.memcached_generate_hash_rvalue(@k1, i)
       Rlibmemcached.memcached_generate_hash_rvalue(@k2, i)
       Rlibmemcached.memcached_generate_hash_rvalue(@k3, i)
       Rlibmemcached.memcached_generate_hash_rvalue(@k4, i)
       Rlibmemcached.memcached_generate_hash_rvalue(@k5, i)
-      Rlibmemcached.memcached_generate_hash_rvalue(@k6, i)    
+      Rlibmemcached.memcached_generate_hash_rvalue(@k6, i)
     end
   end
 end

data/test/setup.rb

@@ -1,26 +1,26 @@
-  
+
 unless defined? UNIX_SOCKET_NAME
   HERE = File.dirname(__FILE__)
   UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','memcached')
-  
+
   # Kill memcached
   system("killall -9 memcached")
-  
+
   # Start memcached
   verbosity = (ENV['DEBUG'] ? "-vv" : "")
   log = "/tmp/memcached.log"
   system ">#{log}"
-  
+
   # TCP memcached
   (43042..43046).each do |port|
     cmd = "memcached #{verbosity} -U 0 -p #{port} >> #{log} 2>&1 &"
     raise "'#{cmd}' failed to start" unless system(cmd)
-  end  
+  end
   # UDP memcached
   (43052..43053).each do |port|
     cmd = "memcached #{verbosity} -U #{port} -p 0 >> #{log} 2>&1 &"
     raise "'#{cmd}' failed to start" unless system(cmd)
-  end  
+  end
   # Domain socket memcached
   (0..1).each do |i|
     cmd = "memcached -M -s #{UNIX_SOCKET_NAME}#{i} #{verbosity} >> #{log} 2>&1 &"

data/test/test_helper.rb

@@ -3,11 +3,13 @@ $LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
 
 require 'rubygems'
 require 'mocha'
+require 'socket'
+require 'benchmark'
 
 if ENV['DEBUG']
-  require 'ruby-debug' 
+  require 'ruby-debug'
 end
-  
+
 require 'memcached'
 require 'test/unit'
 require 'ostruct'
@@ -16,3 +18,4 @@ UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','memcached') unless defined?
 
 class GenericClass
 end
+

data/test/unit/memcached_experimental_test.rb

@@ -1,8 +1,5 @@
 
 require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
-require 'socket'
-require 'mocha'
-require 'benchmark'
 
 class MemcachedExperimentalTest < Test::Unit::TestCase
 

data/test/unit/memcached_test.rb

@@ -1,8 +1,5 @@
 
 require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
-require 'socket'
-require 'mocha'
-require 'benchmark'
 
 class MemcachedTest < Test::Unit::TestCase
 
@@ -144,7 +141,7 @@ class MemcachedTest < Test::Unit::TestCase
 
   def test_set_prefix_key_to_empty_string
     cache = Memcached.new @servers, :prefix_key => "foo"
-    cache.prefix_key = "" 
+    cache.prefix_key = ""
     assert_equal "", cache.prefix_key
   end
 
@@ -388,7 +385,7 @@ class MemcachedTest < Test::Unit::TestCase
       @cache.get(["#{key}_1", "#{key}_2"])
      )
   end
-  
+
   def test_get_multi_empty_string
     @cache.set "#{key}_1", "", 0, false
     assert_equal({"#{key}_1" => ""},
@@ -469,6 +466,10 @@ class MemcachedTest < Test::Unit::TestCase
     assert_raise(Memcached::NotFound) do
       @cache.get key
     end
+
+    assert_raise(TypeError) do
+      @cache.set key, @value, Time.now
+    end
   end
 
   def test_set_with_default_ttl
@@ -1121,7 +1122,7 @@ class MemcachedTest < Test::Unit::TestCase
       :distribution => :random,
       :server_failure_limit => 1,
       :retry_timeout => 1,
-      :exception_retry_limit => 0 
+      :exception_retry_limit => 0
     )
 
     # Provoke the errors in 'failures'