RubyGems - elster - Versions diffs - 0.1.1 → 0.1.2 - Mend

elster 0.1.1 → 0.1.2

Files changed (37) hide show

data/Users/jwebb/src/bigjason/elster/doc/Elster/Streamer.html DELETED

@@ -1,607 +0,0 @@
-<!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>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: Elster::Streamer
-    &mdash; Documentation by YARD 0.8.2.1
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '../';
-  framesUrl = "../frames.html#!" + escape(window.location.href);
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (S)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Elster.html" title="Elster (module)">Elster</a></span></span>
-     &raquo;
-    <span class="title">Streamer</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-      Class List
-    </a>
-    <a class="full_list_link" id="method_list_link"
-        href="../method_list.html">
-      Method List
-    </a>
-    <a class="full_list_link" id="file_list_link"
-        href="../file_list.html">
-      File List
-    </a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Elster::Streamer
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Elster::Streamer</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/elster/streamer.rb</dd>
-</dl>
-<div class="clear"></div>
-  <h2>Constant Summary</h2>
-  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#output-instance_method" title="#output (instance method)">- (Object) <strong>output</strong> </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute output.</p>
-</div></span>
-</li>
-  </ul>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#add-instance_method" title="#add (instance method)">- (Object) <strong>add</strong>(value = nil, &amp;block) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Output an array.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong>(close_stream = false) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Close the encoding optionally closing the provided output stream.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Streamer) <strong>initialize</strong>(output) </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'><p>Create a new instance of Streamer with the specified output stream.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#key-instance_method" title="#key (instance method)">- (Object) <strong>key</strong>(key, value = nil, &amp;block) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Output an object key value pair.</p>
-</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Elster::Streamer (class)">Streamer</a></span></tt>) <strong>initialize</strong>(output)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Create a new instance of Streamer with the specified output stream. The
-<code>output</code> must respond to <code>write</code>.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-9
-10
-11
-12
-13
-14</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/elster/streamer.rb', line 9</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_output'>output</span><span class='rparen'>)</span>
-  <span class='ivar'>@output</span> <span class='op'>=</span> <span class='id identifier rubyid_output'>output</span>
-  <span class='comment'># Some mutable state to make Rich Hickey weep.
-</span>  <span class='ivar'>@stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='ivar'>@item_count</span> <span class='op'>=</span> <span class='int'>0</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id=""></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="output-instance_method">
-    - (<tt>Object</tt>) <strong>output</strong>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the value of attribute output</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-5
-6
-7</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/elster/streamer.rb', line 5</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_output'>output</span>
-  <span class='ivar'>@output</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="add-instance_method">
-    - (<tt>Object</tt>) <strong>add</strong>(value = nil, &amp;block)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Output an array. If a block is passes the <code>value</code> will be ignored and a nested value
-started.</p>
-<p>Example:</p>
-<p>json.add(1)
-  json.add(&quot;Ansible&quot;)</p>
-<p>[ 1, &quot;Ansible&quot; ]</p>
-<p>json.add(1)
-  json.add do
-    json.set(:name, &quot;Wiggens&quot;)
-  end</p>
-<p>[ 1, { &quot;name&quot; : &quot;Wiggens&quot; } ]</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-88
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
-100
-101
-102
-103
-104
-105
-106
-107
-108
-109</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/elster/streamer.rb', line 88</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='ivar'>@current_type</span> <span class='op'>==</span> <span class='symbol'>:object</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>JsonContainerTypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Attempted to add an array value inside a JSON object.</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>end</span>
-  <span class='kw'>if</span> <span class='ivar'>@item_count</span> <span class='op'>&gt;</span> <span class='int'>0</span>
-    <span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>else</span>
-    <span class='ivar'>@current_type</span> <span class='op'>=</span> <span class='symbol'>:array</span>
-    <span class='id identifier rubyid_begin_section'>begin_section</span>
-  <span class='kw'>end</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
-    <span class='id identifier rubyid_nest_in'>nest_in</span>
-    <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
-    <span class='id identifier rubyid_nest_out'>nest_out</span>
-  <span class='kw'>else</span>
-    <span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_encode_value'>encode_value</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-  <span class='ivar'>@item_count</span> <span class='op'>+=</span> <span class='int'>1</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="close-instance_method">
-    - (<tt>Object</tt>) <strong>close</strong>(close_stream = false)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Close the encoding optionally closing the provided output stream.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-17
-18
-19
-20
-21
-22</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/elster/streamer.rb', line 17</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span><span class='lparen'>(</span><span class='id identifier rubyid_close_stream'>close_stream</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_end_section'>end_section</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_close_stream'>close_stream</span>
-    <span class='ivar'>@output</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="key-instance_method">
-    - (<tt>Object</tt>) <strong>key</strong>(key, value = nil, &amp;block)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Output an object key value pair. If a block is passed, the <code>value</code> will be
-ignored and a nested object or array can be added.</p>
-<p>Example:</p>
-<p>json.key(:mistake, &quot;HUGE!&quot;)</p>
-<p>{ &quot;mistake&quot; : &quot;HUGE!&quot; }</p>
-<p>json.key(:mistake) do
-     json.key(:type, &quot;HUGE!&quot;)
-   end</p>
-<p>{ &quot;mistake&quot; : { &quot;type&quot; : &quot;HUGE!&quot; } }</p>
-<p>json.key(:mistake) do
-     json.add(&quot;HUGE!&quot;)
-   end</p>
-<p>{ &quot;mistake&quot; : [ &quot;HUGE!&quot; ] }</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/elster/streamer.rb', line 46</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='ivar'>@current_type</span> <span class='op'>==</span> <span class='symbol'>:array</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>JsonContainerTypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Attempted to write an object `key` value inside a JSON array.</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>end</span>
-  <span class='kw'>if</span> <span class='ivar'>@item_count</span> <span class='op'>&gt;</span> <span class='int'>0</span>
-    <span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>else</span>
-    <span class='ivar'>@current_type</span> <span class='op'>=</span> <span class='symbol'>:object</span>
-    <span class='id identifier rubyid_begin_section'>begin_section</span>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_encode_value'>encode_value</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>:</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
-    <span class='id identifier rubyid_nest_in'>nest_in</span>
-    <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
-    <span class='id identifier rubyid_nest_out'>nest_out</span>
-  <span class='kw'>else</span>
-    <span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_encode_value'>encode_value</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-  <span class='ivar'>@item_count</span> <span class='op'>+=</span> <span class='int'>1</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Tue Aug 21 21:31:10 2012 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.2.1 (ruby-1.9.3).
-</div>
-  </body>
-</html>