RubyGems - steam-condenser - Versions diffs - 1.3.6 → 1.3.7 - Mend

steam-condenser 1.3.6 → 1.3.7

Files changed (500) hide show

data/doc/SteamCondenser/Community/Cacheable/ClassMethods.html ADDED Viewed

@@ -0,0 +1,695 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: SteamCondenser::Community::Cacheable::ClassMethods
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../../';
+  framesUrl = "../../../frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../../../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Community.html" title="SteamCondenser::Community (module)">Community</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">Cacheable</a></span></span>
+     &raquo;
+    <span class="title">ClassMethods</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Module: SteamCondenser::Community::Cacheable::ClassMethods
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/community/cacheable.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module implements functionality to access the cache of a class that
+includes the <span class='object_link'><a href="../Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">SteamCondenser::Community::Cacheable</a></span> module as class methods</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#cache-instance_method" title="#cache (instance method)">- (Hash&lt;Object, Cacheable&gt;) <strong>cache</strong> </a>
+  </span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the current cache for the cacheable class.</p>
+</div></span>
+</li>
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#cache_ids-instance_method" title="#cache_ids (instance method)">- (Array&lt;Symbol, Array&lt;Symbol&gt;&gt;) <strong>cache_ids</strong> </a>
+  </span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the list of IDs used for caching objects.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#cacheable_with_ids-instance_method" title="#cacheable_with_ids (instance method)">- (Object) <strong>cacheable_with_ids</strong>(*ids) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Defines wich instance variables which should be used to index the cached objects.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#cached%3F-instance_method" title="#cached? (instance method)">- (Boolean) <strong>cached?</strong>(id) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether an object with the given ID is already cached.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#clear_cache-instance_method" title="#clear_cache (instance method)">- (Object) <strong>clear_cache</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Clears the object cache for the class this method is called on.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#new-instance_method" title="#new (instance method)">- (Object) <strong>new</strong>(*args) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>This checks the cache for an existing object.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="cache-instance_method">
+    - (<tt>Hash&lt;Object, <span class='object_link'><a href="../Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">Cacheable</a></span>&gt;</tt>) <strong>cache</strong>  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the current cache for the cacheable class</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Object, <span class='object_link'><a href="../Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">Cacheable</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The cache for cacheable class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+117
+118
+119</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/cacheable.rb', line 117</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_cache identifier id'>cache</span>
+  <span class='rubyid_class_variable_get identifier id'>class_variable_get</span> <span class='symbol val'>:@@cache</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cache_ids-instance_method">
+    - (<tt>Array&lt;Symbol, Array&lt;Symbol&gt;&gt;</tt>) <strong>cache_ids</strong>  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the list of IDs used for caching objects</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Symbol, Array&lt;Symbol&gt;&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The IDs used for caching objects</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+124
+125
+126</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/cacheable.rb', line 124</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_cache_ids identifier id'>cache_ids</span>
+  <span class='rubyid_class_variable_get identifier id'>class_variable_get</span> <span class='symbol val'>:@@cache_ids</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cacheable_with_ids-instance_method">
+    - (<tt>Object</tt>) <strong>cacheable_with_ids</strong>(*ids)
+</h3><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>A call to this method is needed if you want a class including
+this module to really use the cache.</p>
+</div>
+  </div>
+<p>Defines wich instance variables which should be used to index the
+cached objects</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>ids</span>
+        <span class='type'>(<tt>Array&lt;Symbol&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The symbolic names of the instance variables
+representing a unique identifier for this object class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/cacheable.rb', line 66</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_cacheable_with_ids identifier id'>cacheable_with_ids</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='rubyid_ids identifier id'>ids</span><span class='rparen token'>)</span>
+  <span class='rubyid_class_variable_set identifier id'>class_variable_set</span> <span class='symbol val'>:@@cache_ids</span><span class='comma token'>,</span> <span class='rubyid_ids identifier id'>ids</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cached?-instance_method">
+    - (<tt>Boolean</tt>) <strong>cached?</strong>(id)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether an object with the given ID is already cached</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>id</span>
+        <span class='type'>(<tt>Object</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The ID of the desired object</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if the object with the given ID is already
+cached</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+75
+76
+77
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/cacheable.rb', line 75</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_cached? fid id'>cached?</span><span class='lparen token'>(</span><span class='rubyid_id identifier id'>id</span><span class='rparen token'>)</span>
+  <span class='rubyid_id identifier id'>id</span><span class='dot token'>.</span><span class='rubyid_downcase! fid id'>downcase!</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_id identifier id'>id</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_String constant id'>String</span>
+  <span class='rubyid_cache identifier id'>cache</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span><span class='lparen token'>(</span><span class='rubyid_id identifier id'>id</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="clear_cache-instance_method">
+    - (<tt>Object</tt>) <strong>clear_cache</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Clears the object cache for the class this method is called on</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+81
+82
+83</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/cacheable.rb', line 81</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_clear_cache identifier id'>clear_cache</span>
+  <span class='rubyid_class_variable_set identifier id'>class_variable_set</span> <span class='symbol val'>:@@cache</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="new-instance_method">
+    - (<tt>Object</tt>) <strong>new</strong>(*args)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This checks the cache for an existing object. If it exists it is
+returned, otherwise a new object is created.
+Overrides the default <code>new</code> method of the cacheable object class.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>args</span>
+        <span class='type'>(<tt>Array&lt;Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The parameters of the object that should be
+created and if possible loaded from cache</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#cached%3F-instance_method" title="SteamCondenser::Community::Cacheable::ClassMethods#cached? (method)">#cached?</a></span></li>
+      <li><span class='object_link'><a href="../Cacheable.html#fetch-instance_method" title="SteamCondenser::Community::Cacheable#fetch (method)">SteamCondenser::Community::Cacheable#fetch</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/cacheable.rb', line 93</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='rubyid_args identifier id'>args</span><span class='rparen token'>)</span>
+  <span class='rubyid_arity identifier id'>arity</span> <span class='assign token'>=</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_instance_method identifier id'>instance_method</span><span class='lparen token'>(</span><span class='symbol val'>:initialize</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_arity identifier id'>arity</span><span class='dot token'>.</span><span class='rubyid_abs identifier id'>abs</span>
+  <span class='rubyid_args identifier id'>args</span> <span class='opasgn op'>+=</span> <span class='lbrack token'>[</span><span class='rubyid_nil nil kw'>nil</span><span class='rbrack token'>]</span> <span class='mult op'>*</span> <span class='lparen token'>(</span><span class='rubyid_arity identifier id'>arity</span> <span class='minus op'>-</span> <span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='lt op'>&lt;</span> <span class='rubyid_arity identifier id'>arity</span>
+  <span class='rubyid_bypass_cache identifier id'>bypass_cache</span> <span class='assign token'>=</span> <span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='gt op'>&gt;</span> <span class='rubyid_arity identifier id'>arity</span> <span class='plus op'>+</span> <span class='integer val'>1</span> <span class='question op'>?</span> <span class='notop op'>!</span><span class='notop op'>!</span><span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_pop identifier id'>pop</span> <span class='colon op'>:</span> <span class='rubyid_false false kw'>false</span>
+  <span class='rubyid_fetch identifier id'>fetch</span> <span class='assign token'>=</span> <span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='gt op'>&gt;</span> <span class='rubyid_arity identifier id'>arity</span> <span class='integer val'>? </span><span class='notop op'>!</span><span class='notop op'>!</span><span class='rubyid_args identifier id'>args</span><span class='dot token'>.</span><span class='rubyid_pop identifier id'>pop</span> <span class='colon op'>:</span> <span class='rubyid_true true kw'>true</span>
+  <span class='rubyid_object identifier id'>object</span> <span class='assign token'>=</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_allocate identifier id'>allocate</span>
+  <span class='rubyid_object identifier id'>object</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='symbol val'>:initialize</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='rubyid_args identifier id'>args</span>
+  <span class='rubyid_cached_object identifier id'>cached_object</span> <span class='assign token'>=</span> <span class='rubyid_object identifier id'>object</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='symbol val'>:cached_instance</span>
+  <span class='rubyid_object identifier id'>object</span> <span class='assign token'>=</span> <span class='rubyid_cached_object identifier id'>cached_object</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_cached_object identifier id'>cached_object</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='rubyid_bypass_cache identifier id'>bypass_cache</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_fetch identifier id'>fetch</span> <span class='andop op'>&amp;&amp;</span> <span class='lparen token'>(</span><span class='rubyid_bypass_cache identifier id'>bypass_cache</span> <span class='orop op'>||</span> <span class='notop op'>!</span><span class='rubyid_object identifier id'>object</span><span class='dot token'>.</span><span class='rubyid_fetched? fid id'>fetched?</span><span class='rparen token'>)</span>
+    <span class='rubyid_object identifier id'>object</span><span class='dot token'>.</span><span class='rubyid_fetch identifier id'>fetch</span>
+    <span class='rubyid_object identifier id'>object</span><span class='dot token'>.</span><span class='rubyid_cache identifier id'>cache</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_object identifier id'>object</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:47:42 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7 (ruby-1.8.7).
+</div>
+  </body>
+</html>