cachetastic 2.1.4 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. data/LICENSE +21 -0
  2. data/README +57 -43
  3. data/doc/classes/Cachetastic/Adapters.html +180 -0
  4. data/doc/classes/Cachetastic/Adapters/Base.html +206 -123
  5. data/doc/classes/Cachetastic/Adapters/File.html +17 -130
  6. data/doc/classes/Cachetastic/Adapters/LocalMemory.html +7 -228
  7. data/doc/classes/Cachetastic/Adapters/Memcached.html +193 -0
  8. data/doc/classes/Cachetastic/Cache.html +425 -0
  9. data/doc/classes/Cachetastic/Cacheable.html +26 -30
  10. data/doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html +66 -62
  11. data/doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html +30 -30
  12. data/doc/classes/Cachetastic/Logger.html +31 -33
  13. data/doc/created.rid +1 -1
  14. data/doc/files/{lib/cachetastic/adapters/html_file_rb.html → LICENSE.html} +29 -34
  15. data/doc/files/README.html +91 -57
  16. data/doc/files/lib/cachetastic/adapters/base_rb.html +1 -39
  17. data/doc/files/lib/cachetastic/adapters/file_rb.html +1 -21
  18. data/doc/files/lib/cachetastic/adapters/local_memory_rb.html +1 -9
  19. data/doc/files/lib/cachetastic/{ruby_extensions/kernel_rb.html → adapters/memcached_rb.html} +4 -4
  20. data/doc/files/lib/cachetastic/{ruby_extensions/string_rb.html → cache_rb.html} +5 -5
  21. data/doc/files/lib/cachetastic/cacheable_rb.html +1 -1
  22. data/doc/files/lib/cachetastic/{caches/base_rb.html → extensions/string_rb.html} +5 -5
  23. data/doc/files/lib/cachetastic/logger_rb.html +1 -7
  24. data/doc/files/lib/cachetastic/{adapters/store_object_rb.html → store_object_rb.html} +3 -3
  25. data/doc/files/lib/cachetastic_rb.html +4 -95
  26. data/doc/fr_class_index.html +3 -15
  27. data/doc/fr_file_index.html +5 -16
  28. data/doc/fr_method_index.html +26 -78
  29. data/lib/cachetastic.rb +16 -70
  30. data/lib/cachetastic/adapters/base.rb +178 -76
  31. data/lib/cachetastic/adapters/file.rb +63 -46
  32. data/lib/cachetastic/adapters/local_memory.rb +36 -67
  33. data/lib/cachetastic/adapters/memcached.rb +114 -0
  34. data/lib/cachetastic/cache.rb +165 -0
  35. data/lib/cachetastic/cacheable.rb +19 -15
  36. data/lib/cachetastic/extensions/string.rb +8 -0
  37. data/lib/cachetastic/logger.rb +41 -41
  38. data/lib/cachetastic/store_object.rb +22 -0
  39. metadata +43 -64
  40. data/bin/cachetastic_drb_server +0 -115
  41. data/doc/classes/ActiveRecord/Base.html +0 -194
  42. data/doc/classes/CGI/Session/CachetasticStore.html +0 -124
  43. data/doc/classes/Cachetastic/Adapters/Drb.html +0 -332
  44. data/doc/classes/Cachetastic/Adapters/FileBase.html +0 -309
  45. data/doc/classes/Cachetastic/Adapters/HtmlFile.html +0 -224
  46. data/doc/classes/Cachetastic/Adapters/Memcache.html +0 -498
  47. data/doc/classes/Cachetastic/Caches/Base.html +0 -643
  48. data/doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html +0 -179
  49. data/doc/classes/Cachetastic/Caches/MackSessionCache.html +0 -119
  50. data/doc/classes/Cachetastic/Caches/PageCache.html +0 -121
  51. data/doc/classes/Cachetastic/Caches/RailsSessionCache.html +0 -154
  52. data/doc/classes/Cachetastic/Connection.html +0 -212
  53. data/doc/classes/Cachetastic/Errors/UnsupportedAdapter.html +0 -146
  54. data/doc/classes/Object.html +0 -222
  55. data/doc/classes/String.html +0 -172
  56. data/doc/files/lib/cachetastic/adapters/drb_rb.html +0 -115
  57. data/doc/files/lib/cachetastic/adapters/file_base_rb.html +0 -109
  58. data/doc/files/lib/cachetastic/adapters/memcache_rb.html +0 -127
  59. data/doc/files/lib/cachetastic/caches/mack_session_cache_rb.html +0 -107
  60. data/doc/files/lib/cachetastic/caches/page_cache_rb.html +0 -109
  61. data/doc/files/lib/cachetastic/caches/rails_session_cache_rb.html +0 -107
  62. data/doc/files/lib/cachetastic/connection_rb.html +0 -107
  63. data/doc/files/lib/cachetastic/errors/unsupported_adapter_rb.html +0 -101
  64. data/doc/files/lib/cachetastic/rails_extensions/active_record_base_rb.html +0 -101
  65. data/doc/files/lib/cachetastic/rails_extensions/cgi_session_store_rb.html +0 -109
  66. data/doc/files/lib/cachetastic/ruby_extensions/object_rb.html +0 -101
  67. data/lib/cachetastic/adapters/drb.rb +0 -51
  68. data/lib/cachetastic/adapters/file_base.rb +0 -86
  69. data/lib/cachetastic/adapters/html_file.rb +0 -68
  70. data/lib/cachetastic/adapters/memcache.rb +0 -114
  71. data/lib/cachetastic/adapters/store_object.rb +0 -28
  72. data/lib/cachetastic/caches/base.rb +0 -238
  73. data/lib/cachetastic/caches/mack_session_cache.rb +0 -3
  74. data/lib/cachetastic/caches/page_cache.rb +0 -6
  75. data/lib/cachetastic/caches/rails_session_cache.rb +0 -12
  76. data/lib/cachetastic/connection.rb +0 -24
  77. data/lib/cachetastic/errors/unsupported_adapter.rb +0 -7
  78. data/lib/cachetastic/rails_extensions/active_record_base.rb +0 -24
  79. data/lib/cachetastic/rails_extensions/cgi_session_store.rb +0 -59
  80. data/lib/cachetastic/ruby_extensions/kernel.rb +0 -25
  81. data/lib/cachetastic/ruby_extensions/object.rb +0 -22
  82. data/lib/cachetastic/ruby_extensions/string.rb +0 -15
  83. data/test/active_record_test.rb +0 -89
  84. data/test/cacheable_test.rb +0 -88
  85. data/test/cachetastic_unit_test.rb +0 -74
  86. data/test/config.rb +0 -30
  87. data/test/drb_adapter_test.rb +0 -14
  88. data/test/file_adapter_test.rb +0 -49
  89. data/test/memcache_adapter_test.rb +0 -18
  90. data/test/test_helper.rb +0 -75
@@ -1,309 +0,0 @@
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::FileBase</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::FileBase</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../../files/lib/cachetastic/adapters/file_base_rb.html">
59
- lib/cachetastic/adapters/file_base.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
-
84
-
85
- </div>
86
-
87
- <div id="method-list">
88
- <h3 class="section-bar">Methods</h3>
89
-
90
- <div class="name-list">
91
- <a href="#M000032">delete</a>&nbsp;&nbsp;
92
- <a href="#M000033">expire_all</a>&nbsp;&nbsp;
93
- <a href="#M000029">setup</a>&nbsp;&nbsp;
94
- <a href="#M000031">stats</a>&nbsp;&nbsp;
95
- <a href="#M000034">store_file_name</a>&nbsp;&nbsp;
96
- <a href="#M000030">valid?</a>&nbsp;&nbsp;
97
- </div>
98
- </div>
99
-
100
- </div>
101
-
102
-
103
- <!-- if includes -->
104
-
105
- <div id="section">
106
-
107
-
108
-
109
-
110
-
111
- <div id="attribute-list">
112
- <h3 class="section-bar">Attributes</h3>
113
-
114
- <div class="name-list">
115
- <table>
116
- <tr class="top-aligned-row context-row">
117
- <td class="context-item-name">directory</td>
118
- <td class="context-item-value">&nbsp;[R]&nbsp;</td>
119
- <td class="context-item-desc"></td>
120
- </tr>
121
- <tr class="top-aligned-row context-row">
122
- <td class="context-item-name">hashed_keys</td>
123
- <td class="context-item-value">&nbsp;[R]&nbsp;</td>
124
- <td class="context-item-desc"></td>
125
- </tr>
126
- </table>
127
- </div>
128
- </div>
129
-
130
-
131
-
132
- <!-- if method_list -->
133
- <div id="methods">
134
- <h3 class="section-bar">Public Instance methods</h3>
135
-
136
- <div id="method-M000032" class="method-detail">
137
- <a name="M000032"></a>
138
-
139
- <div class="method-heading">
140
- <a href="#M000032" class="method-signature">
141
- <span class="method-name">delete</span><span class="method-args">(key, delay = 0)</span>
142
- </a>
143
- </div>
144
-
145
- <div class="method-description">
146
- <p><a class="source-toggle" href="#"
147
- onclick="toggleCode('M000032-source');return false;">[Source]</a></p>
148
- <div class="method-source-code" id="M000032-source">
149
- <pre>
150
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file_base.rb, line 33</span>
151
- 33: <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>)
152
- 34: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">delay</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-value">0</span>
153
- 35: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-identifier">get_key_directoy</span>(<span class="ruby-identifier">key</span>), <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">debug?</span>)
154
- 36: <span class="ruby-keyword kw">else</span>
155
- 37: <span class="ruby-identifier">so</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
156
- 38: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>
157
- 39: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">so</span>.<span class="ruby-identifier">key</span>, <span class="ruby-identifier">so</span>.<span class="ruby-identifier">value</span>, <span class="ruby-identifier">delay</span>)
158
- 40: <span class="ruby-keyword kw">end</span>
159
- 41: <span class="ruby-keyword kw">end</span>
160
- 42: <span class="ruby-keyword kw">end</span>
161
- </pre>
162
- </div>
163
- </div>
164
- </div>
165
-
166
- <div id="method-M000033" class="method-detail">
167
- <a name="M000033"></a>
168
-
169
- <div class="method-heading">
170
- <a href="#M000033" class="method-signature">
171
- <span class="method-name">expire_all</span><span class="method-args">()</span>
172
- </a>
173
- </div>
174
-
175
- <div class="method-description">
176
- <p><a class="source-toggle" href="#"
177
- onclick="toggleCode('M000033-source');return false;">[Source]</a></p>
178
- <div class="method-source-code" id="M000033-source">
179
- <pre>
180
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file_base.rb, line 44</span>
181
- 44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expire_all</span>
182
- 45: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">directory</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">debug?</span>)
183
- 46: <span class="ruby-identifier">setup</span>
184
- 47: <span class="ruby-keyword kw">end</span>
185
- </pre>
186
- </div>
187
- </div>
188
- </div>
189
-
190
- <div id="method-M000029" class="method-detail">
191
- <a name="M000029"></a>
192
-
193
- <div class="method-heading">
194
- <a href="#M000029" class="method-signature">
195
- <span class="method-name">setup</span><span class="method-args">()</span>
196
- </a>
197
- </div>
198
-
199
- <div class="method-description">
200
- <p><a class="source-toggle" href="#"
201
- onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
202
- <div class="method-source-code" id="M000029-source">
203
- <pre>
204
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file_base.rb, line 8</span>
205
- 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setup</span>
206
- 9: <span class="ruby-ivar">@directory</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">store_options</span>.<span class="ruby-identifier">dir</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>)
207
- 10: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">directory</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">debug?</span>)
208
- 11: <span class="ruby-ivar">@hashed_keys</span> = {}
209
- 12: <span class="ruby-keyword kw">end</span>
210
- </pre>
211
- </div>
212
- </div>
213
- </div>
214
-
215
- <div id="method-M000031" class="method-detail">
216
- <a name="M000031"></a>
217
-
218
- <div class="method-heading">
219
- <a href="#M000031" class="method-signature">
220
- <span class="method-name">stats</span><span class="method-args">()</span>
221
- </a>
222
- </div>
223
-
224
- <div class="method-description">
225
- <p><a class="source-toggle" href="#"
226
- onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
227
- <div class="method-source-code" id="M000031-source">
228
- <pre>
229
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file_base.rb, line 18</span>
230
- 18: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stats</span>
231
- 19: <span class="ruby-keyword kw">super</span>
232
- 20: <span class="ruby-identifier">num_files</span> = <span class="ruby-identifier">num_directories</span> = <span class="ruby-identifier">file_size</span> = <span class="ruby-value">0</span>
233
- 21: <span class="ruby-identifier">everything</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-node">&quot;#{self.directory}/**/*&quot;</span>)
234
- 22: <span class="ruby-identifier">everything</span>.<span class="ruby-identifier">reject</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\./</span>}.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
235
- 23: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">entry</span>)
236
- 24: <span class="ruby-identifier">num_directories</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
237
- 25: <span class="ruby-keyword kw">else</span>
238
- 26: <span class="ruby-identifier">file_size</span> <span class="ruby-operator">+=</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">entry</span>)
239
- 27: <span class="ruby-identifier">num_files</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
240
- 28: <span class="ruby-keyword kw">end</span>
241
- 29: <span class="ruby-keyword kw">end</span>
242
- 30: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Number of Files: #{num_files}\nNumber of Directories: #{num_directories}\nTotal Size on Disk: #{file_size/1024.to_f} KB\n\n&quot;</span>
243
- 31: <span class="ruby-keyword kw">end</span>
244
- </pre>
245
- </div>
246
- </div>
247
- </div>
248
-
249
- <div id="method-M000030" class="method-detail">
250
- <a name="M000030"></a>
251
-
252
- <div class="method-heading">
253
- <a href="#M000030" class="method-signature">
254
- <span class="method-name">valid?</span><span class="method-args">()</span>
255
- </a>
256
- </div>
257
-
258
- <div class="method-description">
259
- <p><a class="source-toggle" href="#"
260
- onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
261
- <div class="method-source-code" id="M000030-source">
262
- <pre>
263
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file_base.rb, line 14</span>
264
- 14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
265
- 15: <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">directory</span>)
266
- 16: <span class="ruby-keyword kw">end</span>
267
- </pre>
268
- </div>
269
- </div>
270
- </div>
271
-
272
- <h3 class="section-bar">Protected Instance methods</h3>
273
-
274
- <div id="method-M000034" class="method-detail">
275
- <a name="M000034"></a>
276
-
277
- <div class="method-heading">
278
- <a href="#M000034" class="method-signature">
279
- <span class="method-name">store_file_name</span><span class="method-args">()</span>
280
- </a>
281
- </div>
282
-
283
- <div class="method-description">
284
- <p><a class="source-toggle" href="#"
285
- onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
286
- <div class="method-source-code" id="M000034-source">
287
- <pre>
288
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/file_base.rb, line 50</span>
289
- 50: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store_file_name</span>
290
- 51: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;cachetastic.data&quot;</span>
291
- 52: <span class="ruby-keyword kw">end</span>
292
- </pre>
293
- </div>
294
- </div>
295
- </div>
296
-
297
-
298
- </div>
299
-
300
-
301
- </div>
302
-
303
-
304
- <div id="validator-badges">
305
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
306
- </div>
307
-
308
- </body>
309
- </html>
@@ -1,224 +0,0 @@
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::HtmlFile</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::HtmlFile</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../../files/lib/cachetastic/adapters/html_file_rb.html">
59
- lib/cachetastic/adapters/html_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
-
84
-
85
- </div>
86
-
87
- <div id="method-list">
88
- <h3 class="section-bar">Methods</h3>
89
-
90
- <div class="name-list">
91
- <a href="#M000007">get</a>&nbsp;&nbsp;
92
- <a href="#M000008">set</a>&nbsp;&nbsp;
93
- <a href="#M000009">store_file_name</a>&nbsp;&nbsp;
94
- </div>
95
- </div>
96
-
97
- </div>
98
-
99
-
100
- <!-- if includes -->
101
-
102
- <div id="section">
103
-
104
-
105
- <div id="constants-list">
106
- <h3 class="section-bar">Constants</h3>
107
-
108
- <div class="name-list">
109
- <table summary="Constants">
110
- <tr class="top-aligned-row context-row">
111
- <td class="context-item-name">STORE_FILE_NAME</td>
112
- <td>=</td>
113
- <td class="context-item-value">&quot;index.html&quot;</td>
114
- </tr>
115
- </table>
116
- </div>
117
- </div>
118
-
119
-
120
-
121
-
122
-
123
-
124
- <!-- if method_list -->
125
- <div id="methods">
126
- <h3 class="section-bar">Public Instance methods</h3>
127
-
128
- <div id="method-M000007" class="method-detail">
129
- <a name="M000007"></a>
130
-
131
- <div class="method-heading">
132
- <a href="#M000007" class="method-signature">
133
- <span class="method-name">get</span><span class="method-args">(key)</span>
134
- </a>
135
- </div>
136
-
137
- <div class="method-description">
138
- <p><a class="source-toggle" href="#"
139
- onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
140
- <div class="method-source-code" id="M000007-source">
141
- <pre>
142
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/html_file.rb, line 23</span>
143
- 23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
144
- 24: <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>))
145
- 25: <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>)
146
- 26: <span class="ruby-identifier">so</span> = <span class="ruby-identifier">html_to_store_object</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>)
147
- 27: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>
148
- 28: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">invalid?</span>
149
- 29: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
150
- 30: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
151
- 31: <span class="ruby-keyword kw">end</span>
152
- 32: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">so</span>.<span class="ruby-identifier">value</span>
153
- 33: <span class="ruby-keyword kw">end</span>
154
- 34: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
155
- 35: <span class="ruby-keyword kw">end</span>
156
- </pre>
157
- </div>
158
- </div>
159
- </div>
160
-
161
- <div id="method-M000008" class="method-detail">
162
- <a name="M000008"></a>
163
-
164
- <div class="method-heading">
165
- <a href="#M000008" class="method-signature">
166
- <span class="method-name">set</span><span class="method-args">(key, value, expiry = 0)</span>
167
- </a>
168
- </div>
169
-
170
- <div class="method-description">
171
- <p><a class="source-toggle" href="#"
172
- onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
173
- <div class="method-source-code" id="M000008-source">
174
- <pre>
175
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/html_file.rb, line 37</span>
176
- 37: <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>)
177
- 38: <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>)
178
- 39: <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>
179
- 40: <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">store_object_to_html</span>(<span class="ruby-identifier">so</span>)
180
- 41: <span class="ruby-keyword kw">end</span>
181
- 42: <span class="ruby-keyword kw">end</span>
182
- </pre>
183
- </div>
184
- </div>
185
- </div>
186
-
187
- <h3 class="section-bar">Protected Instance methods</h3>
188
-
189
- <div id="method-M000009" class="method-detail">
190
- <a name="M000009"></a>
191
-
192
- <div class="method-heading">
193
- <a href="#M000009" class="method-signature">
194
- <span class="method-name">store_file_name</span><span class="method-args">()</span>
195
- </a>
196
- </div>
197
-
198
- <div class="method-description">
199
- <p><a class="source-toggle" href="#"
200
- onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
201
- <div class="method-source-code" id="M000009-source">
202
- <pre>
203
- <span class="ruby-comment cmt"># File lib/cachetastic/adapters/html_file.rb, line 45</span>
204
- 45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store_file_name</span>
205
- 46: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">STORE_FILE_NAME</span>
206
- 47: <span class="ruby-keyword kw">end</span>
207
- </pre>
208
- </div>
209
- </div>
210
- </div>
211
-
212
-
213
- </div>
214
-
215
-
216
- </div>
217
-
218
-
219
- <div id="validator-badges">
220
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
221
- </div>
222
-
223
- </body>
224
- </html>