rev_memcache 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andrew Rudenko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= rev_memcache
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Andrew Rudenko. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rev_memcache"
+    gem.summary = %Q{Rev memcache client}
+    gem.description = %Q{Rev memcache client}
+    gem.email = "ceo@prepor.ru"
+    gem.homepage = "http://github.com/prepor/rev_memcache"
+    gem.authors = ["Andrew Rudenko"]
+    gem.add_dependency "rev", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rev_memcache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/test.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rev'
+require File.dirname(__FILE__) + '/../lib/rev_memcache'
+
+event_loop = Rev::Loop.default
+cache = Rev::Memcache.connect('localhost', 11211).attach(event_loop)
+
+cache.set :a, 'hello'
+cache.set :b, 'hi'
+cache.set :c, 'how are you?'
+cache.set :d, ''
+
+cache.get(:a){ |v| p v }
+cache.get_hash(:a, :b, :c, :d){ |v| p v }
+cache.get(:a,:b,:c,:d){ |a,b,c,d| p [a,b,c,d] }
+
+cache.get(:a,:z,:b,:y,:d){ |a,z,b,y,d| p [a,z,b,y,d] }
+
+cache.get(:missing){ |m| p [:missing=, m] }
+cache.set(:missing, 'abc'){ p :stored }
+cache.get(:missing){ |m| p [:missing=, m] }
+cache.del(:missing){ p :deleted }
+cache.get(:missing){ |m| p [:missing=, m] }
+
+event_loop.run

data/lib/rev_memcache.rb

@@ -0,0 +1,205 @@
+module Rev  
+  # Implements the Memcache protocol (http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt).
+  # Requires memcached >= 1.2.4 w/ noreply support
+  #
+  # == Usage example
+  #
+  #   EM.run{
+  #     cache = EM::P::Memcache.connect 'localhost', 11211
+  #
+  #     cache.set :a, 'hello'
+  #     cache.set :b, 'hi'
+  #     cache.set :c, 'how are you?'
+  #     cache.set :d, ''
+  #
+  #     cache.get(:a){ |v| p v }
+  #     cache.get_hash(:a, :b, :c, :d){ |v| p v }
+  #     cache.get(:a,:b,:c,:d){ |a,b,c,d| p [a,b,c,d] }
+  #
+  #     cache.get(:a,:z,:b,:y,:d){ |a,z,b,y,d| p [a,z,b,y,d] }
+  #
+  #     cache.get(:missing){ |m| p [:missing=, m] }
+  #     cache.set(:missing, 'abc'){ p :stored }
+  #     cache.get(:missing){ |m| p [:missing=, m] }
+  #     cache.del(:missing){ p :deleted }
+  #     cache.get(:missing){ |m| p [:missing=, m] }
+  #   }
+  #
+  class Memcache < TCPSocket
+    require 'rev_memcache/deferrable'
+    
+    include Deferrable
+    ##
+    # constants
+
+    # :stopdoc:
+    unless defined? Cempty
+      Cstored    = 'STORED'.freeze
+      Cend       = 'END'.freeze
+      Cdeleted   = 'DELETED'.freeze
+      Cunknown   = 'NOT_FOUND'.freeze
+      Cerror     = 'ERROR'.freeze
+
+      Cempty     = ''.freeze
+      Cdelimiter = "\r\n".freeze
+    end
+    # :startdoc:
+
+    ##
+    # commands
+
+    # Get the value associated with one or multiple keys
+    #
+    #  cache.get(:a){ |v| p v }
+    #  cache.get(:a,:b,:c,:d){ |a,b,c,d| p [a,b,c,d] }
+    #
+    def get *keys
+      raise ArgumentError unless block_given?
+
+      callback{
+        keys = keys.map{|k| k.to_s.gsub(/\s/,'_') }
+        write "get #{keys.join(' ')}\r\n"
+        @get_cbs << [keys, proc{ |values|
+          yield *keys.map{ |k| values[k] }
+        }]
+      }
+    end
+
+    # Set the value for a given key
+    #
+    #  cache.set :a, 'hello'
+    #  cache.set(:missing, 'abc'){ puts "stored the value!" }
+    #
+    def set key, val, exptime = 0, &cb
+      callback{
+        val = val.to_s
+        send_cmd :set, key, 0, exptime, val.respond_to?(:bytesize) ? val.bytesize : val.size, !block_given?
+        write val
+        write Cdelimiter
+        @set_cbs << cb if cb
+      }
+    end
+
+    # Gets multiple values as a hash
+    #
+    #  cache.get_hash(:a, :b, :c, :d){ |h| puts h[:a] }
+    #
+    def get_hash *keys
+      raise ArgumentError unless block_given?
+
+      get *keys do |*values|
+        yield keys.inject({}){ |hash, k| hash.update k => values[keys.index(k)] }
+      end
+    end
+
+    # Delete the value associated with a key
+    #
+    #  cache.del :a
+    #  cache.del(:b){ puts "deleted the value!" }
+    #
+    def delete key, expires = 0, &cb
+      callback{
+        write "delete #{key} #{expires}#{cb ? '' : ' noreply'}\r\n"
+        @del_cbs << cb if cb
+      }
+    end
+    alias del delete
+
+    # :stopdoc:
+
+    def send_cmd cmd, key, flags = 0, exptime = 0, bytes = 0, noreply = false # :nodoc:
+      write "#{cmd} #{key} #{flags} #{exptime} #{bytes}#{noreply ? ' noreply' : ''}\r\n"
+    end
+    private :send_cmd
+
+    ##
+    # errors
+
+    class ParserError < StandardError
+    end
+
+    ##
+    # em hooks
+
+    def on_connect
+      @get_cbs = []
+      @set_cbs = []
+      @del_cbs = []
+
+      @values = {}
+
+      @reconnecting = false
+      @connected = true
+      succeed
+      # set_delimiter "\r\n"
+      # set_line_mode
+    end
+
+    def on_read data
+      (@buffer||='') << data
+
+      while index = @buffer.index(Cdelimiter)
+        begin
+          line = @buffer.slice!(0,index+2)
+          process_cmd line
+        rescue ParserError
+          @buffer[0...0] = line
+          break
+        end
+      end
+    end
+
+    def process_cmd line
+      case line.strip
+      when /^VALUE\s+(.+?)\s+(\d+)\s+(\d+)/ # VALUE <key> <flags> <bytes>
+        bytes = Integer($3)
+        # set_binary_mode bytes+2
+        # @cur_key = $1
+        if @buffer.size >= bytes + 2
+          @values[$1] = @buffer.slice!(0,bytes)
+          @buffer.slice!(0,2) # \r\n
+        else
+          raise ParserError
+        end
+
+      when Cend # END
+        if entry = @get_cbs.shift
+          keys, cb = entry
+          cb.call(@values)
+        end
+        @values = {}
+
+      when Cstored # STORED
+        if cb = @set_cbs.shift
+          cb.call(true)
+        end
+
+      when Cdeleted # DELETED
+        if cb = @del_cbs.shift
+          cb.call(true)
+        end
+
+      when Cunknown # NOT_FOUND
+        if cb = @del_cbs.shift
+          cb.call(false)
+        end
+
+      else
+        p [:MEMCACHE_UNKNOWN, line]
+      end
+    end
+
+    def on_close
+      if @connected or @reconnecting
+        # EM.add_timer(1){ reconnect @host, @port }
+        @connected = false
+        @reconnecting = true
+        @deferred_status = nil
+      else
+        raise 'Unable to connect to memcached server'
+      end
+    end
+
+    # :startdoc:
+  end
+end

data/lib/rev_memcache/deferrable.rb

@@ -0,0 +1,192 @@
+#--
+#
+# Author:: Francis Cianfrocca (gmail: blackhedd)
+# Homepage::  http://rubyeventmachine.com
+# Date:: 16 Jul 2006
+# 
+# See EventMachine and EventMachine::Connection for documentation and
+# usage examples.
+#
+#----------------------------------------------------------------------------
+#
+# Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
+# Gmail: blackhedd
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of either: 1) the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version; or 2) Ruby's License.
+# 
+# See the file COPYING for complete licensing information.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module Rev
+  module Memcache::Deferrable
+
+    # Specify a block to be executed if and when the Deferrable object receives
+    # a status of :succeeded. See #set_deferred_status for more information.
+    #
+    # Calling this method on a Deferrable object whose status is not yet known
+    # will cause the callback block to be stored on an internal list.
+    # If you call this method on a Deferrable whose status is :succeeded, the
+    # block will be executed immediately, receiving the parameters given to the
+    # prior #set_deferred_status call.
+    #
+    #--
+    # If there is no status, add a callback to an internal list.
+    # If status is succeeded, execute the callback immediately.
+    # If status is failed, do nothing.
+    #
+    def callback &block
+      return unless block
+      @deferred_status ||= :unknown
+      if @deferred_status == :succeeded
+        block.call(*@deferred_args)
+      elsif @deferred_status != :failed
+        @callbacks ||= []
+        @callbacks.unshift block # << block
+      end
+    end
+
+    # Specify a block to be executed if and when the Deferrable object receives
+    # a status of :failed. See #set_deferred_status for more information.
+    #--
+    # If there is no status, add an errback to an internal list.
+    # If status is failed, execute the errback immediately.
+    # If status is succeeded, do nothing.
+    #
+    def errback &block
+      return unless block
+      @deferred_status ||= :unknown
+      if @deferred_status == :failed
+        block.call(*@deferred_args)
+      elsif @deferred_status != :succeeded
+        @errbacks ||= []
+        @errbacks.unshift block # << block
+      end
+    end
+
+    # Sets the "disposition" (status) of the Deferrable object. See also the large set of
+    # sugarings for this method.
+    # Note that if you call this method without arguments,
+    # no arguments will be passed to the callback/errback.
+    # If the user has coded these with arguments, then the
+    # user code will throw an argument exception.
+    # Implementors of deferrable classes <b>must</b>
+    # document the arguments they will supply to user callbacks.
+    #
+    # OBSERVE SOMETHING VERY SPECIAL here: you may call this method even
+    # on the INSIDE of a callback. This is very useful when a previously-registered
+    # callback wants to change the parameters that will be passed to subsequently-registered
+    # ones.
+    #
+    # You may give either :succeeded or :failed as the status argument.
+    #
+    # If you pass :succeeded, then all of the blocks passed to the object using the #callback
+    # method (if any) will be executed BEFORE the #set_deferred_status method returns. All of the blocks
+    # passed to the object using #errback will be discarded.
+    #
+    # If you pass :failed, then all of the blocks passed to the object using the #errback
+    # method (if any) will be executed BEFORE the #set_deferred_status method returns. All of the blocks
+    # passed to the object using # callback will be discarded.
+    #
+    # If you pass any arguments to #set_deferred_status in addition to the status argument,
+    # they will be passed as arguments to any callbacks or errbacks that are executed.
+    # It's your responsibility to ensure that the argument lists specified in your callbacks and
+    # errbacks match the arguments given in calls to #set_deferred_status, otherwise Ruby will raise
+    # an ArgumentError.
+    #
+    #--
+    # We're shifting callbacks off and discarding them as we execute them.
+    # This is valid because by definition callbacks are executed no more than
+    # once. It also has the magic effect of permitting recursive calls, which
+    # means that a callback can call #set_deferred_status and change the parameters
+    # that will be sent to subsequent callbacks down the chain.
+    #
+    # Changed @callbacks and @errbacks from push/shift to unshift/pop, per suggestion
+    # by Kirk Haines, to work around the memory leak bug that still exists in many Ruby
+    # versions.
+    #
+    # Changed 15Sep07: after processing callbacks or errbacks, CLEAR the other set of
+    # handlers. This gets us a little closer to the behavior of Twisted's "deferred,"
+    # which only allows status to be set once. Prior to making this change, it was possible
+    # to "succeed" a Deferrable (triggering its callbacks), and then immediately "fail" it,
+    # triggering its errbacks! That is clearly undesirable, but it's just as undesirable
+    # to raise an exception is status is set more than once on a Deferrable. The latter
+    # behavior would invalidate the idiom of resetting arguments by setting status from
+    # within a callback or errback, but more seriously it would cause spurious errors
+    # if a Deferrable was timed out and then an attempt was made to succeed it. See the
+    # comments under the new method #timeout.
+    #
+    def set_deferred_status status, *args
+      cancel_timeout
+      @errbacks ||= nil
+      @callbacks ||= nil
+      @deferred_status = status
+      @deferred_args = args
+      case @deferred_status
+      when :succeeded
+        if @callbacks
+          while cb = @callbacks.pop
+            cb.call(*@deferred_args)
+          end
+        end
+        @errbacks.clear if @errbacks
+      when :failed
+        if @errbacks
+          while eb = @errbacks.pop
+            eb.call(*@deferred_args)
+          end
+        end
+        @callbacks.clear if @callbacks
+      end
+    end
+
+
+    # Setting a timeout on a Deferrable causes it to go into the failed state after
+    # the Timeout expires (passing no arguments to the object's errbacks).
+    # Setting the status at any time prior to a call to the expiration of the timeout
+    # will cause the timer to be cancelled.
+    def timeout seconds
+      cancel_timeout
+      me = self
+      @deferred_timeout = EventMachine::Timer.new(seconds) {me.fail}
+    end
+
+    # Cancels an outstanding timeout if any. Undoes the action of #timeout.
+    #
+    def cancel_timeout
+      @deferred_timeout ||= nil
+      if @deferred_timeout
+        @deferred_timeout.cancel
+        @deferred_timeout = nil
+      end
+    end
+
+
+    # Sugar for set_deferred_status(:succeeded, ...)
+    #
+    def succeed *args
+      set_deferred_status :succeeded, *args
+    end
+    alias set_deferred_success succeed
+
+    # Sugar for set_deferred_status(:failed, ...)
+    #
+    def fail *args
+      set_deferred_status :failed, *args
+    end
+    alias set_deferred_failure fail
+  end
+
+
+  # DefaultDeferrable is an otherwise empty class that includes Deferrable.
+  # This is very useful when you just need to return a Deferrable object
+  # as a way of communicating deferred status to some other part of a program.
+  class Memcache::DefaultDeferrable
+    include Memcache::Deferrable
+  end
+end

data/rev_memcache.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rev_memcache}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Rudenko"]
+  s.date = %q{2010-02-19}
+  s.description = %q{Rev memcache client}
+  s.email = %q{ceo@prepor.ru}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/test.rb",
+     "lib/rev_memcache.rb",
+     "lib/rev_memcache/deferrable.rb",
+     "lib/t.rb",
+     "rev_memcache.gemspec"
+  ]
+  s.homepage = %q{http://github.com/prepor/rev_memcache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rev memcache client}
+  s.test_files = [
+    "examples/test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rev>, [">= 0"])
+    else
+      s.add_dependency(%q<rev>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rev>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rev_memcache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrew Rudenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-19 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rev
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rev memcache client
+email: ceo@prepor.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/test.rb
+- lib/rev_memcache.rb
+- lib/rev_memcache/deferrable.rb
+- lib/t.rb
+- rev_memcache.gemspec
+has_rdoc: true
+homepage: http://github.com/prepor/rev_memcache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rev memcache client
+test_files: 
+- examples/test.rb