memcached 0.10 → 0.11

data/lib/memcached.rb

@@ -20,8 +20,12 @@ require 'rlibmemcached'
 
 class Memcached
   Lib = Rlibmemcached
+  REQUIRED_VERSION = File.read("#{File.dirname(__FILE__)}/../COMPATIBILITY")[/:: ([\d\.]+)/, 1]
+  RECEIVED_VERSION = Lib.memcached_lib_version
+  raise LoadError, "Requires libmemcached #{REQUIRED_VERSION}; you have #{RECEIVED_VERSION}" unless REQUIRED_VERSION == RECEIVED_VERSION
 end  
 
+
 require 'memcached/integer'
 require 'memcached/exceptions'
 require 'memcached/behaviors'

data/lib/memcached/behaviors.rb

@@ -3,9 +3,9 @@ class Memcached
 
 #:stopdoc:
 
-  def self.load_constants(prefix, hash = {}, offset = 0)
+  def self.load_constants(prefix, hash = {})
     Lib.constants.grep(/^#{prefix}/).each do |const_name|
-      hash[const_name[prefix.length..-1].downcase.to_sym] = Lib.const_get(const_name) + offset
+      hash[const_name[prefix.length..-1].downcase.to_sym] = Lib.const_get(const_name)
     end
     hash
   end
@@ -18,10 +18,10 @@ class Memcached
   }
 
   HASH_VALUES = {}
-  BEHAVIOR_VALUES.merge!(load_constants("MEMCACHED_HASH_", HASH_VALUES, 2))
+  BEHAVIOR_VALUES.merge!(load_constants("MEMCACHED_HASH_", HASH_VALUES))
 
   DISTRIBUTION_VALUES = {}
-  BEHAVIOR_VALUES.merge!(load_constants("MEMCACHED_DISTRIBUTION_", DISTRIBUTION_VALUES, 2))
+  BEHAVIOR_VALUES.merge!(load_constants("MEMCACHED_DISTRIBUTION_", DISTRIBUTION_VALUES))
   
   DIRECT_VALUE_BEHAVIORS = [:retry_timeout, :connect_timeout, :socket_recv_size, :poll_timeout, :socket_send_size]
 
@@ -43,9 +43,10 @@ class Memcached
         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)
+    lib_value = BEHAVIOR_VALUES[value] || value    
+    #STDERR.puts "Setting #{behavior}:#{b_id} => #{value} (#{lib_value})"
+    Lib.memcached_behavior_set(@struct, b_id, lib_value)    
+    #STDERR.puts " -> set to #{get_behavior(behavior).inspect}"
   end  
   
   # Get a behavior value for this Memcached instance. Accepts a Symbol.

data/lib/memcached/memcached.rb

@@ -18,12 +18,11 @@ class Memcached
     :retry_timeout => 60,
 #    :poll_timeout => 5,
     :connect_timeout => 5,
-    :namespace => nil,
+    :prefix_key => nil,
     :sort_hosts => false,
-    :failover => false
+    :failover => false,
+    :verify_key => true
   } 
-      
-  # :verify_key => false # XXX We do this ourselves already in Rlibmemcached.ns()
   
 #:stopdoc:
   IGNORED = 0
@@ -36,22 +35,22 @@ class Memcached
 ###### Configuration
 
 =begin rdoc      
-Create a new Memcached instance. Accepts a single server string such as '127.0.0.1:11211', or an array of such strings, as well an an optional configuration hash.
-
-Hostname lookups are not currently supported; you need to use the IP address.
+Create a new Memcached instance. Accepts a single server string such as 'localhost:11211', or an array of such strings, as well an an optional configuration hash.
 
 Valid option parameters are:
 
-<tt>:namespace</tt>:: A namespace string to prepend to every key.
+<tt>:prefix_key</tt>:: A string to prepend to every key, for namespacing. Max length is 11.
 <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>:md5</tt>, and <tt>:murmur</tt>. <tt>:default</tt> is the fastest. Use <tt>:md5</tt> for compatibility with other ketama clients.
 <tt>:distribution</tt>:: Either <tt>:modula</tt>, <tt>:consistent</tt>, or <tt>:consistent_wheel</tt>. Defaults to <tt>:consistent</tt>, which is ketama-compatible.
 <tt>:failover</tt>:: Whether to permanently eject failed hosts from the pool. Defaults to <tt>false</tt>. Note that in the event of a server failure, <tt>:failover</tt> will remap the entire pool unless <tt>:distribution</tt> is set to <tt>:consistent</tt>.
+<tt>:cache_lookups</tt>:: Whether to cache hostname lookups for the life of the instance. Defaults to <tt>true</tt>.
 <tt>:support_cas</tt>:: Flag CAS support in the client. Accepts <tt>true</tt> or <tt>false</tt>. Defaults to <tt>false</tt> because it imposes a slight performance penalty. 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 rarely useful.
+<tt>:verify_key</tt>:: Validate keys before accepting them. Never disable this.
 
 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.
 
@@ -61,9 +60,6 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
     @struct = Lib::MemcachedSt.new    
     Lib.memcached_create(@struct)
 
-    # Set the servers on the struct
-    set_servers(servers)
-    
     # Merge option defaults
     @options = DEFAULTS.merge(opts)
     
@@ -72,6 +68,9 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
     # consistently
     options[:no_block] = true if options[:buffer_requests] 
     
+    # Legacy accessor
+    options[:prefix_key] = options.delete(:namespace) if options[:namespace]
+    
     # Disallow :sort_hosts with consistent hashing
     if options[:sort_hosts] and options[:distribution] == :consistent
       raise ArgumentError, ":sort_hosts defeats :consistent hashing"
@@ -79,20 +78,14 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
     
     # Set the behaviors on the struct
     set_behaviors
-     
-    # Merge the actual behaviors back in
-    BEHAVIORS.keys.each do |behavior|
-      options[behavior] = get_behavior(behavior)
-    end    
+    set_callbacks
 
     # Freeze the hash
     options.freeze
+
+    # Set the servers on the struct
+    set_servers(servers)         
         
-    # Namespace
-    raise ArgumentError, "Invalid namespace" if options[:namespace].to_s =~ / /
-    @namespace = options[:namespace].to_s
-    @namespace_size = @namespace.size
-    
     # Not found exceptions
     # Note that these have global effects since the NotFound class itself is modified. You should only 
     # be enabling the backtrace for debugging purposes, so it's not really a big deal.
@@ -100,8 +93,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
       NotFound.restore_backtraces
     else
       NotFound.remove_backtraces
-    end
-    
+    end    
   end
 
   # Return the array of server strings used to configure this instance.
@@ -114,43 +106,22 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   # Safely copy this instance. Returns a Memcached instance. 
   #
   # <tt>clone</tt> is useful for threading, since each thread must have its own unshared Memcached 
-  # object. However, you must call destroy before each thread returns or you will leak significant memory.
+  # object. 
   #
   def clone
     memcached = super
     memcached.instance_variable_set('@struct', Lib.memcached_clone(nil, @struct))
     memcached
   end
-  
-  # Destroy this instance. Frees memory associated with the C implementation.
-  #
-  # Accepts an optional parameter <tt>disable_methods</tt>. When <tt>false</tt>, destroy
-  # runs much faster, but your instance will segfault if you try to call any other methods on it
-  # after destroy. Defaults to <tt>true</tt>, which safely overwrites all instance methods.
-  def destroy(disable_methods = true)
-    # XXX Should be implemented with rb_wrap_struct
-    Lib.memcached_free(@struct)
-    @struct = nil
     
-    if disable_methods
-      class << self
-        Memcached.instance_methods.each do |method_name|
-          define_method method_name do |*args|
-            raise Memcached::ClientError, "Instance has been explicitly destroyed"
-          end
-        end
-      end
-    end
-  end  
-  
   # Reset the state of the libmemcached struct. This is useful for changing the server list at runtime.
   def reset(current_servers = nil)
     current_servers ||= servers
-    Lib.memcached_free(@struct)        
     @struct = Lib::MemcachedSt.new    
     Lib.memcached_create(@struct)
-    set_servers(current_servers)
     set_behaviors
+    set_callbacks
+    set_servers(current_servers)
   end  
   
   #:stopdoc:
@@ -185,7 +156,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def set(key, value, timeout=0, marshal=true)
     value = marshal ? Marshal.dump(value) : value.to_s
     check_return_code(
-      Lib.memcached_set(@struct, Lib.ns(@namespace, key), value, timeout, FLAGS)
+      Lib.memcached_set(@struct, key, value, timeout, FLAGS)
     )
   end
 
@@ -193,7 +164,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def add(key, value, timeout=0, marshal=true)
     value = marshal ? Marshal.dump(value) : value.to_s
     check_return_code(
-      Lib.memcached_add(@struct, Lib.ns(@namespace, key), value, timeout, FLAGS)
+      Lib.memcached_add(@struct, key, value, timeout, FLAGS)
     )
   end
 
@@ -203,14 +174,14 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   #
   # Note that the key must be initialized to an unmarshalled integer first, via <tt>set</tt>, <tt>add</tt>, or <tt>replace</tt> with <tt>marshal</tt> set to <tt>false</tt>.
   def increment(key, offset=1)
-    ret, value = Lib.memcached_increment(@struct, Lib.ns(@namespace, key), offset)
+    ret, value = Lib.memcached_increment(@struct, key, offset)
     check_return_code(ret)
     value
   end
 
   # Decrement a key's value. The parameters and exception behavior are the same as <tt>increment</tt>.
   def decrement(key, offset=1)
-    ret, value = Lib.memcached_decrement(@struct, Lib.ns(@namespace, key), offset)
+    ret, value = Lib.memcached_decrement(@struct, key, offset)
     check_return_code(ret)
     value
   end
@@ -224,7 +195,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def replace(key, value, timeout=0, marshal=true)
     value = marshal ? Marshal.dump(value) : value.to_s
     check_return_code(
-      Lib.memcached_replace(@struct, Lib.ns(@namespace, key), value, timeout, FLAGS)
+      Lib.memcached_replace(@struct, key, value, timeout, FLAGS)
     )
   end
 
@@ -234,7 +205,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def append(key, value)
     # Requires memcached 1.2.4
     check_return_code(
-      Lib.memcached_append(@struct, Lib.ns(@namespace, key), value.to_s, IGNORED, FLAGS)
+      Lib.memcached_append(@struct, key, value.to_s, IGNORED, FLAGS)
     )
   end
   
@@ -242,7 +213,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def prepend(key, value)
     # Requires memcached 1.2.4
     check_return_code(
-      Lib.memcached_prepend(@struct, Lib.ns(@namespace, key), value.to_s, IGNORED, FLAGS)
+      Lib.memcached_prepend(@struct, key, value.to_s, IGNORED, FLAGS)
     )
   end
   
@@ -260,7 +231,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
     value = marshal ? Marshal.dump(value) : value.to_s
     
     check_return_code(
-      Lib.memcached_cas(@struct, Lib.ns(@namespace, key), value, timeout, FLAGS, @struct.result.cas)
+      Lib.memcached_cas(@struct, key, value, timeout, FLAGS, @struct.result.cas)
     )
   end
 
@@ -269,7 +240,7 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   # Deletes a key/value pair from the server. Accepts a String <tt>key</tt>. Raises <b>Memcached::NotFound</b> if the key does not exist.
   def delete(key)
     check_return_code(
-      Lib.memcached_delete(@struct, Lib.ns(@namespace, key), IGNORED)
+      Lib.memcached_delete(@struct, key, IGNORED)
     )  
   end
   
@@ -295,23 +266,24 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   def get(keys, marshal=true)
     if keys.is_a? Array
       # Multi get
-      keys.map! { |key| Lib.ns(@namespace, key) }
+      keys.map! { |key| key }
       hash = {}
       
-      Lib.memcached_mget(@struct, keys);
+      ret = Lib.memcached_mget(@struct, keys);
+      check_return_code(ret)
       
       keys.size.times do 
         value, key, flags, ret = Lib.memcached_fetch_rvalue(@struct)
         break if ret == Lib::MEMCACHED_END
         check_return_code(ret)
         value = Marshal.load(value) if marshal
-        # Assign the value, removing the namespace, if present
-        hash[key[@namespace_size..-1]] = value
+        # Assign the value
+        hash[key] = value
       end
       hash
     else
       # Single get
-      value, flags, ret = Lib.memcached_get_rvalue(@struct, Lib.ns(@namespace, keys))
+      value, flags, ret = Lib.memcached_get_rvalue(@struct, keys)
       check_return_code(ret)
       value = Marshal.load(value) if marshal
       value
@@ -356,12 +328,7 @@ 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:
     # 0.16 --enable-debug returns 0 for an ActionQueued result but --disable-debug does not
@@ -394,8 +361,8 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   # Set the servers on the struct
   def set_servers(servers)
     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')" 
+      unless server.is_a? String and server =~ /^[\w\d\.]+(:\d{1,5})?$/
+        raise ArgumentError, "Servers must be in the format host:port (e.g., 'localhost:11211')" 
       end
       host, port = server.split(":")
       Lib.memcached_server_add(@struct, host, port.to_i)
@@ -404,11 +371,21 @@ Please note that when non-blocking IO is enabled, setter and deleter methods do
   
   # Set the behaviors on the struct from the current options
   def set_behaviors
-    options.each do |option, value|
-      unless [:namespace, :show_not_found_backtraces, :failover].include? option
-        set_behavior(option, value) 
-      end
-    end   
-  end  
-    
+    BEHAVIORS.keys.each do |behavior|
+      set_behavior(behavior, options[behavior]) if options.key?(behavior)
+    end
+  end
+
+  # Set the callbacks on the struct from the current options
+  def set_callbacks  
+    # Only support prefix_key for now
+    if options[:prefix_key]
+      # XXX Libmemcached doesn't validate the key length properly
+      if options[:prefix_key].size > Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE - 1
+        raise ArgumentError, "Max prefix_key size is #{Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE - 1}"
+      end      
+      Lib.memcached_callback_set(@struct, Lib::MEMCACHED_CALLBACK_PREFIX_KEY, options[:prefix_key])
+    end
+  end
+  
 end

data/lib/memcached/rails.rb

@@ -38,7 +38,7 @@ class Memcached
     
     # Namespace accessor.
     def namespace
-      @namespace
+      options[:prefix_key]
     end
 
     # Alias for get.

data/memcached.gemspec

@@ -1,61 +1,108 @@
 
-# Gem::Specification for Memcached-0.10
+# Gem::Specification for Memcached-0.11
 # Originally generated by Echoe
 
-Gem::Specification.new do |s|
-  s.name = %q{memcached}
-  s.version = "0.10"
+--- !ruby/object:Gem::Specification 
+name: memcached
+version: !ruby/object:Gem::Version 
+  version: "0.11"
+platform: ruby
+authors: 
+- Evan Weaver
+autorequire: 
+bindir: bin
+date: 2008-07-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An interface to the libmemcached C client.
+email: ""
+executables: []
 
-  s.specification_version = 2 if s.respond_to? :specification_version=
+extensions: 
+- ext/extconf.rb
+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
+- 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
+- Rakefile
+- README
+- 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_test.rb
+- test/unit/rails_test.rb
+- TODO
+- memcached.gemspec
+has_rdoc: true
+homepage: http://blog.evanweaver.com/files/doc/fauna/memcached/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Memcached
+- --main
+- README
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - "="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Evan Weaver"]
-  s.date = %q{2008-05-06}
-  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.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
-
-
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'echoe'
-# 
-# Echoe.new("memcached") do |p|
-#   p.author = "Evan Weaver"
-#   p.project = "fauna"
-#   p.summary = "An interface to the libmemcached C client."
-#   p.url = "http://blog.evanweaver.com/files/doc/fauna/memcached/"
-#   p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"
-#   p.rdoc_pattern = /README|TODO|LICENSE|CHANGELOG|BENCH|COMPAT|exceptions|behaviors|rails.rb|memcached.rb/
-# end
-# 
-# task :exceptions do
-#   $LOAD_PATH << "lib"
-#   require 'memcached'
-#   Memcached.constants.sort.each do |const_name|
-#     const = Memcached.send(:const_get, const_name)
-#     next if const == Memcached::Success or const == Memcached::Stored
-#     if const.is_a? Class and const < Memcached::Error
-#       puts "* Memcached::#{const_name}"
-#     end
-#   end
-# end
-# 
-# task :valgrind do
-#   exec("valgrind  --tool=memcheck --leak-check=yes --show-reachable=no --num-callers=15 --track-fds=yes ruby #{File.dirname(__FILE__)}/test/profile/valgrind.rb")
-# end
-# 
-# task :profile do
-#  exec("ruby #{File.dirname(__FILE__)}/test/profile/profile.rb")
-# end
+rubyforge_project: fauna
+rubygems_version: 1.2.0
+specification_version: 2
+summary: An interface to the libmemcached C client.
+test_files: 
+- test/test_helper.rb
+- test/unit/binding_test.rb
+- test/unit/memcached_test.rb
+- test/unit/rails_test.rb