cachetastic 1.5.0 → 1.6.0
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/classes/ActiveRecord/Base.html +188 -0
- data/doc/classes/CGI/Session/CachetasticStore.html +124 -0
- data/doc/classes/Cachetastic/Adapters/Base.html +331 -0
- data/doc/classes/Cachetastic/Adapters/Drb.html +332 -0
- data/doc/classes/Cachetastic/Adapters/File.html +248 -0
- data/doc/classes/Cachetastic/Adapters/FileBase.html +309 -0
- data/doc/classes/Cachetastic/Adapters/HtmlFile.html +224 -0
- data/doc/classes/Cachetastic/Adapters/LocalMemory.html +346 -0
- data/doc/classes/Cachetastic/Adapters/Memcache.html +498 -0
- data/doc/classes/Cachetastic/Cacheable.html +264 -0
- data/doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html +287 -0
- data/doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html +200 -0
- data/doc/classes/Cachetastic/Caches/Base.html +672 -0
- data/doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html +179 -0
- data/doc/classes/Cachetastic/Caches/MackSessionCache.html +119 -0
- data/doc/classes/Cachetastic/Caches/PageCache.html +121 -0
- data/doc/classes/Cachetastic/Caches/RailsSessionCache.html +154 -0
- data/doc/classes/Cachetastic/Connection.html +212 -0
- data/doc/classes/Cachetastic/Errors/UnsupportedAdapter.html +146 -0
- data/doc/classes/Cachetastic/Logger.html +189 -0
- data/doc/classes/Object.html +152 -0
- data/doc/created.rid +1 -0
- data/doc/files/README.html +207 -0
- data/doc/files/lib/adapters/cachetastic_adapters_base_rb.html +139 -0
- data/doc/files/lib/adapters/cachetastic_adapters_drb_rb.html +115 -0
- data/doc/files/lib/adapters/cachetastic_adapters_file_base_rb.html +109 -0
- data/doc/files/lib/adapters/cachetastic_adapters_file_rb.html +121 -0
- data/doc/files/lib/adapters/cachetastic_adapters_html_file_rb.html +137 -0
- data/doc/files/lib/adapters/cachetastic_adapters_local_memory_rb.html +109 -0
- data/doc/files/lib/adapters/cachetastic_adapters_memcache_rb.html +127 -0
- data/doc/files/lib/adapters/cachetastic_adapters_store_object_rb.html +101 -0
- data/doc/files/lib/caches/cachetastic_caches_base_rb.html +108 -0
- data/doc/files/lib/caches/cachetastic_caches_mack_session_cache_rb.html +107 -0
- data/doc/files/lib/caches/cachetastic_caches_page_cache_rb.html +109 -0
- data/doc/files/lib/caches/cachetastic_caches_rails_session_cache_rb.html +107 -0
- data/doc/files/lib/cachetastic_cacheable_rb.html +101 -0
- data/doc/files/lib/cachetastic_connection_rb.html +107 -0
- data/doc/files/lib/cachetastic_logger_rb.html +107 -0
- data/doc/files/lib/cachetastic_rb.html +222 -0
- data/doc/files/lib/errors/cachetastic_errors_unsupported_adapter_rb.html +101 -0
- data/doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html +101 -0
- data/doc/files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html +109 -0
- data/doc/files/lib/ruby_extensions/object_rb.html +101 -0
- data/doc/fr_class_index.html +47 -0
- data/doc/fr_file_index.html +47 -0
- data/doc/fr_method_index.html +100 -0
- data/doc/index.html +24 -0
- data/doc/rdoc-style.css +208 -0
- data/lib/cachetastic.rb +21 -23
- data/lib/cachetastic_cacheable.rb +202 -0
- data/lib/rails_extensions/cachetastic_active_record_base.rb +12 -39
- data/lib/ruby_extensions/object.rb +8 -0
- data/test/active_record_test.rb +8 -8
- data/test/cacheable_test.rb +72 -0
- metadata +52 -2
- data/lib/helpers/cachetastic_helpers_active_record.rb +0 -46
|
@@ -0,0 +1,309 @@
|
|
|
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/adapters/cachetastic_adapters_file_base_rb.html">
|
|
59
|
+
lib/adapters/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="#M000030">delete</a>
|
|
92
|
+
<a href="#M000031">expire_all</a>
|
|
93
|
+
<a href="#M000027">setup</a>
|
|
94
|
+
<a href="#M000029">stats</a>
|
|
95
|
+
<a href="#M000032">store_file_name</a>
|
|
96
|
+
<a href="#M000028">valid?</a>
|
|
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"> [R] </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"> [R] </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-M000030" class="method-detail">
|
|
137
|
+
<a name="M000030"></a>
|
|
138
|
+
|
|
139
|
+
<div class="method-heading">
|
|
140
|
+
<a href="#M000030" 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('M000030-source');return false;">[Source]</a></p>
|
|
148
|
+
<div class="method-source-code" id="M000030-source">
|
|
149
|
+
<pre>
|
|
150
|
+
<span class="ruby-comment cmt"># File lib/adapters/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"><=</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">></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-M000031" class="method-detail">
|
|
167
|
+
<a name="M000031"></a>
|
|
168
|
+
|
|
169
|
+
<div class="method-heading">
|
|
170
|
+
<a href="#M000031" 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('M000031-source');return false;">[Source]</a></p>
|
|
178
|
+
<div class="method-source-code" id="M000031-source">
|
|
179
|
+
<pre>
|
|
180
|
+
<span class="ruby-comment cmt"># File lib/adapters/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">></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-M000027" class="method-detail">
|
|
191
|
+
<a name="M000027"></a>
|
|
192
|
+
|
|
193
|
+
<div class="method-heading">
|
|
194
|
+
<a href="#M000027" 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('M000027-source');return false;">[Source]</a></p>
|
|
202
|
+
<div class="method-source-code" id="M000027-source">
|
|
203
|
+
<pre>
|
|
204
|
+
<span class="ruby-comment cmt"># File lib/adapters/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">store_options</span>[<span class="ruby-value str">"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">></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-M000029" class="method-detail">
|
|
216
|
+
<a name="M000029"></a>
|
|
217
|
+
|
|
218
|
+
<div class="method-heading">
|
|
219
|
+
<a href="#M000029" 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('M000029-source');return false;">[Source]</a></p>
|
|
227
|
+
<div class="method-source-code" id="M000029-source">
|
|
228
|
+
<pre>
|
|
229
|
+
<span class="ruby-comment cmt"># File lib/adapters/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">"#{self.directory}/**/*"</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">"Number of Files: #{num_files}\nNumber of Directories: #{num_directories}\nTotal Size on Disk: #{file_size/1024.to_f} KB\n\n"</span>
|
|
243
|
+
31: <span class="ruby-keyword kw">end</span>
|
|
244
|
+
</pre>
|
|
245
|
+
</div>
|
|
246
|
+
</div>
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
<div id="method-M000028" class="method-detail">
|
|
250
|
+
<a name="M000028"></a>
|
|
251
|
+
|
|
252
|
+
<div class="method-heading">
|
|
253
|
+
<a href="#M000028" 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('M000028-source');return false;">[Source]</a></p>
|
|
261
|
+
<div class="method-source-code" id="M000028-source">
|
|
262
|
+
<pre>
|
|
263
|
+
<span class="ruby-comment cmt"># File lib/adapters/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-M000032" class="method-detail">
|
|
275
|
+
<a name="M000032"></a>
|
|
276
|
+
|
|
277
|
+
<div class="method-heading">
|
|
278
|
+
<a href="#M000032" 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('M000032-source');return false;">[Source]</a></p>
|
|
286
|
+
<div class="method-source-code" id="M000032-source">
|
|
287
|
+
<pre>
|
|
288
|
+
<span class="ruby-comment cmt"># File lib/adapters/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">"cachetastic.data"</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>
|
|
@@ -0,0 +1,224 @@
|
|
|
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/adapters/cachetastic_adapters_html_file_rb.html">
|
|
59
|
+
lib/adapters/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="#M000005">get</a>
|
|
92
|
+
<a href="#M000006">set</a>
|
|
93
|
+
<a href="#M000007">store_file_name</a>
|
|
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">"index.html"</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-M000005" class="method-detail">
|
|
129
|
+
<a name="M000005"></a>
|
|
130
|
+
|
|
131
|
+
<div class="method-heading">
|
|
132
|
+
<a href="#M000005" 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('M000005-source');return false;">[Source]</a></p>
|
|
140
|
+
<div class="method-source-code" id="M000005-source">
|
|
141
|
+
<pre>
|
|
142
|
+
<span class="ruby-comment cmt"># File lib/adapters/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-M000006" class="method-detail">
|
|
162
|
+
<a name="M000006"></a>
|
|
163
|
+
|
|
164
|
+
<div class="method-heading">
|
|
165
|
+
<a href="#M000006" 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('M000006-source');return false;">[Source]</a></p>
|
|
173
|
+
<div class="method-source-code" id="M000006-source">
|
|
174
|
+
<pre>
|
|
175
|
+
<span class="ruby-comment cmt"># File lib/adapters/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">"w"</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-M000007" class="method-detail">
|
|
190
|
+
<a name="M000007"></a>
|
|
191
|
+
|
|
192
|
+
<div class="method-heading">
|
|
193
|
+
<a href="#M000007" 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('M000007-source');return false;">[Source]</a></p>
|
|
201
|
+
<div class="method-source-code" id="M000007-source">
|
|
202
|
+
<pre>
|
|
203
|
+
<span class="ruby-comment cmt"># File lib/adapters/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>
|