unicache 0.0.3 → 0.0.4

data/doc/UniCache/CallbackError.html

@@ -133,7 +133,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:03 2014 by
+  Generated on Sun Nov 23 14:33:03 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/UniCache/Error.html

@@ -129,7 +129,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:03 2014 by
+  Generated on Sun Nov 23 14:33:03 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/UniCache/FetchError.html

@@ -133,7 +133,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:03 2014 by
+  Generated on Sun Nov 23 14:33:03 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/UniCache/LruEviction.html

@@ -295,13 +295,13 @@ of operations.</p>
       <pre class="lines">
 
 
-340
-341
-342
-343</pre>
+359
+360
+361
+362</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 340</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 359</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
     <span class='ivar'>@lock</span> <span class='op'>=</span> <span class='const'>Mutex</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
@@ -345,14 +345,14 @@ of operations.</p>
       <pre class="lines">
 
 
-347
-348
-349
-350
-351</pre>
+366
+367
+368
+369
+370</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 347</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 366</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -390,12 +390,12 @@ of operations.</p>
       <pre class="lines">
 
 
-394
-395
-396</pre>
+413
+414
+415</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 394</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 413</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_nextEvict'>nextEvict</span>
     <span class='ivar'>@list</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
@@ -453,25 +453,25 @@ of operations.</p>
       <pre class="lines">
 
 
-375
-376
-377
-378
-379
-380
-381
-382
-383
-384
-385
-386
-387
-388
-389
-390</pre>
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 375</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 394</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -541,21 +541,21 @@ of the list.</p>
       <pre class="lines">
 
 
-358
-359
-360
-361
-362
-363
-364
-365
-366
-367
-368
-369</pre>
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386
+387
+388</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 358</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 377</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
 
@@ -579,7 +579,7 @@ of the list.</p>
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:03 2014 by
+  Generated on Sun Nov 23 14:33:03 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/UniCache/RemoveError.html

@@ -133,7 +133,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:03 2014 by
+  Generated on Sun Nov 23 14:33:03 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/UniCache/SizeError.html

@@ -133,7 +133,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:03 2014 by
+  Generated on Sun Nov 23 14:33:03 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

@@ -194,7 +194,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:02 2014 by
+  Generated on Sun Nov 23 14:33:03 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,10 @@
 
     <div id="content"><div id='filecontents'>
 <h1>Version history</h1>
-<dl class="rdoc-list"><dt>0.0.3</dt>
+<dl class="rdoc-list"><dt>0.0.4</dt>
+<dd>
+<p>Documentation improvements. Added version method.</p>
+</dd><dt>0.0.3</dt>
 <dd>
 <p>"open" and "close" method for cache content init and dump. Size can be
 "nil" (unlimited size).</p>
@@ -77,7 +80,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:02 2014 by
+  Generated on Sun Nov 23 14:33:03 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

@@ -66,20 +66,21 @@
 
 <h2>Description</h2>
 
-<p>UniCache is a universal purpose cache with Least Recently Used replacement
-policy by default. Cache can be configured to use another policy.</p>
+<p><span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> is a universal purpose cache with Least Recently Used
+replacement policy by default. Cache can be configured to use another
+policy.</p>
 
-<p>UniCache is intended to be Thread safe.</p>
+<p><span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> is intended to be Thread safe.</p>
 
-<p>User can register callbacks that are run at various UniCache events.</p>
+<p>User can register callbacks that are run at various <span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> events.</p>
 
 <h2>Documentation</h2>
 
-<p>Main documentation is generated from UniCache source.</p>
+<p>Main documentation is generated from <span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> source.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:02 2014 by
+  Generated on Sun Nov 23 14:33:03 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

@@ -66,20 +66,21 @@
 
 <h2>Description</h2>
 
-<p>UniCache is a universal purpose cache with Least Recently Used replacement
-policy by default. Cache can be configured to use another policy.</p>
+<p><span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> is a universal purpose cache with Least Recently Used
+replacement policy by default. Cache can be configured to use another
+policy.</p>
 
-<p>UniCache is intended to be Thread safe.</p>
+<p><span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> is intended to be Thread safe.</p>
 
-<p>User can register callbacks that are run at various UniCache events.</p>
+<p>User can register callbacks that are run at various <span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> events.</p>
 
 <h2>Documentation</h2>
 
-<p>Main documentation is generated from UniCache source.</p>
+<p>Main documentation is generated from <span class='object_link'><a href="UniCache.html" title="UniCache (class)">UniCache</a></span> source.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:02 2014 by
+  Generated on Sun Nov 23 14:33:03 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/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jul 17 14:54:02 2014 by
+  Generated on Sun Nov 23 14:33:03 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

@@ -2,13 +2,23 @@
 # replacement policy by default. Cache can be configured with another
 # policy.
 #
-# {UniCache} is intended to be Thread safe.
+# {UniCache} is created with defined size (or without size
+# limitations). {UniCache} inherits Hash and thus almost all Hash
+# methods are usable. The cache content is set and referenced using
+# Hash methods.
 #
-# 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.
+# User can register callbacks that are run at various {UniCache}
+# events (see: {UniCache#registerCallback}). ":getdata" callback is
+# used to retreive cache data if not in cache. Other callbacks don't
+# effect the UniCache state (unless explicitly changed).
+#
+# Cache can be setup with content using {UniCache#open} and content
+# can be stored after use with {UniCache#close}. The "open"/"close"
+# actions are defined in the corresponding callbacks.
+#
+# {UniCache} is intended to be Thread safe. It uses Mutex to implement
+# access control.
 #
-# UniCache is inherits Hash, i.e. almost all Hash methods are usable.
 #
 # Usage example:
 #   require 'unicache'
@@ -74,12 +84,16 @@ class UniCache < Hash
     def initialize( size, evict = LruEviction.new )
         super()
 
+        # Access control
         @lock = Mutex.new
 
+        # Set cache size.
         resize( size )
 
+        # Set eviction policy.
         setEviction( evict )
 
+        # Declare all callbacks.
         @cb = NotifyHub.declare( :open, :close, :getdata,
                                  :add, :replace, :put, :overwrite,
                                  :remove, :valueremove, :hit, :miss,
@@ -87,7 +101,8 @@ class UniCache < Hash
     end
 
 
-    # Set the eviction policy.
+    # Set the eviction policy. Evictor should have the same interface
+    # as {UniCache.LruEviction}.
     #
     # @param evict [Object] Cache eviction policy.
     def setEviction( evict )
@@ -165,6 +180,7 @@ class UniCache < Hash
     #
     # @param key [Object] Key (or tag) of the Cache entry.
     # @yield Procedure to run with the data.
+    # @return [Object] Cache data.
     def get( key, &blk )
         @lock.lock
         ret = _get( key, &blk )
@@ -182,6 +198,7 @@ class UniCache < Hash
     # Get Cache entry by key (no effect to eviction).
     #
     # @param key [Object] Entry key or tag.
+    # @return [Object] Cache data.
     def peek( key )
         runCallbacks( :peek, key )
         hash_fetch( key, nil )
@@ -192,6 +209,7 @@ class UniCache < Hash
     # {UniCache#peek}, i.e. peek CB is run.
     #
     # @param key [Object] Entry key or tag.
+    # @return [Boolean] True if value found.
     def exist?( key )
         if peek( key )
             true
@@ -278,7 +296,8 @@ class UniCache < Hash
     #
     # [:hit]  Entry is found in Cache. <key,value> from cache.
     #
-    # [:miss]  Entry is not found in Cache. <key> from request.
+    # [:miss] Entry is not found in Cache. <key> from
+    #         request. Callback is called before ":getdata".
     #
     # [:peek]  Cache peek. <key,value> from request.
     #
@@ -524,4 +543,4 @@ class UniCache < Hash
 
 end
 
-require 'version'
+require_relative 'version'

data/lib/version.rb

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

metadata

@@ -1,97 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: unicache
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Tero Isannainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notifyhub
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.2
-description: ! 'UniCache is a universal purpose cache with Least Recently Used
-
-  replacement policy by default. Cache can be configured to use another policy. UniCache
-  is intended to be Thread safe. User can register callbacks that are run at various
-  UniCache events.'
+description: |-
+  UniCache is a universal purpose cache with Least Recently Used
+  replacement policy by default. Cache can be configured to use another policy. UniCache is intended to be Thread safe. User can register callbacks that are run at various UniCache events.
 email: tero.isannainen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- README.rdoc
 - CHANGELOG.rdoc
 - LICENSE
-- Rakefile
-- lib/version.rb
-- lib/unicache.rb
-- test/test_all.rb
-- doc/top-level-namespace.html
-- doc/js/full_list.js
-- doc/js/app.js
-- doc/js/jquery.js
-- doc/index.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
+- README.rdoc
 - doc/UniCache.html
-- doc/file.README.html
-- doc/method_list.html
-- doc/file_list.html
-- doc/UniCache/UniCacheCommon.html
 - doc/UniCache/CallbackError.html
+- doc/UniCache/Error.html
 - doc/UniCache/FetchError.html
 - doc/UniCache/LruEviction.html
-- doc/UniCache/Error.html
-- doc/UniCache/SizeError.html
 - doc/UniCache/RemoveError.html
-- doc/class_list.html
+- doc/UniCache/SizeError.html
 - doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
 - doc/file.CHANGELOG.html
+- doc/file.README.html
+- doc/file_list.html
 - doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/unicache.rb
+- lib/version.rb
+- test/test_all.rb
 homepage: 
 licenses:
 - Ruby
+metadata: {}
 post_install_message: Check README...
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Universal purpose Cache with callback facility.
 test_files: []
 has_rdoc: