unicache 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 000e4b3cd4cec0e1dcf6cc2481aba8f91fe7aa0f
+  data.tar.gz: 81ac57728d3ee82d220f88b16be855811c01d01d
+SHA512:
+  metadata.gz: 6ba744c4953b73e31f180d333c71994192d5a33e50df4c44f326a1bd3d5a8fa9451fca67b48931f355d01ff094043ad43eb6730cbf772b2b3c7f93f4b0a315ce
+  data.tar.gz: 73eda8af1c78de44dd7fbfefcc533b7320be8fdf6113dee28af972db90b9d7762000ec9dc5c4bc0140fcbd80f1eccafccff11ef309d91c73546c251f0d20c508

data/CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = Version history
 
+[0.0.4] Documentation improvements.
+        Added version method.
+
 [0.0.3] "open" and "close" method for cache content init and dump.
         Size can be "nil" (unlimited size).
 

data/README.rdoc

@@ -2,14 +2,14 @@
 
 == Description
 
-UniCache is a universal purpose cache with Least Recently Used
+{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.
+{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.
 
 == Documentation
 
-Main documentation is generated from UniCache source.
+Main documentation is generated from {UniCache} source.

data/doc/UniCache.html

@@ -109,13 +109,21 @@
 <p><span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> is Universal purpose Cache with Least Recently Used replacement
 policy by default. Cache can be configured with another policy.</p>
 
-<p><span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> is intended to be Thread safe.</p>
+<p><span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> is created with defined size (or without size limitations).
+<span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> inherits Hash and thus almost all Hash methods are usable. The
+cache content is set and referenced using Hash methods.</p>
 
-<p>User can register callbacks that are run at various <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> events.
-":getdata" callback is used to retreive cache data if not in cache. Others
-do not effect the UniCache state.</p>
+<p>User can register callbacks that are run at various <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> events (see:
+<span class='object_link'><a href="#registerCallback-instance_method" title="UniCache#registerCallback (method)">#registerCallback</a></span>). ":getdata" callback is used to retreive cache
+data if not in cache. Other callbacks don't effect the UniCache state
+(unless explicitly changed).</p>
 
-<p>UniCache is inherits Hash, i.e. almost all Hash methods are usable.</p>
+<p>Cache can be setup with content using <span class='object_link'><a href="#open-instance_method" title="UniCache#open (method)">#open</a></span> and content can be
+stored after use with <span class='object_link'><a href="#close-instance_method" title="UniCache#close (method)">#close</a></span>. The "open"/"close" actions are
+defined in the corresponding callbacks.</p>
+
+<p><span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> is intended to be Thread safe. It uses Mutex to implement access
+control.</p>
 
 <p>Usage example:</p>
 
@@ -172,7 +180,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.3</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.4</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -808,34 +816,42 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-74
-75
-76
-77
-78
-79
-80
-81
-82
-83
 84
 85
 86
-87</pre>
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 74</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 84</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_size'>size</span><span class='comma'>,</span> <span class='id identifier rubyid_evict'>evict</span> <span class='op'>=</span> <span class='const'>LruEviction</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='rparen'>)</span>
     <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</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>
+    <span class='comment'># Access control
+</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>
 
-    <span class='id identifier rubyid_resize'>resize</span><span class='lparen'>(</span> <span class='id identifier rubyid_size'>size</span> <span class='rparen'>)</span>
+    <span class='comment'># Set cache size.
+</span>    <span class='id identifier rubyid_resize'>resize</span><span class='lparen'>(</span> <span class='id identifier rubyid_size'>size</span> <span class='rparen'>)</span>
 
-    <span class='id identifier rubyid_setEviction'>setEviction</span><span class='lparen'>(</span> <span class='id identifier rubyid_evict'>evict</span> <span class='rparen'>)</span>
+    <span class='comment'># Set eviction policy.
+</span>    <span class='id identifier rubyid_setEviction'>setEviction</span><span class='lparen'>(</span> <span class='id identifier rubyid_evict'>evict</span> <span class='rparen'>)</span>
 
-    <span class='ivar'>@cb</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='symbol'>:open</span><span class='comma'>,</span> <span class='symbol'>:close</span><span class='comma'>,</span> <span class='symbol'>:getdata</span><span class='comma'>,</span>
+    <span class='comment'># Declare all callbacks.
+</span>    <span class='ivar'>@cb</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='symbol'>:open</span><span class='comma'>,</span> <span class='symbol'>:close</span><span class='comma'>,</span> <span class='symbol'>:getdata</span><span class='comma'>,</span>
                              <span class='symbol'>:add</span><span class='comma'>,</span> <span class='symbol'>:replace</span><span class='comma'>,</span> <span class='symbol'>:put</span><span class='comma'>,</span> <span class='symbol'>:overwrite</span><span class='comma'>,</span>
                              <span class='symbol'>:remove</span><span class='comma'>,</span> <span class='symbol'>:valueremove</span><span class='comma'>,</span> <span class='symbol'>:hit</span><span class='comma'>,</span> <span class='symbol'>:miss</span><span class='comma'>,</span>
                              <span class='symbol'>:peek</span> <span class='rparen'>)</span>
@@ -878,12 +894,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-67
-68
-69</pre>
+77
+78
+79</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 67</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 77</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_lock'>lock</span>
   <span class='ivar'>@lock</span>
@@ -921,12 +937,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-64
-65
-66</pre>
+74
+75
+76</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 74</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
   <span class='ivar'>@size</span>
@@ -966,7 +982,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="code"><span class="info file"># File 'lib/version.rb', line 3</span>
 
 <span class='kw'>def</span> <span class='const'>UniCache</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
-    <span class='const'>VERSION</span>
+    <span class='const'>UniCache</span><span class='op'>::</span><span class='const'>VERSION</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1005,12 +1021,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-177
-178
-179</pre>
+193
+194
+195</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 177</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 193</span>
 
 <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
@@ -1046,12 +1062,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-152
-153
-154</pre>
+167
+168
+169</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 152</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 167</span>
 
 <span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
     <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
@@ -1087,17 +1103,17 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-316
-317
-318
-319
-320
-321
-322
-323</pre>
+335
+336
+337
+338
+339
+340
+341
+342</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 316</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 335</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>
@@ -1139,12 +1155,12 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
       <pre class="lines">
 
 
-126
-127
-128</pre>
+141
+142
+143</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 126</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 141</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span>
     <span class='id identifier rubyid_runCallbacks'>runCallbacks</span><span class='lparen'>(</span> <span class='symbol'>:close</span><span class='comma'>,</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
@@ -1204,6 +1220,11 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
       
       
       
+        &mdash;
+        <div class='inline'>
+<p>True if value found.</p>
+</div>
+      
     </li>
   
 </ul>
@@ -1214,16 +1235,16 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
       <pre class="lines">
 
 
-195
-196
-197
-198
-199
-200
-201</pre>
+213
+214
+215
+216
+217
+218
+219</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 195</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 213</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='kw'>if</span> <span class='id identifier rubyid_peek'>peek</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
@@ -1299,6 +1320,24 @@ used, also when nil. <span class='object_link'><a href="" title="UniCache (class
       
     </li>
   
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Object</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Cache data.</p>
+</div>
+      
+    </li>
+  
 </ul>
 
 </div><table class="source_code">
@@ -1307,15 +1346,15 @@ used, also when nil. <span class='object_link'><a href="" title="UniCache (class
       <pre class="lines">
 
 
-168
-169
-170
-171
-172
-173</pre>
+184
+185
+186
+187
+188
+189</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 168</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 184</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -1343,10 +1382,10 @@ used, also when nil. <span class='object_link'><a href="" title="UniCache (class
       <pre class="lines">
 
 
-99</pre>
+114</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 99</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 114</span>
 
 <span class='kw'>alias</span> <span class='symbol'>:hash_get_op</span> <span class='symbol'>:[]</span></pre>
     </td>
@@ -1369,10 +1408,10 @@ used, also when nil. <span class='object_link'><a href="" title="UniCache (class
       <pre class="lines">
 
 
-98</pre>
+113</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 113</span>
 
 <span class='kw'>alias</span> <span class='symbol'>:hash_set_op</span> <span class='symbol'>:[]=</span></pre>
     </td>
@@ -1395,10 +1434,10 @@ used, also when nil. <span class='object_link'><a href="" title="UniCache (class
       <pre class="lines">
 
 
-101</pre>
+116</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 101</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 116</span>
 
 <span class='kw'>alias</span> <span class='symbol'>:hash_store</span> <span class='symbol'>:store</span></pre>
     </td>
@@ -1433,12 +1472,12 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
       <pre class="lines">
 
 
-118
-119
-120</pre>
+133
+134
+135</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 118</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 133</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span>
     <span class='id identifier rubyid_runCallbacks'>runCallbacks</span><span class='lparen'>(</span> <span class='symbol'>:open</span><span class='comma'>,</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
@@ -1487,6 +1526,24 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
   
 </ul>
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Object</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Cache data.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -1494,13 +1551,13 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
       <pre class="lines">
 
 
-185
-186
-187
-188</pre>
+202
+203
+204
+205</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 185</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 202</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_peek'>peek</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_runCallbacks'>runCallbacks</span><span class='lparen'>(</span> <span class='symbol'>:peek</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
@@ -1573,15 +1630,15 @@ user would perform <span class='object_link'><a href="" title="UniCache (class)"
       <pre class="lines">
 
 
-143
-144
-145
-146
-147
-148</pre>
+158
+159
+160
+161
+162
+163</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 143</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 158</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -1651,7 +1708,8 @@ entry.</p>
 <p>Entry is found in Cache. &lt;key,value&gt; from cache.</p>
 </dd><dt>:miss</dt>
 <dd>
-<p>Entry is not found in Cache. &lt;key&gt; from request.</p>
+<p>Entry is not found in Cache. &lt;key&gt; from request. Callback is called
+before ":getdata".</p>
 </dd><dt>:peek</dt>
 <dd>
 <p>Cache peek. &lt;key,value&gt; from request.</p>
@@ -1711,16 +1769,16 @@ entry.</p>
       <pre class="lines">
 
 
-292
-293
-294
-295
-296
-297
-298</pre>
+311
+312
+313
+314
+315
+316
+317</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 292</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 311</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_registerCallback'>registerCallback</span><span class='lparen'>(</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_proc'>proc</span> <span class='rparen'>)</span>
     <span class='kw'>begin</span>
@@ -1800,15 +1858,15 @@ entry.</p>
       <pre class="lines">
 
 
-208
-209
-210
-211
-212
-213</pre>
+226
+227
+228
+229
+230
+231</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 208</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 226</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>
@@ -1869,18 +1927,18 @@ entry.</p>
       <pre class="lines">
 
 
-304
-305
-306
-307
-308
-309
-310
-311
-312</pre>
+323
+324
+325
+326
+327
+328
+329
+330
+331</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 304</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 323</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_removeCallback'>removeCallback</span><span class='lparen'>(</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
     <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
@@ -1973,30 +2031,30 @@ entry.</p>
       <pre class="lines">
 
 
-220
-221
-222
-223
-224
-225
-226
-227
-228
-229
-230
-231
-232
-233
-234
-235
-236
-237
 238
 239
-240</pre>
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 220</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 238</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_resize'>resize</span><span class='lparen'>(</span> <span class='id identifier rubyid_size'>size</span> <span class='rparen'>)</span>
 
@@ -2036,7 +2094,8 @@ entry.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Set the eviction policy.</p>
+<p>Set the eviction policy. Evictor should have the same interface as
+<span class='object_link'><a href="UniCache/LruEviction.html" title="UniCache::LruEviction (class)">LruEviction</a></span>.</p>
 
 
   </div>
@@ -2070,12 +2129,12 @@ entry.</p>
       <pre class="lines">
 
 
-93
-94
-95</pre>
+108
+109
+110</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 93</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 108</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_setEviction'>setEviction</span><span class='lparen'>(</span> <span class='id identifier rubyid_evict'>evict</span> <span class='rparen'>)</span>
     <span class='ivar'>@evict</span> <span class='op'>=</span> <span class='id identifier rubyid_evict'>evict</span>
@@ -2111,10 +2170,10 @@ entry.</p>
       <pre class="lines">
 
 
-132</pre>
+147</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 132</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 147</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
@@ -2127,7 +2186,7 @@ entry.</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>