ionian 0.6.12 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1530db96be4407d57fc89cc8046d9f92b97f54e
-  data.tar.gz: b180870567aa3ed43f417748e22a1082154b3fd9
+  metadata.gz: 4164186ec6ea1d5a2253e87a7a7d29a0eb42ad88
+  data.tar.gz: f31dfb488830387206a4991ac4261efecdae2ac9
 SHA512:
-  metadata.gz: ee0d50045eca52b78c7ad2ddd7caacd31256555f6686517b25fff52c39a4dcc8f57232634820e201408a84b2efa6a518baac0605efc97b5075e75feff2eb3662
-  data.tar.gz: 2e715c46f0edd97eae342951a54106d4e0574e37af0fa94b5325e7bc674555fe0e1ebef79574718f8f5270d939c0dd5e7db3e7182a6ca1006d62fa4bcfc17e78
+  metadata.gz: 6cb8ded96fe343dad4535a811783c0797d7951f793efbd0d3519f3cd894def3dae8062dc6dd82021a2c6292cf194608562be3812c628ec96f2de0297c6f85266
+  data.tar.gz: 3e039f674576317a2a814f7d4c39ec03fbeb054b60066b8210385d44e139d4dae97f74e39285dde8413dfb691eaab13048d27994aec1765906503671df766c5f

data/README.md

@@ -16,6 +16,19 @@ A Ruby library to simplify interaction with IO streams. This includes network so
 	gem install ionian
 
 
+## Issues, Bugs, Feature Requests
+
+Any bugs and feature requests should be reported on the GitHub issue tracker:
+
+https://github.com/amclain/ionian/issues
+
+
+**Pull requests are preferred via GitHub.**
+
+Mercurial users can use [Hg-Git](http://hg-git.github.io/) to interact with
+GitHub repositories.
+
+
 ## Code Examples
 
 ### Creating A Socket

data/doc/Ionian.html

@@ -80,7 +80,7 @@
   
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/ionian.rb<span class="defines">,<br />
-  lib/ionian/socket.rb,<br /> lib/ionian/server.rb,<br /> lib/ionian/extension/io.rb,<br /> lib/ionian/extension/socket.rb</span>
+  lib/ionian/server.rb,<br /> lib/ionian/socket.rb,<br /> lib/ionian/extension/io.rb,<br /> lib/ionian/managed_socket.rb,<br /> lib/ionian/extension/socket.rb</span>
 </dd>
   
 </dl>
@@ -107,7 +107,7 @@ Features regular expression matching and notification of received data.</p>
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Ionian/Server.html" title="Ionian::Server (class)">Server</a></span>, <span class='object_link'><a href="Ionian/Socket.html" title="Ionian::Socket (class)">Socket</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Ionian/ManagedSocket.html" title="Ionian::ManagedSocket (class)">ManagedSocket</a></span>, <span class='object_link'><a href="Ionian/Server.html" title="Ionian::Server (class)">Server</a></span>, <span class='object_link'><a href="Ionian/Socket.html" title="Ionian::Socket (class)">Socket</a></span>
     
   
 </p>
@@ -123,7 +123,7 @@ Features regular expression matching and notification of received data.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 21:45:48 2015 by
+  Generated on Wed Jan 28 16:07:19 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/Ionian/Extension.html

@@ -119,7 +119,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 21:45:48 2015 by
+  Generated on Wed Jan 28 16:07:19 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/Ionian/Extension/IO.html

@@ -182,7 +182,7 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#expression-instance_method" title="#expression (instance method)">- (Object) <strong>expression</strong> </a>
+      <a href="#expression-instance_method" title="#expression (instance method)">- (Regexp) <strong>expression</strong> </a>
     
 
     
@@ -197,7 +197,7 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
+<p>Regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
 </div></span>
   
 </li>
@@ -444,6 +444,28 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
 <p>Start a thread that checks for data and notifies match and error handlers.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#run_match_is_running%3F-instance_method" title="#run_match_is_running? (instance method)">- (Boolean) <strong>run_match_is_running?</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
 </li>
 
       
@@ -627,7 +649,7 @@ standard library IO::select.</p>
       <div class="method_details first">
   <h3 class="signature first" id="expression-instance_method">
   
-    - (<tt>Object</tt>) <strong>expression</strong> 
+    - (<tt>Regexp</tt>) <strong>expression</strong> 
   
 
   
@@ -636,13 +658,31 @@ standard library IO::select.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
+<p>Returns Regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Regexp</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -873,14 +913,14 @@ automatically.</p>
       <pre class="lines">
 
 
-173
-174
-175
-176
-177</pre>
+189
+190
+191
+192
+193</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 173</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 189</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_purge'>purge</span>
   <span class='comment'># Erase IO buffer.
@@ -1115,8 +1155,7 @@ of this method.</p>
       
         &mdash;
         <div class='inline'>
-<p>Returns an array of matches. Returns nil if no data was received within the
-timeout period.</p>
+<p>matches. Nil if no data was received within the timeout period.</p>
 </div>
       
     </li>
@@ -1173,7 +1212,14 @@ timeout period.</p>
 148
 149
 150
-151</pre>
+151
+152
+153
+154
+155
+156
+157
+158</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 107</span>
@@ -1188,16 +1234,23 @@ timeout period.</p>
   <span class='id identifier rubyid_exp'>exp</span>           <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>(.*?)</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_exp'>exp</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_exp'>exp</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
   
   <span class='kw'>unless</span> <span class='id identifier rubyid_skip_select'>skip_select</span>
-    <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='op'>::</span><span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span>
+    <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_has_data?'>has_data?</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span>
   <span class='kw'>end</span>
   
-  <span class='comment'># Read data from the IO buffer until it&#39;s empty.
-</span>  <span class='ivar'>@ionian_buf</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_read_all'>read_all</span>
-  
   <span class='ivar'>@matches</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
   
+  <span class='comment'># TODO: Implement an option for number of bytes or timeout to throw away
+</span>  <span class='comment'>#       data if no match is found.
+</span>  <span class='const'>Timeout</span><span class='period'>.</span><span class='id identifier rubyid_timeout'>timeout</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
+      <span class='comment'># Read data from the IO buffer until it&#39;s empty.
+</span>      <span class='ivar'>@ionian_buf</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_read_all'>read_all</span>
+      <span class='kw'>break</span> <span class='kw'>if</span> <span class='ivar'>@ionian_buf</span> <span class='op'>=~</span> <span class='id identifier rubyid_exp'>exp</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  
   <span class='kw'>while</span> <span class='ivar'>@ionian_buf</span> <span class='op'>=~</span> <span class='id identifier rubyid_exp'>exp</span>
-    <span class='ivar'>@matches</span> <span class='op'>&lt;&lt;</span> <span class='gvar'>$~</span> <span class='comment'># Match data.
+    <span class='ivar'>@matches</span> <span class='op'>&lt;&lt;</span> <span class='gvar'>$~</span>   <span class='comment'># Match data.
 </span>    <span class='ivar'>@ionian_buf</span> <span class='op'>=</span> <span class='backref'>$&#39;</span> <span class='comment'># Leave post match data in the buffer.
 </span>  <span class='kw'>end</span>
   
@@ -1290,13 +1343,13 @@ callbacks can be registered with &amp;object.method(:method).</p>
       <pre class="lines">
 
 
-216
-217
-218
-219</pre>
+234
+235
+236
+237</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 216</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 234</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register_error_handler'>register_error_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_error_handlers</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span> <span class='kw'>unless</span> <span class='ivar'>@ionian_error_handlers</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_block'>block</span>
@@ -1385,13 +1438,13 @@ Method callbacks can be registered with &amp;object.method(:method).</p>
       <pre class="lines">
 
 
-189
-190
-191
-192</pre>
+205
+206
+207
+208</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 189</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 205</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register_match_handler'>register_match_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_match_handlers</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span> <span class='kw'>unless</span> <span class='ivar'>@ionian_match_handlers</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_block'>block</span>
@@ -1429,14 +1482,16 @@ Method callbacks can be registered with &amp;object.method(:method).</p>
       <pre class="lines">
 
 
-197
-198
-199</pre>
+213
+214
+215
+216</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 197</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 213</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register_observer'>register_observer</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
+  <span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARN: Call to deprecated method </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='id identifier rubyid_register_match_handler'>register_match_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -1472,26 +1527,28 @@ Passes kwargs to <span class='object_link'><a href="#read_match-instance_method"
       <pre class="lines">
 
 
-156
-157
-158
-159
-160
-161
-162
 163
 164
 165
 166
 167
 168
-169</pre>
+169
+170
+171
+172
+173
+174
+175
+176
+177</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 156</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 163</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_run_match'>run_match</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span>
   <span class='ivar'>@run_match_thread</span> <span class='op'>||=</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+    <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_thread_variable_set'>thread_variable_set</span> <span class='symbol'>:match_thread_running</span><span class='comma'>,</span> <span class='kw'>true</span>
     <span class='kw'>begin</span>
       <span class='kw'>while</span> <span class='kw'>not</span> <span class='id identifier rubyid_closed?'>closed?</span> <span class='kw'>do</span>
         <span class='id identifier rubyid_matches'>matches</span> <span class='op'>=</span> <span class='id identifier rubyid_read_match'>read_match</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span>
@@ -1507,6 +1564,66 @@ Passes kwargs to <span class='object_link'><a href="#read_match-instance_method"
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="run_match_is_running?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>run_match_is_running?</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+179
+180
+181
+182
+183
+184
+185</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 179</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_run_match_is_running?'>run_match_is_running?</span>
+  <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> \
+    <span class='ivar'>@run_match_thread</span> <span class='kw'>and</span>
+    <span class='ivar'>@run_match_thread</span><span class='period'>.</span><span class='id identifier rubyid_thread_variable_get'>thread_variable_get</span><span class='lparen'>(</span><span class='symbol'>:match_thread_running</span><span class='rparen'>)</span>
+  
+  <span class='kw'>false</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1535,13 +1652,13 @@ Passes kwargs to <span class='object_link'><a href="#read_match-instance_method"
       <pre class="lines">
 
 
-224
-225
-226
-227</pre>
+242
+243
+244
+245</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 224</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 242</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unregister_error_handler'>unregister_error_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_error_handlers</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>==</span> <span class='id identifier rubyid_block'>block</span> <span class='rbrace'>}</span>
@@ -1578,13 +1695,13 @@ Passes kwargs to <span class='object_link'><a href="#read_match-instance_method"
       <pre class="lines">
 
 
-202
-203
-204
-205</pre>
+219
+220
+221
+222</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 202</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 219</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unregister_match_handler'>unregister_match_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_match_handlers</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>==</span> <span class='id identifier rubyid_block'>block</span> <span class='rbrace'>}</span>
@@ -1622,14 +1739,16 @@ Passes kwargs to <span class='object_link'><a href="#read_match-instance_method"
       <pre class="lines">
 
 
-208
-209
-210</pre>
+225
+226
+227
+228</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 208</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 225</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unregister_observer'>unregister_observer</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
+  <span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARN: Call to deprecated method </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='id identifier rubyid_unregister_match_handler'>unregister_match_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -1642,7 +1761,7 @@ Passes kwargs to <span class='object_link'><a href="#read_match-instance_method"
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 21:45:48 2015 by
+  Generated on Wed Jan 28 16:07:20 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>