ionian 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b86e85b6f1eac510ccf6b43d701e0d1ff6fc8c90
-  data.tar.gz: 322d2d6bd87e89d79a357017bb561192b101d38d
+  metadata.gz: 56bba77a98b933d714a09236d6d1caf7a19826e5
+  data.tar.gz: b480aa6ceb1ff16602dcdf214cc9ca42c67f0509
 SHA512:
-  metadata.gz: a2b555e4a9d5ad52f3a8ad7720c570d0f2710e246bff41ab5a7fe49465a3b3bc00b508a3c2ee2b017cd8049cec1ef13f182c668a631eef5cbd0dd0d022f08831
-  data.tar.gz: 1e556b489c9513e82b364774756bdff1247cedb6266a82eaa3f3c3611460fc6c76fca675a5f5f6aa5e11d55a768e2234bd624f2c6f0ad252c2ce791c404d1579
+  metadata.gz: 1ecbcd365657210fcbafbb95834320556905f2065a730baa2c0655c5a7e90f08ce0dc5c3538b94aaafb2940c92c3ba74f72ac8c2b1192fa1268b52d3cd8ce4bd
+  data.tar.gz: bbc718243843149e4fe45b49389ebc99c9209c5b48c0c8509b634b28a0354121104027523a263fb4e57704be2d8f1196e02c5a37c707289e1d6e7206d9aaad25

data/doc/Ionian/IO.html

@@ -69,9 +69,13 @@
     
     <li ><a href="#method-c-extended">::extended</a>
     
+    <li ><a href="#method-i-expression">#expression</a>
+    
+    <li ><a href="#method-i-expression-3D">#expression=</a>
+    
     <li ><a href="#method-i-initialize_ionian">#initialize_ionian</a>
     
-    <li ><a href="#method-i-match">#match</a>
+    <li ><a href="#method-i-on_match">#on_match</a>
     
     <li ><a href="#method-i-purge">#purge</a>
     
@@ -97,7 +101,7 @@
   <section class="description">
     
 <p>A mixin for <a href="IO.html">IO</a> objects that allows regular expression
-matching and convenient notification of data in the buffer.</p>
+matching and convenient notification of received data.</p>
 
 <p>This module was designed to be EXTENDED by instantiated objects that
 implement the standard library <a href="IO.html">IO</a> class.
@@ -187,10 +191,10 @@ timing out. See standard library IO::select.</p>
        </header>
 
     
-      <div id="method-i-initialize_ionian" class="method-detail ">
+      <div id="method-i-expression" class="method-detail ">
         
         <div class="method-heading">
-          <span class="method-name">initialize_ionian</span><span
+          <span class="method-name">expression</span><span
             class="method-args">()</span>
           
           <span class="method-click-advice">click to toggle source</span>
@@ -200,19 +204,16 @@ timing out. See standard library IO::select.</p>
 
         <div class="method-description">
           
-          <p>Initialize the <a href="../Ionian.html">Ionian</a> instance variables. This
-is called automatically if extend is called on an object.</p>
+          <p>Returns the regular expression used for <a
+href="IO.html#method-i-read_match">read_match</a>.</p>
           
           
 
           
-          <div class="method-source-code" id="initialize_ionian-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 20</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_ionian</span>
-  <span class="ruby-ivar">@ionian_listeners</span>  = []
-  <span class="ruby-ivar">@ionian_buf</span>        = <span class="ruby-string">&#39;&#39;</span>
-  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-regexp">/(.*?)\n/</span>
-  <span class="ruby-ivar">@ionian_timeout</span>    = <span class="ruby-value">1</span>
+          <div class="method-source-code" id="expression-source">
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 30</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">expression</span>
+  <span class="ruby-ivar">@ionian_expression</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
           
@@ -224,11 +225,11 @@ is called automatically if extend is called on an object.</p>
       </div>
 
     
-      <div id="method-i-match" class="method-detail ">
+      <div id="method-i-expression-3D" class="method-detail ">
         
         <div class="method-heading">
-          <span class="method-name">match</span><span
-            class="method-args">(expression)</span>
+          <span class="method-name">expression=</span><span
+            class="method-args">(exp)</span>
           
           <span class="method-click-advice">click to toggle source</span>
           
@@ -246,11 +247,11 @@ href=":parameter">match</a>.</p>
           
 
           
-          <div class="method-source-code" id="match-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 33</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">match</span>(<span class="ruby-identifier">expression</span>)
-  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-identifier">expression</span>
-  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span> <span class="ruby-node">&quot;(.*?)#{expression}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">expression</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
+          <div class="method-source-code" id="expression-3D-source">
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 40</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">expression=</span>(<span class="ruby-identifier">exp</span>)
+  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-identifier">exp</span>
+  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span> <span class="ruby-node">&quot;(.*?)#{expression}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exp</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
           
@@ -262,6 +263,73 @@ href=":parameter">match</a>.</p>
       </div>
 
     
+      <div id="method-i-initialize_ionian" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">initialize_ionian</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Initialize the <a href="../Ionian.html">Ionian</a> instance variables. This
+is called automatically if extend is called on an object.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="initialize_ionian-source">
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 20</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_ionian</span>
+  <span class="ruby-ivar">@ionian_listeners</span>     = []
+  <span class="ruby-ivar">@ionian_buf</span>           = <span class="ruby-string">&#39;&#39;</span>
+  <span class="ruby-ivar">@ionian_expression</span>    = <span class="ruby-regexp">/(.*?)\n/</span>
+  <span class="ruby-ivar">@ionian_timeout</span>       = <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@ionian_skip_select</span>   = <span class="ruby-keyword">false</span>
+  <span class="ruby-ivar">@ionian_build_methods</span> = <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-on_match" class="method-detail method-alias">
+        
+        <div class="method-heading">
+          <span class="method-name">on_match</span><span
+            class="method-args">(&block)</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+        </div>
+
+        
+
+        
+        <div class="aliases">
+          Alias for: <a href="IO.html#method-i-register_observer">register_observer</a>
+        </div>
+        
+      </div>
+
+    
       <div id="method-i-purge" class="method-detail ">
         
         <div class="method-heading">
@@ -275,14 +343,21 @@ href=":parameter">match</a>.</p>
 
         <div class="method-description">
           
-          <p>Erase the data in Ionian&#39;s buffer.</p>
+          <p>Erase the data in the <a href="IO.html">IO</a> and <a
+href="../Ionian.html">Ionian</a> buffers. This is typically handled
+automatically.</p>
           
           
 
           
           <div class="method-source-code" id="purge-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 89</span>
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 128</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">purge</span>
+  <span class="ruby-comment"># Erase IO buffer.</span>
+  <span class="ruby-keyword">while</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">0</span>
+    <span class="ruby-identifier">readpartial</span>(<span class="ruby-value">0xFFFF</span>)
+  <span class="ruby-keyword">end</span>
+  
   <span class="ruby-ivar">@ionian_buf</span> = <span class="ruby-string">&#39;&#39;</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -322,33 +397,57 @@ with match.pre_match.</p>
 
 <p>Data at the end of the buffer that is not matched can be accessed in the
 last match with match.post_match. This data remains in the buffer for the
-next <a href="IO.html#method-i-read_match">#read_match</a> cycle. This is
+next <a href="IO.html#method-i-read_match">read_match</a> cycle. This is
 helpful for protocols like RS232 that do not have packet boundries.</p>
 
 <p>kvargs:</p>
 
-<pre>Timeout: Timeout in seconds IO::select will block.</pre>
+<pre>timeout:        Timeout in seconds IO::select will block.
+skip_select:    Skip over the IO::select statement. Use if you
+                are calling IO::select ahead of this method.
+build_methods:  Build method accessors from named captures.
+                Enabled by default.</pre>
           
           
 
           
           <div class="method-source-code" id="read_match-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 57</span>
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">read_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-   <span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:timeout</span>, <span class="ruby-ivar">@ionian_timeout</span>
-   
-   <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">timeout</span>
-   <span class="ruby-ivar">@ionian_buf</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">read_partial</span> <span class="ruby-value">0xFFFF</span>
-   
-   <span class="ruby-ivar">@matches</span> = []
-   
-   <span class="ruby-keyword">while</span> <span class="ruby-ivar">@ionian_buf</span> <span class="ruby-operator">=~</span> <span class="ruby-ivar">@ionian_expression</span>
-     <span class="ruby-ivar">@matches</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">$~</span> <span class="ruby-comment"># Match data.</span>
-     <span class="ruby-keyword">yield</span> <span class="ruby-identifier">$~</span>
-   <span class="ruby-keyword">end</span>
-   
-   <span class="ruby-ivar">@ionian_buf</span> = <span class="ruby-node">$&#39;</span> <span class="ruby-comment"># Leave post match data in the buffer.</span>
-   <span class="ruby-ivar">@matches</span>
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 68</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+  <span class="ruby-identifier">timeout</span>       = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:timeout</span>, <span class="ruby-ivar">@ionian_timeout</span>
+  <span class="ruby-identifier">skip_select</span>   = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:skip_select</span>, <span class="ruby-ivar">@ionian_skip_select</span>
+  <span class="ruby-identifier">build_methods</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:build_methods</span>, <span class="ruby-ivar">@ionian_build_methods</span>
+  
+  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">skip_select</span>
+    <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">timeout</span>
+  <span class="ruby-keyword">end</span>
+  
+  <span class="ruby-comment"># Read data from the IO buffer until it&#39;s empty.</span>
+  <span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
+    <span class="ruby-ivar">@ionian_buf</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">readpartial</span>(<span class="ruby-value">0xFFFF</span>)
+    <span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">0</span>
+  <span class="ruby-keyword">end</span>
+  
+  <span class="ruby-ivar">@matches</span> = []
+  
+  <span class="ruby-keyword">while</span> <span class="ruby-ivar">@ionian_buf</span> <span class="ruby-operator">=~</span> <span class="ruby-ivar">@ionian_expression</span>
+    <span class="ruby-ivar">@matches</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">$~</span> <span class="ruby-comment"># Match data.</span>
+    <span class="ruby-keyword">yield</span> <span class="ruby-identifier">$~</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
+    <span class="ruby-ivar">@ionian_buf</span> = <span class="ruby-node">$&#39;</span> <span class="ruby-comment"># Leave post match data in the buffer.</span>
+  <span class="ruby-keyword">end</span>
+  
+  <span class="ruby-comment"># Convert match parameters to methods.</span>
+  <span class="ruby-keyword">if</span> <span class="ruby-identifier">build_methods</span>
+    <span class="ruby-ivar">@matches</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">match</span>.<span class="ruby-identifier">names</span>
+        .<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>}
+        .<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">symbol</span><span class="ruby-operator">|</span> <span class="ruby-identifier">match</span>.<span class="ruby-identifier">singleton_class</span>
+          .<span class="ruby-identifier">send</span>(<span class="ruby-value">:define_method</span>, <span class="ruby-identifier">symbol</span>) { <span class="ruby-identifier">match</span>[<span class="ruby-identifier">symbol</span>] }                  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">match</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">symbol</span>
+        }
+    <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">end</span>
+  
+  <span class="ruby-ivar">@matches</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
           
@@ -383,7 +482,7 @@ ionian_socket.register_observer {…}</p>
 
           
           <div class="method-source-code" id="register_observer-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 97</span>
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 141</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">register_observer</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
   <span class="ruby-ivar">@ionian_listeners</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">block</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">block</span>
   <span class="ruby-identifier">block</span>
@@ -393,6 +492,10 @@ ionian_socket.register_observer {…}</p>
         </div>
 
         
+        <div class="aliases">
+          Also aliased as: <a href="IO.html#method-i-on_match">on_match</a>
+        </div>
+        
 
         
       </div>
@@ -402,7 +505,7 @@ ionian_socket.register_observer {…}</p>
         
         <div class="method-heading">
           <span class="method-name">run_match</span><span
-            class="method-args">(**kvargs) { |matches| ... }</span>
+            class="method-args">(**kvargs)</span>
           
           <span class="method-click-advice">click to toggle source</span>
           
@@ -411,21 +514,27 @@ ionian_socket.register_observer {…}</p>
 
         <div class="method-description">
           
-          <p>Start a thread that checks for data and notifies listeners. Passes kvargs
-to <a href="IO.html#method-i-read_match">read_match</a>. This method SHOULD
-NOT be used if <a href="IO.html#method-i-read_match">read_match</a> is
-used.</p>
+          <p>Start a thread that checks for data and notifies listeners (do |match,
+socket|). Passes kvargs to <a
+href="IO.html#method-i-read_match">read_match</a>. This method SHOULD NOT
+be used if <a href="IO.html#method-i-read_match">read_match</a> is used.</p>
           
           
 
           
           <div class="method-source-code" id="run_match-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 77</span>
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 109</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">run_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
   <span class="ruby-ivar">@match_listener</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
-    <span class="ruby-keyword">while</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">closed?</span> <span class="ruby-keyword">do</span>
-        <span class="ruby-identifier">matches</span> = <span class="ruby-identifier">read_match</span> <span class="ruby-identifier">kvargs</span>
-        <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">listener</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">matches</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">matches</span>
+    <span class="ruby-keyword">begin</span>
+      <span class="ruby-keyword">while</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">closed?</span> <span class="ruby-keyword">do</span>
+          <span class="ruby-identifier">matches</span> = <span class="ruby-identifier">read_match</span> <span class="ruby-identifier">kvargs</span>
+          <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
+            <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">listener</span><span class="ruby-operator">|</span> <span class="ruby-identifier">listener</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">match</span>, <span class="ruby-keyword">self</span>}
+          } <span class="ruby-keyword">if</span> <span class="ruby-identifier">matches</span>
+      <span class="ruby-keyword">end</span>
+    <span class="ruby-keyword">rescue</span> <span class="ruby-constant">EOFError</span>
+    <span class="ruby-keyword">rescue</span> <span class="ruby-constant">IOError</span>
     <span class="ruby-keyword">end</span>
     
     <span class="ruby-ivar">@match_listener</span> = <span class="ruby-keyword">nil</span>
@@ -460,7 +569,7 @@ used.</p>
 
           
           <div class="method-source-code" id="unregister_observer-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 103</span>
+            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 149</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">unregister_observer</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
   <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">delete_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">o</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">block</span>}
   <span class="ruby-identifier">block</span>

data/doc/Ionian.html

@@ -72,6 +72,11 @@
 
   <section class="description">
     
+<p>A library to simplify interaction with <a href="Ionian/IO.html">IO</a>
+streams. This includes network sockets, file sockets, and serial streams
+like the console and RS232. Features regular expression matching and
+notification of received data.</p>
+
   </section>
 
   

data/doc/created.rid

@@ -1,3 +1,3 @@
-Wed, 13 Nov 2013 18:38:14 -0800
-lib/ionian.rb	Wed, 13 Nov 2013 18:29:31 -0800
-lib/ionian/io.rb	Wed, 13 Nov 2013 18:31:32 -0800
+Thu, 14 Nov 2013 20:06:47 -0800
+lib/ionian.rb	Thu, 14 Nov 2013 20:05:18 -0800
+lib/ionian/io.rb	Thu, 14 Nov 2013 20:03:31 -0800

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["ionian","io","extended()","initialize_ionian()","match()","purge()","read_match()","register_observer()","run_match()","unregister_observer()"],"longSearchIndex":["ionian","ionian::io","ionian::io::extended()","ionian::io#initialize_ionian()","ionian::io#match()","ionian::io#purge()","ionian::io#read_match()","ionian::io#register_observer()","ionian::io#run_match()","ionian::io#unregister_observer()"],"info":[["Ionian","","Ionian.html","",""],["Ionian::IO","","Ionian/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of data in …\n"],["extended","Ionian::IO","Ionian/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["initialize_ionian","Ionian::IO","Ionian/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["match","Ionian::IO","Ionian/IO.html#method-i-match","(expression)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["purge","Ionian::IO","Ionian/IO.html#method-i-purge","()","<p>Erase the data in Ionian&#39;s buffer.\n"],["read_match","Ionian::IO","Ionian/IO.html#method-i-read_match","(**kvargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["register_observer","Ionian::IO","Ionian/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["run_match","Ionian::IO","Ionian/IO.html#method-i-run_match","(**kvargs)","<p>Start a thread that checks for data and notifies listeners. Passes kvargs\nto #read_match. This method …\n"],["unregister_observer","Ionian::IO","Ionian/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"]]}}
+var search_data = {"index":{"searchIndex":["ionian","io","expression()","expression=()","extended()","initialize_ionian()","on_match()","purge()","read_match()","register_observer()","run_match()","unregister_observer()"],"longSearchIndex":["ionian","ionian::io","ionian::io#expression()","ionian::io#expression=()","ionian::io::extended()","ionian::io#initialize_ionian()","ionian::io#on_match()","ionian::io#purge()","ionian::io#read_match()","ionian::io#register_observer()","ionian::io#run_match()","ionian::io#unregister_observer()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::IO","","Ionian/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["expression","Ionian::IO","Ionian/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::IO","Ionian/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::IO","Ionian/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["initialize_ionian","Ionian::IO","Ionian/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["on_match","Ionian::IO","Ionian/IO.html#method-i-on_match","(&block)",""],["purge","Ionian::IO","Ionian/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["read_match","Ionian::IO","Ionian/IO.html#method-i-read_match","(**kvargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["register_observer","Ionian::IO","Ionian/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["run_match","Ionian::IO","Ionian/IO.html#method-i-run_match","(**kvargs)","<p>Start a thread that checks for data and notifies listeners (do |match,\nsocket|). Passes kvargs to #read_match …\n"],["unregister_observer","Ionian::IO","Ionian/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"]]}}

data/doc/table_of_contents.html

@@ -44,13 +44,23 @@
     —
     <span class="container">Ionian::IO</span>
 
+  <li class="method">
+    <a href="Ionian/IO.html#method-i-expression">#expression</a>
+    &mdash;
+    <span class="container">Ionian::IO</span>
+
+  <li class="method">
+    <a href="Ionian/IO.html#method-i-expression-3D">#expression=</a>
+    &mdash;
+    <span class="container">Ionian::IO</span>
+
   <li class="method">
     <a href="Ionian/IO.html#method-i-initialize_ionian">#initialize_ionian</a>
     &mdash;
     <span class="container">Ionian::IO</span>
 
   <li class="method">
-    <a href="Ionian/IO.html#method-i-match">#match</a>
+    <a href="Ionian/IO.html#method-i-on_match">#on_match</a>
     &mdash;
     <span class="container">Ionian::IO</span>
 

data/lib/ionian/io.rb

@@ -1,6 +1,6 @@
 module Ionian
   # A mixin for IO objects that allows regular expression matching
-  # and convenient notification of data in the buffer.
+  # and convenient notification of received data.
   #
   # This module was designed to be EXTENDED by instantiated objects
   # that implement the standard library IO class.
@@ -9,32 +9,39 @@ module Ionian
     # Number of seconds to attempt an IO operation before timing out.
     # See standard library IO::select.
     attr_accessor :ionian_timeout
-   
+    
     # Called automaticallly when the object is extended with #extend.
     def self.extended(obj)
       obj.initialize_ionian
     end
-   
+    
     # Initialize the Ionian instance variables.
     # This is called automatically if #extend is called on an object.
     def initialize_ionian
-      @ionian_listeners  = []
-      @ionian_buf        = ''
-      @ionian_expression = /(.*?)\n/
-      @ionian_timeout    = 1
+      @ionian_listeners     = []
+      @ionian_buf           = ''
+      @ionian_expression    = /(.*?)\n/
+      @ionian_timeout       = nil
+      @ionian_skip_select   = false
+      @ionian_build_methods = true
     end
-   
+    
+    # Returns the regular expression used for #read_match.
+    def expression
+      @ionian_expression
+    end
+    
     # Set the expression to match against the read buffer.
     # Can be a regular expression specifying capture groups,
     # or a string specifying the separator or line terminator
     # sequence. It is possible to use named captures in a
     # regex, which allows for convienient accessors like
     # match[:parameter].
-    def match(expression)
-      @ionian_expression = expression
-      @ionian_expression = Regexp.new "(.*?)#{expression}" if expression.is_a? String
+    def expression=(exp)
+      @ionian_expression = exp
+      @ionian_expression = Regexp.new "(.*?)#{expression}" if exp.is_a? String
     end
-   
+    
     # Read matched data from the buffer.
     # This method SHOULD NOT be used if #run_match is used.
     #
@@ -49,47 +56,84 @@ module Ionian
     #
     # Data at the end of the buffer that is not matched can be accessed
     # in the last match with match.post_match. This data remains in the
-    # buffer for the next read_match cycle. This is helpful for protocols
+    # buffer for the next #read_match cycle. This is helpful for protocols
     # like RS232 that do not have packet boundries.
     #
     # kvargs:
-    #   Timeout: Timeout in seconds IO::select will block.
+    #   timeout:        Timeout in seconds IO::select will block.
+    #   skip_select:    Skip over the IO::select statement. Use if you
+    #                   are calling IO::select ahead of this method.
+    #   build_methods:  Build method accessors from named captures.
+    #                   Enabled by default.
     def read_match(**kvargs, &block)
-      timeout = kvargs.fetch :timeout, @ionian_timeout
+      timeout       = kvargs.fetch :timeout, @ionian_timeout
+      skip_select   = kvargs.fetch :skip_select, @ionian_skip_select
+      build_methods = kvargs.fetch :build_methods, @ionian_build_methods
       
-      return nil unless IO.select [self], nil, nil, timeout
-      @ionian_buf << read_partial 0xFFFF
+      unless skip_select
+        return nil unless ::IO.select [self], nil, nil, timeout
+      end
+      
+      # Read data from the IO buffer until it's empty.
+      loop do
+        @ionian_buf << readpartial(0xFFFF)
+        break unless ::IO.select [self], nil, nil, 0
+      end
       
       @matches = []
       
       while @ionian_buf =~ @ionian_expression
         @matches << $~ # Match data.
-        yield $~
+        yield $~ if block_given?
+        @ionian_buf = $' # Leave post match data in the buffer.
+      end
+      
+      # Convert match parameters to methods.
+      if build_methods
+        @matches.each do |match|
+          match.names
+            .map {|name| name.to_sym}
+            .each {|symbol| match.singleton_class
+              .send(:define_method, symbol) { match[symbol] } \
+                unless match.respond_to? symbol
+            }
+        end
       end
       
-      @ionian_buf = $' # Leave post match data in the buffer.
       @matches
-   end
+    end
    
-    # Start a thread that checks for data and notifies listeners.
+    # Start a thread that checks for data and notifies listeners (do |match, socket|).
     # Passes kvargs to #read_match.
     # This method SHOULD NOT be used if #read_match is used.
     def run_match(**kvargs)
       @match_listener ||= Thread.new do
-        while not closed? do
-            matches = read_match kvargs
-            @ionian_listeners.each {|listener| yield matches} if matches
+        begin
+          while not closed? do
+              matches = read_match kvargs
+              matches.each {|match|
+                @ionian_listeners.each {|listener| listener.call match, self}
+              } if matches
+          end
+        rescue EOFError
+        rescue IOError
         end
         
         @match_listener = nil
       end
     end
-   
-   # Erase the data in Ionian's buffer.
+    
+    # Erase the data in the IO and Ionian buffers.
+    # This is typically handled automatically.
     def purge
+      # Erase IO buffer.
+      while ::IO.select [self], nil, nil, 0
+        readpartial(0xFFFF)
+      end
+      
       @ionian_buf = ''
     end
-   
+    
     # Register a block to be called when #run_match receives matched data.
     # Method callbacks can be registered with &object.method(:method).
     # Returns a reference to the given block.
@@ -98,13 +142,14 @@ module Ionian
       @ionian_listeners << block unless @ionian_listeners.include? block
       block
     end
-   
+    
+    alias_method :on_match, :register_observer
+    
     # Unregister a block from being called when matched data is received.
     def unregister_observer(&block)
       @ionian_listeners.delete_if {|o| o == block}
       block
     end
-   
+  
   end
-end
- 
+end

data/lib/ionian.rb

@@ -1 +1,8 @@
-require 'ionian/io'
+require 'ionian/io'
+
+# A library to simplify interaction with IO streams.
+# This includes network sockets, file sockets, and
+# serial streams like the console and RS232. Features
+# regular expression matching and notification of
+# received data.
+module Ionian; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ionian
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex McLain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,60 +66,61 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A mixin for IO objects that allows regular expression matching and convenient
-  notification of data in the buffer.
+description: A library to simplify interaction with IO streams. This includes network
+  sockets, file sockets, and serial streams like the console and RS232. Features regular
+  expression matching and notification of received data.
 email: alex@alexmclain.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- doc/Ionian.html
-- doc/Ionian/IO.html
-- doc/created.rid
+- license.txt
+- lib/ionian.rb
+- lib/ionian/io.rb
 - doc/fonts.css
-- doc/fonts/Lato-Light.ttf
-- doc/fonts/Lato-LightItalic.ttf
-- doc/fonts/Lato-Regular.ttf
-- doc/fonts/Lato-RegularItalic.ttf
-- doc/fonts/SourceCodePro-Bold.ttf
-- doc/fonts/SourceCodePro-Regular.ttf
-- doc/images/add.png
-- doc/images/arrow_up.png
+- doc/images/page_green.png
 - doc/images/brick.png
-- doc/images/brick_link.png
+- doc/images/wrench.png
+- doc/images/find.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/arrow_up.png
 - doc/images/bug.png
-- doc/images/bullet_black.png
 - doc/images/bullet_toggle_minus.png
-- doc/images/bullet_toggle_plus.png
-- doc/images/date.png
-- doc/images/delete.png
-- doc/images/find.png
-- doc/images/loadingAnimation.gif
-- doc/images/macFFBgHack.png
-- doc/images/package.png
-- doc/images/page_green.png
-- doc/images/page_white_text.png
+- doc/images/wrench_orange.png
+- doc/images/tag_blue.png
 - doc/images/page_white_width.png
+- doc/images/page_white_text.png
+- doc/images/package.png
+- doc/images/bullet_black.png
 - doc/images/plugin.png
+- doc/images/delete.png
+- doc/images/brick_link.png
 - doc/images/ruby.png
-- doc/images/tag_blue.png
+- doc/images/loadingAnimation.gif
+- doc/images/date.png
+- doc/images/add.png
+- doc/images/zoom.png
 - doc/images/tag_green.png
+- doc/images/macFFBgHack.png
 - doc/images/transparent.png
-- doc/images/wrench.png
-- doc/images/wrench_orange.png
-- doc/images/zoom.png
-- doc/index.html
-- doc/js/darkfish.js
+- doc/js/searcher.js
 - doc/js/jquery.js
-- doc/js/navigation.js
 - doc/js/search.js
+- doc/js/darkfish.js
 - doc/js/search_index.js
-- doc/js/searcher.js
-- doc/rdoc.css
+- doc/js/navigation.js
+- doc/Ionian.html
+- doc/Ionian/IO.html
 - doc/table_of_contents.html
-- lib/ionian.rb
-- lib/ionian/io.rb
-- license.txt
+- doc/created.rid
+- doc/index.html
+- doc/rdoc.css
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
 homepage: https://bitbucket.org/amclain/ionian
 licenses:
 - MIT
@@ -140,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.preview.1
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Regular expression matching and notification for IO.
+summary: Regular expression matching and notification for IO streams.
 test_files: []