cachetastic 1.5.0 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. data/doc/classes/ActiveRecord/Base.html +188 -0
  2. data/doc/classes/CGI/Session/CachetasticStore.html +124 -0
  3. data/doc/classes/Cachetastic/Adapters/Base.html +331 -0
  4. data/doc/classes/Cachetastic/Adapters/Drb.html +332 -0
  5. data/doc/classes/Cachetastic/Adapters/File.html +248 -0
  6. data/doc/classes/Cachetastic/Adapters/FileBase.html +309 -0
  7. data/doc/classes/Cachetastic/Adapters/HtmlFile.html +224 -0
  8. data/doc/classes/Cachetastic/Adapters/LocalMemory.html +346 -0
  9. data/doc/classes/Cachetastic/Adapters/Memcache.html +498 -0
  10. data/doc/classes/Cachetastic/Cacheable.html +264 -0
  11. data/doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html +287 -0
  12. data/doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html +200 -0
  13. data/doc/classes/Cachetastic/Caches/Base.html +672 -0
  14. data/doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html +179 -0
  15. data/doc/classes/Cachetastic/Caches/MackSessionCache.html +119 -0
  16. data/doc/classes/Cachetastic/Caches/PageCache.html +121 -0
  17. data/doc/classes/Cachetastic/Caches/RailsSessionCache.html +154 -0
  18. data/doc/classes/Cachetastic/Connection.html +212 -0
  19. data/doc/classes/Cachetastic/Errors/UnsupportedAdapter.html +146 -0
  20. data/doc/classes/Cachetastic/Logger.html +189 -0
  21. data/doc/classes/Object.html +152 -0
  22. data/doc/created.rid +1 -0
  23. data/doc/files/README.html +207 -0
  24. data/doc/files/lib/adapters/cachetastic_adapters_base_rb.html +139 -0
  25. data/doc/files/lib/adapters/cachetastic_adapters_drb_rb.html +115 -0
  26. data/doc/files/lib/adapters/cachetastic_adapters_file_base_rb.html +109 -0
  27. data/doc/files/lib/adapters/cachetastic_adapters_file_rb.html +121 -0
  28. data/doc/files/lib/adapters/cachetastic_adapters_html_file_rb.html +137 -0
  29. data/doc/files/lib/adapters/cachetastic_adapters_local_memory_rb.html +109 -0
  30. data/doc/files/lib/adapters/cachetastic_adapters_memcache_rb.html +127 -0
  31. data/doc/files/lib/adapters/cachetastic_adapters_store_object_rb.html +101 -0
  32. data/doc/files/lib/caches/cachetastic_caches_base_rb.html +108 -0
  33. data/doc/files/lib/caches/cachetastic_caches_mack_session_cache_rb.html +107 -0
  34. data/doc/files/lib/caches/cachetastic_caches_page_cache_rb.html +109 -0
  35. data/doc/files/lib/caches/cachetastic_caches_rails_session_cache_rb.html +107 -0
  36. data/doc/files/lib/cachetastic_cacheable_rb.html +101 -0
  37. data/doc/files/lib/cachetastic_connection_rb.html +107 -0
  38. data/doc/files/lib/cachetastic_logger_rb.html +107 -0
  39. data/doc/files/lib/cachetastic_rb.html +222 -0
  40. data/doc/files/lib/errors/cachetastic_errors_unsupported_adapter_rb.html +101 -0
  41. data/doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html +101 -0
  42. data/doc/files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html +109 -0
  43. data/doc/files/lib/ruby_extensions/object_rb.html +101 -0
  44. data/doc/fr_class_index.html +47 -0
  45. data/doc/fr_file_index.html +47 -0
  46. data/doc/fr_method_index.html +100 -0
  47. data/doc/index.html +24 -0
  48. data/doc/rdoc-style.css +208 -0
  49. data/lib/cachetastic.rb +21 -23
  50. data/lib/cachetastic_cacheable.rb +202 -0
  51. data/lib/rails_extensions/cachetastic_active_record_base.rb +12 -39
  52. data/lib/ruby_extensions/object.rb +8 -0
  53. data/test/active_record_test.rb +8 -8
  54. data/test/cacheable_test.rb +72 -0
  55. metadata +52 -2
  56. data/lib/helpers/cachetastic_helpers_active_record.rb +0 -46
data/doc/classes/Cachetastic/Adapters/Drb.html ADDED
@@ -0,0 +1,332 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Cachetastic::Adapters::Drb</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Cachetastic::Adapters::Drb</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../../files/lib/adapters/cachetastic_adapters_drb_rb.html">
59
+ lib/adapters/cachetastic_adapters_drb.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ <a href="Base.html">
69
+ Cachetastic::Adapters::Base
70
+ </a>
71
+ </td>
72
+ </tr>
73
+ </table>
74
+ </div>
75
+ <!-- banner header -->
76
+
77
+ <div id="bodyContent">
78
+
79
+
80
+
81
+ <div id="contextContent">
82
+
83
+ <div id="description">
84
+ <p>
85
+ This adapter uses Cachetastic::Drb::Server as it&#8216;s backing. The
86
+ configuration for this should look something like this:
87
+ </p>
88
+ <pre>
89
+ my_awesome_cache_options:
90
+ debug: false
91
+ adapter: drb
92
+ store_options:
93
+ host: druby://127.0.0.1:61676
94
+ </pre>
95
+
96
+ </div>
97
+
98
+
99
+ </div>
100
+
101
+ <div id="method-list">
102
+ <h3 class="section-bar">Methods</h3>
103
+
104
+ <div class="name-list">
105
+ <a href="#M000042">delete</a>&nbsp;&nbsp;
106
+ <a href="#M000039">expire_all</a>&nbsp;&nbsp;
107
+ <a href="#M000040">get</a>&nbsp;&nbsp;
108
+ <a href="#M000041">set</a>&nbsp;&nbsp;
109
+ <a href="#M000038">setup</a>&nbsp;&nbsp;
110
+ <a href="#M000043">stats</a>&nbsp;&nbsp;
111
+ <a href="#M000037">valid?</a>&nbsp;&nbsp;
112
+ </div>
113
+ </div>
114
+
115
+ </div>
116
+
117
+
118
+ <!-- if includes -->
119
+
120
+ <div id="section">
121
+
122
+
123
+
124
+
125
+
126
+ <div id="attribute-list">
127
+ <h3 class="section-bar">Attributes</h3>
128
+
129
+ <div class="name-list">
130
+ <table>
131
+ <tr class="top-aligned-row context-row">
132
+ <td class="context-item-name">drb_store</td>
133
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
134
+ <td class="context-item-desc"></td>
135
+ </tr>
136
+ </table>
137
+ </div>
138
+ </div>
139
+
140
+
141
+
142
+ <!-- if method_list -->
143
+ <div id="methods">
144
+ <h3 class="section-bar">Public Instance methods</h3>
145
+
146
+ <div id="method-M000042" class="method-detail">
147
+ <a name="M000042"></a>
148
+
149
+ <div class="method-heading">
150
+ <a href="#M000042" class="method-signature">
151
+ <span class="method-name">delete</span><span class="method-args">(key, delay = 0)</span>
152
+ </a>
153
+ </div>
154
+
155
+ <div class="method-description">
156
+ <p><a class="source-toggle" href="#"
157
+ onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
158
+ <div class="method-source-code" id="M000042-source">
159
+ <pre>
160
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 38</span>
161
+ 38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">delay</span> = <span class="ruby-value">0</span>)
162
+ 39: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">key</span>)
163
+ 40: <span class="ruby-keyword kw">end</span>
164
+ </pre>
165
+ </div>
166
+ </div>
167
+ </div>
168
+
169
+ <div id="method-M000039" class="method-detail">
170
+ <a name="M000039"></a>
171
+
172
+ <div class="method-heading">
173
+ <a href="#M000039" class="method-signature">
174
+ <span class="method-name">expire_all</span><span class="method-args">()</span>
175
+ </a>
176
+ </div>
177
+
178
+ <div class="method-description">
179
+ <p><a class="source-toggle" href="#"
180
+ onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
181
+ <div class="method-source-code" id="M000039-source">
182
+ <pre>
183
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 25</span>
184
+ 25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expire_all</span>
185
+ 26: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">expire_all</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>)
186
+ 27: <span class="ruby-keyword kw">end</span>
187
+ </pre>
188
+ </div>
189
+ </div>
190
+ </div>
191
+
192
+ <div id="method-M000040" class="method-detail">
193
+ <a name="M000040"></a>
194
+
195
+ <div class="method-heading">
196
+ <a href="#M000040" class="method-signature">
197
+ <span class="method-name">get</span><span class="method-args">(key)</span>
198
+ </a>
199
+ </div>
200
+
201
+ <div class="method-description">
202
+ <p>
203
+ See <a href="Base.html">Cachetastic::Adapters::Base</a>
204
+ </p>
205
+ <p><a class="source-toggle" href="#"
206
+ onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
207
+ <div class="method-source-code" id="M000040-source">
208
+ <pre>
209
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 30</span>
210
+ 30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
211
+ 31: <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Caches</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">unmarshall</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">get</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">key</span>))
212
+ 32: <span class="ruby-keyword kw">end</span>
213
+ </pre>
214
+ </div>
215
+ </div>
216
+ </div>
217
+
218
+ <div id="method-M000041" class="method-detail">
219
+ <a name="M000041"></a>
220
+
221
+ <div class="method-heading">
222
+ <a href="#M000041" class="method-signature">
223
+ <span class="method-name">set</span><span class="method-args">(key, value, expiry = 0)</span>
224
+ </a>
225
+ </div>
226
+
227
+ <div class="method-description">
228
+ <p><a class="source-toggle" href="#"
229
+ onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
230
+ <div class="method-source-code" id="M000041-source">
231
+ <pre>
232
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 34</span>
233
+ 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>)
234
+ 35: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">set</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">key</span>, <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Caches</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">marshall</span>(<span class="ruby-identifier">value</span>), <span class="ruby-identifier">expiry</span>)
235
+ 36: <span class="ruby-keyword kw">end</span>
236
+ </pre>
237
+ </div>
238
+ </div>
239
+ </div>
240
+
241
+ <div id="method-M000038" class="method-detail">
242
+ <a name="M000038"></a>
243
+
244
+ <div class="method-heading">
245
+ <a href="#M000038" class="method-signature">
246
+ <span class="method-name">setup</span><span class="method-args">()</span>
247
+ </a>
248
+ </div>
249
+
250
+ <div class="method-description">
251
+ <p><a class="source-toggle" href="#"
252
+ onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
253
+ <div class="method-source-code" id="M000038-source">
254
+ <pre>
255
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 20</span>
256
+ 20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setup</span>
257
+ 21: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">all_options</span>[<span class="ruby-value str">&quot;marshall_method&quot;</span>] = <span class="ruby-value str">&quot;ruby&quot;</span>
258
+ 22: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span> = <span class="ruby-constant">DRbObject</span>.<span class="ruby-identifier">new_with_uri</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">store_options</span>[<span class="ruby-value str">&quot;host&quot;</span>])
259
+ 23: <span class="ruby-keyword kw">end</span>
260
+ </pre>
261
+ </div>
262
+ </div>
263
+ </div>
264
+
265
+ <div id="method-M000043" class="method-detail">
266
+ <a name="M000043"></a>
267
+
268
+ <div class="method-heading">
269
+ <a href="#M000043" class="method-signature">
270
+ <span class="method-name">stats</span><span class="method-args">()</span>
271
+ </a>
272
+ </div>
273
+
274
+ <div class="method-description">
275
+ <p><a class="source-toggle" href="#"
276
+ onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
277
+ <div class="method-source-code" id="M000043-source">
278
+ <pre>
279
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 42</span>
280
+ 42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stats</span>
281
+ 43: <span class="ruby-keyword kw">super</span>
282
+ 44: <span class="ruby-keyword kw">begin</span>
283
+ 45: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">stats</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value str">'stats'</span>
284
+ 46: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
285
+ 47: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Calling stats on the DRb store raised this exception: #{e.message}&quot;</span>
286
+ 48: <span class="ruby-keyword kw">end</span>
287
+ 49: <span class="ruby-keyword kw">end</span>
288
+ </pre>
289
+ </div>
290
+ </div>
291
+ </div>
292
+
293
+ <div id="method-M000037" class="method-detail">
294
+ <a name="M000037"></a>
295
+
296
+ <div class="method-heading">
297
+ <a href="#M000037" class="method-signature">
298
+ <span class="method-name">valid?</span><span class="method-args">()</span>
299
+ </a>
300
+ </div>
301
+
302
+ <div class="method-description">
303
+ <p><a class="source-toggle" href="#"
304
+ onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
305
+ <div class="method-source-code" id="M000037-source">
306
+ <pre>
307
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_drb.rb, line 12</span>
308
+ 12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
309
+ 13: <span class="ruby-keyword kw">begin</span>
310
+ 14: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">drb_store</span>.<span class="ruby-identifier">ping</span>
311
+ 15: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
312
+ 16: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
313
+ 17: <span class="ruby-keyword kw">end</span>
314
+ 18: <span class="ruby-keyword kw">end</span>
315
+ </pre>
316
+ </div>
317
+ </div>
318
+ </div>
319
+
320
+
321
+ </div>
322
+
323
+
324
+ </div>
325
+
326
+
327
+ <div id="validator-badges">
328
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
329
+ </div>
330
+
331
+ </body>
332
+ </html>
data/doc/classes/Cachetastic/Adapters/File.html ADDED
@@ -0,0 +1,248 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Cachetastic::Adapters::File</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Cachetastic::Adapters::File</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../../files/lib/adapters/cachetastic_adapters_file_rb.html">
59
+ lib/adapters/cachetastic_adapters_file.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ <a href="FileBase.html">
69
+ Cachetastic::Adapters::FileBase
70
+ </a>
71
+ </td>
72
+ </tr>
73
+ </table>
74
+ </div>
75
+ <!-- banner header -->
76
+
77
+ <div id="bodyContent">
78
+
79
+
80
+
81
+ <div id="contextContent">
82
+
83
+ <div id="description">
84
+ <p>
85
+ This adapter uses the file system as it&#8216;s backing. The configuration
86
+ for this should look something like this:
87
+ </p>
88
+ <pre>
89
+ my_awesome_cache_options:
90
+ debug: false
91
+ adapter: file
92
+ marshall_method: none
93
+ default_expiry: &lt;%= 24.hours %&gt;
94
+ store_options:
95
+ dir: /usr/local/caches/
96
+ logging:
97
+ logger_1:
98
+ type: file
99
+ file: log/file_store_cache.log
100
+ </pre>
101
+
102
+ </div>
103
+
104
+
105
+ </div>
106
+
107
+ <div id="method-list">
108
+ <h3 class="section-bar">Methods</h3>
109
+
110
+ <div class="name-list">
111
+ <a href="#M000044">get</a>&nbsp;&nbsp;
112
+ <a href="#M000045">set</a>&nbsp;&nbsp;
113
+ <a href="#M000046">store_file_name</a>&nbsp;&nbsp;
114
+ </div>
115
+ </div>
116
+
117
+ </div>
118
+
119
+
120
+ <!-- if includes -->
121
+
122
+ <div id="section">
123
+
124
+
125
+ <div id="constants-list">
126
+ <h3 class="section-bar">Constants</h3>
127
+
128
+ <div class="name-list">
129
+ <table summary="Constants">
130
+ <tr class="top-aligned-row context-row">
131
+ <td class="context-item-name">STORE_FILE_NAME</td>
132
+ <td>=</td>
133
+ <td class="context-item-value">&quot;cache.yml&quot;</td>
134
+ </tr>
135
+ </table>
136
+ </div>
137
+ </div>
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <!-- if method_list -->
145
+ <div id="methods">
146
+ <h3 class="section-bar">Public Instance methods</h3>
147
+
148
+ <div id="method-M000044" class="method-detail">
149
+ <a name="M000044"></a>
150
+
151
+ <div class="method-heading">
152
+ <a href="#M000044" class="method-signature">
153
+ <span class="method-name">get</span><span class="method-args">(key)</span>
154
+ </a>
155
+ </div>
156
+
157
+ <div class="method-description">
158
+ <p><a class="source-toggle" href="#"
159
+ onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
160
+ <div class="method-source-code" id="M000044-source">
161
+ <pre>
162
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_file.rb, line 16</span>
163
+ 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
164
+ 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>))
165
+ 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>)
166
+ 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>)
167
+ 20: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>
168
+ 21: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">invalid?</span>
169
+ 22: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
170
+ 23: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
171
+ 24: <span class="ruby-keyword kw">end</span>
172
+ 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>)
173
+ 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>
174
+ 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>)
175
+ 28: <span class="ruby-keyword kw">end</span>
176
+ 29: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">value</span>
177
+ 30: <span class="ruby-keyword kw">end</span>
178
+ 31: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
179
+ 32: <span class="ruby-keyword kw">end</span>
180
+ </pre>
181
+ </div>
182
+ </div>
183
+ </div>
184
+
185
+ <div id="method-M000045" class="method-detail">
186
+ <a name="M000045"></a>
187
+
188
+ <div class="method-heading">
189
+ <a href="#M000045" class="method-signature">
190
+ <span class="method-name">set</span><span class="method-args">(key, value, expiry = 0)</span>
191
+ </a>
192
+ </div>
193
+
194
+ <div class="method-description">
195
+ <p><a class="source-toggle" href="#"
196
+ onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
197
+ <div class="method-source-code" id="M000045-source">
198
+ <pre>
199
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_file.rb, line 34</span>
200
+ 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>)
201
+ 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>)
202
+ 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>
203
+ 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>)
204
+ 38: <span class="ruby-keyword kw">end</span>
205
+ 39: <span class="ruby-keyword kw">end</span>
206
+ </pre>
207
+ </div>
208
+ </div>
209
+ </div>
210
+
211
+ <h3 class="section-bar">Protected Instance methods</h3>
212
+
213
+ <div id="method-M000046" class="method-detail">
214
+ <a name="M000046"></a>
215
+
216
+ <div class="method-heading">
217
+ <a href="#M000046" class="method-signature">
218
+ <span class="method-name">store_file_name</span><span class="method-args">()</span>
219
+ </a>
220
+ </div>
221
+
222
+ <div class="method-description">
223
+ <p><a class="source-toggle" href="#"
224
+ onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
225
+ <div class="method-source-code" id="M000046-source">
226
+ <pre>
227
+ <span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_file.rb, line 42</span>
228
+ 42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store_file_name</span>
229
+ 43: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">STORE_FILE_NAME</span>
230
+ 44: <span class="ruby-keyword kw">end</span>
231
+ </pre>
232
+ </div>
233
+ </div>
234
+ </div>
235
+
236
+
237
+ </div>
238
+
239
+
240
+ </div>
241
+
242
+
243
+ <div id="validator-badges">
244
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
245
+ </div>
246
+
247
+ </body>
248
+ </html>