memcached 0.8.1 → 0.9

data/lib/memcached/behaviors.rb

@@ -29,23 +29,41 @@ class Memcached
   
   # Set a behavior option for this Memcached instance. Accepts a Symbol <tt>behavior</tt> and either <tt>true</tt>, <tt>false</tt>, or a Symbol for <tt>value</tt>. Arguments are validated and converted into integers for the struct setter method.
   def set_behavior(behavior, value) #:doc:
-    raise ArgumentError, "No setting #{behavior.inspect}" unless b_id = BEHAVIORS[behavior]    
-    raise ArgumentError, "No setting value #{value.inspect}" unless v_id = BEHAVIOR_VALUES[value]
+    raise ArgumentError, "No behavior #{behavior.inspect}" unless b_id = BEHAVIORS[behavior]    
     
-    # Scoped validations
-    msg =  "Invalid setting value #{value.inspect} for #{behavior.inspect}" 
-    if behavior == :hash
-      raise ArgumentError, msg unless HASH_VALUES[value]
-    elsif behavior == :distribution
-      raise ArgumentError, msg unless DISTRIBUTION_VALUES[value]
-    end
-    # STDERR.puts "Setting #{behavior}:#{b_id} => #{value}:#{v_id}"
-    
-    unless value == false
-      # XXX Setting false still turns on the behavior; maybe a Lib bug
-      Lib.memcached_behavior_set(@struct, b_id, v_id)
+    # Scoped validations; annoying
+    msg =  "Invalid behavior value #{value.inspect} for #{behavior.inspect}" 
+    case behavior 
+      when :hash then raise(ArgumentError, msg) unless HASH_VALUES[value]
+      when :distribution then raise(ArgumentError, msg) unless DISTRIBUTION_VALUES[value]
+      when :retry_timeout, :connect_timeout then raise(ArgumentError, msg) unless value.is_a? Fixnum and value > 0
+      else
+        raise(ArgumentError, msg) unless BEHAVIOR_VALUES[value]
     end
     
+    value = BEHAVIOR_VALUES[value] || value    
+    # STDERR.puts "Setting #{behavior}:#{b_id} => #{value}:#{value}"    
+    Lib.memcached_behavior_set(@struct, b_id, value)
   end  
-      
+  
+  # Get a behavior value for this Memcached instance. Accepts a Symbol.
+  def get_behavior(behavior)
+    raise ArgumentError, "No behavior #{behavior.inspect}" unless b_id = BEHAVIORS[behavior]
+    value = Lib.memcached_behavior_get(@struct, b_id)        
+
+    if BEHAVIOR_VALUES.invert.has_key?(value) 
+      # False, nil are valid values so we can not rely on direct lookups
+      case behavior
+        # Scoped values; still annoying
+        when :hash then HASH_VALUES.invert[value]
+        when :distribution then DISTRIBUTION_VALUES.invert[value]
+        when :retry_timeout, :connect_timeout then value
+        else
+          BEHAVIOR_VALUES.invert[value]
+      end
+    else
+      value
+    end
+  end
+  
 end

data/lib/memcached/exceptions.rb

@@ -85,7 +85,7 @@ Subclasses correspond one-to-one with server response strings or libmemcached er
   end
   
   # Verify library version
-  # XXX Waiting on libmemcached 0.14
+  # XXX Waiting on libmemcached 0.18
   
 #:startdoc:
 end

data/lib/memcached/memcached.rb

@@ -14,10 +14,12 @@ class Memcached
     :support_cas => false,
     :tcp_nodelay => false,
     :show_not_found_backtraces => false,
-    :namespace => nil
+    :retry_timeout => 60,
+    :connect_timeout => 5,
+    :namespace => nil,
+    :sort_hosts => false
   } 
-    
-  # :sort_hosts => false # XXX No effect due to libmemcached 0.16 bug
+      
   # :verify_key => false # XXX We do this ourselves already in Rlibmemcached.ns()
   
 #:stopdoc:
@@ -38,13 +40,14 @@ Hostname lookups are not currently supported; you need to use the IP address.
 Valid option parameters are:
 
 <tt>:namespace</tt>:: A namespace string to prepend to every key.
-<tt>:hash</tt>:: The name of a hash function to use. Possible values are: <tt>:crc</tt>, <tt>:default</tt>, <tt>:fnv1_32</tt>, <tt>:fnv1_64</tt>, <tt>:fnv1a_32</tt>, <tt>:fnv1a_64</tt>, <tt>:hsieh</tt>, <tt>:ketama</tt>, and <tt>:md5</tt>. <tt>:default</tt> is the fastest.
+<tt>:hash</tt>:: The name of a hash function to use. Possible values are: <tt>:crc</tt>, <tt>:default</tt>, <tt>:fnv1_32</tt>, <tt>:fnv1_64</tt>, <tt>:fnv1a_32</tt>, <tt>:fnv1a_64</tt>, <tt>:hsieh</tt>, <tt>:ketama</tt>, <tt>:md5</tt>, and <tt>:murmur</tt>. <tt>:default</tt> is the fastest.
 <tt>:distribution</tt>:: The type of distribution function to use. Possible values are <tt>:modula</tt> and <tt>:consistent</tt>. Note that this is decoupled from the choice of hash function.
 <tt>:support_cas</tt>:: Flag CAS support in the client. Accepts <tt>true</tt> or <tt>false</tt>. Note that your server must also support CAS or you will trigger <b>Memcached::ProtocolError</b> exceptions.
 <tt>:tcp_nodelay</tt>:: Turns on the no-delay feature for connecting sockets. Accepts <tt>true</tt> or <tt>false</tt>. Performance may or may not change, depending on your system.
 <tt>:no_block</tt>:: Whether to use non-blocking, asynchronous IO for writes. Accepts <tt>true</tt> or <tt>false</tt>.
 <tt>:buffer_requests</tt>:: Whether to use an internal write buffer. Accepts <tt>true</tt> or <tt>false</tt>. Calling <tt>get</tt> or closing the connection will force the buffer to flush. Note that <tt>:buffer_requests</tt> might not work well without <tt>:no_block</tt> also enabled.
 <tt>:show_not_found_backtraces</tt>:: Whether <b>Memcached::NotFound</b> exceptions should include backtraces. Generating backtraces is slow, so this is off by default. Turn it on to ease debugging.
+<tt>:sort_hosts</tt>:: Whether to force the server list to stay sorted. This defeats consistent hashing and is only allowed if <tt>:distribution => :modula</tt>.
 
 Please note that when non-blocking IO is enabled, setter and deleter methods do not raise on errors. For example, if you try to set an invalid key with <tt>:no_block => true</tt>, it will appear to succeed. The actual setting of the key occurs after libmemcached has returned control to your program, so there is no way to backtrack and raise the exception.
 
@@ -55,29 +58,42 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
     Lib.memcached_create(@struct)
 
     # Servers
-    # XXX We have to sort them ahead of time due to a libmemcached 0.16 bug
-    Array(servers).sort.each_with_index do |server, index|
+    Array(servers).each_with_index do |server, index|
       unless server.is_a? String and server =~ /^(\d{1,3}\.){3}\d{1,3}:\d{1,5}$/
         raise ArgumentError, "Servers must be in the format ip:port (e.g., '127.0.0.1:11211')" 
       end
       host, port = server.split(":")
       Lib.memcached_server_add(@struct, host, port.to_i)
     end  
-    
-    # Behaviors
+
+    # Merge option defaults
     @options = DEFAULTS.merge(opts)
+    
+    # Force :buffer_requests to use :no_block
+    # XXX Deleting the :no_block key should also work, but libmemcached doesn't seem to set it
+    # consistently
+    options[:no_block] = true if options[:buffer_requests] 
+    
+    # Disallow :sort_hosts with consistent hashing
+    if options[:sort_hosts] and options[:distribution] == :consistent
+      raise ArgumentError, ":sort_hosts defeats :consistent hashing"
+    end
+    
+    # Set the behaviors
     options.each do |option, value|
       unless [:namespace, :show_not_found_backtraces].include? option
         set_behavior(option, value) 
       end
     end
     
-    # Make sure :buffer_requests uses :no_block
-    # XXX Not enforcing this for now.
-    # if options[:buffer_requests] and not options[:no_block]
-    #   raise ArgumentError, "Invalid options; :buffer_requests does not work well without :no_block."
-    # end
+    # Merge the actual behaviors back in
+    BEHAVIORS.keys.each do |behavior|
+      options[behavior] = get_behavior(behavior)
+    end
 
+    # Freeze the hash
+    options.freeze
+        
     # Namespace
     raise ArgumentError, "Invalid namespace" if options[:namespace].to_s =~ / /
     @namespace = options[:namespace].to_s
@@ -241,7 +257,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def cas(key, timeout = 0, marshal = true)
     raise ClientError, "CAS not enabled for this Memcached instance" unless options[:support_cas]
       
-    value = get(key)
+    value = get(key, marshal)
     value = yield value
     value = marshal ? Marshal.dump(value) : value.to_s
     
@@ -335,6 +351,11 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   ### Operations helpers
   
   private
+  
+  # Returns the hash value for a master key
+  def hash(key)
+    Lib.memcached_generate_hash(@struct, Lib.ns(@namespace, key))
+  end
     
   # Checks the return code from Rlibmemcached against the exception list. Raises the corresponding exception if the return code is not Memcached::Success or Memcached::ActionQueued. Accepts an integer return code.
   def check_return_code(ret) #:doc:

data/memcached.gemspec

@@ -1,25 +1,27 @@
 
-# Gem::Specification for Memcached-0.8.1
+# Gem::Specification for Memcached-0.9
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{memcached}
-  s.version = "0.8.1"
+  s.version = "0.9"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
-  s.date = %q{2008-02-21}
+  s.date = %q{2008-04-09}
   s.description = %q{An interface to the libmemcached C client.}
   s.email = %q{}
   s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = ["BENCHMARKS", "CHANGELOG", "COMPATIBILITY", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb", "lib/memcached.rb", "LICENSE", "README", "TODO"]
   s.files = ["BENCHMARKS", "CHANGELOG", "COMPATIBILITY", "ext/extconf.rb", "ext/rlibmemcached.i", "ext/rlibmemcached_wrap.c", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/integer.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb", "lib/memcached.rb", "LICENSE", "Manifest", "README", "test/profile/benchmark.rb", "test/profile/key.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_test.rb", "test/unit/rails_test.rb", "TODO", "memcached.gemspec"]
   s.has_rdoc = true
   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"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.0.1}
+  s.rubygems_version = %q{1.1.0}
   s.summary = %q{An interface to the libmemcached C client.}
   s.test_files = ["test/test_helper.rb", "test/unit/binding_test.rb", "test/unit/memcached_test.rb", "test/unit/rails_test.rb"]
 end

data/test/profile/benchmark.rb

@@ -50,7 +50,10 @@ class Bench
     @key1 = "Short"
     @key2 = "Sym1-2-3::45"*8
     @key3 = "Long"*40
-    @key4 = "Medium"*8        
+    @key4 = "Medium"*8
+    # 5 and 6 are only used for multiget miss test
+    @key5 = "Medium2"*8 
+    @key6 = "Long3"*40 
     
     restart_servers
   end
@@ -245,6 +248,37 @@ class Bench
           end
         end
       end
+
+      if defined? Memcached
+        @m = Memcached.new(*@opts)
+
+        # Avoid rebuilding the array every request
+        keys = [@key1, @key2, @key3, @key4, @key5, @key6]
+
+        x.report("multiget:ruby:memcached") do
+          n.times do
+            @m.get keys
+          end
+        end
+      end
+      if defined? Caffeine
+        @m = Caffeine::MemCache.new(@opts[1]); @m.servers = @opts[0]
+        x.report("multiget:ruby:caffeine") do
+          n.times do
+            # We don't use the keys array because splat is slow
+            @m.get @key1, @key2, @key3, @key4, @key5, @key6
+          end
+        end
+      end
+      if defined? MemCache
+        @m = MemCache.new(*@opts)
+        x.report("multiget:ruby:memcache-client") do
+          n.times do
+            # We don't use the keys array because splat is slow
+            @m.get_multi @key1, @key2, @key3, @key4, @key5, @key6
+          end
+        end
+      end
     
       # restart_servers
     

data/test/test_helper.rb

@@ -12,8 +12,3 @@ require 'ostruct'
 
 class GenericClass
 end
-
-class Memcached
-  class StubError < Error
-  end
-end

data/test/unit/memcached_test.rb

@@ -6,18 +6,21 @@ class MemcachedTest < Test::Unit::TestCase
   def setup
     @servers = ['127.0.0.1:43042', '127.0.0.1:43043']
     @namespace = 'memcached_test_namespace'
-    @cache = Memcached.new(
-      @servers, 
+    
+    @options = {      
       :namespace => @namespace, 
       :distribution => :modula
-    )
-    @nb_cache = Memcached.new(
-      @servers, 
+    }
+    @cache = Memcached.new(@servers, @options)
+    
+    @nb_options = {
       :namespace => @namespace, 
       :no_block => true, 
       :buffer_requests => true, 
       :distribution => :modula
-    )
+    }
+    @nb_cache = Memcached.new(@servers, @nb_options)
+
     @value = OpenStruct.new(:a => 1, :b => 2, :c => GenericClass)
     @marshalled_value = Marshal.dump(@value)
   end
@@ -39,6 +42,19 @@ class MemcachedTest < Test::Unit::TestCase
     assert_equal 43043, cache.send(:server_structs).last.port
   end
   
+  def test_options_are_set
+    Memcached::DEFAULTS.merge(@nb_options).each do |key, expected|
+      value = @nb_cache.options[key]
+      assert(expected == value, "#{key} should be #{expected} but was #{value}")
+    end
+  end
+  
+  def test_options_are_frozen
+    assert_raise(TypeError) do
+      @cache.options[:no_block] = true
+    end
+  end
+  
   def test_destroy
     cache = Memcached.new @servers, :namespace => 'test'
     cache.destroy
@@ -53,14 +69,12 @@ class MemcachedTest < Test::Unit::TestCase
     assert_raise(ArgumentError) { Memcached.new "127.0.0.1:43043:1" }
   end
   
-  def test_initialize_with_missing_server
-    # XXX Triggers abort trap with libmemcached --enable-debug.
-    cache = Memcached.new "127.0.0.1:43044"
-    assert_raises Memcached::SystemError do
-      cache.get key
+  def test_initialize_with_invalid_options
+    assert_raise(ArgumentError) do 
+      Memcached.new @servers, :sort_hosts => true, :distribution => :consistent
     end
   end
-
+  
   def test_initialize_without_namespace
     cache = Memcached.new @servers
     assert_equal nil, cache.options[:namespace]
@@ -105,24 +119,21 @@ class MemcachedTest < Test::Unit::TestCase
     cache.destroy
     
     # Reversed 
-    # XXX Fails due to libmemcached 0.16 bug
-    # cache = Memcached.new(@servers.sort.reverse)
-    # assert_equal @servers.sort.reverse, 
-    #  cache.servers
-    # cache.destroy
+    cache = Memcached.new(@servers.sort.reverse)
+      assert_equal @servers.sort.reverse, 
+    cache.servers
+    cache.destroy
       
     # Reversed with sort_hosts
     cache = Memcached.new(@servers.sort.reverse,
-      :sort_hosts => true)
+      :sort_hosts => true,
+      :distribution => :modula
+    )
     assert_equal @servers.sort, 
       cache.servers
     cache.destroy
   end
   
-  # def test_initialize_verify_key
-  #  # XXX Not necessary
-  # end
-
   def test_initialize_single_server
     cache = Memcached.new '127.0.0.1:43042'
     assert_equal nil, cache.options[:namespace]
@@ -408,6 +419,13 @@ class MemcachedTest < Test::Unit::TestCase
     end
     assert_equal value2, cache.get(key)
     
+    # Existing test without marshalling
+    cache.set(key, "foo", 0, false)
+    cache.cas(key, 0, false) do |current|
+      "#{current}bar"
+    end
+    assert_equal "foobar", cache.get(key, false)
+    
     # Missing set
     cache.delete key
     assert_raises(Memcached::NotFound) do
@@ -586,7 +604,34 @@ class MemcachedTest < Test::Unit::TestCase
       @nb_cache.add key, @value
     end
   end  
+  
+  # Server removal and consistent hashing
+  
+  def test_missing_server
+    cache = Memcached.new(
+      [@servers.last, '127.0.0.1:43044'], # Use a server that isn't running
+      :namespace => @namespace
+    )
+    
+    # Verify that the second server is the hash target
+    key = 'test_missing_server3'
+    assert_equal 1, cache.send(:hash, key)
 
+    assert_raise(Memcached::SystemError) do
+      cache.set(key, @value)
+      cache.get(key)
+    end    
+
+    return
+    # XXX Waiting on failover support in Libmemcached    
+    assert_nothing_raised do
+      cache.set(key, @value)
+      cache.get(key)
+    end    
+  end
+
+  # Concurrency
+  
   def test_thread_contention
     threads = []
     4.times do |index|
@@ -601,6 +646,8 @@ class MemcachedTest < Test::Unit::TestCase
     threads.each {|thread| thread.join}
   end
   
+  # Memory cleanup
+  
   def test_reset
     original_struct = @cache.instance_variable_get("@struct")
     assert_nothing_raised do
@@ -610,6 +657,12 @@ class MemcachedTest < Test::Unit::TestCase
       @cache.instance_variable_get("@struct") 
   end
   
+  # Private hash generation method
+  
+  def test_hash_generation
+    assert [0, 1].include?(@cache.send(:hash, key))
+  end
+  
   private
   
   def key

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: memcached
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
+  version: "0.9"
 platform: ruby
 authors: 
 - Evan Weaver
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2008-02-21 00:00:00 -05:00
+date: 2008-04-09 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -40,8 +40,18 @@ executables: []
 
 extensions: 
 - ext/extconf.rb
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- BENCHMARKS
+- CHANGELOG
+- COMPATIBILITY
+- lib/memcached/behaviors.rb
+- lib/memcached/exceptions.rb
+- lib/memcached/memcached.rb
+- lib/memcached/rails.rb
+- lib/memcached.rb
+- LICENSE
+- README
+- TODO
 files: 
 - BENCHMARKS
 - CHANGELOG
@@ -73,8 +83,13 @@ files:
 has_rdoc: true
 homepage: http://blog.evanweaver.com/files/doc/fauna/memcached/
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Memcached
+- --main
+- README
 require_paths: 
 - lib
 - ext
@@ -93,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 1.0.1
+rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
 summary: An interface to the libmemcached C client.