cabalist 0.0.2 → 0.0.3

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.
@@ -0,0 +1,404 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Cabalist::Configuration
8
+
9
+ &mdash; Documentation by YARD 0.7.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (C)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Cabalist.html" title="Cabalist (module)">Cabalist</a></span></span>
38
+ &raquo;
39
+ <span class="title">Configuration</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Cabalist::Configuration
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Cabalist::Configuration</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+ <dt class="r2">Includes:</dt>
87
+ <dd class="r2">Singleton</dd>
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r1 last">Defined in:</dt>
94
+ <dd class="r1 last">lib/cabalist/configuration.rb</dd>
95
+
96
+ </dl>
97
+ <div class="clear"></div>
98
+
99
+ <h2>Overview</h2><div class="docstring">
100
+ <div class="discussion">
101
+ <p>
102
+ Cabalist settings.
103
+ </p>
104
+ <p>
105
+ This class is a singleton storing some configuration data of the Cabalist
106
+ library as used by the application.
107
+ </p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+ </div>
115
+
116
+
117
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#db_path-instance_method" title="#db_path (instance method)">- (String) <strong>db_path</strong> </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+ <span class="summary_desc"><div class='inline'><p>
140
+ Path to the local LevelDB instance.
141
+ </p>
142
+ </div></span>
143
+
144
+ </li>
145
+
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#frontend_classes-instance_method" title="#frontend_classes (instance method)">- (Array) <strong>frontend_classes</strong> </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'><p>
167
+ Cabalist-enabled classes that should be exposed via web GUI.
168
+ </p>
169
+ </div></span>
170
+
171
+ </li>
172
+
173
+
174
+ </ul>
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <h2>
182
+ Instance Method Summary
183
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
184
+ </h2>
185
+
186
+ <ul class="summary">
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#database-instance_method" title="#database (instance method)">- (LevelDB::DB) <strong>database</strong> </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+ <span class="summary_desc"><div class='inline'><p>
205
+ Get the local instance of LevelDB used for caching.
206
+ </p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ </ul>
213
+
214
+
215
+
216
+
217
+ <div id="instance_attr_details" class="attr_details">
218
+ <h2>Instance Attribute Details</h2>
219
+
220
+
221
+ <span id="db_path=-instance_method"></span>
222
+ <span id="db_path-instance_method"></span>
223
+ <div class="method_details first">
224
+ <p class="signature first" id="db_path-instance_method">
225
+
226
+ - (<tt>String</tt>) <strong>db_path</strong>
227
+
228
+
229
+
230
+ </p><div class="docstring">
231
+ <div class="discussion">
232
+ <p>
233
+ Path to the local LevelDB instance
234
+ </p>
235
+
236
+
237
+ </div>
238
+ </div>
239
+ <div class="tags">
240
+ <h3>Returns:</h3>
241
+ <ul class="return">
242
+
243
+ <li>
244
+
245
+
246
+ <span class='type'>(<tt>String</tt>)</span>
247
+
248
+
249
+
250
+ </li>
251
+
252
+ </ul>
253
+
254
+ </div><table class="source_code">
255
+ <tr>
256
+ <td>
257
+ <pre class="lines">
258
+
259
+
260
+ 16
261
+ 17
262
+ 18</pre>
263
+ </td>
264
+ <td>
265
+ <pre class="code"><span class="info file"># File 'lib/cabalist/configuration.rb', line 16</span>
266
+
267
+ <span class='kw'>def</span> <span class='id db_path'>db_path</span>
268
+ <span class='ivar'>@db_path</span>
269
+ <span class='kw'>end</span></pre>
270
+ </td>
271
+ </tr>
272
+ </table>
273
+ </div>
274
+
275
+
276
+ <span id="frontend_classes=-instance_method"></span>
277
+ <span id="frontend_classes-instance_method"></span>
278
+ <div class="method_details ">
279
+ <p class="signature " id="frontend_classes-instance_method">
280
+
281
+ - (<tt>Array</tt>) <strong>frontend_classes</strong>
282
+
283
+
284
+
285
+ </p><div class="docstring">
286
+ <div class="discussion">
287
+ <p>
288
+ Cabalist-enabled classes that should be exposed via web GUI
289
+ </p>
290
+
291
+
292
+ </div>
293
+ </div>
294
+ <div class="tags">
295
+ <h3>Returns:</h3>
296
+ <ul class="return">
297
+
298
+ <li>
299
+
300
+
301
+ <span class='type'>(<tt>Array</tt>)</span>
302
+
303
+
304
+
305
+ </li>
306
+
307
+ </ul>
308
+
309
+ </div><table class="source_code">
310
+ <tr>
311
+ <td>
312
+ <pre class="lines">
313
+
314
+
315
+ 20
316
+ 21
317
+ 22</pre>
318
+ </td>
319
+ <td>
320
+ <pre class="code"><span class="info file"># File 'lib/cabalist/configuration.rb', line 20</span>
321
+
322
+ <span class='kw'>def</span> <span class='id frontend_classes'>frontend_classes</span>
323
+ <span class='ivar'>@frontend_classes</span>
324
+ <span class='kw'>end</span></pre>
325
+ </td>
326
+ </tr>
327
+ </table>
328
+ </div>
329
+
330
+ </div>
331
+
332
+
333
+ <div id="instance_method_details" class="method_details_list">
334
+ <h2>Instance Method Details</h2>
335
+
336
+
337
+ <div class="method_details first">
338
+ <p class="signature first" id="database-instance_method">
339
+
340
+ - (<tt>LevelDB::DB</tt>) <strong>database</strong>
341
+
342
+
343
+
344
+ </p><div class="docstring">
345
+ <div class="discussion">
346
+ <p>
347
+ Get the local instance of LevelDB used for caching.
348
+ </p>
349
+
350
+
351
+ </div>
352
+ </div>
353
+ <div class="tags">
354
+ <h3>Returns:</h3>
355
+ <ul class="return">
356
+
357
+ <li>
358
+
359
+
360
+ <span class='type'>(<tt>LevelDB::DB</tt>)</span>
361
+
362
+
363
+
364
+ &mdash;
365
+ <div class='inline'><p>
366
+ instance of LevelDB used by the application
367
+ </p>
368
+ </div>
369
+
370
+ </li>
371
+
372
+ </ul>
373
+
374
+ </div><table class="source_code">
375
+ <tr>
376
+ <td>
377
+ <pre class="lines">
378
+
379
+
380
+ 25
381
+ 26</pre>
382
+ </td>
383
+ <td>
384
+ <pre class="code"><span class="info file"># File 'lib/cabalist/configuration.rb', line 25</span>
385
+
386
+ <span class='kw'>def</span> <span class='id database'>database</span>
387
+ <span class='kw'>end</span></pre>
388
+ </td>
389
+ </tr>
390
+ </table>
391
+ </div>
392
+
393
+ </div>
394
+
395
+ </div>
396
+
397
+ <div id="footer">
398
+ Generated on Wed Apr 25 18:24:45 2012 by
399
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
400
+ 0.7.2 (ruby-1.9.2).
401
+ </div>
402
+
403
+ </body>
404
+ </html>
@@ -0,0 +1,152 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Cabalist::Frontend
8
+
9
+ &mdash; Documentation by YARD 0.7.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (F)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Cabalist.html" title="Cabalist (module)">Cabalist</a></span></span>
38
+ &raquo;
39
+ <span class="title">Frontend</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Cabalist::Frontend
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Sinatra::Base</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Sinatra::Base</li>
75
+
76
+ <li class="next">Cabalist::Frontend</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/cabalist/frontend.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+ <h2>Overview</h2><div class="docstring">
98
+ <div class="discussion">
99
+ <p>
100
+ Provides a web frontend to models where Cabalist functionality has been
101
+ enabled.
102
+ </p>
103
+
104
+
105
+ </div>
106
+ </div>
107
+ <div class="tags">
108
+
109
+ </div>
110
+ <h2>Constant Summary</h2>
111
+
112
+ <dl class="constants">
113
+
114
+ <dt id="PER_PAGE-constant" class="">PER_PAGE =
115
+ <div class="docstring">
116
+ <div class="discussion">
117
+ <p>
118
+ Specifies how many records of a given class should be visible on a web GUI
119
+ page.
120
+ </p>
121
+
122
+
123
+ </div>
124
+ </div>
125
+ <div class="tags">
126
+
127
+ </div>
128
+ </dt>
129
+ <dd><pre class="code"><span class='int'>25</span></pre></dd>
130
+
131
+ </dl>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+ </div>
144
+
145
+ <div id="footer">
146
+ Generated on Wed Apr 25 18:24:45 2012 by
147
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
148
+ 0.7.2 (ruby-1.9.2).
149
+ </div>
150
+
151
+ </body>
152
+ </html>