spymemcached.jruby 1.0.3-java → 1.0.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5780ea53b6d60b038125beb9dd617f8add8cbbc7
-  data.tar.gz: e55cd318622f535a5351ab76d02b666b2294dbab
+  metadata.gz: de172a58da9de394e290392fe8e3797e917d98ca
+  data.tar.gz: c73d9b51e084d5858d7191a4a5ab93f6bd6642bd
 SHA512:
-  metadata.gz: a78224ec0b00eb60041e3e0ccfaf2a97b37b79c139e6f7e766fafe9d0133fa292edd77b4b5e5e17bacd1d6bf2d2f880a37439c491f584d4e236da4bc96ce15d1
-  data.tar.gz: e022c6ef66b52a9da19958a9753dcda754d536050305a3c0e87e62095894e0f8c16e3bb103fcec378bbdfacb26af09e932644c1b0c7c75c6e90c27a64c9b3303
+  metadata.gz: e7533c8391fb29bf4cabdfcdfb97319d4b0924f164d87e8e67e1fdda173135fd03bbb24ab863eadb0670928a1dbf345f3f29f8e36b1c3e523c35f7215d4eebbe
+  data.tar.gz: f035eca85fbb17adc7e5d493a8f0d84880f9e38fa7270893a7beac3bd5e7adffb1798971fae850ae9c756aad446897cc5c68d76980abe8cbc0314ac22f58536a

data/README.md

@@ -0,0 +1,43 @@
+Spymemcached.jruby
+================
+
+A JRuby extension wraps the latest spymemcached client.
+
+Usage
+----------------
+
+
+Start a local networked memcached server:
+
+    $ memcached -p 11211
+
+Require the library and instantiate a Spymemcached object at a global level:
+
+    require 'spymemcached'
+    $cache = Spymemcached.new("localhost:11211")
+
+Setup multiple servers with options
+
+    require 'spymemcached'
+    $cache = Spymemcached.new(['memcached1.host:11211', 'memcached2.host:11211', 'memcached3.host:11211'],
+                              {:namespace => 'appName', :timeout => 0.1, :binary => true})
+
+Valid +options+ are:
+
+    [:namespace]   Prepends this value to all keys added or retrieved.
+    [:timeout]     Time to use as the socket read timeout, seconds.  Defaults to 0.5 sec.
+    [:binary]      Talks binary protocol with Memcached server. Default to true.
+
+Rails 3 & 4
+
+    TODO
+
+Rails 2.3
+
+    ActionController::Base.cache_store = :mem_cache_store, Spymemcached.new(servers).rails23
+
+
+Performance
+---------------
+
+[Benchmark result](https://github.com/ThoughtWorksStudios/memcached-client-benchmark) compared with gem dalli and jruby-memcached

data/lib/spymemcached.rb

@@ -1,6 +1,7 @@
 require 'spymemcached-2.11.4.jar'
 require 'spymemcached_adapter.jar'
 require 'spymemcached_adapter'
+require 'digest/md5'
 
 #
 # Memcached client Spymemcached JRuby extension
@@ -9,6 +10,7 @@ class Spymemcached
   class Error < StandardError; end
   class TimeoutError < Error; end
 
+  ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/n
   # default options for client
   DEFAULT_OPTIONS = {
     :timeout => 0.5, # second
@@ -49,53 +51,54 @@ class Spymemcached
   end
 
   def get(key)
-    @client.get(ns(key))
+    @client.get(encode(key))
   end
   alias :[] :get
 
   def get_multi(*keys)
-    Hash[@client.get_multi(keys.map(&method(:ns))).map {|k, v| [unns(k), v]}]
+    key_map = Hash[keys.flatten.compact.map {|k| [encode(k), k]}]
+    Hash[@client.get_multi(key_map.keys).map {|k, v| [key_map[k], v]}]
   end
 
-  def add(key, value, ttl=0, opts={})
-    @client.add(ns(key), value, ttl)
+  def add(key, value, ttl=0)
+    @client.add(encode(key), value, ttl)
   end
 
-  def set(key, value, ttl=0, opts={})
-    @client.set(ns(key), value, ttl)
+  def set(key, value, ttl=0)
+    @client.set(encode(key), value, ttl)
   end
   alias :[]= :set
 
   def cas(key, ttl=0, &block)
-    @client.cas(ns(key), ttl, &block)
+    @client.cas(encode(key), ttl, &block)
   end
 
   def replace(key, value, ttl=0)
-    @client.replace(ns(key), value, ttl)
+    @client.replace(encode(key), value, ttl)
   end
 
   def delete(key)
-    @client.delete(ns(key))
+    @client.delete(encode(key))
   end
 
   def incr(key, by=1)
-    @client.incr(ns(key), by)
+    @client.incr(encode(key), by)
   end
 
   def decr(key, by=1)
-    @client.decr(ns(key), by)
+    @client.decr(encode(key), by)
   end
 
   def append(key, value)
-    @client.append(ns(key), value)
+    @client.append(encode(key), value)
   end
 
   def prepend(key, value)
-    @client.prepend(ns(key), value)
+    @client.prepend(encode(key), value)
   end
 
   def touch(key, ttl=0)
-    @client.touch(ns(key), ttl)
+    @client.touch(encode(key), ttl)
   end
 
   def stats
@@ -116,29 +119,31 @@ class Spymemcached
     @client.shutdown
   end
 
-  # compatible api
+  # compatible api with Rails 2.3 MemcacheStore
+  # ActionController::Base.cache_store = :mem_cache_store, Spymemcached.new(servers).rails23
   def rails23
     require 'spymemcached/rails23'
     Rails23.new(self)
   end
 
   private
-  def raw?(opts)
-    opts.is_a?(Hash) ? opts[:raw] : opts
+  def encode(key)
+    escape_key(namespace ? "#{namespace.call}:#{key}" : key)
   end
 
-  def ns(key)
-    return key unless namespace
-     "#{namespace.call}:#{key}"
+  def namespace
+    @namespace
   end
 
-  def unns(k)
-    return k unless namespace
-    @ns_size ||= namespace.call.size + 1
-    k[@ns_size..-1]
+  # Memcache keys are binaries. So we need to force their encoding to binary
+  # before applying the regular expression to ensure we are escaping all
+  # characters properly.
+  def escape_key(key)
+    key = key.to_s.dup
+    key = key.force_encoding(Encoding::ASCII_8BIT)
+    key = key.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 namespace
-    @namespace
-  end
 end

data/test/spymemcached_binary_protocol_test.rb

@@ -74,6 +74,7 @@ class SpymemcachedBinaryProtocolTest < Test::Unit::TestCase
     assert_equal(2, ret.size)
     assert_equal('v1', ret['k1'])
     assert_equal(Msg.new('v2'), ret['k2'])
+    assert_equal(ret, @client.get_multi(['k1', 'k2', 'k3']))
   end
 
   def test_cas

data/test/spymemcached_plain_protocol_test.rb

@@ -74,6 +74,7 @@ class SpymemcachedPlainProtocolTest < Test::Unit::TestCase
     assert_equal(2, ret.size)
     assert_equal('v1', ret['k1'])
     assert_equal(Msg.new('v2'), ret['k2'])
+    assert_equal(ret, @client.get_multi(['k1', 'k2', 'k3']))
   end
 
   def test_cas

data/test/spymemcached_test.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'test_helper'
 
 class SpymemcachedTest < Test::Unit::TestCase
@@ -172,4 +173,12 @@ class SpymemcachedTest < Test::Unit::TestCase
     assert_match(/\:11211/, v.keys.first)
     assert_match(/\d\.\d+\.\d+/, v.values.first)
   end
+
+  def test_escape_key
+    k = 'k 开' * 250
+    @client.add(k, 'v1')
+    assert_equal('v1', @client.get(k))
+    @client.set(k, 'v2')
+    assert_equal({k => 'v2'}, @client.get_multi(k))
+  end
 end

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 require 'test/unit'
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 require "spymemcached"
 
 class Msg < Struct.new(:name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spymemcached.jruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: java
 authors:
 - Xiao Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake