gioext-sinatra-memcache 0.1.0

data/README.textile

@@ -0,0 +1,71 @@
+h1. Sinatra-MemCache
+
+h2. Dependencies
+
+memcache-client
+
+zlib
+
+h2. Install
+
+<pre>
+sudo gem install gioext-sinatra-memcache
+</pre>
+
+h2. Example
+
+<pre>
+require 'rubygems'
+require 'sinatra'
+require 'sinatra/memcache'
+
+# cache
+get '/cache1' do
+  cache 'cache1' do
+    sleep(5)
+    'Hello Cache1'
+  end
+end
+
+# args
+get '/cache2' do
+  cache 'cache2', :expiry => 10, :compress => true do
+    sleep(3)
+    'Hello Cache2'
+  end
+end
+
+# cache object
+get '/obj' do
+  hash = cache 'obj' do
+    sleep(2)
+    { :a => 'Hello Object' }
+  end
+  hash[:a]
+end
+
+# expire
+get '/expire' do
+  expire 'cache1'
+  expire /^cache/
+  expire //
+  'Hello Expire'
+end
+
+# default options
+set :cache_server, "localhost:11211"
+set :cache_namespace, "sinatra-memcache"
+set :cache_enable, true
+set :cache_logging, true
+set :cache_default_expiry, 3600
+set :cache_default_compress, false
+</pre>
+
+h2. License
+
+Copyright (c) 2009 Kazuki UCHIDA
+
+Licensed under the MIT License:
+
+- http://www.opensource.org/licenses/mit-license.php
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--color', '--format specdoc']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/lib/sinatra/memcache.rb

@@ -0,0 +1,145 @@
+require 'memcache'
+require 'zlib'
+#require 'rubygems'
+#require 'sinatra/base'
+
+class MemCache
+  def all_keys
+    raise MemCacheError, "No active servers" unless active?
+    keys = []
+
+    @servers.each do |server|
+      sock = server.socket
+      raise MemCacheError, "No connection to server" if sock.nil?
+
+      begin
+        sock.write "stats items\r\n"
+        slabs = {}
+        while line = sock.gets
+          break if line == "END\r\n"
+          slabs[$1] = $2 if line =~ /^STAT items:(\d+):number (\d+)/ 
+        end
+
+        slabs.each do |k, v|
+          sock.write "stats cachedump #{k} #{v}\r\n"
+          while line = sock.gets
+            break if line == "END\r\n"
+            prefix = @namespace.empty? ? '' : "#{@namespace}:"
+            r = Regexp.new("^ITEM #{prefix}([^\s]+)")
+            keys << $1 if line =~ r
+          end
+        end
+      rescue SocketError, SystemCallError, IOError => err
+        server.close
+        raise MemCacheError, err.message
+      end
+    end
+
+    keys
+  end
+end
+
+module Sinatra
+  module MemCache
+    module Helpers
+
+      #
+      #
+      #
+      def cache(key, params = {}, &block)
+        return block.call unless options.cache_enable
+
+        opts = {
+          :expiry => options.cache_default_expiry,
+          :compress => options.cache_default_compress
+        }.merge(params)
+
+        value = get(key, opts)
+        return value unless block_given?
+
+        if value
+          log "Get: #{key}"
+          value
+        else
+          log "Set: #{key}"
+          set(key, block.call, opts)
+        end
+      rescue => e
+        throw e if development?
+        block.call
+      end
+
+      #
+      #
+      #
+      def expire(p)
+        return unless options.cache_enable
+
+        case p
+        when String
+          expire_key(p)
+        when Regexp
+          expire_regexp(p)
+        end
+        true
+      rescue => e
+        throw e if development?
+        false
+      end
+
+
+      private
+
+      def client
+        options.cache_client ||= ::MemCache.new options.cache_server,
+          :namespace => options.cache_namespace
+      end
+
+      def log(msg)
+        puts "[sinatra-memcache] #{msg}" if options.cache_logging
+      end
+
+      def get(key, opts)
+        v = client[key, true]
+        return v unless v
+
+        v = Zlib::Inflate.inflate(v) if opts[:compress]
+        Marshal.load(v)
+      end
+
+      def set(key, value, opts)
+        v = Marshal.dump(value)
+        v = Zlib::Deflate.deflate(v) if opts[:compress]
+        client.set(key, v, opts[:expiry], true)
+        value
+      end
+
+      def expire_key(key)
+        client.delete(key)
+        log "Expire: #{key}"
+      end
+
+      def expire_regexp(re)
+        keys = client.all_keys
+        keys.each do |key|
+          expire_key(key) if key =~ re
+        end
+      end
+    end
+
+    def self.registered(app)
+      app.helpers MemCache::Helpers
+
+      app.set :cache_client, nil
+      app.set :cache_server, "localhost:11211"
+      app.set :cache_namespace, "sinatra-memcache"
+      app.set :cache_enable, true
+      app.set :cache_logging, true
+      app.set :cache_default_expiry, 3600
+      app.set :cache_default_compress, false
+    end
+  end
+  
+  register MemCache
+
+end

data/spec/fixture.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'sinatra'
+require File.dirname(__FILE__) + '/../lib/sinatra/memcache'
+
+get '/' do
+  "Hello World"
+end
+
+get '/cache' do
+  cache "cache" do
+    "Hello World"
+  end
+end
+
+get '/cache2' do
+  cache "cache2", :expiry => 1 do
+    "Hello World"
+  end
+end
+
+get '/read' do
+  cache 'cache'
+end
+
+get '/compress' do
+  cache "compress", :compress => true do
+    "Hello Compress"
+  end
+end
+
+get '/object' do
+  hash = cache "object" do
+    { :a => 'hello a', :b => 'hello b' }
+  end
+  hash[:a] + ' ' + hash[:b]
+end
+
+get '/expire' do
+  expire "cache"
+end
+
+get '/expire_re' do
+  expire //
+end
+
+configure do
+  set :cache_namespace, "test"
+  set :cache_logging, false
+end

data/spec/sinatra-memcache_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/fixture'
+require 'rack/test'
+
+include Rack::Test::Methods
+def app
+  Sinatra::Application
+end
+
+describe 'Sinatra-MemCache' do
+  before do
+    @client = MemCache.new 'localhost:11211', :namespace => "test"
+  end
+
+  it "indexのレスポンスが正しいこと" do
+    get '/'
+    last_response.ok?.should be_true
+    last_response.body.should == "Hello World"
+  end
+
+  it "cacheしたときのレスポンスが正しいこと" do
+    get '/cache'
+    last_response.ok?.should be_true
+    last_response.body.should == "Hello World"
+  end
+
+  it "cacheした内容が正しいこと" do
+    get '/cache'
+    Marshal.load(@client['cache', true]).should == "Hello World"
+  end
+
+  it "ブロック無しで読み取りのみできること" do
+    get '/cache'
+    get '/read'
+    last_response.ok?.should be_true
+    last_response.body.should == "Hello World"
+  end
+
+  it "cacheした内容がexpireされること" do
+    get '/cache'
+    get '/expire'
+    @client['cache'].should be_nil
+  end
+
+  it "cacheが有効時間後にexpireされること" do
+    get '/cache2'
+    sleep(1)
+    @client['cache2'].should be_nil
+  end
+
+  it "compressが有効であること" do
+    get '/compress'
+    last_response.ok?.should be_true
+    last_response.body.should == "Hello Compress"
+    @client['compress', true].should == Zlib::Deflate.deflate(Marshal.dump('Hello Compress'))
+  end
+
+  it "オブジェクトがcacheされること" do
+    get '/object'
+    last_response.ok?.should be_true
+    last_response.body.should == "hello a hello b"
+    Marshal.load(@client['object', true]).should == { :a => 'hello a', :b => 'hello b' }
+  end
+
+  it "全てのcacheがexpireされること" do
+    get '/cache'
+    get '/cache2'
+    get '/compress'
+    get '/expire_re'
+    @client['cache'].should be_nil
+    @client['cache2'].should be_nil
+    @client['compress'].should be_nil
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: gioext-sinatra-memcache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- gioext
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: gioext@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.textile
+- lib/sinatra/memcache.rb
+- spec/sinatra-memcache_spec.rb
+- spec/fixture.rb
+has_rdoc: "false"
+homepage: http://github.com/gioext/sinatra-memcache
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Cache extension on Sinatra
+test_files: []
+