binary42-remix-stash 0.9.1 → 0.9.2

data/{README.mdown → README.markdown}

@@ -8,6 +8,8 @@ It does require memcached 1.4+ but you should be running that anyway (if you are
 
 # TODO
 
+* write extras, keys, and values directly to avoid packing overhead
+* gracefully handle connection interruptions
 * optimize option merging with cache
 * make clusters selectable per stash
 * implement the rest of the memcached 1.4 binary API

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.9.2

data/{examples/bench.rb → benchmarks/get_set.rb}

@@ -2,9 +2,9 @@ require 'benchmark'
 require File.dirname(__FILE__) + '/../harness'
 require File.dirname(__FILE__) + '/../harness_cache'
 
-LARGE_NUMBER = 20_000
+LARGE_NUMBER = 200_000
 
-Benchmark.bm do |b|
+Benchmark.bmbm do |b|
   b.report('get/set stash') do
     LARGE_NUMBER.times {|n|
       stash[:abcxyz123] = n

data/benchmarks/payload.rb

@@ -0,0 +1,63 @@
+require 'benchmark'
+require File.dirname(__FILE__) + '/../harness'
+require File.dirname(__FILE__) + '/../harness_cache'
+
+LARGE_NUMBER = 20_000
+
+large_value = 'a' * 100_000
+med_value = 'b' * 2_000
+small_value = 'c' * 100
+tiny_value = 'd'
+
+KEY = 'abc123xyz'
+
+Benchmark.bmbm do |b|
+  b.report('100k stash') do
+    LARGE_NUMBER.times {
+      stash.write(KEY, large_value)
+      stash.read(KEY)
+    }
+  end
+  b.report('100k cache') do
+    LARGE_NUMBER.times {
+      Cache.set(KEY, large_value, 0, true)
+      Cache.get(KEY, true)
+    }
+  end
+  b.report('2k stash') do
+    LARGE_NUMBER.times {
+      stash.write(KEY, med_value)
+      stash.read(KEY)
+    }
+  end
+  b.report('2k cache') do
+    LARGE_NUMBER.times {
+      Cache.set(KEY, med_value, 0, true)
+      Cache.get(KEY, true)
+    }
+  end
+  b.report('100b stash') do
+    LARGE_NUMBER.times {
+      stash.write(KEY, small_value)
+      stash.read(KEY)
+    }
+  end
+  b.report('100b cache') do
+    LARGE_NUMBER.times {
+      Cache.set(KEY, small_value, 0, true)
+      Cache.get(KEY, true)
+    }
+  end
+  b.report('1b stash') do
+    LARGE_NUMBER.times {
+      stash.write(KEY, tiny_value)
+      stash.read(KEY)
+    }
+  end
+  b.report('1b cache') do
+    LARGE_NUMBER.times {
+      Cache.set(KEY, tiny_value, 0, true)
+      Cache.get(KEY, true)
+    }
+  end
+end

data/lib/remix/stash/protocol.rb

@@ -1,7 +1,7 @@
 module Stash::Protocol
   extend self
 
-  HEADER_FORMAT = "CCnCCnNa4a8"
+  HEADER_FORMAT = "CCnCCnNNQ"
 
   # Magic codes
   REQUEST   = 0x80
@@ -50,47 +50,18 @@ module Stash::Protocol
   # Extras
   COUNTER_FAULT_EXPIRATION = 0xFFFFFFFF
 
-  def add(io, key, data)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x02
-    # Key length   (2,3)  : 0x0005
-    # Extra length (4)    : 0x08
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x00000012
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              :
-    #   Flags      (24-27): 0xdeadbeef
-    #   Expiry     (28-31): 0x00000e10
-    # Key          (32-36): The textual string "Hello"
-    # Value        (37-41): The textual string "World"
-    header = [REQUEST, ADD, key.size, 8, 0, 0, data.size + key.size + 8, '', '', 0, 0, key, data].pack(HEADER_FORMAT + 'NNa*a*')
+  ADD_PACKET = HEADER_FORMAT + 'NNa*a*'
+  def add(io, key, data, ttl = 0)
+    header = [REQUEST, ADD, key.size, 8, 0, 0, data.size + key.size + 8, 0, 0, 0, ttl, key, data].pack(ADD_PACKET)
     io.write(header)
     resp = read_resp(io)
     resp[:status] == NO_ERROR
   end
 
+  DECR_PACKET = HEADER_FORMAT + 'NNQNa*'
   def decr(io, key, step)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x06
-    # Key length   (2,3)  : 0x0007
-    # Extra length (4)    : 0x14
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x0000001b
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              :
-    #   delta      (24-31): 0x0000000000000001
-    #   initial    (32-39): 0x0000000000000000
-    #   exipration (40-43): 0x00000e10
-    # Key                 : Textual string "counter"
-    # Value               : None
     low, high = split64(step)
-    header = [REQUEST, DECREMENT, key.size, 20, 0, 0, key.size + 20, '', '', high, low, 0, COUNTER_FAULT_EXPIRATION, key].pack(HEADER_FORMAT + 'NNQNa*')
+    header = [REQUEST, DECREMENT, key.size, 20, 0, 0, key.size + 20, 0, 0, high, low, 0, COUNTER_FAULT_EXPIRATION, key].pack(DECR_PACKET)
     io.write(header)
     resp = read_resp(io)
     if resp[:status] == NO_ERROR
@@ -98,60 +69,25 @@ module Stash::Protocol
     end
   end
 
+  DELETE_PACKET = HEADER_FORMAT + 'a*'
   def delete(io, key, ttl = 0)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x04
-    # Key length   (2,3)  : 0x0005
-    # Extra length (4)    : 0x00
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x00000005
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              : None
-    # Key                 : The textual string "Hello"
-    # Value               : None
-    header = [REQUEST, DELETE, key.size, 0, 0, 0, key.size, '', '', key].pack(HEADER_FORMAT + 'a*')
+    header = [REQUEST, DELETE, key.size, 0, 0, 0, key.size, 0, 0, key].pack(DELETE_PACKET)
     io.write(header)
     resp = read_resp(io)
     resp[:status] == NO_ERROR
   end
 
+  FLUSH_PACKET = HEADER_FORMAT + 'N'
   def flush(io)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x08
-    # Key length   (2,3)  : 0x0000
-    # Extra length (4)    : 0x04
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x00000004
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              :
-    #    Expiry    (24-27): 0x000e10
-    header = [REQUEST, FLUSH, 0, 4, 0, 0, 4, '', '', 0].pack(HEADER_FORMAT + 'N')
+    header = [REQUEST, FLUSH, 0, 4, 0, 0, 4, 0, 0, 0].pack(FLUSH_PACKET)
     io.write(header)
     resp = read_resp(io)
     resp[:status] == NO_ERROR
   end
 
+  GET_PACKET = HEADER_FORMAT + 'a*'
   def get(io, key)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x00
-    # Key length   (2,3)  : 0x0005
-    # Extra length (4)    : 0x00
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x00000005
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              : None
-    # Key          (24-29): The textual string: "Hello"
-    # Value               : None
-    header = [REQUEST, GET, key.size, 0, 0, 0, key.size, '', '', key].pack(HEADER_FORMAT + 'a*')
+    header = [REQUEST, GET, key.size, 0, 0, 0, key.size, 0, 0, key].pack(GET_PACKET)
     io.write(header)
     resp = read_resp(io)
     resp[:status] == NO_ERROR ? parse_get(resp[:body])[:value] : nil
@@ -161,25 +97,10 @@ module Stash::Protocol
     load_ruby_value(get(io, key))
   end
 
+  INCR_PACKET = HEADER_FORMAT + 'NNQNa*'
   def incr(io, key, step)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x05
-    # Key length   (2,3)  : 0x0007
-    # Extra length (4)    : 0x14
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x0000001b
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              :
-    #   delta      (24-31): 0x0000000000000001
-    #   initial    (32-39): 0x0000000000000000
-    #   exipration (40-43): 0x00000e10
-    # Key                 : Textual string "counter"
-    # Value               : None
     low, high = split64(step)
-    header = [REQUEST, INCREMENT, key.size, 20, 0, 0, key.size + 20, '', '', high, low, 0, COUNTER_FAULT_EXPIRATION, key].pack(HEADER_FORMAT + 'NNQNa*')
+    header = [REQUEST, INCREMENT, key.size, 20, 0, 0, key.size + 20, 0, 0, high, low, 0, COUNTER_FAULT_EXPIRATION, key].pack(INCR_PACKET)
     io.write(header)
     resp = read_resp(io)
     if resp[:status] == NO_ERROR
@@ -187,24 +108,10 @@ module Stash::Protocol
     end
   end
 
+  SET_PACKET = HEADER_FORMAT + 'NNa*a*'
   def set(io, key, data, ttl = 0)
-    # Field        (offset) (value)
-    # Magic        (0)    : 0x80
-    # Opcode       (1)    : 0x01
-    # Key length   (2,3)  : 0x0005
-    # Extra length (4)    : 0x08
-    # Data type    (5)    : 0x00
-    # Reserved     (6,7)  : 0x0000
-    # Total body   (8-11) : 0x00000012
-    # Opaque       (12-15): 0x00000000
-    # CAS          (16-23): 0x0000000000000000
-    # Extras              :
-    #   Flags      (24-27): 0xdeadbeef
-    #   Expiry     (28-31): 0x00000e10
-    # Key          (32-36): The textual string "Hello"
-    # Value        (37-41): The textual string "World"
-    header = [REQUEST, SET, key.size, 8, 0, 0, data.size + key.size + 8, '', '', 0, 0, key, data].pack(HEADER_FORMAT + 'NNa*a*')
-    io.write(header)
+    header = [REQUEST, SET, key.size, 8, 0, 0, data.size + key.size + 8, 0, 0, 0, ttl, key, data].pack(SET_PACKET)
+    io << header
     resp = read_resp(io)
     resp[:status] == NO_ERROR
   end
@@ -213,10 +120,6 @@ module Stash::Protocol
     set(io, key, Marshal.dump(value), ttl)
   end
 
-  def method_missing(message, *a)
-    fail [:NOT_IMPLEMENTED, self, message, *a].inspect
-  end
-
 private
 
   def load_ruby_value(data)
@@ -242,7 +145,7 @@ private
     resp = { :magic => magic, :opcode => opcode, :key_length => key_length,
       :extra => extra, :type => type, :status => status,
       :body_length => body_length, :opaque => opaque, :cas => cas }
-    resp[:body] = io.read(resp[:body_length]) if resp[:body_length] > 0
+    resp[:body] = io.read(body_length) if body_length > 0
     resp
   end
 

data/lib/remix/stash.rb

@@ -33,6 +33,13 @@ class Stash
     @opts = name == :root ? {:coherency => :action, :ttl => 0} : {}
   end
 
+  def add(*keys)
+    opts = default_opts(keys)
+    value = keys.pop
+    key = canonical_key(keys)
+    cluster.select(key) {|io| Protocol.add(io, key, value, opts[:ttl])}
+  end
+
   def clear(*keys)
     if keys.empty?
       if @name == :root
@@ -159,8 +166,9 @@ class Stash
 
 private
 
+  KEY_SEPARATOR = '/'
   def canonical_key(keys)
-    "#{implicit_scope}#{keys.join('/')}#{vector}"
+    "#{implicit_scope}#{keys.join(KEY_SEPARATOR)}#{vector}"
   end
 
   def cluster
@@ -175,12 +183,13 @@ private
     params.last.is_a?(Hash) ? default.merge(params.pop) : default
   end
 
+  EMPTY_SCOPE = ''
   def implicit_scope
     if @scope
       scope = @scope.call(self)
-      scope ? "#{scope}/" : ''
+      scope ? "#{scope}/" : EMPTY_SCOPE
     else
-      ''
+      EMPTY_SCOPE
     end
   end
 

data/remix-stash.gemspec

@@ -5,23 +5,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{remix-stash}
-  s.version = "0.9.1"
+  s.version = "0.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Mitchell"]
-  s.date = %q{2009-09-02}
+  s.date = %q{2009-09-09}
   s.email = %q{binary42@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.mdown"
+     "README.markdown"
   ]
   s.files = [
     ".gitignore",
      "LICENSE",
-     "README.mdown",
+     "README.markdown",
      "Rakefile",
      "VERSION",
-     "examples/bench.rb",
+     "benchmarks/get_set.rb",
+     "benchmarks/payload.rb",
      "examples/eval.rb",
      "examples/gate.rb",
      "examples/getset.rb",
@@ -49,7 +50,6 @@ Gem::Specification.new do |s|
     "spec/extension_spec.rb",
      "spec/spec.rb",
      "spec/stash_spec.rb",
-     "examples/bench.rb",
      "examples/eval.rb",
      "examples/gate.rb",
      "examples/getset.rb",

data/spec/stash_spec.rb

@@ -105,6 +105,21 @@ class StashSpec < Spec
 
   end
 
+  context '#add' do
+
+    should 'allow keys to be set with new values' do
+      assert stash.add('f', '42')
+      assert_equal '42', stash.read('f')
+    end
+
+    should 'not overwrite existing values' do
+      stash['f'] = '43'
+      assert !stash.add('f', '42')
+      assert_equal '43', stash['f']
+    end
+
+  end
+
   context '#clear' do
 
     setup do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: binary42-remix-stash
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Brian Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-02 00:00:00 -07:00
+date: 2009-09-09 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -21,14 +21,15 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.mdown
+- README.markdown
 files: 
 - .gitignore
 - LICENSE
-- README.mdown
+- README.markdown
 - Rakefile
 - VERSION
-- examples/bench.rb
+- benchmarks/get_set.rb
+- benchmarks/payload.rb
 - examples/eval.rb
 - examples/gate.rb
 - examples/getset.rb
@@ -75,7 +76,6 @@ test_files:
 - spec/extension_spec.rb
 - spec/spec.rb
 - spec/stash_spec.rb
-- examples/bench.rb
 - examples/eval.rb
 - examples/gate.rb
 - examples/getset.rb