File.html in cachetastic-3.0.0

- old
+ new

@@ -63,12 +63,12 @@
         </tr>
 
         <tr class="top-aligned-row">
             <td><strong>Parent:</strong></td>
             <td>
-                <a href="FileBase.html">
-                Cachetastic::Adapters::FileBase
+                <a href="Base.html">
+                Cachetastic::Adapters::Base
                </a>
             </td>
         </tr>
         </table>
     </div>
@@ -80,162 +80,49 @@
 
   <div id="contextContent">
 
     <div id="description">
       <p>
-This adapter uses the file system as it&#8216;s backing. The configuration
-for this should look something like this:
+An adapter to cache objects to the file system.
 </p>
+<p>
+This adapter supports the following configuration settings, in addition to
+the default settings:
+</p>
 <pre>
- my_awesome_cache_options:
-   debug: false
-   adapter: file
-   marshall_method: none
-   default_expiry: &lt;%= 24.hours %&gt;
-   store_options:
-     dir: /usr/local/caches/
-   logging:
-     logger_1:
-       type: file
-       file: log/file_store_cache.log
+  configatron.cachetastic.defaults.storage_path = ::File.join(FileUtils.pwd, 'cachetastic')
+  configatron.cachetastic.defaults.marshal_method = :yaml
 </pre>
+<p>
+The <tt>storage_path</tt> setting defines the path to where cached objects
+are written to on disk.
+</p>
+<p>
+See <tt><a href="Base.html">Cachetastic::Adapters::Base</a></tt> for a list
+of public API methods.
+</p>
 
     </div>
 
 
    </div>
 
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
 
-      <div class="name-list">
-      <a href="#M000047">get</a>&nbsp;&nbsp;
-      <a href="#M000048">set</a>&nbsp;&nbsp;
-      <a href="#M000049">store_file_name</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
   </div>
 
 
     <!-- if includes -->
 
     <div id="section">
 
 
-    <div id="constants-list">
-      <h3 class="section-bar">Constants</h3>
 
-      <div class="name-list">
-        <table summary="Constants">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">STORE_FILE_NAME</td>
-          <td>=</td>
-          <td class="context-item-value">&quot;cache.yml&quot;</td>
-        </tr>
-        </table>
-      </div>
-    </div>
 
 
-
       
 
 
     <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000047" class="method-detail">
-        <a name="M000047"></a>
-
-        <div class="method-heading">
-          <a href="#M000047" class="method-signature">
-          <span class="method-name">get</span><span class="method-args">(key)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000047-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file.rb, line 16</span>
-16:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
-17:     <span class="ruby-identifier">full_path</span> = <span class="ruby-identifier">full_path_from_dir</span>(<span class="ruby-identifier">get_key_directoy</span>(<span class="ruby-identifier">key</span>, <span class="ruby-keyword kw">false</span>))
-18:     <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">full_path</span>)
-19:     <span class="ruby-identifier">so</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">full_path</span>).<span class="ruby-identifier">read</span>)
-20:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>
-21:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">invalid?</span>
-22:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
-23:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-24:       <span class="ruby-keyword kw">end</span>
-25:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>)
-26:         <span class="ruby-identifier">require</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">value</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">underscore</span>
-27:         <span class="ruby-identifier">so</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">full_path</span>).<span class="ruby-identifier">read</span>)
-28:       <span class="ruby-keyword kw">end</span>
-29:       <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">value</span>
-30:     <span class="ruby-keyword kw">end</span>
-31:     <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-32:   <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000048" class="method-detail">
-        <a name="M000048"></a>
-
-        <div class="method-heading">
-          <a href="#M000048" class="method-signature">
-          <span class="method-name">set</span><span class="method-args">(key, value, expiry = 0)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000048-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file.rb, line 34</span>
-34:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
-35:     <span class="ruby-identifier">so</span> = <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapters</span><span class="ruby-operator">::</span><span class="ruby-constant">StoreObject</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>)
-36:     <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">full_path_from_key</span>(<span class="ruby-identifier">key</span>), <span class="ruby-value str">&quot;w&quot;</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
-37:       <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">so</span>)
-38:     <span class="ruby-keyword kw">end</span>
-39:   <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <h3 class="section-bar">Protected Instance methods</h3>
-
-      <div id="method-M000049" class="method-detail">
-        <a name="M000049"></a>
-
-        <div class="method-heading">
-          <a href="#M000049" class="method-signature">
-          <span class="method-name">store_file_name</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000049-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file.rb, line 42</span>
-42:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store_file_name</span>
-43:     <span class="ruby-keyword kw">return</span> <span class="ruby-constant">STORE_FILE_NAME</span>
-44:   <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-
-    </div>
 
 
   </div>
 
 
\ No newline at end of file