RubyGems - redsnow - Versions diffs - 0.3.1 → 0.3.2 - Mend

redsnow 0.3.1 → 0.3.2

Files changed (583) hide show

@@ -0,0 +1,343 @@
+<!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: RedSnow::Metadata
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/Metadata.html";
+</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 (M)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">Metadata</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: RedSnow::Metadata
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="KeyValueCollection.html" title="RedSnow::KeyValueCollection (class)">KeyValueCollection</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BlueprintNode.html" title="RedSnow::BlueprintNode (class)">BlueprintNode</a></span></li>
+            <li class="next"><span class='object_link'><a href="KeyValueCollection.html" title="RedSnow::KeyValueCollection (class)">KeyValueCollection</a></span></li>
+            <li class="next">RedSnow::Metadata</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/redsnow/blueprint.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Metadata collection Blueprint AST node  represents &#39;metadata
+section&#39;</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <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="#collection-instance_method" title="#collection (instance method)">- (Array&lt;Hash&gt;) <strong>collection</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="KeyValueCollection.html#collection-instance_method" title="RedSnow::KeyValueCollection#collection (method)">KeyValueCollection</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>array of key value hashes.</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="#initialize-instance_method" title="#initialize (instance method)">- (Metadata) <strong>initialize</strong>(sc_metadata_collection_handle) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Constructor.</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="RedSnow::Metadata (class)">Metadata</a></span></tt>) <strong>initialize</strong>(sc_metadata_collection_handle)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Constructor</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>sc_metadata_collection_handle</span>
+        <span class='type'>(<tt>FFI::Pointer</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 62</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_metadata_collection_handle'>sc_metadata_collection_handle</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_sc_metadata_collection_size'>sc_metadata_collection_size</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_metadata_collection_size'>sc_metadata_collection_size</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_metadata_collection_handle'>sc_metadata_collection_handle</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_sc_metadata_collection_size'>sc_metadata_collection_size</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_metadata_size'>metadata_size</span> <span class='op'>=</span> <span class='id identifier rubyid_sc_metadata_collection_size'>sc_metadata_collection_size</span> <span class='op'>-</span> <span class='int'>1</span>
+    <span class='ivar'>@collection</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+    <span class='kw'>for</span> <span class='id identifier rubyid_index'>index</span> <span class='kw'>in</span> <span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_metadata_size'>metadata_size</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_sc_metadata_handle'>sc_metadata_handle</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_metadata_handle'>sc_metadata_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_metadata_collection_handle'>sc_metadata_collection_handle</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
+      <span class='ivar'>@collection</span> <span class='op'>&lt;&lt;</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_metadata_key'>sc_metadata_key</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_metadata_handle'>sc_metadata_handle</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:value</span> <span class='op'>=&gt;</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_metadata_value'>sc_metadata_value</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_metadata_handle'>sc_metadata_handle</span><span class='rparen'>)</span><span class='rbracket'>]</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</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="collection=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="collection-instance_method">
+    - (<tt>Array&lt;Hash&gt;</tt>) <strong>collection</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="KeyValueCollection.html#collection-instance_method" title="RedSnow::KeyValueCollection#collection (method)">KeyValueCollection</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>array of key value hashes</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of collection</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>

data/doc/RedSnow/NamedBlueprintNode.html ADDED

@@ -0,0 +1,444 @@
+<!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: RedSnow::NamedBlueprintNode
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/NamedBlueprintNode.html";
+</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 (N)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">NamedBlueprintNode</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: RedSnow::NamedBlueprintNode
+  <span class="abstract note title">Abstract</span>
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="BlueprintNode.html" title="RedSnow::BlueprintNode (class)">BlueprintNode</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BlueprintNode.html" title="RedSnow::BlueprintNode (class)">BlueprintNode</a></span></li>
+            <li class="next">RedSnow::NamedBlueprintNode</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/redsnow/blueprint.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This class is abstract.</strong>
+  <div class='inline'></div>
+</div>
+<p>Blueprint AST node with name and description associated</p>
+  </div>
+</div>
+<div class="tags">
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="Action.html" title="RedSnow::Action (class)">Action</a></span>, <span class='object_link'><a href="Blueprint.html" title="RedSnow::Blueprint (class)">Blueprint</a></span>, <span class='object_link'><a href="Parameter.html" title="RedSnow::Parameter (class)">Parameter</a></span>, <span class='object_link'><a href="Payload.html" title="RedSnow::Payload (class)">Payload</a></span>, <span class='object_link'><a href="Resource.html" title="RedSnow::Resource (class)">Resource</a></span>, <span class='object_link'><a href="ResourceGroup.html" title="RedSnow::ResourceGroup (class)">ResourceGroup</a></span>, <span class='object_link'><a href="TransactionExample.html" title="RedSnow::TransactionExample (class)">TransactionExample</a></span></p>
+</div>
+  <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="#description-instance_method" title="#description (instance method)">- (String) <strong>description</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>description of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>name of the node.</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="#ensure_description_newlines-instance_method" title="#ensure_description_newlines (instance method)">- (Object) <strong>ensure_description_newlines</strong>(buffer) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Ensure the input string buffer ends with two newlines.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="description=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="description-instance_method">
+    - (<tt>String</tt>) <strong>description</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>description of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of description</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 20</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
+  <span class='ivar'>@description</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="name=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>name of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of name</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 20</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
+  <span class='ivar'>@name</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="ensure_description_newlines-instance_method">
+    - (<tt><span class='object_link'><a href="Object.html" title="RedSnow::Object (class)">Object</a></span></tt>) <strong>ensure_description_newlines</strong>(buffer)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Ensure the input string buffer ends with two newlines.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>buffer</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>a buffer to check If the buffer does not ends with two newlines the
+newlines are added.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+29
+30
+31
+32
+33
+34
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 29</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_ensure_description_newlines'>ensure_description_newlines</span><span class='lparen'>(</span><span class='id identifier rubyid_buffer'>buffer</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_buffer'>buffer</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_description'>description</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>1</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_description'>description</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>2</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_buffer'>buffer</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>