RubyGems - rfuzz - Versions diffs - 0.7 → 0.8 - Mend

rfuzz 0.7 → 0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (123) hide show

data/doc/rdoc/classes/RFuzz/PushBackIO.html ADDED Viewed

@@ -0,0 +1,296 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: RFuzz::PushBackIO</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">RFuzz::PushBackIO</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/rfuzz/pushbackio_rb.html">
+                lib/rfuzz/pushbackio.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+A simple class that using a StringIO object internally to allow for faster
+and simpler &quot;push back&quot; semantics. It basically lets you read a
+random amount from a secondary IO object, parse what is needed, and then
+anything remaining can be quickly pushed back in one chunk for the next
+read.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000017">close</a>&nbsp;&nbsp;
+      <a href="#M000015">flush</a>&nbsp;&nbsp;
+      <a href="#M000010">new</a>&nbsp;&nbsp;
+      <a href="#M000012">pop</a>&nbsp;&nbsp;
+      <a href="#M000018">protect</a>&nbsp;&nbsp;
+      <a href="#M000011">push</a>&nbsp;&nbsp;
+      <a href="#M000014">read</a>&nbsp;&nbsp;
+      <a href="#M000013">reset</a>&nbsp;&nbsp;
+      <a href="#M000016">write</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">secondary</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000010.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(secondary)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000017.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000017.html');return false;">
+          <span class="method-name">close</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000015.html');return false;">
+          <span class="method-name">flush</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000012.html');return false;">
+          <span class="method-name">pop</span><span class="method-args">(n)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000018.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000018.html');return false;">
+          <span class="method-name">protect</span><span class="method-args">() {|| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000011.html');return false;">
+          <span class="method-name">push</span><span class="method-args">(content)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Pushes the given string content back onto the stream for the next read to
+handle.
+</p>
+        </div>
+      </div>
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000014.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000014.html');return false;">
+          <span class="method-name">read</span><span class="method-args">(n, partial=false)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+First does a read from the internal buffer, and then appends anything
+needed from the secondary IO to complete the request. The return value is
+guaranteed to be a String, and never nil. If it returns a string of length
+0 then there is nothing to read from the buffer (most likely closed). It
+will also avoid reading from a secondary that&#8217;s closed.
+</p>
+<p>
+If partial==true then readpartial is used instead.
+</p>
+        </div>
+      </div>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000013.html');return false;">
+          <span class="method-name">reset</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+        <div class="method-heading">
+          <a href="PushBackIO.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('PushBackIO.src/M000016.html');return false;">
+          <span class="method-name">write</span><span class="method-args">(content)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000010.html ADDED Viewed

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>new (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 11</span>
+11:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">secondary</span>)
+12:       <span class="ruby-ivar">@secondary</span> = <span class="ruby-identifier">secondary</span>
+13:       <span class="ruby-ivar">@buffer</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>
+14:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000011.html ADDED Viewed

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>push (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 18</span>
+18:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">push</span>(<span class="ruby-identifier">content</span>)
+19:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">content</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
+20:         <span class="ruby-ivar">@buffer</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">content</span>)
+21:       <span class="ruby-keyword kw">end</span>
+22:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000012.html ADDED Viewed

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>pop (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 24</span>
+24:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pop</span>(<span class="ruby-identifier">n</span>)
+25:       <span class="ruby-ivar">@buffer</span>.<span class="ruby-identifier">rewind</span>
+26:       <span class="ruby-ivar">@buffer</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">n</span>) <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;&quot;</span>
+27:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000013.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>reset (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 29</span>
+29:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>
+30:       <span class="ruby-ivar">@buffer</span>.<span class="ruby-identifier">string</span> = <span class="ruby-ivar">@buffer</span>.<span class="ruby-identifier">read</span>  <span class="ruby-comment cmt"># reset out internal buffer</span>
+31:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000014.html ADDED Viewed

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>read (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 40</span>
+40:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>(<span class="ruby-identifier">n</span>, <span class="ruby-identifier">partial</span>=<span class="ruby-keyword kw">false</span>)
+41:       <span class="ruby-identifier">r</span> = <span class="ruby-identifier">pop</span>(<span class="ruby-identifier">n</span>)
+42:       <span class="ruby-identifier">needs</span> = <span class="ruby-identifier">n</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">length</span>
+43:
+44:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">needs</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
+45:         <span class="ruby-identifier">sec</span> = <span class="ruby-value str">&quot;&quot;</span>
+46:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">partial</span>
+47:           <span class="ruby-keyword kw">begin</span>
+48:             <span class="ruby-identifier">protect</span> <span class="ruby-keyword kw">do</span>
+49:               <span class="ruby-identifier">sec</span> = <span class="ruby-ivar">@secondary</span>.<span class="ruby-identifier">readpartial</span>(<span class="ruby-identifier">needs</span>)
+50:             <span class="ruby-keyword kw">end</span>
+51:           <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">EOFError</span>
+52:             <span class="ruby-comment cmt"># TODO: notify closed? error?</span>
+53:           <span class="ruby-keyword kw">end</span>
+54:         <span class="ruby-keyword kw">else</span>
+55:           <span class="ruby-identifier">protect</span> { <span class="ruby-identifier">sec</span> = <span class="ruby-ivar">@secondary</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">needs</span>)}
+56:         <span class="ruby-keyword kw">end</span>
+57:
+58:         <span class="ruby-identifier">r</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">sec</span> <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;&quot;</span>)
+59:
+60:         <span class="ruby-comment cmt"># finally, if there's nothing at all returned then this is bad</span>
+61:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+62:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">HttpClientError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;Server returned empty response.&quot;</span>)
+63:         <span class="ruby-keyword kw">end</span>
+64:       <span class="ruby-keyword kw">end</span>
+65:
+66:       <span class="ruby-identifier">reset</span>
+67:       <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">r</span>
+68:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000015.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>flush (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 70</span>
+70:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">flush</span>
+71:       <span class="ruby-identifier">protect</span> { <span class="ruby-ivar">@secondary</span>.<span class="ruby-identifier">flush</span> }
+72:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000016.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>write (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 74</span>
+74:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">content</span>)
+75:       <span class="ruby-identifier">protect</span> { <span class="ruby-ivar">@secondary</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">content</span>) }
+76:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000017.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>close (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 78</span>
+78:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
+79:       <span class="ruby-identifier">protect</span> { <span class="ruby-ivar">@secondary</span>.<span class="ruby-identifier">close</span> }
+80:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RFuzz/PushBackIO.src/M000018.html ADDED Viewed

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>protect (RFuzz::PushBackIO)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/rfuzz/pushbackio.rb, line 82</span>
+82:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">protect</span>
+83:       <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@secondary</span>.<span class="ruby-identifier">closed?</span>
+84:         <span class="ruby-keyword kw">yield</span>
+85:       <span class="ruby-keyword kw">else</span>
+86:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">HttpClientError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;Socket closed.&quot;</span>)
+87:       <span class="ruby-keyword kw">end</span>
+88:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>