marky_markov 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. data/README.md +0 -1
  2. data/doc/MarkyMarkov.html +120 -0
  3. data/doc/MarkyMarkov/Dictionary.html +415 -0
  4. data/doc/MarkyMarkov/TemporaryDictionary.html +588 -0
  5. data/doc/_index.html +136 -0
  6. data/doc/class_list.html +47 -0
  7. data/doc/css/common.css +1 -0
  8. data/doc/css/full_list.css +55 -0
  9. data/doc/css/style.css +322 -0
  10. data/doc/file.README.html +162 -0
  11. data/doc/file_list.html +49 -0
  12. data/doc/frames.html +13 -0
  13. data/doc/index.html +162 -0
  14. data/doc/js/app.js +205 -0
  15. data/doc/js/full_list.js +173 -0
  16. data/doc/js/jquery.js +16 -0
  17. data/doc/method_list.html +110 -0
  18. data/doc/top-level-namespace.html +105 -0
  19. data/lib/marky_markov.rb +8 -1
  20. data/lib/marky_markov/one_word_dictionary.rb +3 -0
  21. data/lib/marky_markov/one_word_sentence_generator.rb +1 -0
  22. data/lib/marky_markov/persistent_dictionary.rb +1 -0
  23. data/lib/marky_markov/two_word_dictionary.rb +1 -0
  24. data/lib/marky_markov/two_word_sentence_generator.rb +1 -0
  25. data/spec/textdictcompare.mmd +1 -0
  26. metadata +21 -3
data/README.md CHANGED
@@ -7,7 +7,6 @@ in Ruby. It can be used both from the command-line and as a library within your
7
7
  # Installation
8
8
 
9
9
  gem install marky_markov
10
-
11
10
 
12
11
  # Module Usage
13
12
 
data/doc/MarkyMarkov.html ADDED
@@ -0,0 +1,120 @@
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
+ Module: MarkyMarkov
8
+
9
+ &mdash; Documentation by YARD 0.7.5
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 (M)</a> &raquo;
37
+
38
+
39
+ <span class="title">MarkyMarkov</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>Module: MarkyMarkov
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dt class="r1 last">Defined in:</dt>
75
+ <dd class="r1 last">lib/marky_markov.rb</dd>
76
+
77
+ </dl>
78
+ <div class="clear"></div>
79
+
80
+ <h2>Defined Under Namespace</h2>
81
+ <p class="children">
82
+
83
+
84
+
85
+
86
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="MarkyMarkov/Dictionary.html" title="MarkyMarkov::Dictionary (class)">Dictionary</a></span>, <span class='object_link'><a href="MarkyMarkov/TemporaryDictionary.html" title="MarkyMarkov::TemporaryDictionary (class)">TemporaryDictionary</a></span>
87
+
88
+
89
+ </p>
90
+
91
+ <h2>Constant Summary</h2>
92
+
93
+ <dl class="constants">
94
+
95
+ <dt id="VERSION-constant" class="">VERSION =
96
+
97
+ </dt>
98
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>'</span></span></pre></dd>
99
+
100
+ </dl>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+ </div>
112
+
113
+ <div id="footer">
114
+ Generated on Mon Feb 6 22:18:54 2012 by
115
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
116
+ 0.7.5 (ruby-1.9.3).
117
+ </div>
118
+
119
+ </body>
120
+ </html>
data/doc/MarkyMarkov/Dictionary.html ADDED
@@ -0,0 +1,415 @@
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: MarkyMarkov::Dictionary
8
+
9
+ &mdash; Documentation by YARD 0.7.5
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 (D)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../MarkyMarkov.html" title="MarkyMarkov (module)">MarkyMarkov</a></span></span>
38
+ &raquo;
39
+ <span class="title">Dictionary</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: MarkyMarkov::Dictionary
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"><span class='object_link'><a href="TemporaryDictionary.html" title="MarkyMarkov::TemporaryDictionary (class)">TemporaryDictionary</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next"><span class='object_link'><a href="TemporaryDictionary.html" title="MarkyMarkov::TemporaryDictionary (class)">TemporaryDictionary</a></span></li>
75
+
76
+ <li class="next">MarkyMarkov::Dictionary</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/marky_markov.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ <h2>
106
+ Class Method Summary
107
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
108
+ </h2>
109
+
110
+ <ul class="summary">
111
+
112
+ <li class="public ">
113
+ <span class="summary_signature">
114
+
115
+ <a href="#delete_dictionary%21-class_method" title="delete_dictionary! (class method)">+ (Object) <strong>delete_dictionary!</strong>(location) </a>
116
+
117
+
118
+
119
+ </span>
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <span class="summary_desc"><div class='inline'>
129
+ <p>Class Method: Takes a dictionary location/name and deletes it from the
130
+ file-system.</p>
131
+ </div></span>
132
+
133
+ </li>
134
+
135
+
136
+ </ul>
137
+
138
+ <h2>
139
+ Instance Method Summary
140
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
141
+ </h2>
142
+
143
+ <ul class="summary">
144
+
145
+ <li class="public ">
146
+ <span class="summary_signature">
147
+
148
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Dictionary) <strong>initialize</strong>(location) </a>
149
+
150
+
151
+
152
+ </span>
153
+
154
+ <span class="note title constructor">constructor</span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'>
164
+ <p>Open (or create if it doesn't exist) a Persistent Markov Chain Dictionary
165
+ and sentence generator for use.</p>
166
+ </div></span>
167
+
168
+ </li>
169
+
170
+
171
+ <li class="public ">
172
+ <span class="summary_signature">
173
+
174
+ <a href="#save_dictionary%21-instance_method" title="#save_dictionary! (instance method)">- (Object) <strong>save_dictionary!</strong> </a>
175
+
176
+
177
+
178
+ </span>
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Save the Persistent Dictionary file into JSON format for later use.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="TemporaryDictionary.html" title="MarkyMarkov::TemporaryDictionary (class)">TemporaryDictionary</a></span></h3>
206
+ <p class="inherited"><span class='object_link'><a href="TemporaryDictionary.html#clear%21-instance_method" title="MarkyMarkov::TemporaryDictionary#clear! (method)">#clear!</a></span>, <span class='object_link'><a href="TemporaryDictionary.html#generate_n_words-instance_method" title="MarkyMarkov::TemporaryDictionary#generate_n_words (method)">#generate_n_words</a></span>, <span class='object_link'><a href="TemporaryDictionary.html#parse_file-instance_method" title="MarkyMarkov::TemporaryDictionary#parse_file (method)">#parse_file</a></span>, <span class='object_link'><a href="TemporaryDictionary.html#parse_string-instance_method" title="MarkyMarkov::TemporaryDictionary#parse_string (method)">#parse_string</a></span></p>
207
+ <div id="constructor_details" class="method_details_list">
208
+ <h2>Constructor Details</h2>
209
+
210
+ <div class="method_details first">
211
+ <p class="signature first" id="initialize-instance_method">
212
+
213
+ - (<tt><span class='object_link'><a href="" title="MarkyMarkov::Dictionary (class)">Dictionary</a></span></tt>) <strong>initialize</strong>(location)
214
+
215
+
216
+
217
+ </p><div class="docstring">
218
+ <div class="discussion">
219
+
220
+ <p>Open (or create if it doesn't exist) a Persistent Markov Chain Dictionary
221
+ and sentence generator for use.</p>
222
+
223
+
224
+ </div>
225
+ </div>
226
+ <div class="tags">
227
+
228
+ <div class="examples">
229
+ <h3>Examples:</h3>
230
+
231
+ <h4><div class='inline'>
232
+ <p>Create a new Persistent Dictionary object.</p>
233
+ </div></h4>
234
+ <pre class="example code"><span class='id identifier rubyid_markov'>markov</span> <span class='op'>=</span> <span class='const'>MarkyMarkov</span><span class='op'>::</span><span class='const'>Dictionary</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HOME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>/markov_dictionary</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
235
+
236
+ </div>
237
+
238
+
239
+ </div><table class="source_code">
240
+ <tr>
241
+ <td>
242
+ <pre class="lines">
243
+
244
+
245
+ 66
246
+ 67
247
+ 68
248
+ 69</pre>
249
+ </td>
250
+ <td>
251
+ <pre class="code"><span class="info file"># File 'lib/marky_markov.rb', line 66</span>
252
+
253
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
254
+ <span class='ivar'>@dictionary</span> <span class='op'>=</span> <span class='const'>PersistentDictionary</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
255
+ <span class='ivar'>@sentence</span> <span class='op'>=</span> <span class='const'>TwoWordSentenceGenerator</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@dictionary</span><span class='rparen'>)</span>
256
+ <span class='kw'>end</span></pre>
257
+ </td>
258
+ </tr>
259
+ </table>
260
+ </div>
261
+
262
+ </div>
263
+
264
+
265
+ <div id="class_method_details" class="method_details_list">
266
+ <h2>Class Method Details</h2>
267
+
268
+
269
+ <div class="method_details first">
270
+ <p class="signature first" id="delete_dictionary!-class_method">
271
+
272
+ + (<tt>Object</tt>) <strong>delete_dictionary!</strong>(location)
273
+
274
+
275
+
276
+ </p><div class="docstring">
277
+ <div class="discussion">
278
+
279
+ <div class="note notetag">
280
+ <strong>Note:</strong>
281
+ <div class='inline'>
282
+ <p>To ensure that someone doesn't pass in something that shouldn't be deleted
283
+ by accident, the filetype .mmd is added to the end of the supplied
284
+ arguement, so do not include the extension when calling the method.</p>
285
+ </div>
286
+ </div>
287
+
288
+
289
+ <p>Class Method: Takes a dictionary location/name and deletes it from the
290
+ file-system.</p>
291
+
292
+
293
+ </div>
294
+ </div>
295
+ <div class="tags">
296
+
297
+ <div class="examples">
298
+ <h3>Examples:</h3>
299
+
300
+ <h4><div class='inline'>
301
+ <p>Delete the dictionary located at '~/markov_dictionary.mmd'</p>
302
+ </div></h4>
303
+ <pre class="example code"><span class='const'>MarkyMarkov</span><span class='op'>::</span><span class='const'>Dictionary</span><span class='period'>.</span><span class='id identifier rubyid_delete_dictionary!'>delete_dictionary!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HOME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>/markov_dictionary</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
304
+
305
+ </div>
306
+ <h3>Parameters:</h3>
307
+ <ul class="param">
308
+
309
+ <li>
310
+
311
+ <span class='name'>location</span>
312
+
313
+
314
+ <span class='type'>(<tt>String</tt>)</span>
315
+
316
+
317
+
318
+ &mdash;
319
+ <div class='inline'>
320
+ <p>location/name of the dictionary file to be deleted.</p>
321
+ </div>
322
+
323
+ </li>
324
+
325
+ </ul>
326
+
327
+
328
+ </div><table class="source_code">
329
+ <tr>
330
+ <td>
331
+ <pre class="lines">
332
+
333
+
334
+ 88
335
+ 89
336
+ 90</pre>
337
+ </td>
338
+ <td>
339
+ <pre class="code"><span class="info file"># File 'lib/marky_markov.rb', line 88</span>
340
+
341
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_dictionary!'>delete_dictionary!</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
342
+ <span class='const'>PersistentDictionary</span><span class='period'>.</span><span class='id identifier rubyid_delete_dictionary!'>delete_dictionary!</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
343
+ <span class='kw'>end</span></pre>
344
+ </td>
345
+ </tr>
346
+ </table>
347
+ </div>
348
+
349
+ </div>
350
+
351
+ <div id="instance_method_details" class="method_details_list">
352
+ <h2>Instance Method Details</h2>
353
+
354
+
355
+ <div class="method_details first">
356
+ <p class="signature first" id="save_dictionary!-instance_method">
357
+
358
+ - (<tt>Object</tt>) <strong>save_dictionary!</strong>
359
+
360
+
361
+
362
+ </p><div class="docstring">
363
+ <div class="discussion">
364
+
365
+ <p>Save the Persistent Dictionary file into JSON format for later use.</p>
366
+
367
+
368
+ </div>
369
+ </div>
370
+ <div class="tags">
371
+
372
+ <div class="examples">
373
+ <h3>Examples:</h3>
374
+
375
+ <h4><div class='inline'>
376
+ <p>Save the dictionary to disk.</p>
377
+ </div></h4>
378
+ <pre class="example code"><span class='id identifier rubyid_markov'>markov</span><span class='period'>.</span><span class='id identifier rubyid_save_dictionary!'>save_dictionary!</span></pre>
379
+
380
+ </div>
381
+
382
+
383
+ </div><table class="source_code">
384
+ <tr>
385
+ <td>
386
+ <pre class="lines">
387
+
388
+
389
+ 75
390
+ 76
391
+ 77</pre>
392
+ </td>
393
+ <td>
394
+ <pre class="code"><span class="info file"># File 'lib/marky_markov.rb', line 75</span>
395
+
396
+ <span class='kw'>def</span> <span class='id identifier rubyid_save_dictionary!'>save_dictionary!</span>
397
+ <span class='ivar'>@dictionary</span><span class='period'>.</span><span class='id identifier rubyid_save_dictionary!'>save_dictionary!</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+ </div>
405
+
406
+ </div>
407
+
408
+ <div id="footer">
409
+ Generated on Mon Feb 6 22:18:54 2012 by
410
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
411
+ 0.7.5 (ruby-1.9.3).
412
+ </div>
413
+
414
+ </body>
415
+ </html>