Class CacheManager
In: lib/cache_manager.rb
Parent: Object

$Id: cache_manager.rb 351 2008-04-06 05:08:37Z tommy $

Copyright (C) 2007-2008 TOMITA Masahiro

CacheManager

Author:TOMITA Masahiro <tommy@tmtm.org>
License:Ruby‘s. see www.ruby-lang.org/en/LICENSE.txt

Download

Install

 $ make
 # make install

Usage

 double = CacheManager.new do |key|
   puts "invoked"
   key * 2
 end
 double[1]   # => 2, invoked
 double[2]   # => 4, invoked
 double[1]   # => 2, not invoked

 three_obj_cache = CacheManager.new :limit=>3 do |key|
   true
 end
 three_obj_cache[1]
 three_obj_cache.cache  # => {1=>true}
 three_obj_cache[2]
 three_obj_cache.cache  # => {1=>true, 2=>true}
 three_obj_cache[3]
 three_obj_cache.cache  # => {1=>true, 2=>true, 3=>true}
 three_obj_cache[4]
 three_obj_cache.cache  # => {2=>true, 3=>true, 4=>true}

 cm = CacheManager.new
 cm[1]                   # => nil
 cm.get(1)               # => nil
 cm.get(1) {|key| key*3} # => 3
 cm[1]                   # => 3

Methods

[]   []=   cache   clear   delete   get   key?   new   set  

Public Class methods

new(opt={}, &block)
opt:オプション (Hash)
block:Proc

CacheManager を初期化する。 self#[key] 時またはブロックなしの self#get(key) 時に key に対応する値がキャッシュされていない場合は、key を引数として block が呼び出され、その戻り値がキャッシュされる。

opt の有効なキーは次のとおり。

:expire
Numeric。キャッシュ保持期間(秒数)。これより古いキャッシュは破棄される。
:limit
Integer。最大キャッシュ保持数。これより多く値が設定された場合は古いものから削除される。

Public Instance methods

[](key)

key に対応する値を返す。 ブロックが指定されていない get と同じ。

[]=(key, value)

キャッシュのキー key に value を対応させる。value を返す。 戻り値以外は set と同じ。

cache()

{key => value} の Hash を返す。

clear()

キャッシュをクリアする。

delete(key)

キャッシュからキー key を削除する。

get(key, &block)

key に対応する値を返す。 値が存在しなくて、ブロックが与えられた場合は key を引数としてブロックを実行した結果を返す。 ブロックが指定されなくても initialize 時にブロックが与えられればそれを使用する。 それ以外は nil を返す。

key?(key)

key をキャッシュしているかどうかを true/false で返す。

set(key, value)

キャッシュのキー key に value を対応させる。self を返す。

[Validate]