cw 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 989e1bb7fa13915779b903aaefd8167e0afda345
-  data.tar.gz: 8e473d0a5adfec8808ba0d2fd4255dc4cbc22df1
+  metadata.gz: f96c63ebcba919ae57d460aae5e40a871af17ad1
+  data.tar.gz: 4df1a6780ff5ae0b2e1f0966171735156061f409
 SHA512:
-  metadata.gz: fa0bbd224e8b08c6b67241df869fc41b3b8f857c8b9baf4d337007d56acfaacd31f73f7def2434f8f1b56acb922989aaebba7461814cb3fed3b97472ceea8407
-  data.tar.gz: b2c18e86a87c71948a0d9aa0e416f7c935cbe0c0113374afe871c20034c1b5c4549f182ef8c9bd283f44679a2f98090bc4ca4c22cb3f5cf5b6b0db6e04a0b137
+  metadata.gz: 8d601393c438cb66221a8e427dbb0f723daea1a24db7084435f494903925b444efaaeeb972341f051b501fdb50a3c4ee2b30c55b3eca1269e8444a3cc9e94e77
+  data.tar.gz: 4ac510de739832dd440d8cbb94dd6937660bd5ed63a2bce83622d0c12bddf814b44973b395d7e75fbb902ac308657e28f68153b3da106a0b9f25e32ba8f402ef

data/.gitignore

@@ -1,5 +1,28 @@
-/Gemfile.lock
-/test.rb
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
 /.ruby_version/
+
 audio/audio_output.wav
-working_example.rb

data/.yardoc/checksums

@@ -1,7 +1,7 @@
-lib/cw.rb 30117a5cd8ca9e2d5281f8c08cb0a2de37491d0d
+lib/cw.rb 028740926efd506dda72274477fed69cc51a001a
 lib/cw/cl.rb 5b8288fd93e577aa1251c13174a64066fcb23503
 lib/cw/str.rb bb5d3558c51cc754de6eab7a83a0dbff37285694
-lib/cw/rss.rb 2623f80cbf9b5a9e1ecb706915d7584815c80871
+lib/cw/rss.rb 8c0e55d7d47aeaf6955483834cd79bbc47155cde
 lib/cw/book.rb da54e4f3df96fc45e9076464a8c9aa3a5e5a607c
 lib/cw/speak.rb fed0aaf5384d8dc0ebc4fd1c8cf07b227a168e86
 lib/cw/print.rb dda478b67c0517ac0ac885fb8029a3848803ab00

data/cw.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = 'cw'
-  spec.version     = '0.0.11'
+  spec.version     = '0.0.12'
   spec.date        = '2016-05-21'
   spec.authors     = ["Martyn Jago"]
   spec.email       = ["martyn.jago@btinternet.com"]

data/doc/Alphabet.html

@@ -424,7 +424,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:17 2016 by
+  Generated on Wed May 25 15:00:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>

data/doc/AudioPlayer.html

@@ -796,7 +796,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:17 2016 by
+  Generated on Wed May 25 15:00:26 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>

data/doc/Book.html

@@ -3125,7 +3125,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:16 2016 by
+  Generated on Wed May 25 15:00:24 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>

data/doc/BookDetails.html

@@ -655,7 +655,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:17 2016 by
+  Generated on Wed May 25 15:00:26 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>

data/doc/CW.html

@@ -238,7 +238,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Play book using provided arguments.</p>
+</div></span>
   
 </li>
 
@@ -246,7 +248,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#read_rss-instance_method" title="#read_rss (instance method)">- (Object) <strong>read_rss</strong>(source, show_count = 3) </a>
+      <a href="#read_rss-instance_method" title="#read_rss (instance method)">- (Object) <strong>read_rss</strong>(source, article_count = 3) </a>
     
 
     
@@ -260,7 +262,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads RSS feed (requires an internet connection).</p>
+</div></span>
   
 </li>
 
@@ -282,7 +286,10 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Repeat word repeats the current word if the word is entered incorrectly (or
+not entered at all).</p>
+</div></span>
   
 </li>
 
@@ -304,29 +311,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#run_word_test-instance_method" title="#run_word_test (instance method)">- (Object) <strong>run_word_test</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Run word test.</p>
+</div></span>
   
 </li>
 
@@ -348,7 +335,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Test user against letters rather than words.</p>
+</div></span>
   
 </li>
 
@@ -370,7 +359,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Test user against complete words rather than letters.</p>
+</div></span>
   
 </li>
 
@@ -378,7 +369,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (String) <strong>to_s</strong> </a>
     
 
     
@@ -392,7 +383,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Return string containing name or comment of test.</p>
+</div></span>
   
 </li>
 
@@ -440,17 +433,17 @@
       <pre class="lines">
 
 
-50
-51
-52
-53
-54
-55
-56
-57</pre>
+67
+68
+69
+70
+71
+72
+73
+74</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 67</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
 
@@ -572,22 +565,103 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Play book using provided arguments.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>args</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the options to play book with.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    <p class="tag_title">Options Hash (<tt>args</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:sentences</span>
+          <span class="type">(<tt>Integer</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Number of sentences to play</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:duration</span>
+          <span class="type">(<tt>Integer</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Number of minutes to play</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:letter</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Mark by letter if true else mark by word</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-72
-73
-74
-75
-76
-77
-78</pre>
+89
+90
+91
+92
+93
+94
+95</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 72</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 89</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_play_book'>play_book</span> <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
   <span class='ivar'>@inhibit_block_run</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -604,44 +678,100 @@
       <div class="method_details ">
   <h3 class="signature " id="read_rss-instance_method">
   
-    - (<tt>Object</tt>) <strong>read_rss</strong>(source, show_count = 3) 
+    - (<tt>Object</tt>) <strong>read_rss</strong>(source, article_count = 3) 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Reads RSS feed (requires an internet connection). Feed can be one of:</p>
+<ul><li>
+<p>bbc:</p>
+</li><li>
+<p>reuters:</p>
+</li><li>
+<p>guardian:</p>
+</li><li>
+<p>quotation:</p>
+</li></ul>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>source</span>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The source of the feed.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>article_count</span>
+      
+      
+        <span class='type'>(<tt>Integer</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>3</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Number of articles to play.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-80
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91</pre>
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 80</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 105</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_read_rss'>read_rss</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_show_count'>show_count</span> <span class='op'>=</span> <span class='int'>3</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_read_rss'>read_rss</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_article_count'>article_count</span> <span class='op'>=</span> <span class='int'>3</span><span class='rparen'>)</span>
   <span class='ivar'>@inhibit_block_run</span> <span class='op'>=</span> <span class='kw'>true</span>
   <span class='id identifier rubyid_rss'>rss</span><span class='comma'>,</span> <span class='op'>=</span> <span class='const'>Rss</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='id identifier rubyid_rss'>rss</span><span class='period'>.</span><span class='id identifier rubyid_read_rss'>read_rss</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_show_count'>show_count</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_rss'>rss</span><span class='period'>.</span><span class='id identifier rubyid_read_rss'>read_rss</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_article_count'>article_count</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
     <span class='id identifier rubyid_article'>article</span> <span class='op'>=</span> <span class='id identifier rubyid_rss'>rss</span><span class='period'>.</span><span class='id identifier rubyid_next_article'>next_article</span>
     <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_article'>article</span>
-    <span class='id identifier rubyid_test_words'>test_words</span> <span class='op'>=</span> <span class='const'>TestWords</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
     <span class='ivar'>@words</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span> <span class='id identifier rubyid_article'>article</span>
-    <span class='id identifier rubyid_test_words'>test_words</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='ivar'>@words</span>
+    <span class='id identifier rubyid_run'>run</span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -658,20 +788,32 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Repeat word repeats the current word if the word is entered incorrectly (or
+not entered at all).</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-44
-45
-46
-47
-48</pre>
+58
+59
+60
+61
+62</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 58</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_repeat_word'>repeat_word</span>
   <span class='ivar'>@inhibit_block_run</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -692,50 +834,29 @@
   
 
   
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Run word test</p>
 
-93</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 93</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span> <span class='semicolon'>;</span> <span class='id identifier rubyid_test_words'>test_words</span> <span class='semicolon'>;</span> <span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
+  </div>
 </div>
-    
-      <div class="method_details ">
-  <h3 class="signature " id="run_word_test-instance_method">
-  
-    - (<tt>Object</tt>) <strong>run_word_test</strong> 
-  
-
+<div class="tags">
   
 
-  
-</h3><table class="source_code">
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-63
-64
-65
-66</pre>
+118</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 63</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 118</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_run_word_test'>run_word_test</span>
-  <span class='id identifier rubyid_test_words'>test_words</span> <span class='op'>=</span> <span class='const'>TestWords</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='id identifier rubyid_test_words'>test_words</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='ivar'>@words</span>
-<span class='kw'>end</span></pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span> <span class='semicolon'>;</span> <span class='id identifier rubyid_test_words'>test_words</span> <span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -750,20 +871,31 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Test user against letters rather than words.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-38
-39
-40
 41
-42</pre>
+42
+43
+44
+45</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 41</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_test_letters'>test_letters</span>
   <span class='ivar'>@inhibit_block_run</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -784,21 +916,34 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Test user against complete words rather than letters.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-68
-69
-70</pre>
+50
+51
+52
+53</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 68</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 50</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_test_words'>test_words</span>
-  <span class='id identifier rubyid_run_word_test'>run_word_test</span>
+  <span class='id identifier rubyid_tw'>tw</span> <span class='op'>=</span> <span class='const'>TestWords</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_tw'>tw</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='ivar'>@words</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -808,24 +953,53 @@
       <div class="method_details ">
   <h3 class="signature " id="to_s-instance_method">
   
-    - (<tt>Object</tt>) <strong>to_s</strong> 
+    - (<tt>String</tt>) <strong>to_s</strong> 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Return string containing name or comment of test.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>comment / name</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-59
-60
-61</pre>
+79
+80
+81</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 59</span>
+      <pre class="code"><span class="info file"># File 'lib/cw.rb', line 79</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
   <span class='ivar'>@str</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
@@ -840,7 +1014,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:16 2016 by
+  Generated on Wed May 25 15:00:24 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>