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

steam-condenser 1.3.7 → 1.3.8

Files changed (883) hide show

data/pkg/steam-condenser-1.3.7/doc/Cacheable.html ADDED Viewed

@@ -0,0 +1,903 @@
+<!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: Cacheable
+    &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">Cacheable</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: Cacheable
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="GameInventory.html" title="GameInventory (class)">GameInventory</a></span>, <span class='object_link'><a href="GameItemSchema.html" title="GameItemSchema (class)">GameItemSchema</a></span>, <span class='object_link'><a href="SteamGame.html" title="SteamGame (class)">SteamGame</a></span>, <span class='object_link'><a href="SteamGroup.html" title="SteamGroup (class)">SteamGroup</a></span>, <span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/cacheable.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module implements caching functionality to be used in any object class
+having one or more unique object identifier (i.e. ID) and using a <code>fetch</code>
+method to fetch data, e.g. using a HTTP download.</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>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Cacheable/ClassMethods.html" title="Cacheable::ClassMethods (module)">ClassMethods</a></span>
+</p>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#fetch_time-instance_method" title="#fetch_time (instance method)">- (Time) <strong>fetch_time</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the time the object&#39;s data has been fetched the last time.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(base) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>When this module is included in another class it is initialized to make use of caching.</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#cache-instance_method" title="#cache (instance method)">- (Object) <strong>cache</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Saves this object in the cache.</p>
+</div></span>
+</li>
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#cache_id_value-instance_method" title="#cache_id_value (instance method)">- (Object) <strong>cache_id_value</strong>(id) </a>
+  </span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value for the ID.</p>
+</div></span>
+</li>
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#cache_ids-instance_method" title="#cache_ids (instance method)">- (Array&lt;Object, Array&lt;Object&gt;&gt;) <strong>cache_ids</strong> </a>
+  </span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'><p>Returns a complete list of all values for the cache IDs of the cachable object.</p>
+</div></span>
+</li>
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#cached_instance-instance_method" title="#cached_instance (instance method)">- (Object) <strong>cached_instance</strong> </a>
+  </span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'><p>If available, returns the cached instance for the object it is called on.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Fetches the object from some data source.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#fetched%3F-instance_method" title="#fetched? (instance method)">- (Boolean) <strong>fetched?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns whether the data for this object has already been fetched.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="fetch_time-instance_method">
+    - (<tt>Time</tt>) <strong>fetch_time</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the time the object&#39;s data has been fetched the last time</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Time</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The time the object has been updated the last time</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+133
+134
+135</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 133</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_fetch_time'>fetch_time</span>
+  <span class='ivar'>@fetch_time</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="included-class_method">
+    + (<tt>Object</tt>) <strong>included</strong>(base)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>When this module is included in another class it is initialized to make use
+of caching</p>
+<p>The original <code>initialize</code> method of the including class will be wrapped,
+relaying all instantiations to the <code>new</code> method defined in <span class='object_link'><a href="Cacheable/ClassMethods.html" title="Cacheable::ClassMethods (module)">ClassMethods</a></span>.
+Additionally the class variable to save the attributes to cache (i.e. cache
+IDs) and the cache class variable itself are initialized.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>base</span>
+        <span class='type'>(<tt>Class</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The class to extend with caching functionality</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="Cacheable/ClassMethods.html" title="Cacheable::ClassMethods (module)">ClassMethods</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 30</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span> <span class='const'>ClassMethods</span>
+  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:class_variable_set</span><span class='comma'>,</span> <span class='symbol'>:@@cache</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:class_variable_set</span><span class='comma'>,</span> <span class='symbol'>:@@cache_ids</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='kw'>class</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_base'>base</span>
+    <span class='kw'>def</span> <span class='id identifier rubyid_method_added'>method_added</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
+      <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='symbol'>:fetch</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='lparen'>(</span><span class='cvar'>@@in_method_added</span> <span class='op'>||=</span> <span class='kw'>false</span><span class='rparen'>)</span>
+        <span class='cvar'>@@in_method_added</span> <span class='op'>=</span> <span class='kw'>true</span>
+        <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:original_fetch</span><span class='comma'>,</span> <span class='symbol'>:fetch</span>
+        <span class='id identifier rubyid_define_method'>define_method</span> <span class='symbol'>:fetch</span> <span class='kw'>do</span>
+          <span class='id identifier rubyid_original_fetch'>original_fetch</span>
+          <span class='ivar'>@fetch_time</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span>
+        <span class='kw'>end</span>
+        <span class='cvar'>@@in_method_added</span> <span class='op'>=</span> <span class='kw'>false</span>
+      <span class='kw'>end</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <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>Object</tt>) <strong>cache</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Saves this object in the cache</p>
+<p>This will use the ID attributes selected for caching</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+138
+139
+140
+141
+142
+143
+144
+145</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 138</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cache'>cache</span>
+  <span class='id identifier rubyid_cache'>cache</span>     <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:cache</span>
+  <span class='id identifier rubyid_cache_ids'>cache_ids</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cache_id'>cache_id</span><span class='op'>|</span>
+    <span class='id identifier rubyid_cache'>cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_cache_id'>cache_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_cache_id'>cache_id</span>
+  <span class='kw'>end</span>
+  <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cache_id_value-instance_method">
+    - (<tt>Object</tt>) <strong>cache_id_value</strong>(id)  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value for the ID</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>Symbol</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The name of an instance variable</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Object</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The value of the given instance variable</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+195
+196
+197</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 195</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cache_id_value'>cache_id_value</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cache_ids-instance_method">
+    - (<tt>Array&lt;Object, Array&lt;Object&gt;&gt;</tt>) <strong>cache_ids</strong>  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a complete list of all values for the cache IDs of the cachable
+object</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Object, Array&lt;Object&gt;&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The values for the cache IDs</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#cache_id_value-instance_method" title="Cacheable#cache_id_value (method)">#cache_id_value</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+183
+184
+185
+186
+187
+188
+189</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 183</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cache_ids'>cache_ids</span>
+  <span class='id identifier rubyid_values'>values</span> <span class='op'>=</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_id'>id</span><span class='op'>|</span>
+    <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_values'>values</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_cache_id_value'>cache_id_value</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:cache_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='op'>&amp;</span><span class='id identifier rubyid_values'>values</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cached_instance-instance_method">
+    - (<tt>Object</tt>) <strong>cached_instance</strong>  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>If available, returns the cached instance for the object it is called on</p>
+<p>This may be used to either replace an initial object with a completely
+cached instance of the same ID or to compare a modified object with the
+copy that was cached before.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#cache_ids-instance_method" title="Cacheable#cache_ids (method)">#cache_ids</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+172
+173
+174
+175
+176</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 172</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cached_instance'>cached_instance</span>
+  <span class='id identifier rubyid_ids'>ids</span> <span class='op'>=</span> <span class='id identifier rubyid_cache_ids'>cache_ids</span>
+  <span class='id identifier rubyid_cached'>cached</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:cache</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_object'>object</span><span class='op'>|</span> <span class='id identifier rubyid_ids'>ids</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span>
+  <span class='id identifier rubyid_cached'>cached</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_cached'>cached</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="fetch-instance_method">
+    - (<tt>Object</tt>) <strong>fetch</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>This method should be overridden in cacheable object classes and
+should implement the logic to retrieve the object&#39;s data. Updating
+the time is handled dynamically and does not need to be implemented
+separately.</p>
+</div>
+  </div>
+<p>Fetches the object from some data source</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+153
+154</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 153</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="fetched?-instance_method">
+    - (<tt>Boolean</tt>) <strong>fetched?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns whether the data for this object has already been fetched</p>
+  </div>
+</div>
+<div class="tags">
+<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 this object&#39;s data is available</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+159
+160
+161</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/cacheable.rb', line 159</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_fetched?'>fetched?</span>
+  <span class='op'>!</span><span class='ivar'>@fetch_time</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sun Oct 27 11:01:17 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.1 (ruby-2.0.0).
+</div>
+  </body>
+</html>