unicache 0.0.2 → 0.0.3

data/doc/_index.html

@@ -194,7 +194,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 10 23:59:39 2014 by
+  Generated on Thu Jul 17 14:54:02 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/file.CHANGELOG.html

@@ -63,7 +63,11 @@
 
     <div id="content"><div id='filecontents'>
 <h1>Version history</h1>
-<dl class="rdoc-list"><dt>0.0.2</dt>
+<dl class="rdoc-list"><dt>0.0.3</dt>
+<dd>
+<p>"open" and "close" method for cache content init and dump. Size can be
+"nil" (unlimited size).</p>
+</dd><dt>0.0.2</dt>
 <dd>
 <p>Uses NotifyHub for callbacks. No user visible changes.</p>
 </dd><dt>0.0.1</dt>
@@ -73,7 +77,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Mon Feb 10 23:59:39 2014 by
+  Generated on Thu Jul 17 14:54:02 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/file.README.html

@@ -79,7 +79,7 @@ policy by default. Cache can be configured to use another policy.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Mon Feb 10 23:59:39 2014 by
+  Generated on Thu Jul 17 14:54:02 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -79,7 +79,7 @@ policy by default. Cache can be configured to use another policy.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Mon Feb 10 23:59:39 2014 by
+  Generated on Thu Jul 17 14:54:02 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/method_list.html

@@ -59,71 +59,83 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="UniCache.html#clear-instance_method" title="UniCache#clear (method)">#clear</a></span>
-    <small>UniCache</small>
+    <span class='object_link'><a href="UniCache/LruEviction.html#clear-instance_method" title="UniCache::LruEviction#clear (method)">#clear</a></span>
+    <small>UniCache::LruEviction</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="UniCache/LruEviction.html#clear-instance_method" title="UniCache::LruEviction#clear (method)">#clear</a></span>
-    <small>UniCache::LruEviction</small>
+    <span class='object_link'><a href="UniCache.html#clear-instance_method" title="UniCache#clear (method)">#clear</a></span>
+    <small>UniCache</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="UniCache.html#exist%3F-instance_method" title="UniCache#exist? (method)">#exist?</a></span>
+    <span class='object_link'><a href="UniCache.html#close-instance_method" title="UniCache#close (method)">#close</a></span>
     <small>UniCache</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="UniCache.html#get-instance_method" title="UniCache#get (method)">#get</a></span>
+    <span class='object_link'><a href="UniCache.html#exist%3F-instance_method" title="UniCache#exist? (method)">#exist?</a></span>
     <small>UniCache</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="UniCache.html#hash_get_op-instance_method" title="UniCache#hash_get_op (method)">#hash_get_op</a></span>
+    <span class='object_link'><a href="UniCache.html#get-instance_method" title="UniCache#get (method)">#get</a></span>
     <small>UniCache</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="UniCache.html#hash_set_op-instance_method" title="UniCache#hash_set_op (method)">#hash_set_op</a></span>
+    <span class='object_link'><a href="UniCache.html#hash_get_op-instance_method" title="UniCache#hash_get_op (method)">#hash_get_op</a></span>
     <small>UniCache</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="UniCache.html#hash_store-instance_method" title="UniCache#hash_store (method)">#hash_store</a></span>
+    <span class='object_link'><a href="UniCache.html#hash_set_op-instance_method" title="UniCache#hash_set_op (method)">#hash_set_op</a></span>
     <small>UniCache</small>
   </li>
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="UniCache.html#hash_store-instance_method" title="UniCache#hash_store (method)">#hash_store</a></span>
+    <small>UniCache</small>
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="UniCache/LruEviction.html#initialize-instance_method" title="UniCache::LruEviction#initialize (method)">#initialize</a></span>
     <small>UniCache::LruEviction</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="UniCache.html#initialize-instance_method" title="UniCache#initialize (method)">#initialize</a></span>
     <small>UniCache</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="UniCache.html#lock-instance_method" title="UniCache#lock (method)">#lock</a></span>
     <small>UniCache</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="UniCache/LruEviction.html#nextEvict-instance_method" title="UniCache::LruEviction#nextEvict (method)">#nextEvict</a></span>
     <small>UniCache::LruEviction</small>
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="UniCache.html#open-instance_method" title="UniCache#open (method)">#open</a></span>
+    <small>UniCache</small>
+  </li>
+  
+
   <li class="r2 ">
     <span class='object_link'><a href="UniCache.html#peek-instance_method" title="UniCache#peek (method)">#peek</a></span>
     <small>UniCache</small>
@@ -143,14 +155,14 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="UniCache/LruEviction.html#remove-instance_method" title="UniCache::LruEviction#remove (method)">#remove</a></span>
-    <small>UniCache::LruEviction</small>
+    <span class='object_link'><a href="UniCache.html#remove-instance_method" title="UniCache#remove (method)">#remove</a></span>
+    <small>UniCache</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="UniCache.html#remove-instance_method" title="UniCache#remove (method)">#remove</a></span>
-    <small>UniCache</small>
+    <span class='object_link'><a href="UniCache/LruEviction.html#remove-instance_method" title="UniCache::LruEviction#remove (method)">#remove</a></span>
+    <small>UniCache::LruEviction</small>
   </li>
   
 
@@ -190,6 +202,12 @@
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="UniCache.html#version-class_method" title="UniCache.version (method)">version</a></span>
+    <small>UniCache</small>
+  </li>
+  
+
       </ul>
     </div>
   </body>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 10 23:59:39 2014 by
+  Generated on Thu Jul 17 14:54:02 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/lib/unicache.rb

@@ -1,19 +1,21 @@
-# UniCache is Universal purpose Cache with Least Recently Used
+# {UniCache} is Universal purpose Cache with Least Recently Used
 # replacement policy by default. Cache can be configured with another
 # policy.
 #
-# UniCache is intended to be Thread safe.
+# {UniCache} is intended to be Thread safe.
 #
-# User can register callbacks that are run at various UniCache events.
+# User can register callbacks that are run at various {UniCache} events.
 # ":getdata" callback is used to retreive cache data if not in
 # cache. Others do not effect the UniCache state.
 #
+# UniCache is inherits Hash, i.e. almost all Hash methods are usable.
+#
 # Usage example:
 #   require 'unicache'
 #
 #   # Create cache with size 2.
 #   c = UniCache.new( 2 )
-# 
+#
 #   # Register callbacks for some events (two for hit).
 #   c.registerCallback( :hit, Proc.new{ |k,v| puts  "Hit:   #{k}:#{v}" } )
 #   c.registerCallback( :hit, Proc.new{ |k,v| puts  "Found: #{k}:#{v}" } )
@@ -67,7 +69,7 @@ class UniCache < Hash
 
     # Cache initialization.
     #
-    # @param size [Integer] Cache size.
+    # @param size [Integer] Cache size (> 0), nil for infinite size.
     # @param evict [Object] Eviction policy.
     def initialize( size, evict = LruEviction.new )
         super()
@@ -78,7 +80,7 @@ class UniCache < Hash
 
         setEviction( evict )
 
-        @cb = NotifyHub.declare( :getdata,
+        @cb = NotifyHub.declare( :open, :close, :getdata,
                                  :add, :replace, :put, :overwrite,
                                  :remove, :valueremove, :hit, :miss,
                                  :peek )
@@ -109,9 +111,26 @@ class UniCache < Hash
         undef_method method
     end
 
+
+    # Open {UniCache} for access. The ":open" callback is
+    # executed. Typically the user would perform {UniCache} content
+    # initialization with the callback.
+    def open
+        runCallbacks( :open, nil )
+    end
+
+
+    # Close {UniCache} access. The ":close" callback is
+    # executed. Typically the user would perform {UniCache} content
+    # store with the callback.
+    def close
+        runCallbacks( :close, nil )
+    end
+
+
     # Dummy definition for "store" just for removal.
     def store(); end
-    
+
     # Remove "store" from UniCache.
     remove_method :store
 
@@ -125,11 +144,11 @@ class UniCache < Hash
         @lock.lock
         ret = _put( key, value )
         @lock.unlock
-        ret 
+        ret
     end
 
 
-    # Put operator.
+    # Put operator (See: {UniCache#put})
     def []=( key, value )
         self.put( key, value )
     end
@@ -137,24 +156,24 @@ class UniCache < Hash
 
     # Get Cache entry by key or return nil if not in Cache.
     #
-    # If block is provided, it is run under UniCache lock and will
+    # If block is provided, it is run under {UniCache} lock and will
     # protect the used data from being removed (concurrently).
     #
     # If ":getdata" callback is defined, it is used to get data. Data
-    # is always used, also when nil. UniCache lock is released before
+    # is always used, also when nil. {UniCache} lock is released before
     # callback is called.
     #
     # @param key [Object] Key (or tag) of the Cache entry.
-    # @yield Procedure to fetch the data.
+    # @yield Procedure to run with the data.
     def get( key, &blk )
         @lock.lock
         ret = _get( key, &blk )
         @lock.unlock
-        ret 
+        ret
     end
 
 
-    # Get operator.
+    # Get operator (See: {UniCache#get})
     def []( key )
         get( key )
     end
@@ -170,7 +189,7 @@ class UniCache < Hash
 
 
     # Get Cache entry existance by key (no effect to eviction). Uses
-    # "peek", i.e. peek CB is run.
+    # {UniCache#peek}, i.e. peek CB is run.
     #
     # @param key [Object] Entry key or tag.
     def exist?( key )
@@ -196,9 +215,12 @@ class UniCache < Hash
 
     # Resize the Cache.
     #
-    # @param size [Integer] New Cache size.
+    # @param size [Integer] New Cache size, "> 0" or "nil".
+    # @return [Integer] New Cache size.
     def resize( size )
-        
+
+        return nil if size == nil
+
         raise SizeError, "UniCache: Size must be bigger than 0" unless size > 0
 
         @lock.lock
@@ -218,41 +240,52 @@ class UniCache < Hash
     end
 
 
-    # Register a callback to be executed on Cache event.
+    # Register a callback to be executed on Cache event. Callbacks are
+    # passed with following arguments: CacheKey, CacheValue,
+    # CacheObject.
+    #
     #
     # Possible events:
     #
-    # [getdata]  Data not found in cache, callback is used to fetch
-    #            it. Data is always added to cache unless an exception
-    #            is raised. Also all retrys should be captured into
-    #            ":getdata". <key,value> from request.
+    # [:open] Called when {UniCache#open} is executed. This is
+    #         typically used to initialize the UniCache content.
+    #
+    # [:close] Called when {UniCache#close} is executed. This is
+    #          typically used to store the UniCache content for next
+    #          session.
     #
-    # [add]  Item is added to Cache without anything being
-    #        replaced. <key,value> from request.
+    # [:getdata]  Data not found in cache, callback is used to fetch
+    #             it. Data is always added to cache unless an exception
+    #             is raised. Also all retrys should be captured into
+    #             ":getdata". <key,value> from request.
     #
-    # [replace]  Item is added to Cache and another item is
-    #            removed. <key,value> is evicted entry.
+    # [:add]  Item is added to Cache without anything being
+    #         replaced. <key,value> from request.
     #
-    # [put]  Item is added to Cache. Cache conditions has no effect
-    #        i.e. always run for "put". <key,value> from request.
+    # [:replace]  Item is added to Cache and another item is
+    #             removed. <key,value> is evicted entry.
     #
-    # [overwrite]  Existing entry value is replaced by new item
-    #              value. <key,value> from request.
+    # [:put]  Item is added to Cache. Cache conditions has no effect
+    #         i.e. always run for "put". <key,value> from request.
     #
-    # [remove]  Entry is deleted from Cache.
+    # [:overwrite]  Existing entry value is replaced by new item
+    #               value. <key,value> from request.
     #
-    # [valueremove]  Entry value is removed (remove or overwrite).
-    #                <key,value> from old entry.
+    # [:remove]  Entry is deleted from Cache.
     #
-    # [hit]  Entry is found in Cache. <key,value> from cache.
+    # [:valueremove]  Entry value is removed (remove or overwrite).
+    #                 <key,value> from old entry.
     #
-    # [miss]  Entry is not found in Cache. <key> from request.
+    # [:hit]  Entry is found in Cache. <key,value> from cache.
     #
-    # [peek]  Cache peek. <key,value> from request.
+    # [:miss]  Entry is not found in Cache. <key> from request.
+    #
+    # [:peek]  Cache peek. <key,value> from request.
     #
     # Example:
     #   registerCallback( :add,
     #     Proc.new do |k,v,o| puts "Key: #{k} with value #{v} added" end
+    #   )
     #
     # @param type [Symbol] Callback event.
     # @param proc [Proc] Callback called with args: <key>, <value>, <self>.
@@ -321,14 +354,14 @@ class UniCache < Hash
         # Keep track of the least recently used keys. Place oldest at
         # the beginning of the list.
         #
-        # @param key [Object] 
+        # @param key [Object] Entry key.
         def update( key )
 
             @lock.lock
 
             # Delete old entries of this key.
             @list.delete_if do |i| i == key end
-            
+
             # Add to end of LRU.
             @list.push key
 
@@ -367,8 +400,17 @@ class UniCache < Hash
 
 
     private
-    
-    
+
+
+    def _full
+        if @size && self.length >= @size
+            true
+        else
+            false
+        end
+    end
+
+
     def _put( key, value )
         runAdd = false
 
@@ -378,7 +420,7 @@ class UniCache < Hash
             runCallbacks( :overwrite, key, value )
             runCallbacks( :valueremove, key )
 
-        elsif self.length >= @size
+        elsif _full
 
             # Overflow.
             runCallbacks( :replace, @evict.nextEvict )
@@ -394,13 +436,13 @@ class UniCache < Hash
         @evict.update( key )
 
         hash_store( key, value )
-        
+
         runCallbacks( :add, key ) if runAdd
         runCallbacks( :put, key )
 
         self
     end
-    
+
 
     def _get( key, &blk )
 
@@ -417,7 +459,7 @@ class UniCache < Hash
 
             if @cb[ :getdata ][0]
 
-                # Get value using callback. 
+                # Get value using callback.
 
                 @lock.unlock if @lock.locked?
                 ret = runCallbacks( :getdata, key, nil )
@@ -444,18 +486,18 @@ class UniCache < Hash
 
 
     def _remove( key = nil )
-        
+
         if key
             unless keys.index( key )
                 @lock.unlock if @lock.locked?
-                raise RemoveError, "Key \"#{key}\" does not exist..." 
+                raise RemoveError, "Key \"#{key}\" does not exist..."
             end
         else
             key = @evict.remove
         end
 
         value = removeEntry( key )
-        
+
         [ key, value ]
     end
 
@@ -481,3 +523,5 @@ class UniCache < Hash
     end
 
 end
+
+require 'version'

data/lib/version.rb

@@ -0,0 +1,6 @@
+class UniCache
+    VERSION="0.0.3"
+    def UniCache.version
+        VERSION
+    end
+end

data/test/test_all.rb

@@ -7,7 +7,7 @@ class TestableUniCache < UniCache
 end
 
 class UniCacheTest < Test::Unit::TestCase
-    
+
     def test_put_get
         c = UniCache.new( 2 )
 
@@ -34,7 +34,7 @@ class UniCacheTest < Test::Unit::TestCase
 
         assert_equal( 'duu', c[ 'dii2' ] )
         assert_equal( 'bar', c[ 'foo2' ] )
-        
+
         assert_equal( nil, c.get( 'dii' ) )
         assert_equal( nil, c.get( 'foo' ) )
     end
@@ -74,7 +74,7 @@ class UniCacheTest < Test::Unit::TestCase
         c.put( 'dii', 'duu' )
 
         assert_equal( 2, c.length )
-        
+
         c.resize( 1 )
 
         assert_equal( 1, c.length )
@@ -148,12 +148,12 @@ class UniCacheTest < Test::Unit::TestCase
         c.clear
 
     end
-        
+
 
     def test_callbacks
         c = TestableUniCache.new( 2 )
         c.cb_table = {}
-        
+
         # Register dummy callbacks.
         c.cb.ids.each do |type|
             eval "c.registerCallback( :#{type.to_s}, Proc.new{ |k,v,o| o.cb_table[ :#{type.to_s} ] = [ k, v ] } )"
@@ -161,7 +161,7 @@ class UniCacheTest < Test::Unit::TestCase
 
         c.removeCallback( :getdata )
         c.registerCallback( :getdata, Proc.new{ |k| k+1 } )
-       
+
         # Wrong type.
         exception = false
         begin
@@ -170,7 +170,7 @@ class UniCacheTest < Test::Unit::TestCase
             exception = true
         end
         assert_equal( true, exception )
-       
+
         # Invalid proc.
         exception = false
         begin
@@ -203,7 +203,32 @@ class UniCacheTest < Test::Unit::TestCase
         c[1]
         assert_equal( {}, c.cb_table )
         c.cb_table.clear
-        
+
+    end
+
+
+    def test_callbacks_open_close
+        c = TestableUniCache.new( 2 )
+
+        c.registerCallback( :open,
+
+            Proc.new{ |k,v,o|
+                o.put( 'foo', 'bar' )
+                o.put( 'dii', 'duu' )
+            } )
+
+        c.registerCallback( :close,
+            Proc.new{ |k,v,o|
+                o.clear
+            } )
+
+        c.open
+        assert_equal( 'bar', c['foo'] )
+        assert_equal( 'duu', c['dii'] )
+
+        c.close
+        assert_equal( nil, c['foo'] )
+
     end
 
 
@@ -216,9 +241,9 @@ class UniCacheTest < Test::Unit::TestCase
             sleep( 1 )
             c.remove( 0 )
         end
-                
+
         c.registerCallback( :getdata, Proc.new do 'data' end )
-    
+
         gotValue = nil
 
         # Block value through get.
@@ -243,4 +268,31 @@ class UniCacheTest < Test::Unit::TestCase
         assert_equal( 'data', gotValue )
     end
 
+
+    def test_nosize
+        c = UniCache.new( nil )
+
+        assert_equal( nil, c.size )
+
+        c.put( 'foo', 'bar' )
+
+        assert_equal( 1, c.length )
+
+        c.put( 'dii', 'duu' )
+
+        assert_equal( 2, c.length )
+
+        assert_equal( 'duu', c.get( 'dii' ) )
+        assert_equal( 'bar', c.get( 'foo' ) )
+
+        c[ 'foo2' ] = 'bar'
+
+        assert_equal( 3, c.length )
+
+        c[ 'dii2' ] = 'duu'
+
+        assert_equal( 4, c.length )
+
+    end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unicache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notifyhub
@@ -42,6 +42,7 @@ files:
 - CHANGELOG.rdoc
 - LICENSE
 - Rakefile
+- lib/version.rb
 - lib/unicache.rb
 - test/test_all.rb
 - doc/top-level-namespace.html
@@ -56,6 +57,7 @@ files:
 - doc/file.README.html
 - doc/method_list.html
 - doc/file_list.html
+- doc/UniCache/UniCacheCommon.html
 - doc/UniCache/CallbackError.html
 - doc/UniCache/FetchError.html
 - doc/UniCache/LruEviction.html