sinatra-dalli 0.1.0

data/README.rdoc

@@ -0,0 +1,72 @@
+= Sinatra-Dalli
+
+== Install
+
+gem install sinatra-dalli
+
+== Dependencies
+
+  dalli
+  zlib
+
+== Usage:
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'sinatra/dalli'
+
+  # 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-dalli"
+  set :cache_enable, true
+  set :cache_logging, true
+  set :cache_default_expiry, 3600
+  set :cache_default_compress, false
+
+== Authors & Contributors
+
+  Kazuki Uchida, gioext@gmail.com
+
+  Casey Manion, casey@manion.com
+
+== 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/dalli.rb

@@ -0,0 +1,101 @@
+# Based on https://github.com/JGailor/sinatra-memcache/blob/master/lib/sinatra/memcache.rb
+# Modified to use dalli instead of memcache-client
+
+require 'dalli'
+require 'zlib'
+
+module Sinatra
+  module Dalli
+    module Helpers
+
+      #
+      #
+      #
+      def cache(key, params = {}, &block)
+        return block.call unless settings.cache_enable
+
+        opts = {
+          :expiry => settings.cache_default_expiry,
+          :compress => settings.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 settings.development? || settings.show_exceptions
+        block.call
+      end
+
+      #
+      #
+      #
+      def expire(p)
+        return unless settings.cache_enable
+
+        case p
+        when String
+          expire_key(p)
+        when Regexp
+          expire_regexp(p)
+        end
+        true
+      rescue => e
+        throw e if settings.development? or settings.show_exceptions
+        false
+      end
+
+      private
+
+      def client
+        settings.cache_client ||= ::Dalli::Client.new settings.cache_server,
+          :namespace => settings.cache_namespace
+      end
+
+      def log(msg)
+        puts "[sinatra-dalli] #{msg}" if settings.cache_logging
+      end
+
+      def get(key, opts)
+        v = client.get(key, :raw => 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], :raw => true)
+        value
+      end
+
+      def expire_key(key)
+        client.delete(key)
+        log "Expire: #{key}"
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Dalli::Helpers
+
+      app.set :cache_client, nil
+      app.set :cache_server, 'localhost:11211'
+      app.set :cache_namespace, 'sinatra-dalli'
+      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 Dalli
+end

data/spec/fixture.rb

@@ -0,0 +1,51 @@
+
+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 '/drop' do
+end
+
+get '/expire_all' do
+  expire "cache"
+  expire "cache2"
+  expire "compress"
+end
+
+configure do
+  set :cache_namespace, "test"
+  set :cache_logging, false
+end

data/spec/sinatra-dalli_spec.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'sinatra'
+require 'rack/test'
+
+require File.dirname(__FILE__) + '/../lib/sinatra/dalli'
+require File.dirname(__FILE__) + '/fixture'
+
+include Rack::Test::Methods
+def app
+  Sinatra::Application
+end
+
+describe 'Sinatra-Dalli' do
+  before do
+    @client = Dalli::Client.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 - marshal" do
+    get '/cache'
+    Marshal.load(@client.get('cache', true)).should == "Hello World"
+  end
+
+  it "/cache, /read" do
+    get '/cache'
+    get '/read'
+    last_response.ok?.should be_true
+    last_response.body.should == "Hello World"
+  end
+
+  it "/cache, /expire - nil" do
+    get '/cache'
+    get '/expire'
+    @client.get('cache').should be_nil
+  end
+
+  it "/cache2 - nil" do
+    get '/cache2'
+    sleep(1)
+    @client.get('cache2').should be_nil
+  end
+
+  it "/compress" do
+    get '/compress'
+    last_response.ok?.should be_true
+    last_response.body.should == "Hello Compress"
+    @client.get('compress', true).should == Zlib::Deflate.deflate(Marshal.dump('Hello Compress'))
+  end
+
+  it "/object" do
+    get '/object'
+    last_response.ok?.should be_true
+    last_response.body.should == "hello a hello b"
+    Marshal.load(@client.get('object', true)).should == { :a => 'hello a', :b => 'hello b' }
+  end
+
+  it "/cache, /cache2, /compress, /expire_all - nil " do
+    get '/cache'
+    get '/cache2'
+    get '/compress'
+    get '/expire_all'
+    @client.get('cache').should be_nil
+    @client.get('cache2').should be_nil
+    @client.get('compress').should be_nil
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-dalli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Casey Manion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-30 00:00:00.000000000 +00:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &11569220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11569220
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: &11568780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11568780
+description: Cache extension on Sinatra
+email: casey@manion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- README.rdoc
+- lib/sinatra/dalli.rb
+- spec/sinatra-dalli_spec.rb
+- spec/fixture.rb
+has_rdoc: true
+homepage: https://github.com/caseman72/sinatra-dalli
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Cache extension on Sinatra
+test_files: []