RubyGems - ionian - Versions diffs - 0.3.0 → 0.4.0 - Mend

ionian 0.3.0 → 0.4.0

Files changed (13) hide show

checksums.yaml +4 -4
data/doc/Ionian/Socket.html +296 -51
data/doc/Ionian.html +3 -4
data/doc/created.rid +5 -4
data/doc/index.html +5 -1
data/doc/js/search_index.js +1 -1
data/doc/table_of_contents.html +86 -25
data/lib/ionian/extension/io.rb +165 -0
data/lib/ionian/extension/socket.rb +40 -0
data/lib/ionian/socket.rb +135 -25
data/lib/ionian.rb +2 -1
metadata +4 -3
data/lib/ionian/io.rb +0 -155

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bcea8e76124f692dbb73310c5eb10545318c838
-  data.tar.gz: 85c23350aa38dcce18ccbb9df3ac7fd32e1d6f05
+  metadata.gz: 81979c2c40c6fa759df1c49a2d5226edfb46ba18
+  data.tar.gz: 76e21b58efbdce773066a8f20c23f1a422df43e5
 SHA512:
-  metadata.gz: f1c181e45023688d2b978c396a488e1614dbecc7d5b4b7e790cfed11db794d2df1de267510a20c3fbc83922853f166c20823bdf7a6260bb5a58060d23929f1c7
-  data.tar.gz: 90d906bd4f2ca67bde0f4bb1dea8bdcc305ef9a6d85af1eea56bc3a5c58ff96bf87ed56e336214601facdd4b9195d057fb35b09c95a51ef59b36920e4298f3c7
+  metadata.gz: 239b709e5a1f3f112f238d01054d8e31d0b5f983ae4ef0093025f92573038f689ef1aa7f8425546afb7e53d8a8aac7e6d6d259a31bd38e023e3b78d433a06500
+  data.tar.gz: d8b5ab66d8ae1d31f0aa5d6046198eb34404e15af7711abce4ec09f43b1cecfcf16a0e0c71f31dee609ea8978081ad5369c1bd94787146f23de644f91c0bd5d9

data/doc/Ionian/Socket.html CHANGED Viewed

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
-<title>module Ionian::Socket - RDoc Documentation</title>
+<title>class Ionian::Socket - RDoc Documentation</title>
 <link href="../fonts.css" rel="stylesheet">
 <link href="../rdoc.css" rel="stylesheet">
@@ -21,7 +21,7 @@
 <script src="../js/darkfish.js"></script>
-<body id="top" role="document" class="module">
+<body id="top" role="document" class="class">
 <nav role="navigation">
   <div id="project-navigation">
     <div id="home-section" role="banner" class="nav-section">
@@ -58,7 +58,14 @@
   <div id="class-metadata">
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+  <p class="link">Object
+</div>
     <div id="extends-section" class="nav-section">
   <h3>Extended With Modules</h3>
@@ -66,7 +73,7 @@
   <ul class="link-list">
-    <li><a class="extend" href="IO.html">Ionian::IO</a>
+    <li><a class="extend" href="Extension/Socket.html">Ionian::Extension::Socket</a>
   </ul>
@@ -78,13 +85,25 @@
   <ul class="link-list" role="directory">
-    <li ><a href="#method-c-extended">::extended</a>
+    <li ><a href="#method-c-new">::new</a>
+    <li ><a href="#method-i-3C-3C">#&lt;&lt;</a>
+    <li ><a href="#method-i-closed-3F">#closed?</a>
+    <li ><a href="#method-i-cmd">#cmd</a>
+    <li ><a href="#method-i-flush">#flush</a>
+    <li ><a href="#method-i-has_data-3F">#has_data?</a>
-    <li ><a href="#method-i-initialize_ionian_socket">#initialize_ionian_socket</a>
+    <li ><a href="#method-i-persistent-3F">#persistent?</a>
-    <li ><a href="#method-i-no_delay">#no_delay</a>
+    <li ><a href="#method-i-protocol-3F">#protocol?</a>
-    <li ><a href="#method-i-no_delay-3D">#no_delay=</a>
+    <li ><a href="#method-i-puts">#puts</a>
+    <li ><a href="#method-i-write">#write</a>
   </ul>
 </div>
@@ -92,21 +111,13 @@
   </div>
 </nav>
-<main role="main" aria-labelledby="module-Ionian::Socket">
-  <h1 id="module-Ionian::Socket" class="module">
-    module Ionian::Socket
+<main role="main" aria-labelledby="class-Ionian::Socket">
+  <h1 id="class-Ionian::Socket" class="class">
+    class Ionian::Socket
   </h1>
   <section class="description">
-<p>A mixin for <a href="Socket.html">Socket</a> objects.</p>
-<p>This module was designed to be extended by instantiated objects that
-implement the standard library <a href="Socket.html">Socket</a> class.
-my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
-<p>Extending this module also extends <a href="IO.html">Ionian::IO</a>.</p>
   </section>
@@ -128,11 +139,11 @@ my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
        </header>
-      <div id="method-c-extended" class="method-detail ">
+      <div id="method-c-new" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">extended</span><span
-            class="method-args">(obj)</span>
+          <span class="method-name">new</span><span
+            class="method-args">(**kvargs)</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -141,16 +152,28 @@ my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
         <div class="method-description">
-          <p>Called automaticallly when the object is extended with extend.</p>
+          <p>TODO NOTES</p>
+<p>Always lazily instiantiate @socket, even when persistent? May not work with
+forwarding method calls. Oh! Unless the forwarded methods check for @socket
+to exist. Will persistent methods have to check for the socket not to be
+closed as well?</p>
-          <div class="method-source-code" id="extended-source">
+          <div class="method-source-code" id="new-source">
             <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 15</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">extended</span>(<span class="ruby-identifier">obj</span>)
-  <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">Ionian</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span>
-  <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">initialize_ionian_socket</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
+  <span class="ruby-ivar">@socket</span>         = <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@host</span>           = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:host</span>
+  <span class="ruby-ivar">@port</span>           = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:port</span>, <span class="ruby-value">23</span>
+  <span class="ruby-ivar">@expression</span>     = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:expression</span>, <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@protocol</span>       = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:protocol</span>, <span class="ruby-value">:tcp</span>
+  <span class="ruby-ivar">@persistent</span>     = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:persistent</span>, <span class="ruby-keyword">true</span>
+  <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@persistent</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -170,10 +193,38 @@ my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
        </header>
-      <div id="method-i-initialize_ionian_socket" class="method-detail ">
+      <div id="method-i-3C-3C" class="method-detail method-alias">
+        <div class="method-heading">
+          <span class="method-name">&lt;&lt;</span><span
+            class="method-args">(string)</span>
+        </div>
+        <div class="method-description">
+        </div>
+        <div class="aliases">
+          Alias for: <a href="Socket.html#method-i-write">write</a>
+        </div>
+      </div>
+      <div id="method-i-closed-3F" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">initialize_ionian_socket</span><span
+          <span class="method-name">closed?</span><span
             class="method-args">()</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -183,14 +234,58 @@ my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
         <div class="method-description">
+          <p>Returns true if the socket is closed.</p>
+          <div class="method-source-code" id="closed-3F-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 65</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">closed?</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">closed?</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-i-cmd" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">cmd</span><span
+            class="method-args">(string, **kvargs) { |match| ... }</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Send a command (data) to the socket. Returns received matches. Block yields
+received match. See <a
+href="Extension/IO.html#method-i-read_match">Ionian::Extension::IO#read_match</a></p>
-          <div class="method-source-code" id="initialize_ionian_socket-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 20</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_ionian_socket</span>
+          <div class="method-source-code" id="cmd-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 41</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">cmd</span>(<span class="ruby-identifier">string</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">create_socket</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">flush</span>
+  <span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">read_match</span>(<span class="ruby-identifier">kvargs</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">match</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>}
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
+  <span class="ruby-identifier">matches</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -202,10 +297,10 @@ my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
       </div>
-      <div id="method-i-no_delay" class="method-detail ">
+      <div id="method-i-flush" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">no_delay</span><span
+          <span class="method-name">flush</span><span
             class="method-args">()</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -215,17 +310,16 @@ my_socket.extend <a href="Socket.html">Ionian::Socket</a></p>
         <div class="method-description">
-          <p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise
-false.</p>
+          <p>Flushes buffered data to the operating system. This method has no effect on
+non-persistent sockets.</p>
-          <div class="method-source-code" id="no_delay-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 25</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">no_delay</span>
-  <span class="ruby-identifier">nagle_disabled</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">getsockopt</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">TCP_NODELAY</span>).<span class="ruby-identifier">data</span>.<span class="ruby-identifier">ord</span>
-  <span class="ruby-identifier">nagle_disabled</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
+          <div class="method-source-code" id="flush-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 72</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">flush</span>
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">flush</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@persistent</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -237,11 +331,11 @@ false.</p>
       </div>
-      <div id="method-i-no_delay-3D" class="method-detail ">
+      <div id="method-i-has_data-3F" class="method-detail ">
         <div class="method-heading">
-          <span class="method-name">no_delay=</span><span
-            class="method-args">(value)</span>
+          <span class="method-name">has_data?</span><span
+            class="method-args">(**kvargs)</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -250,17 +344,19 @@ false.</p>
         <div class="method-description">
-          <p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to
-false disables the flag (enables Nagle).</p>
+          <p>Returns true if there is data in the receive buffer. Args:</p>
+<pre>Timeout: Number of seconds to wait for data until
+  giving up. Set to nil for blocking.</pre>
-          <div class="method-source-code" id="no_delay-3D-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 32</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">no_delay=</span>(<span class="ruby-identifier">value</span>)
-  <span class="ruby-identifier">disable_nagle</span> = <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
-  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">setsockopt</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">TCP_NODELAY</span>, <span class="ruby-identifier">disable_nagle</span>
+          <div class="method-source-code" id="has_data-3F-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 59</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_data?</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
+  <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">has_data?</span> <span class="ruby-identifier">kvargs</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -269,6 +365,155 @@ false disables the flag (enables Nagle).</p>
+      </div>
+      <div id="method-i-persistent-3F" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">persistent?</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Returns true if the socket remains open after writing data.</p>
+          <div class="method-source-code" id="persistent-3F-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 34</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">persistent?</span>
+  <span class="ruby-ivar">@persistent</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@persistent</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-i-protocol-3F" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">protocol?</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,
+:unix</p>
+          <div class="method-source-code" id="protocol-3F-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 29</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">protocol?</span>
+  <span class="ruby-ivar">@protocol</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-i-puts" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">puts</span><span
+            class="method-args">(*string)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Writes the given string(s) to the socket and appends a newline character to
+any string not already ending with one.</p>
+          <div class="method-source-code" id="puts-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 78</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">string</span>)
+  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">chomp</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n&quot;</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;\n&quot;</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-i-write" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">write</span><span
+            class="method-args">(string)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Writes the given string to the socket. Returns the number of bytes written.</p>
+          <div class="method-source-code" id="write-source">
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 84</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">string</span>)
+  <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
+  <span class="ruby-identifier">num_bytes</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>
+  <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
+    <span class="ruby-comment"># Read in data to prevent RST packets.</span>
+    <span class="ruby-identifier">has_data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-ivar">@socket</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">0</span>
+    <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">readpartial</span> <span class="ruby-value">0xFFFF</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">has_data</span>
+    <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">close</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">num_bytes</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+        <div class="aliases">
+          Also aliased as: <a href="Socket.html#method-i-3C-3C">&lt;&lt;</a>
+        </div>
       </div>

data/doc/Ionian.html CHANGED Viewed

@@ -72,10 +72,9 @@
   <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>
+<p>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.</p>
   </section>

data/doc/created.rid CHANGED Viewed

@@ -1,4 +1,5 @@
-Sun, 01 Dec 2013 18:46:23 -0800
-lib/ionian.rb	Sun, 01 Dec 2013 18:46:19 -0800
-lib/ionian/io.rb	Sun, 01 Dec 2013 18:46:19 -0800
-lib/ionian/socket.rb	Sun, 01 Dec 2013 18:46:19 -0800
+Sun, 01 Dec 2013 18:46:48 -0800
+lib/ionian.rb	Sun, 01 Dec 2013 18:46:44 -0800
+lib/ionian/extension/io.rb	Sun, 01 Dec 2013 18:46:44 -0800
+lib/ionian/extension/socket.rb	Sun, 01 Dec 2013 18:46:44 -0800
+lib/ionian/socket.rb	Sun, 01 Dec 2013 18:46:44 -0800

data/doc/index.html CHANGED Viewed

@@ -64,7 +64,11 @@
     <li><a href="./Ionian.html">Ionian</a>
-    <li><a href="./Ionian/IO.html">Ionian::IO</a>
+    <li><a href="./Ionian/Extension.html">Ionian::Extension</a>
+    <li><a href="./Ionian/Extension/IO.html">Ionian::Extension::IO</a>
+    <li><a href="./Ionian/Extension/Socket.html">Ionian::Extension::Socket</a>
     <li><a href="./Ionian/Socket.html">Ionian::Socket</a>

data/doc/js/search_index.js CHANGED Viewed

	@@ -1 +1 @@
1	- var search_data = {"index":{"searchIndex":["ionian","io","socket","expression()","expression=()","extended()","extended()","initialize_ionian()","initialize_ionian_socket()","no_delay()","no_delay=()","on_match()","purge()","read_match()","register_observer()","run_match()","unregister_observer()"],"longSearchIndex":["ionian","ionian::io","ionian::socket","ionian::io#expression()","ionian::io#expression=()","ionian::io::extended()","ionian::socket::extended()","ionian::io#initialize_ionian()","ionian::socket#initialize_ionian_socket()","ionian::socket#no_delay()","ionian::socket#no_delay=()","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"],["Ionian::Socket","","Ionian/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\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"],["extended","Ionian::Socket","Ionian/Socket.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"],["initialize_ionian_socket","Ionian::Socket","Ionian/Socket.html#method-i-initialize_ionian_socket","()",""],["no_delay","Ionian::Socket","Ionian/Socket.html#method-i-no_delay","()","<p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise\nfalse.\n"],["no_delay=","Ionian::Socket","Ionian/Socket.html#method-i-no_delay-3D","(value)","<p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to\nfalse disables the flag (enables …\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"]]}}
1	+ var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","socket","<<()","closed?()","cmd()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","new()","no_delay()","no_delay=()","on_match()","persistent?()","protocol?()","purge()","puts()","read_match()","register_observer()","run_match()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::socket","ionian::socket#<<()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::io#on_match()","ionian::socket#persistent?()","ionian::socket#protocol?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_match()","ionian::extension::io#register_observer()","ionian::extension::io#run_match()","ionian::extension::io#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","",""],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Socket","","Ionian/Socket.html","",""],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, kvargs, &block)","<p>Send a command (data) to the socket. Returns received matches. Block yields\nreceived match. See Ionian::Extension::IO#read_match …\n"],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/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::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(kvargs)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/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"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()",""],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(*kvargs)","<p>TODO NOTES\n<p>Always lazily instiantiate @socket, even when persistent? May not work with\nforwarding method …\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise\nfalse.\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to\nfalse disables the flag (enables …\n"],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["protocol?","Ionian::Socket","Ionian/Socket.html#method-i-protocol-3F","()","<p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,\n:unix\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/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::Extension::IO","Ionian/Extension/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::Extension::IO","Ionian/Extension/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::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}

data/doc/table_of_contents.html CHANGED Viewed

@@ -32,9 +32,15 @@
     <a href="Ionian.html">Ionian</a>
   </li>
   <li class="module">
-    <a href="Ionian/IO.html">Ionian::IO</a>
+    <a href="Ionian/Extension.html">Ionian::Extension</a>
   </li>
   <li class="module">
+    <a href="Ionian/Extension/IO.html">Ionian::Extension::IO</a>
+  </li>
+  <li class="module">
+    <a href="Ionian/Extension/Socket.html">Ionian::Extension::Socket</a>
+  </li>
+  <li class="class">
     <a href="Ionian/Socket.html">Ionian::Socket</a>
   </li>
 </ul>
@@ -43,74 +49,129 @@
 <ul>
   <li class="method">
-    <a href="Ionian/IO.html#method-c-extended">::extended</a>
+    <a href="Ionian/Extension/IO.html#method-c-extended">::extended</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-c-extended">::extended</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
-    <a href="Ionian/Socket.html#method-c-extended">::extended</a>
+    <a href="Ionian/Socket.html#method-c-new">::new</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-expression">#expression</a>
+    <a href="Ionian/Socket.html#method-i-3C-3C">#&lt;&lt;</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-expression-3D">#expression=</a>
+    <a href="Ionian/Socket.html#method-i-closed-3F">#closed?</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-initialize_ionian">#initialize_ionian</a>
+    <a href="Ionian/Socket.html#method-i-cmd">#cmd</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/Socket.html#method-i-initialize_ionian_socket">#initialize_ionian_socket</a>
+    <a href="Ionian/Extension/IO.html#method-i-expression">#expression</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/IO.html#method-i-expression-3D">#expression=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Socket.html#method-i-flush">#flush</a>
+    &mdash;
+    <span class="container">Ionian::Socket</span>
+  <li class="method">
+    <a href="Ionian/Socket.html#method-i-has_data-3F">#has_data?</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/Socket.html#method-i-no_delay">#no_delay</a>
+    <a href="Ionian/Extension/IO.html#method-i-has_data-3F">#has_data?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/IO.html#method-i-initialize_ionian">#initialize_ionian</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-initialize_ionian_socket">#initialize_ionian_socket</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-no_delay">#no_delay</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-no_delay-3D">#no_delay=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/IO.html#method-i-on_match">#on_match</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Socket.html#method-i-persistent-3F">#persistent?</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/Socket.html#method-i-no_delay-3D">#no_delay=</a>
+    <a href="Ionian/Socket.html#method-i-protocol-3F">#protocol?</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-on_match">#on_match</a>
+    <a href="Ionian/Extension/IO.html#method-i-purge">#purge</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Extension::IO</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-purge">#purge</a>
+    <a href="Ionian/Socket.html#method-i-puts">#puts</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Socket</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-read_match">#read_match</a>
+    <a href="Ionian/Extension/IO.html#method-i-read_match">#read_match</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Extension::IO</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-register_observer">#register_observer</a>
+    <a href="Ionian/Extension/IO.html#method-i-register_observer">#register_observer</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Extension::IO</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-run_match">#run_match</a>
+    <a href="Ionian/Extension/IO.html#method-i-run_match">#run_match</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Extension::IO</span>
   <li class="method">
-    <a href="Ionian/IO.html#method-i-unregister_observer">#unregister_observer</a>
+    <a href="Ionian/Extension/IO.html#method-i-unregister_observer">#unregister_observer</a>
     &mdash;
-    <span class="container">Ionian::IO</span>
+    <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Socket.html#method-i-write">#write</a>
+    &mdash;
+    <span class="container">Ionian::Socket</span>
 </ul>
 </main>

data/lib/ionian/extension/io.rb ADDED Viewed

@@ -0,0 +1,165 @@
+module Ionian
+  module Extension
+    # A mixin for IO objects that allows regular expression matching
+    # and convenient notification of received data.
+    #
+    # This module was designed to be extended by instantiated objects
+    # that implement the standard library IO class.
+    # my_socket.extend Ionian::IO
+    module IO
+      # 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       = nil
+        @ionian_skip_select   = false
+        @ionian_build_methods = true
+      end
+      # Returns true if there is data in the receive buffer.
+      # Args:
+      #   Timeout: Number of seconds to wait for data until
+      #     giving up. Set to nil for blocking.
+      def has_data?(timeout: 0)
+        ::IO.select([self], nil, nil, timeout) ? true : false
+      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 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.
+      #
+      # Passes matches to the block (do |match|). If there are multiple
+      # matches, the block is called multiple times.
+      #
+      # Returns an array of matches.
+      # Returns nil if no data was received within the timeout period.
+      #
+      # Junk data that could exist before a match in the buffer can
+      # be accessed with match.pre_match.
+      #
+      # 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
+      # like RS232 that do not have packet boundries.
+      #
+      # kvargs:
+      #   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
+        skip_select   = kvargs.fetch :skip_select, @ionian_skip_select
+        build_methods = kvargs.fetch :build_methods, @ionian_build_methods
+        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 $~ if block_given?
+          @ionian_buf = $' # Leave post match data in the buffer.
+        end
+        # Convert named captures 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
+        @matches
+      end
+      # 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
+          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
+          ensure
+            @match_listener = nil
+          end
+        end
+      end
+      # 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.
+      # block = ionian_socket.register_observer {...}
+      def register_observer(&block)
+        @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/extension/socket.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require 'ionian/extension/io'
+require 'socket'
+module Ionian
+  module Extension
+    # A mixin for Socket objects.
+    #
+    # This module was designed to be extended by instantiated objects
+    # that implement the standard library Socket class.
+    # my_socket.extend Ionian::Socket
+    #
+    # Extending this module also extends Ionian::IO.
+    module Socket
+      # Called automaticallly when the object is extended with #extend.
+      def self.extended(obj)
+        obj.extend Ionian::Extension::IO
+        obj.initialize_ionian_socket
+      end
+      def initialize_ionian_socket
+      end
+      # Returns true if the TCP_NODELAY flag is enabled (Nagle disabled).
+      # Otherwise false.
+      def no_delay
+        nagle_disabled = self.getsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY).data.ord
+        nagle_disabled > 0 ? true : false
+      end
+      # Setting to true enables the TCP_NODELAY flag (disables Nagle).
+      # Setting to false disables the flag (enables Nagle).
+      def no_delay=(value)
+        disable_nagle = value ? 1 : 0
+        self.setsockopt ::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, disable_nagle
+      end
+    end
+  end
+end

data/lib/ionian/socket.rb CHANGED Viewed

@@ -1,37 +1,147 @@
-require 'ionian/io'
-require 'socket'
+require 'ionian/extension/socket'
 module Ionian
-  # A mixin for Socket objects.
-  #
-  # This module was designed to be extended by instantiated objects
-  # that implement the standard library Socket class.
-  # my_socket.extend Ionian::Socket
-  #
-  # Extending this module also extends Ionian::IO.
-  module Socket
+  class Socket
-    # Called automaticallly when the object is extended with #extend.
-    def self.extended(obj)
-      obj.extend Ionian::IO
-      obj.initialize_ionian_socket
+    ############
+    # TODO NOTES
+    ############
+    # Always lazily instiantiate @socket, even when persistent?
+    # May not work with forwarding method calls.
+    # Oh! Unless the forwarded methods check for @socket to exist.
+    # Will persistent methods have to check for the socket not to be
+    # closed as well?
+    def initialize(**kvargs)
+      @socket         = nil
+      @host           = kvargs.fetch :host
+      @port           = kvargs.fetch :port, 23
+      @expression     = kvargs.fetch :expression, nil
+      @protocol       = kvargs.fetch :protocol, :tcp
+      @persistent     = kvargs.fetch :persistent, true
+      create_socket if @persistent
+    end
+    # Returns a symbol of the type of protocol this socket uses:
+    # :tcp, :udp, :unix
+    def protocol?
+      @protocol
+    end
+    # Returns true if the socket remains open after writing data.
+    def persistent?
+      @persistent == false || @persistent == nil ? false : true
+    end
+    # Send a command (data) to the socket. Returns received matches.
+    # Block yields received match.
+    # See Ionian::Extension::IO#read_match
+    def cmd(string, **kvargs, &block)
+      create_socket unless @persistent
+      @socket.write string
+      @socket.flush
+      matches = @socket.read_match(kvargs) {|match| yield match if block_given?}
+      @socket.close unless @persistent
+      matches
+    end
+    ### Methods Forwarded To @socket ###
+    # Returns true if there is data in the receive buffer.
+    # Args:
+    #   Timeout: Number of seconds to wait for data until
+    #     giving up. Set to nil for blocking.
+    def has_data?(**kvargs)
+      return false unless @socket
+      @socket.has_data? kvargs
     end
-    def initialize_ionian_socket
+    # Returns true if the socket is closed.
+    def closed?
+      return true unless @socket
+      @socket.closed?
     end
-    # Returns true if the TCP_NODELAY flag is enabled (Nagle disabled).
-    # Otherwise false.
-    def no_delay
-      nagle_disabled = self.getsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY).data.ord
-      nagle_disabled > 0 ? true : false
+    # Flushes buffered data to the operating system.
+    # This method has no effect on non-persistent sockets.
+    def flush
+      @socket.flush if @persistent
+    end
+    # Writes the given string(s) to the socket and appends a
+    # newline character to any string not already ending with one.
+    def puts(*string)
+      self.write string.map{|s| s.chomp}.join("\n") + "\n"
+    end
+    # Writes the given string to the socket. Returns the number of
+    # bytes written.
+    def write(string)
+      create_socket unless @persistent
+      num_bytes = @socket.write string
+      unless @persistent
+        # Read in data to prevent RST packets.
+        has_data = ::IO.select [@socket], nil, nil, 0
+        @socket.readpartial 0xFFFF if has_data
+        @socket.close
+      end
+      num_bytes
+    end
+    alias_method :<<, :write
+    private
+    def create_socket
+      @socket.close if @socket and not @socket.closed?
+      case @protocol
+      when :tcp
+        @socket = ::TCPSocket.new @host, @port
+      when :udp
+        @socket = ::UDPSocket.new
+        @socket.connect @host, @port
+      when :unix
+        @socket = ::UNIXSocket.new @host
+      end
+      @socket.extend Ionian::Extension::Socket
+      @socket.expression = @expression if @expression
+      initialize_socket_methods
     end
-    # Setting to true enables the TCP_NODELAY flag (disables Nagle).
-    # Setting to false disables the flag (enables Nagle).
-    def no_delay=(value)
-      disable_nagle = value ? 1 : 0
-      self.setsockopt ::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, disable_nagle
+    # Expose the @socket methods that haven't been defined by this class.
+    # Only do this once for performance -- when non-persistent sockets are
+    # recreated, they should be of the same type of socket.
+    def initialize_socket_methods
+      # Only initialize once, lazily.
+      # For non-persistent sockets, this forwards the socket methods
+      # the first time data is sent -- when the new socket is created.
+      return if @socket_methods_initialized
+      # Forward undefined methods to @socket.
+      # This was chosen over method_missing to avoid traversing the object
+      # hierarchy on every method call, like transmitting data.
+      @socket.methods
+        .select {|m| @socket.respond_to? m}
+        .select {|m| not self.respond_to? m}
+        .each do |m|
+          self.singleton_class.send :define_method, m do |*args, &block|
+            @socket.__send__ m, *args, &block
+          end
+        end
+      @socket_methods_initialized = true
     end
   end

data/lib/ionian.rb CHANGED Viewed

@@ -1,4 +1,5 @@
-require 'ionian/io'
+require 'ionian/extension/io'
+require 'ionian/extension/socket'
 require 'ionian/socket'
 # A library to simplify interaction with IO streams.

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ionian
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex McLain
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -75,8 +75,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - license.txt
+- lib/ionian/extension/socket.rb
+- lib/ionian/extension/io.rb
 - lib/ionian/socket.rb
-- lib/ionian/io.rb
 - lib/ionian.rb
 - doc/fonts/SourceCodePro-Regular.ttf
 - doc/fonts/SourceCodePro-Bold.ttf

data/lib/ionian/io.rb DELETED Viewed

@@ -1,155 +0,0 @@
-module Ionian
-  # A mixin for IO objects that allows regular expression matching
-  # and convenient notification of received data.
-  #
-  # This module was designed to be extended by instantiated objects
-  # that implement the standard library IO class.
-  # my_socket.extend Ionian::IO
-  module IO
-    # 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       = 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 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.
-    #
-    # Passes matches to the block (do |match|). If there are multiple
-    # matches, the block is called multiple times.
-    #
-    # Returns an array of matches.
-    # Returns nil if no data was received within the timeout period.
-    #
-    # Junk data that could exist before a match in the buffer can
-    # be accessed with match.pre_match.
-    #
-    # 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
-    # like RS232 that do not have packet boundries.
-    #
-    # kvargs:
-    #   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
-      skip_select   = kvargs.fetch :skip_select, @ionian_skip_select
-      build_methods = kvargs.fetch :build_methods, @ionian_build_methods
-      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 $~ if block_given?
-        @ionian_buf = $' # Leave post match data in the buffer.
-      end
-      # Convert named captures 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
-      @matches
-    end
-    # 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
-        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 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.
-    # block = ionian_socket.register_observer {...}
-    def register_observer(&block)
-      @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