cw 0.0.8 → 0.0.9

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 (55) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +33 -0
  3. data/.yardoc/object_types +0 -0
  4. data/.yardoc/objects/root.dat +0 -0
  5. data/.yardoc/proxy_types +0 -0
  6. data/cw.gemspec +1 -1
  7. data/doc/Alphabet.html +433 -0
  8. data/doc/AudioPlayer.html +805 -0
  9. data/doc/Book.html +3134 -0
  10. data/doc/BookDetails.html +664 -0
  11. data/doc/CW.html +849 -0
  12. data/doc/CWThreads.html +514 -0
  13. data/doc/Cl.html +1125 -0
  14. data/doc/CurrentWord.html +636 -0
  15. data/doc/CwDsl.html +1871 -0
  16. data/doc/CwEncoding.html +329 -0
  17. data/doc/FileDetails.html +236 -0
  18. data/doc/KeyInput.html +758 -0
  19. data/doc/MonitorKeys.html +482 -0
  20. data/doc/Numbers.html +433 -0
  21. data/doc/Params.html +352 -0
  22. data/doc/Print.html +1130 -0
  23. data/doc/Print/ProgressPrint.html +419 -0
  24. data/doc/Process.html +202 -0
  25. data/doc/Progress.html +337 -0
  26. data/doc/Randomize.html +959 -0
  27. data/doc/RepeatWord.html +816 -0
  28. data/doc/Rss.html +630 -0
  29. data/doc/Sentence.html +1457 -0
  30. data/doc/Spoken.html +215 -0
  31. data/doc/Str.html +771 -0
  32. data/doc/Stream.html +1401 -0
  33. data/doc/TestLetters.html +586 -0
  34. data/doc/TestWords.html +646 -0
  35. data/doc/Tester.html +3064 -0
  36. data/doc/Timing.html +1244 -0
  37. data/doc/ToneGenerator.html +2111 -0
  38. data/doc/Voice.html +273 -0
  39. data/doc/Words.html +1750 -0
  40. data/doc/_index.html +376 -0
  41. data/doc/class_list.html +58 -0
  42. data/doc/css/common.css +1 -0
  43. data/doc/css/full_list.css +57 -0
  44. data/doc/css/style.css +339 -0
  45. data/doc/file.README.html +148 -0
  46. data/doc/file_list.html +60 -0
  47. data/doc/frames.html +26 -0
  48. data/doc/index.html +148 -0
  49. data/doc/js/app.js +219 -0
  50. data/doc/js/full_list.js +181 -0
  51. data/doc/js/jquery.js +4 -0
  52. data/doc/method_list.html +2697 -0
  53. data/doc/monitor.html +435 -0
  54. data/doc/top-level-namespace.html +114 -0
  55. metadata +53 -1
data/doc/BookDetails.html ADDED
@@ -0,0 +1,664 @@
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: BookDetails
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!BookDetails.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (B)</a> &raquo;
35
+
36
+
37
+ <span class="title">BookDetails</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: BookDetails
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">BookDetails</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/cw/book_details.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+
103
+ <h2>Constant Summary</h2>
104
+
105
+ <dl class="constants">
106
+
107
+ <dt id="HERE-constant" class="">HERE =
108
+
109
+ </dt>
110
+ <dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span></pre></dd>
111
+
112
+ <dt id="BOOK_DIRECTORY-constant" class="">BOOK_DIRECTORY =
113
+
114
+ </dt>
115
+ <dd><pre class="code"><span class='const'>HERE</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>../../data/text/</span><span class='tstring_end'>&#39;</span></span></pre></dd>
116
+
117
+ <dt id="BOOK_NAME-constant" class="">BOOK_NAME =
118
+
119
+ </dt>
120
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>adv_of_sh_holmes.txt</span><span class='tstring_end'>&#39;</span></span></pre></dd>
121
+
122
+ </dl>
123
+
124
+
125
+
126
+
127
+
128
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
129
+ <ul class="summary">
130
+
131
+ <li class="public ">
132
+ <span class="summary_signature">
133
+
134
+ <a href="#args-instance_method" title="#args (instance method)">- (Object) <strong>args</strong> </a>
135
+
136
+
137
+
138
+ </span>
139
+
140
+
141
+
142
+
143
+ <span class="note title readonly">readonly</span>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <span class="summary_desc"><div class='inline'>
154
+ <p>Returns the value of attribute args.</p>
155
+ </div></span>
156
+
157
+ </li>
158
+
159
+
160
+ </ul>
161
+
162
+
163
+
164
+
165
+
166
+ <h2>
167
+ Instance Method Summary
168
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
169
+ </h2>
170
+
171
+ <ul class="summary">
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#arguments-instance_method" title="#arguments (instance method)">- (Object) <strong>arguments</strong>(args) </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <span class="summary_desc"><div class='inline'></div></span>
191
+
192
+ </li>
193
+
194
+
195
+ <li class="public ">
196
+ <span class="summary_signature">
197
+
198
+ <a href="#book_location-instance_method" title="#book_location (instance method)">- (Object) <strong>book_location</strong> </a>
199
+
200
+
201
+
202
+ </span>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'></div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#book_timeout%3F-instance_method" title="#book_timeout? (instance method)">- (Boolean) <strong>book_timeout?</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <span class="summary_desc"><div class='inline'></div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (BookDetails) <strong>initialize</strong> </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+ <span class="note title constructor">constructor</span>
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>A new instance of BookDetails.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ <li class="public ">
266
+ <span class="summary_signature">
267
+
268
+ <a href="#sentences_complete%3F-instance_method" title="#sentences_complete? (instance method)">- (Boolean) <strong>sentences_complete?</strong>(source) </a>
269
+
270
+
271
+
272
+ </span>
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <span class="summary_desc"><div class='inline'></div></span>
283
+
284
+ </li>
285
+
286
+
287
+ <li class="public ">
288
+ <span class="summary_signature">
289
+
290
+ <a href="#session_finished%3F-instance_method" title="#session_finished? (instance method)">- (Boolean) <strong>session_finished?</strong>(source) </a>
291
+
292
+
293
+
294
+ </span>
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <span class="summary_desc"><div class='inline'></div></span>
305
+
306
+ </li>
307
+
308
+
309
+ </ul>
310
+
311
+
312
+ <div id="constructor_details" class="method_details_list">
313
+ <h2>Constructor Details</h2>
314
+
315
+ <div class="method_details first">
316
+ <h3 class="signature first" id="initialize-instance_method">
317
+
318
+ - (<tt><span class='object_link'><a href="" title="BookDetails (class)">BookDetails</a></span></tt>) <strong>initialize</strong>
319
+
320
+
321
+
322
+
323
+
324
+ </h3><div class="docstring">
325
+ <div class="discussion">
326
+
327
+ <p>Returns a new instance of BookDetails</p>
328
+
329
+
330
+ </div>
331
+ </div>
332
+ <div class="tags">
333
+
334
+
335
+ </div><table class="source_code">
336
+ <tr>
337
+ <td>
338
+ <pre class="lines">
339
+
340
+
341
+ 11
342
+ 12
343
+ 13
344
+ 14</pre>
345
+ </td>
346
+ <td>
347
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 11</span>
348
+
349
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
350
+ <span class='ivar'>@book_name</span> <span class='op'>=</span> <span class='const'>BOOK_NAME</span>
351
+ <span class='ivar'>@book_directory</span> <span class='op'>=</span> <span class='const'>BOOK_DIRECTORY</span>
352
+ <span class='kw'>end</span></pre>
353
+ </td>
354
+ </tr>
355
+ </table>
356
+ </div>
357
+
358
+ </div>
359
+
360
+ <div id="instance_attr_details" class="attr_details">
361
+ <h2>Instance Attribute Details</h2>
362
+
363
+
364
+ <span id=""></span>
365
+ <div class="method_details first">
366
+ <h3 class="signature first" id="args-instance_method">
367
+
368
+ - (<tt>Object</tt>) <strong>args</strong> <span class="extras">(readonly)</span>
369
+
370
+
371
+
372
+
373
+
374
+ </h3><div class="docstring">
375
+ <div class="discussion">
376
+
377
+ <p>Returns the value of attribute args</p>
378
+
379
+
380
+ </div>
381
+ </div>
382
+ <div class="tags">
383
+
384
+
385
+ </div><table class="source_code">
386
+ <tr>
387
+ <td>
388
+ <pre class="lines">
389
+
390
+
391
+ 5
392
+ 6
393
+ 7</pre>
394
+ </td>
395
+ <td>
396
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 5</span>
397
+
398
+ <span class='kw'>def</span> <span class='id identifier rubyid_args'>args</span>
399
+ <span class='ivar'>@args</span>
400
+ <span class='kw'>end</span></pre>
401
+ </td>
402
+ </tr>
403
+ </table>
404
+ </div>
405
+
406
+ </div>
407
+
408
+
409
+ <div id="instance_method_details" class="method_details_list">
410
+ <h2>Instance Method Details</h2>
411
+
412
+
413
+ <div class="method_details first">
414
+ <h3 class="signature first" id="arguments-instance_method">
415
+
416
+ - (<tt>Object</tt>) <strong>arguments</strong>(args)
417
+
418
+
419
+
420
+
421
+
422
+ </h3><table class="source_code">
423
+ <tr>
424
+ <td>
425
+ <pre class="lines">
426
+
427
+
428
+ 20
429
+ 21
430
+ 22
431
+ 23
432
+ 24
433
+ 25
434
+ 26</pre>
435
+ </td>
436
+ <td>
437
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 20</span>
438
+
439
+ <span class='kw'>def</span> <span class='id identifier rubyid_arguments'>arguments</span> <span class='id identifier rubyid_args'>args</span>
440
+ <span class='ivar'>@args</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span>
441
+ <span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:output</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:letter</span> <span class='kw'>unless</span> <span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:output</span><span class='rbracket'>]</span>
442
+ <span class='kw'>if</span> <span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:duration</span><span class='rbracket'>]</span>
443
+ <span class='ivar'>@timeout</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span> <span class='op'>+</span> <span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:duration</span><span class='rbracket'>]</span> <span class='op'>*</span> <span class='float'>60.0</span>
444
+ <span class='kw'>end</span>
445
+ <span class='kw'>end</span></pre>
446
+ </td>
447
+ </tr>
448
+ </table>
449
+ </div>
450
+
451
+ <div class="method_details ">
452
+ <h3 class="signature " id="book_location-instance_method">
453
+
454
+ - (<tt>Object</tt>) <strong>book_location</strong>
455
+
456
+
457
+
458
+
459
+
460
+ </h3><table class="source_code">
461
+ <tr>
462
+ <td>
463
+ <pre class="lines">
464
+
465
+
466
+ 16
467
+ 17
468
+ 18</pre>
469
+ </td>
470
+ <td>
471
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 16</span>
472
+
473
+ <span class='kw'>def</span> <span class='id identifier rubyid_book_location'>book_location</span>
474
+ <span class='ivar'>@book_directory</span> <span class='op'>+</span> <span class='ivar'>@book_name</span>
475
+ <span class='kw'>end</span></pre>
476
+ </td>
477
+ </tr>
478
+ </table>
479
+ </div>
480
+
481
+ <div class="method_details ">
482
+ <h3 class="signature " id="book_timeout?-instance_method">
483
+
484
+ - (<tt>Boolean</tt>) <strong>book_timeout?</strong>
485
+
486
+
487
+
488
+
489
+
490
+ </h3><div class="docstring">
491
+ <div class="discussion">
492
+
493
+
494
+ </div>
495
+ </div>
496
+ <div class="tags">
497
+
498
+ <p class="tag_title">Returns:</p>
499
+ <ul class="return">
500
+
501
+ <li>
502
+
503
+
504
+ <span class='type'>(<tt>Boolean</tt>)</span>
505
+
506
+
507
+
508
+ </li>
509
+
510
+ </ul>
511
+
512
+ </div><table class="source_code">
513
+ <tr>
514
+ <td>
515
+ <pre class="lines">
516
+
517
+
518
+ 44
519
+ 45
520
+ 46</pre>
521
+ </td>
522
+ <td>
523
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 44</span>
524
+
525
+ <span class='kw'>def</span> <span class='id identifier rubyid_book_timeout?'>book_timeout?</span>
526
+ <span class='ivar'>@timeout</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span> <span class='op'>&gt;</span> <span class='ivar'>@timeout</span><span class='rparen'>)</span>
527
+ <span class='kw'>end</span></pre>
528
+ </td>
529
+ </tr>
530
+ </table>
531
+ </div>
532
+
533
+ <div class="method_details ">
534
+ <h3 class="signature " id="sentences_complete?-instance_method">
535
+
536
+ - (<tt>Boolean</tt>) <strong>sentences_complete?</strong>(source)
537
+
538
+
539
+
540
+
541
+
542
+ </h3><div class="docstring">
543
+ <div class="discussion">
544
+
545
+
546
+ </div>
547
+ </div>
548
+ <div class="tags">
549
+
550
+ <p class="tag_title">Returns:</p>
551
+ <ul class="return">
552
+
553
+ <li>
554
+
555
+
556
+ <span class='type'>(<tt>Boolean</tt>)</span>
557
+
558
+
559
+
560
+ </li>
561
+
562
+ </ul>
563
+
564
+ </div><table class="source_code">
565
+ <tr>
566
+ <td>
567
+ <pre class="lines">
568
+
569
+
570
+ 32
571
+ 33
572
+ 34
573
+ 35
574
+ 36
575
+ 37
576
+ 38
577
+ 39
578
+ 40
579
+ 41
580
+ 42</pre>
581
+ </td>
582
+ <td>
583
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 32</span>
584
+
585
+ <span class='kw'>def</span> <span class='id identifier rubyid_sentences_complete?'>sentences_complete?</span> <span class='id identifier rubyid_source'>source</span>
586
+ <span class='kw'>if</span> <span class='ivar'>@args</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:sentences</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:sentences</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span>
587
+ <span class='kw'>if</span> <span class='ivar'>@sentence_count_source</span>
588
+ <span class='ivar'>@sentence_count_source</span> <span class='op'>=</span> <span class='kw'>nil</span>
589
+ <span class='kw'>else</span>
590
+ <span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:sentences</span><span class='rbracket'>]</span> <span class='op'>-=</span> <span class='int'>1</span>
591
+ <span class='ivar'>@sentence_count_source</span> <span class='op'>=</span> <span class='kw'>true</span>
592
+ <span class='kw'>end</span>
593
+ <span class='kw'>true</span> <span class='kw'>if</span><span class='lparen'>(</span><span class='ivar'>@args</span><span class='lbracket'>[</span><span class='symbol'>:sentences</span><span class='rbracket'>]</span> <span class='op'>&lt;</span> <span class='int'>0</span><span class='rparen'>)</span>
594
+ <span class='kw'>end</span>
595
+ <span class='kw'>end</span></pre>
596
+ </td>
597
+ </tr>
598
+ </table>
599
+ </div>
600
+
601
+ <div class="method_details ">
602
+ <h3 class="signature " id="session_finished?-instance_method">
603
+
604
+ - (<tt>Boolean</tt>) <strong>session_finished?</strong>(source)
605
+
606
+
607
+
608
+
609
+
610
+ </h3><div class="docstring">
611
+ <div class="discussion">
612
+
613
+
614
+ </div>
615
+ </div>
616
+ <div class="tags">
617
+
618
+ <p class="tag_title">Returns:</p>
619
+ <ul class="return">
620
+
621
+ <li>
622
+
623
+
624
+ <span class='type'>(<tt>Boolean</tt>)</span>
625
+
626
+
627
+
628
+ </li>
629
+
630
+ </ul>
631
+
632
+ </div><table class="source_code">
633
+ <tr>
634
+ <td>
635
+ <pre class="lines">
636
+
637
+
638
+ 28
639
+ 29
640
+ 30</pre>
641
+ </td>
642
+ <td>
643
+ <pre class="code"><span class="info file"># File 'lib/cw/book_details.rb', line 28</span>
644
+
645
+ <span class='kw'>def</span> <span class='id identifier rubyid_session_finished?'>session_finished?</span> <span class='id identifier rubyid_source'>source</span>
646
+ <span class='id identifier rubyid_sentences_complete?'>sentences_complete?</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_book_timeout?'>book_timeout?</span>
647
+ <span class='kw'>end</span></pre>
648
+ </td>
649
+ </tr>
650
+ </table>
651
+ </div>
652
+
653
+ </div>
654
+
655
+ </div>
656
+
657
+ <div id="footer">
658
+ Generated on Mon May 23 21:20:17 2016 by
659
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
660
+ 0.8.7.6 (ruby-2.2.0).
661
+ </div>
662
+
663
+ </body>
664
+ </html>